Skip to content
Authrim

List tenants.

GET
/api/admin/tenants
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenants \
  --header 'Authorization: Bearer <token>'

List tenants visible to the authenticated platform administrator or tenant inventory scope. This platform inventory endpoint does not use X-Tenant-Id because the tenant scope comes from the administrator authorization context.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Tenant inventory response.

Media type application/json
object
tenants
required
Array<object>

Tenant inventory row returned by list and detail endpoints. Provisioning progress is exposed by the dedicated tenant provisioning operation endpoint.

object
id
required
string
tenant_code
required
string
name
required
string
description
required
string | null
isolation_policy
required
string
Allowed values: shared_pool tenant_exclusive
lifecycle_state
required
string
Allowed values: provisioning active suspended frozen migration_read_only deleting deleted restore_pending restore_validating
is_default
required
boolean
created_at
required

Unix timestamp in seconds.

integer format: int64
updated_at
required

Unix timestamp in seconds.

integer format: int64
key
additional properties
total
required
integer
single_tenant_mode
required
boolean
single_tenant_reason
required
string | null
key
additional properties
Example 
{
  "tenants": [
    {
      "id": "default",
      "tenant_code": "default",
      "name": "Default Tenant",
      "description": "Primary tenant.",
      "lifecycle_state": "active",
      "is_default": true,
      "created_at": 1770000000,
      "updated_at": 1770000000
    },
    {
      "id": "acme",
      "tenant_code": "acme",
      "name": "Acme Corp",
      "description": "Production tenant for Acme Corp.",
      "lifecycle_state": "active",
      "is_default": false,
      "created_at": 1770003600,
      "updated_at": 1770003600
    }
  ],
  "total": 2,
  "single_tenant_mode": false,
  "single_tenant_reason": null
}