IAM Subjects Swagger API

GET /archivist/iam/v1/subjects

List subjects

Returns a paginated list of subjects

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) –

  Display name for filtering

  Customer friendly name for the subject.

• wallet_address (string) –

  XXX: Investigate max length. Its 256 elsewhere in this file, but that doesn’t seem right. Wallet address for filtering

  Customer friendly name for the subject.

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 subject.

• 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

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

• subjects[].confirmation_status (string) –

• subjects[].display_name (string) – Customer friendly name for the subject.

• subjects[].identity (string) – Unique identification for the subject, Relative Resource Name

• subjects[].tenant (string) – Tenent id

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

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

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

POST /archivist/iam/v1/subjects

Create an subject

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

Request JSON Object

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

• tessera_pub_key[] (string) –

• wallet_pub_key[] (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.

• 403 Forbidden – Returned when the user is not authorized to create a subject.

• 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

• confirmation_status (string) –

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

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

• tenant (string) – Tenent id

• tessera_pub_key[] (string) –

• wallet_address[] (string) –

• wallet_pub_key[] (string) –

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

Get an subject

Returns the identified subject

Parameters

• uuid (string) – Specify the Subject UUID where subjects/{uuid} is the Subject Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity subjects/add30235-1424-4fda-840a-d5ef82c4c96f. Note the special subject 00000000-0000-0000-0000-000000000000 represents the self subject, or your own organisation.

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 subject.

• 404 Not Found – Returned when the identified subject 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

• confirmation_status (string) –

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

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

• tenant (string) – Tenent id

• tessera_pub_key[] (string) –

• wallet_address[] (string) –

• wallet_pub_key[] (string) –

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

Delete a subject

Delete the identified subject

Parameters

• uuid (string) – Specify the Subject UUID where subjects/{uuid} is the Subject Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity subjects/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 subject.

• 404 Not Found – Returned when the identified laccess 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/subjects/{uuid}

Update a subject’s details

Perform a full or partial update of the identified subject

Parameters

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

Query Parameters

• mask (string) – The mask says exactly which fields are to be updated. This removes the ambiguity caused by ‘zero’ valued fields. https://grpc-ecosystem.github.io/grpc-gateway/docs/patch.html

Request JSON Object

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

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

• tenant (string) – Tenent id

• tessera_pub_key[] (string) –

• wallet_address[] (string) –

• wallet_pub_key[] (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.

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

• 404 Not Found – Returned when the identified subject 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

• confirmation_status (string) –

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

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

• tenant (string) – Tenent id

• tessera_pub_key[] (string) –

• wallet_address[] (string) –

• wallet_pub_key[] (string) –

GET /archivist/iam/v1/subjects:openapi

Get OpenAPI spec for Subjects

Get OpenAPI v2.0 spec for Subjects

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/subjects:openapi-ui

Get OpenAPI UI for Subjects

Get OpenAPI v2.0 UI for Subjects

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.