OMomni
User groups

Replace user group

Changed on

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}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/scim/v2/groups/{userGroupId}
  • Auth
    HTTP bearer

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 required

Unique identifier for the group

displayNamestring required

The name of the group

schemasstring[] required

SCIM schema information for the group

Example response

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

Changes

  • 43290040f88fRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status