Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

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

SUMMARY Update a tenant

Updates an existing tenant. You must have the System Administrator or Security Administrator permissions to call this endpoint.

Table 1: POST /config/access/tenant_management/tenants/{tenant_id} resource details:

POST /config/access/tenant_management/tenants/{tenant_id} resource details
MIME Type

application/json

Table 2: POST /config/access/tenant_management/tenants/{tenant_id} request parameter details:

POST /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
Required - Integer - the tenant id to modify
  • tenant_id - Long - The ID of the tenant being updated.

fields

header

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: POST /config/access/tenant_management/tenants/{tenant_id} request body details:

POST /config/access/tenant_management/tenants/{tenant_id} request body details
Parameter Data Type MIME Type Description Sample

tenant

Object

application/json
Required - Tenant - includes name, event_rate_limit (unit eps), flow_rate_limit (unit fpm) and description
  • name - String - The new name for the tenant.
  • description - String - The new description for the tenant.
  • event_rate_limit - Integer - The new event rate (per second) for the tenant.
  • flow_rate_limit - Integer - The new flow rate (per minute) for the tenant.

{ "deleted": true, "description": "String", "event_rate_limit": 42, "flow_rate_limit": 42, "name": "String" }
Table 4: POST /config/access/tenant_management/tenants/{tenant_id} response codes:

POST /config/access/tenant_management/tenants/{tenant_id} response codes
HTTP Response Code Unique Code Description

200

A tenant profile that was updated successfully and returned the updated tenant object.

404

1002

The tenant profile does not exist.

409

1004

A tenant with the given name already exists.

422

1005

A request parameter is invalid.

500

1020

Failed to retrieve/update the given tenant profile.

Response Description

The updated tenant object.
  • 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