SCIM

Patch a Group

To update specific attributes of an existing group, send a PATCH request to /Groups/$GROUP_ID. The PATCH operation is defined by RFC-7644 §3.5.2.

The request body MUST contain a valid SCIM PATCH request with a "schemas" value of "urn:ietf:params:scim:api:messages:2.0:PatchOp" and an "Operations" array with one or more PATCH operations (add, remove, or replace).

Values in the request body for immutable or read-only fields (as defined in RFC-7643 §4.2) will be ignored. Fields that are omitted from the request body will be left unchanged.

Note: The Beyond Identity SCIM server currently does not support atomic PATCH operations. If a request contains multiple operations, the request may be partially applied.

The Beyond Identity SCIM server also does not support modifying both a group's attributes and its membership in the same operation. For example, a PATCH request to update a group's display name and its membership should specify two separate operations, one to update the display name and the other to modify the membership.

If a request contains multiple operations, the request may be partially applied:

  1. The server first validates the overall request schema and attribute types
  2. Operations are then applied sequentially in the order provided
  3. If any operation fails, processing stops immediately
  4. Previously successful operations remain applied
  5. The error response does not indicate which operation failed or which operations were applied
  6. To determine the current state, clients should issue a GET request after receiving an error

This method can be used to provision roles to a user. Role provisioning is performed by adding the user to the appropriate role group as a member.

It is not possible to rename a role group or change its description.

patch/scim/v2/Groups/{group_id}

Request

Path parameters

group_idstring required

ID of the group.

Request body

schemasstring[] required

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Response

Successfully updated the Group resource. The response contains the full representation of the modified Group, including any server-side changes and read-only attributes as specified in RFC-7644 §3.5.2.

schemasstring[] required

The list of schemas used to define the group. This must contain the core Group schema ("urn:ietf:params:scim:schemas:core:2.0:Group") and may include the custom Beyond Identity Group schema extension ("urn:scim:schemas:extension:byndid:1.0:Group").

idstring required

The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only.

displayNamestring required

The unique display name of the group. This name is used for display purposes.

metaMeta required(unresolved $ref)

Changes

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