Retrieve tenant

GET/v1/tenants/{tenantId}

Retrieves a tenant by its ID.

Analytics Events

TENANT_RETRIEVE_STARTTENANT_RETRIEVE_SUCCESSTENANT_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Unique ID of the tenant to retrieve.

Formatuuid

Response Body

`application/json`

`text/plain`

`application/json`

curl -X GET "https://example.com/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "86cb97a9-5e80-4ed7-af13-a170752bb1ea",  "name": "My Tenant",  "subdomain": "my-tenant.vii.au01.mattr.global",  "environment": {    "id": "fa605282-0223-4ae0-831d-af368bc39a55",    "name": "MATTR Public Sydney, Australia",    "domain": "vii.au01.mattr.global",    "authorizationServerDomain": "manage.auth.auth0.com",    "deploymentModel": "public",    "region": {      "id": "70bb433a-f0ec-4297-ad76-3b09c71311f3",      "name": "AU01",      "displayName": "Sydney, Australia"    }  },  "membership": {    "roles": [      "dts-provider",      "issuer"    ]  }}

GET/v1/tenants/{tenantId}

Retrieves a tenant by its ID.

Analytics Events

TENANT_RETRIEVE_STARTTENANT_RETRIEVE_SUCCESSTENANT_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Unique ID of the tenant to retrieve.

Formatuuid

Response Body

`application/json`

`text/plain`

`application/json`

curl -X GET "https://example.com/v1/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "86cb97a9-5e80-4ed7-af13-a170752bb1ea",  "name": "My Tenant",  "subdomain": "my-tenant.vii.au01.mattr.global",  "environment": {    "id": "fa605282-0223-4ae0-831d-af368bc39a55",    "name": "MATTR Public Sydney, Australia",    "domain": "vii.au01.mattr.global",    "authorizationServerDomain": "manage.auth.auth0.com",    "deploymentModel": "public",    "region": {      "id": "70bb433a-f0ec-4297-ad76-3b09c71311f3",      "name": "AU01",      "displayName": "Sydney, Australia"    }  },  "membership": {    "roles": [      "dts-provider",      "issuer"    ]  }}

Analytics Events

Authorization

Path Parameters

Response Body

200application/json

400application/json

401text/plain

403

404application/json

500

Retrieve tenant

Analytics Events

Authorization

Path Parameters

Response Body

200application/json

400application/json

401text/plain

403

404application/json

500

`application/json`

`application/json`

`text/plain`

`application/json`

`application/json`

`application/json`

`text/plain`

`application/json`