Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
User groups

Replace user group

Replace the specified user group. Per the SCIM 2.0 specification, PUT replaces the entire group resource, including its membership.

To add or remove individual members without replacing the full membership list, use the Update user group endpoint, which performs a partial update via PATCH.

put/scim/v2/groups/{userGroupId}

Path parameters

userGroupIdstring required

The ID of the group to be replaced

Request body

displayNamestring required

The name of the group. Names must be 64 characters or less.

Example request

{
  "displayName": "Blob SEs",
  "members": [
    {
      "display": "blob.ross@blobsrus.co",
      "value": "9e8719d9-276a-4964-9395-a493189a247c"
    }
  ]
}

Response

Group replaced successfully

idstring

Unique identifier for the group

displayNamestring

The name of the group

schemasstring[]

SCIM schema information for the group

Example response

{
  "meta": {
    "resourceType": "Group"
  }
}