Lists all tenants

GET 
https://apis.<domain>/iam/tenants

Lists all tenants.

Authorization Action:

iam:tenants:list

Request

Responses

200

A successful response.

application/json

Schema

Schema

tenants object[]
Array [
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
]

Example (from schema)

{
  "tenants": [
    {
      "name": "My Custom Tenant",
      "id": "custom-tenant"
    },
    {
      "name": "My Custom Tenant 2",
      "id": "custom-tenant-2"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://apis.<domain>/iam/tenants' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://apis.<domain>