BEbeyondidentity
Tenants

Patch a Tenant

To update only specific attributes of an existing tenant, send a PATCH request to /v1/tenants/$TENANT_ID. Values in the request body for immutable or read-only fields will be ignored. Fields that are omitted from the request body will be left unchanged.

patch/v1/tenants/{tenant_id}

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

Request body

Example request

{
  "tenant": {
    "id": "000176d94fd7b4d1",
    "display_name": "Test Tenant",
    "create_time": "2022-01-28T12:00:02.423Z",
    "update_time": "2022-04-19T15:17:21.186Z"
  }
}

Response

The response will be a JSON object containing the standard attributes associated with a tenant.

idstring

A unique identifier for the tenant. This is automatically generated on creation. This field is immutable and read-only.

display_namestring

A human-readable name for the tenant. This name is used for display purposes.

create_timestring date-time

A time value given in ISO8601 combined date and time format that represents when the tenant was created. This is automatically generated on creation. This field is read-only.

update_timestring date-time

A time value given in ISO8601 combined date and time format that represents when the tenant was last updated. This is automatically updated when the tenant is updated. This field is read-only.

Example response

{
  "id": "000176d94fd7b4d1",
  "display_name": "Test Tenant",
  "create_time": "2022-01-28T12:00:02.423Z",
  "update_time": "2022-04-19T15:17:21.186Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.