Query Tenants

Operation ID: queryTenants
Query tenants of the platform

Request

URI

GET

https://{api_host}/api/v1/tenants/query

COPY

Query Parameters

integer

offset

Optional

The start index of tenants to return

integer

limit

Optional

Maximum number of tenants to return

string

filter

Optional

The conditions to query platform tenants

Authentication

This operation uses the following authentication methods.

basicAuth

bearerAuth

Responses

200

Tenants of the platform are returned

Returns PageOfTenants of type(s) application/json

{
    "page_info": {
        "total": 1,
        "offset": 6,
        "limit": 0
    },
    "items": [
        {
            "tenant_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "extensions": {
                "key": ""
            },
            "cd_tenant_ids": [
                "8daca9a9-5b11-4f63-9c52-953a2ef77739"
            ],
            "name": "ACME",
            "active": true
        },
        {
            "tenant_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "extensions": {
                "key": ""
            },
            "cd_tenant_ids": [
                "8daca9a9-5b11-4f63-9c52-953a2ef77739"
            ],
            "name": "ACME",
            "active": true
        }
    ]
}

array of OsisTenant

items

Optional

items

PageInfo

page_info

Optional

page_info

On This Page

Description

Request

Query Parameters