Gets a tenant

GET /iam/tenants/:id

Returns the details for a tenant.

Authorization Action:

iam:tenants:get

Request

id stringrequired

ID of the tenant.

A successful response.

Schema

tenant object

name string

Name for the tenant.

id string

Unique ID. Cannot be changed.

type compiuta.api.iam.v2.Type

Possible values: [COMPIUTA_MANAGED, CUSTOM]

Default value: COMPIUTA_MANAGED

{
  "name": "My Custom Tenant",
  "id": "custom-tenant"
}

An unexpected error response.

Schema

code int32

message string

details object[]

Array [

@type string

]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}