Get a list of Tenants.

get

https://cluster.ip.address/v2/tenants

Privileges: ORGANIZATION_VIEW

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of strings or null

List of tenantIds to filter.

ids

statuses

array of strings or null

Filter by current status of tenant.
If left blank, only active and inactive tenants are returned.

statuses

Allowed:

livenessModes

array of strings or null

Filter by liveness modes of the tenant.
This filter only applies is tenant metadata is added for external
vendor such as 'IBM'. In all other cases, the values provided for
this filter will be ignored.

livenessModes

Allowed:

ownershipModes

array of strings or null

Filter by ownership modes of the tenant.
This filter only applies is tenant metadata is added for external
vendor such as 'IBM'. In all other cases, the values provided for
this filter will be ignored.

ownershipModes

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError