IAM access Policies Swagger API

GET /archivist/iam/v1/access_policies

List access policies

Returns a paginated list of access_policies

Query Parameters

  • order_by (string) – Specify the sort order for the results.

  • page_size (integer) – Maximum entries per page

  • page_token (string) – The next_page_token returned from a previous list request if any.

  • display_name (string) –

    Further fields are bound to query parameters and act to filter the result

    Customer friendly name for the access policy.

  • description (string) – Customer description of the access policy.

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to list the access policy.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

Response JSON Object

  • access_policies[].access_permissions[].asset_attributes_read[] (string) –

  • access_policies[].access_permissions[].asset_attributes_write[] (string) –

  • access_policies[].access_permissions[].behaviours[] (string) –

  • access_policies[].access_permissions[].event_arc_display_type_read[] (string) –

  • access_policies[].access_permissions[].event_arc_display_type_write[] (string) –

  • access_policies[].access_permissions[].include_attributes[] (string) –

  • access_policies[].access_permissions[].subjects[] (string) –

  • access_policies[].access_permissions[].user_attributes[].or[] (string) –

  • access_policies[].description (string) – Customer description for the access policy.

  • access_policies[].display_name (string) – Customer friendly name for the access policy.

  • access_policies[].filters[].or[] (string) –

  • access_policies[].identity (string) – Unique identification for the access policy, Relative Resource Name

  • access_policies[].tenant (string) – Tenant id

  • next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

POST /archivist/iam/v1/access_policies

Create an access policy

This request creates a new access policy. The display_name is the friendly name.

Request JSON Object

  • access_permissions[].asset_attributes_read[] (string) –

  • access_permissions[].asset_attributes_write[] (string) –

  • access_permissions[].behaviours[] (string) –

  • access_permissions[].event_arc_display_type_read[] (string) –

  • access_permissions[].event_arc_display_type_write[] (string) –

  • access_permissions[].include_attributes[] (string) –

  • access_permissions[].subjects[] (string) –

  • access_permissions[].user_attributes[].or[] (string) –

  • description (string) – Customer description for the access policy.

  • display_name (string) – Customer friendly name for the access policy. (required)

  • filters[].or[] (string) –

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 402 Payment Required – Returned when the user’s quota of access policies has been reached.

  • 403 Forbidden – Returned when the user is not authorized to create an access policy.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

Response JSON Object

  • access_permissions[].asset_attributes_read[] (string) –

  • access_permissions[].asset_attributes_write[] (string) –

  • access_permissions[].behaviours[] (string) –

  • access_permissions[].event_arc_display_type_read[] (string) –

  • access_permissions[].event_arc_display_type_write[] (string) –

  • access_permissions[].include_attributes[] (string) –

  • access_permissions[].subjects[] (string) –

  • access_permissions[].user_attributes[].or[] (string) –

  • description (string) – Customer description for the access policy.

  • display_name (string) – Customer friendly name for the access policy.

  • filters[].or[] (string) –

  • identity (string) – Unique identification for the access policy, Relative Resource Name

  • tenant (string) – Tenant id

GET /archivist/iam/v1/access_policies/{uuid}

Get an access policy

Returns the identified access policy

Parameters

  • uuid (string) – Specify the Access Policy UUID where access_policies/{uuid} is the Access Policy Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity access_policies/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to read the access policy.

  • 404 Not Found – Returned when the identified access policy does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

Response JSON Object

  • access_permissions[].asset_attributes_read[] (string) –

  • access_permissions[].asset_attributes_write[] (string) –

  • access_permissions[].behaviours[] (string) –

  • access_permissions[].event_arc_display_type_read[] (string) –

  • access_permissions[].event_arc_display_type_write[] (string) –

  • access_permissions[].include_attributes[] (string) –

  • access_permissions[].subjects[] (string) –

  • access_permissions[].user_attributes[].or[] (string) –

  • description (string) – Customer description for the access policy.

  • display_name (string) – Customer friendly name for the access policy.

  • filters[].or[] (string) –

  • identity (string) – Unique identification for the access policy, Relative Resource Name

  • tenant (string) – Tenant id

DELETE /archivist/iam/v1/access_policies/{uuid}

Delete an access policy

Delete the identified access policy

Parameters

  • uuid (string) – Specify the Access Policy UUID where access_policies/{uuid} is the Access Policy Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity access_policies/add30235-1424-4fda-840a-d5ef82c4c96f

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to delete the access policy.

  • 404 Not Found – Returned when the identified access policy does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

PATCH /archivist/iam/v1/access_policies/{uuid}

Update a access policy details

Perform a full or partial update of the identified access policy

Parameters

  • uuid (string) – Specify the Access Policy UUID where access_policies/{uuid} is the Access Policy Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity access_policies/add30235-1424-4fda-840a-d5ef82c4c96f

Query Parameters
Request JSON Object

  • access_permissions[].asset_attributes_read[] (string) –

  • access_permissions[].asset_attributes_write[] (string) –

  • access_permissions[].behaviours[] (string) –

  • access_permissions[].event_arc_display_type_read[] (string) –

  • access_permissions[].event_arc_display_type_write[] (string) –

  • access_permissions[].include_attributes[] (string) –

  • access_permissions[].subjects[] (string) –

  • access_permissions[].user_attributes[].or[] (string) –

  • description (string) – Customer description for the access policy.

  • display_name (string) – Customer friendly name for the access policy.

  • filters[].or[] (string) –

  • identity (string) – Unique identification for the access policy, Relative Resource Name

  • tenant (string) – Tenant id

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to update the access policy.

  • 404 Not Found – Returned when the identified access policy does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

Response JSON Object

  • access_permissions[].asset_attributes_read[] (string) –

  • access_permissions[].asset_attributes_write[] (string) –

  • access_permissions[].behaviours[] (string) –

  • access_permissions[].event_arc_display_type_read[] (string) –

  • access_permissions[].event_arc_display_type_write[] (string) –

  • access_permissions[].include_attributes[] (string) –

  • access_permissions[].subjects[] (string) –

  • access_permissions[].user_attributes[].or[] (string) –

  • description (string) – Customer description for the access policy.

  • display_name (string) – Customer friendly name for the access policy.

  • filters[].or[] (string) –

  • identity (string) – Unique identification for the access policy, Relative Resource Name

  • tenant (string) – Tenant id

GET /archivist/iam/v1/access_policies/{uuid}/assets

Returns assets matching access policy

Returns assets matching access policy

Parameters

  • uuid (string) – Specify the Access Policy UUID where access_policies/{uuid} is the Access Policy Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity access_policies/add30235-1424-4fda-840a-d5ef82c4c96f

Query Parameters

  • order_by (string) – Specify the sort order for the results.

  • page_size (integer) – Maximum entries per page

  • page_token (string) – The next_page_token returned from a previous list request if any.

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to list the access policy.

  • 404 Not Found – Returned when the identified access policy does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

Response JSON Object

  • assets[].access_policy (object) – key value mapping of behaviour to private for keys

  • assets[].at_time (string) – indicates time the asset data is from (read only)

  • assets[].attributes (object) – key value mapping of asset properties

  • assets[].behaviours[] (string) –

  • assets[].chain_id (string) – chain id of the blockchain associated with this asset (read only)

  • assets[].confirmation_status (string) –

  • assets[].identity (string) – relative resource address assets/{UUID} (read only)

  • assets[].owner (string) – wallet address of the asset owner (read only)

  • assets[].proof_mechanism (string) –

  • assets[].public (boolean) – Public asset

  • assets[].storage_integrity (string) – Specifies how the asset data will be stored. This is set once on creation and does not change.

  • assets[].tenant_identity (string) – Identity of the tenant the that created this asset

  • assets[].tracked (string) –

  • next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

GET /archivist/iam/v1/access_policies:caps

Get remaining capped resources for AccessPolicies

Not stable or officially supported. Get remaining capped resources for AccessPolicies

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

Response JSON Object

  • caps[].resource_remaining (string) – Number of capped resources remaining

  • caps[].resource_type (string) – String identifying the capped resource type

GET /archivist/iam/v1/assets/{uuid}/access_policies

Get matching access policies

Get matching access policies for specified asset

Parameters

  • uuid (string) – Specify the Asset UUID where assets/{uuid} is the Asset Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity assets/add30235-1424-4fda-840a-d5ef82c4c96f

Query Parameters

  • at_time (string) – Specify time in the past to show asset data as it was at time specified

Status Codes

  • 200 OK – A successful response.

  • 400 Bad Request – Returned when the request is badly formed.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 403 Forbidden – Returned when the user is not authorized to list the access policy.

  • 404 Not Found – Returned when the identified access policy does not exist.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • 500 Internal Server Error – Returned when the underlying storage system returns an error.

  • default – An unexpected error response.

Response JSON Object

  • access_policies[].access_permissions[].asset_attributes_read[] (string) –

  • access_policies[].access_permissions[].asset_attributes_write[] (string) –

  • access_policies[].access_permissions[].behaviours[] (string) –

  • access_policies[].access_permissions[].event_arc_display_type_read[] (string) –

  • access_policies[].access_permissions[].event_arc_display_type_write[] (string) –

  • access_policies[].access_permissions[].include_attributes[] (string) –

  • access_policies[].access_permissions[].subjects[] (string) –

  • access_policies[].access_permissions[].user_attributes[].or[] (string) –

  • access_policies[].description (string) – Customer description for the access policy.

  • access_policies[].display_name (string) – Customer friendly name for the access policy.

  • access_policies[].filters[].or[] (string) –

  • access_policies[].identity (string) – Unique identification for the access policy, Relative Resource Name

  • access_policies[].tenant (string) – Tenant id

  • next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

GET /archivist/iam/v1/access_policies:openapi

Get OpenAPI spec for AccessPolicies

Get OpenAPI v2.0 spec for AccessPolicies

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.

GET /archivist/iam/v1/access_policies:openapi-ui

Get OpenAPI UI for AccessPolicies

Get OpenAPI v2.0 UI for AccessPolicies

Status Codes

  • 200 OK – A successful response.

  • 401 Unauthorized – Returned when the user is not authenticated to the system.

  • 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

  • default – An unexpected error response.