BEbeyondidentity
Realms

Patch a Realm

To update only specific attributes of an existing realm, send a PATCH request to /v1/tenants/$TENANT_ID/realms/$REALM_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}/realms/{realm_id}

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

Example request

{
  "realm": {
    "id": "19a95130480dfa79",
    "tenant_id": "0001f1f460b1ace6",
    "display_name": "Test Realm",
    "classification": "SECURE_CUSTOMER",
    "create_time": "2022-05-18T18:00:01.167Z",
    "update_time": "2022-05-19T14:23:01.327Z"
  }
}

Response

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

idstring

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

tenant_idstring

A unique identifier of the realm's tenant. This is automatically set on creation. This field is immutable and read-only.

display_namestring

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

classificationstring

Classification of the realm. Can be either SECURE_WORFORCE or SECURE_CUSTOMER

create_timestring date-time

A time value given in ISO8601 combined date and time format that represents when the realm 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 realm was last updated. This is automatically updated when the realm is updated. This field is read-only.

Example response

{
  "id": "19a95130480dfa79",
  "tenant_id": "0001f1f460b1ace6",
  "display_name": "Test Realm",
  "classification": "SECURE_CUSTOMER",
  "create_time": "2022-05-18T18:00:01.167Z",
  "update_time": "2022-05-19T14:23:01.327Z"
}

Changes

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