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. You must have the System Administrator or Security Administrator permissions to call this endpoint.

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
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.
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.

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.

id - Integer - The ID of the tenant.
name - String - The name of the tenant.
description - String - The description of the tenant.
event_rate_limit - Integer - The event rate limit that is assigned to the tenant.
flow_rate_limit - Integer - The flow rate limit that is assigned to the tenant.
deleted - Boolean - Whether or not the tenant has been deleted. Will be true if the tenant has been deleted, and false if it is still active.

Response Sample


[
    {
        "deleted": true,
        "description": "String",
        "event_rate_limit": 42,
        "flow_rate_limit": 42,
        "id": 42,
        "name": "String"
    }
]