List Tenants

Get all tenants visible to this auth

GET /api/v1/tenants

Error

A valid request URL is required to generate request examples

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "is_personal": true,
    "is_deleted": true,
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_handle": "<string>",
    "data_plane_url": "<string>",
    "read_only": false,
    "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role_name": "<string>",
    "permissions": [
      "<string>"
    ]
  }
]

Authorizations

Authorization · string · header · required

Bearer tokens are used to authenticate from the UI. Must also specify x-tenant-id or x-organization-id (for org scoped apis).

Query Parameters

skip_create · boolean · default: false

include_deleted · boolean · default: false

Response

200

application/json

Successful Response

id · string<uuid> · required

created_at · string<date-time> · required

display_name · string · required

is_personal · boolean · required

is_deleted · boolean · required

organization_id · string<uuid> | null

tenant_handle · string | null

data_plane_url · string | null

read_only · boolean · default: false · deprecated

role_id · string<uuid> | null

role_name · string | null

permissions · string[] | null