OpenAPI Example Render

get  /archivist/iam/v1/subjects

List subjects

Description: Returns a paginated list of subjects

{
  "page_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6InN0dW50aWR",
  "subjects": [
    {
      "display_name": "Some description",
      "identity": "subjects/08838336-c357-460d-902a-3aba9528dd22",
      "tessera_pub_key": [
        "key3"
      ],
      "wallet_pub_key": [
        "key1"
      ]
    }
  ]
}
Response Parameter Type Description
next_page_token string Token to retrieve the next page of results or empty if there are none.
subjects array Describes an Access Policy for OBAC
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to read the subject.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

post  /archivist/iam/v1/subjects

Create an subject

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

{
  "display_name": "Some description",
  "tessera_pub_key": [
    "key3"
  ],
  "wallet_pub_key": [
    "key1"
  ]
}
Parameter Type Description
display_name string Customer friendly name for the subject.
tessera_pub_key array Organisation’s tessara wallet keys (BNF)
wallet_pub_key array Organisation’s public wallet keys (BNF)

{
  "display_name": "Some description",
  "identity": "subjects/08838336-c357-460d-902a-3aba9528dd22",
  "tessera_pub_key": [
    "key3"
  ],
  "wallet_address": [
    "address1"
  ],
  "wallet_pub_key": [
    "key1"
  ]
}
Response Parameter Type Description
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 array Organisation’s tessara wallet keys (BNF)
wallet_address array Organisation’s wallet addresses
wallet_pub_key array Organisation’s public wallet keys (BNF)
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to create a subject.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

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

Delete a subject

Description: Delete the identified subject

Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to delete the subject.
404Returned when the identified laccess policy does not exist.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

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

Get an subject

Description: Returns the identified subject

{
  "display_name": "Some description",
  "identity": "subjects/08838336-c357-460d-902a-3aba9528dd22",
  "tessera_pub_key": [
    "key3"
  ],
  "wallet_address": [
    "address1"
  ],
  "wallet_pub_key": [
    "key1"
  ]
}
Response Parameter Type Description
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 array Organisation’s tessara wallet keys (BNF)
wallet_address array Organisation’s wallet addresses
wallet_pub_key array Organisation’s public wallet keys (BNF)
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to read the subject.
404Returned when the identified subject does not exist.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

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

Update a subject's details

Description: Perform a full or partial update of the identified subject

{
  "display_name": "Some description",
  "identity": "subjects/08838336-c357-460d-902a-3aba9528dd22",
  "tessera_pub_key": [
    "key3"
  ],
  "wallet_address": [
    "address1"
  ],
  "wallet_pub_key": [
    "key1"
  ]
}
Parameter Type Description
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 array Organisation’s tessara wallet keys (BNF)
wallet_address array Organisation’s wallet addresses
wallet_pub_key array Organisation’s public wallet keys (BNF)

{
  "display_name": "Some description",
  "identity": "subjects/08838336-c357-460d-902a-3aba9528dd22",
  "tessera_pub_key": [
    "key3"
  ],
  "wallet_address": [
    "address1"
  ],
  "wallet_pub_key": [
    "key1"
  ]
}
Response Parameter Type Description
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 array Organisation’s tessara wallet keys (BNF)
wallet_address array Organisation’s wallet addresses
wallet_pub_key array Organisation’s public wallet keys (BNF)
Responses Description
200A successful response.
400Returned when the request is badly formed.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to update the subject.
404Returned when the identified subject does not exist.
500Returned when the underlying storage system returns an error.
defaultAn unexpected error response.

Edit this page on GitHub