v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Groups

Update a Group

Documentation on updating a Group via SCIM. This includes updating group membership.

OAuth Scope required: scim.groups.updateGroups

patch/Groups/{groupId}

Path parameters

groupIdstring required

A group's unique id can be identified using the Retrieve all Groups endpoint with a filter parameter

Query parameters

excludedAttributesstring

A comma-separated list of attributes to exclude from the resources in the response.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

schemasstring[] required

Response

200 OK

schemasstring[] required

displayNamestring

The name of the group.

idstring required

The group's identifier.

externalIdstring

An optional identifier of the group sourced from the identity provider.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Legal Ops Group",
  "id": "74906dd6-f2c6-4442-8875-57846f15b061",
  "externalId": "123",
  "members": [
    {
      "type": "User",
      "value": "2bf1bb84-f7ed-4a11-8cbe-138814f9fc21"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "location": "https://na1.ironcladapp.com/scim/v2/Groups/67e4488c605caf0d8aa2e5c6"
  }
}