BEbeyondidentity
Groups

Patch a group

To update only specific attributes of an existing group, send a PATCH request to /v2/groups/$GROUP_ID. Values in the request body for read-only attributes get ignored. Fields omitted from the request body will be left unchanged.

If the updated name of the group is already in use, you'll receive a 409 error.

Note that this endpoint does not support updates to permission groups. If the request attempts to use the name of a permission group or attempts to update a permission group, you'll receive a 403 error.

patch/v2/groups/{group_id}

Request

Path parameters

group_idstring required
Example:25f94daf-63d8-4b40-b0ea-4843971d1d8e

A unique identifier for a group.

Request body

Example request

{
  "group": {
    "id": "25f94daf-63d8-4b40-b0ea-4843971d1d8e",
    "create_time": "2022-04-12T05:53:07.119Z",
    "update_time": "2022-06-16T14:31:03.770Z",
    "tenant_id": "acme-corp",
    "name": "Acme Group",
    "description": "Members of the Acme Group",
    "source": "scim"
  }
}

Response

The response is a JSON object containing standard group attributes.

idstring

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

create_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the group gets created. This field is immutable and read-only.

update_timestring date-time

A time value in the ISO8601 combined date and time format that gets generated automatically and represents the time the group gets updated. This field is read-only.

tenant_idstring

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

namestring

A required unique name for the group within the tenant.

descriptionstring

A required description for the group within the tenant.

sourcestring

The source that created the group. This field is immutable and read-only.

Example response

{
  "id": "25f94daf-63d8-4b40-b0ea-4843971d1d8e",
  "create_time": "2022-04-12T05:53:07.119Z",
  "update_time": "2022-06-16T14:31:03.770Z",
  "tenant_id": "acme-corp",
  "name": "Acme Group",
  "description": "Members of the Acme Group",
  "source": "scim"
}

Changes

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