Skip to main content

Get Tenant

Required role: owner.

Retrieve a single tenant by name or identifier. A selector that parses as a UUID is looked up by tenant identifier, otherwise by name.

Path Parameters
tenant_id string REQUIRED

Tenant name or identifier (UUID)

Responses
200

Tenant retrieved

Schema OPTIONAL
id uuid
initial_provider string

The OIDC issuer this tenant was first provisioned under. Provenance only: a tenant is resolved by name, so this does not affect which tenant a login reaches.

name string
403

Caller is not a platform owner

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

404

No tenant with that name or identifier

Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.