Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/access/tenant_management/tenants

Retrieve the list of all tenants ordered by tenant id.

Retrieve the list of all tenants. The list is ordered by tenant id.

Table 1: GET /config/access/tenant_management/tenants Resource Details

MIME Type

application/json

Table 2: GET /config/access/tenant_management/tenants Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /config/access/tenant_management/tenants Response Codes

HTTP Response Code

Unique Code

Description

200

 

The tenant list was successfully retrieved.

500

1020

An error occurred while the tenant list was being retrieved.

Response Description

a list of all the tenants

Response Sample