GET /config/access/tenant_management/tenants/{tenant_id}

Retrieve a tenant by tenant id.

Retrieve a tenant by tenant id.

Table 1. GET /config/access/tenant_management/tenants/{tenant_id} resource details
MIME Type

application/json

Table 2. GET /config/access/tenant_management/tenants/{tenant_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

tenant_id

path

Required

Number (Integer)

text/plain

null

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/{tenant_id} response codes
HTTP Response Code Unique Code Description

200

The tenant was successfully retrieved.

404

1002

No tenant was found for the provided tenant id.

500

1020

An error occurred while the tenant was being retrieved.

Response Description

the associated tenants object

Response Sample


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