This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
If you are looking for a simple way to test our API you might prefer our
Postman collection, the
YAML runner or the
Developers section of the web UI.
Additional YAML examples can be found in the articles in the
Overview section.
The principal description assured by the configured Identity Provider. All values are according to OIDC id token claims and standard claims. See https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
Responses
Description
200
A successful response.
401
Returned when the user is not authenticated to the system.
403
Returned when the user is not authorized to update the root principals.
patch/archivist/v1/tenancies/root_principals
Update the list of tenant root user principals
Description: Replace the list of tenant root user principals. Note that you are not able to remove yourself from the list.
The principal description assured by the configured Identity Provider. All values are according to OIDC id token claims and standard claims. See https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
The principal description assured by the configured Identity Provider. All values are according to OIDC id token claims and standard claims. See https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
Responses
Description
200
A successful response.
400
Returned when the request is badly formed. Including, but not limited to, attempting to remove yourself as a root uesr principal.
401
Returned when the user is not authenticated to the system.
403
Returned when the user is not authorized to update the root principals.
get/archivist/v1/tenancies/self
Get tenant record
Description: Returns an administrator’s view of tenant for which they’re authenticated
{
"display_name": "My First Tenancy",
"identity": "tenant/08838336-c357-460d-902a-3aba9528dd22",
"verified_domain": "foo.com"
}
Response Parameter
Type
Description
display_name
string
Customer friendly name for the tenant.
enterprise_sso_config
enterprise_sso_enabled
boolean
identity
string
tenant identity {UUID}
verified_domain
string
Responses
Description
200
A successful response.
400
Supplied parameters were invalid
401
Returned when the user is not authenticated to the system.
403
Returned when the user is not authorized to retrieve the tenant id.
patch/archivist/v1/tenancies/self
Update tenant record
Description: Enables a root principal of the tenant to update the tenant record.
{
"display_name": "My First Tenancy",
"identity": "tenant/08838336-c357-460d-902a-3aba9528dd22",
"verified_domain": "foo.com"
}
Response Parameter
Type
Description
display_name
string
Customer friendly name for the tenant.
enterprise_sso_config
enterprise_sso_enabled
boolean
identity
string
tenant identity {UUID}
verified_domain
string
Responses
Description
200
A successful response.
400
Returned when the request is badly formed.
401
Returned when the user is not authenticated to the system.
403
Returned when the user is not authorized to perform this action.
404
Returned when the referenced tenant does not exist.
get/archivist/v1/tenancies/tenantid
Get ID of tenant associated with issuer and/or subject, and create if not exists.
Description: Get ID of tenant associated with issuer and/or subject, and create if not exists.
null
Response Parameter
Type
Description
identity
string
tenant identity {UUID}
new_tenant
boolean
true if this request created a new tenant
tier
tenant tier FREE or PREMIUM
Responses
Description
200
A successful response.
400
Returned when the user doesn’t provide an issuer or subject to filter on.
401
Returned when the user is not authenticated to the system.
403
Returned when the user is not authorized to retrieve the tenant id.
get/archivist/v1/tenancies/users
List Users
Description: Returns a list of Users active in or invited to the tenant.