Skip to main content
PUT
/
scim
/
v2
/
groups
/
{userGroupId}
Update user group
curl --request PUT \
  --url https://{instance}.omniapp.co/api/scim/v2/groups/{userGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "members": [
    {
      "value": "<string>"
    }
  ]
}
'
{
  "id": "<string>",
  "displayName": "<string>",
  "members": [
    {
      "value": "<string>",
      "display": "<string>"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Path Parameters

userGroupId
string
required

Group ID

Body

application/json
displayName
string
required
members
object[]
required

Overrides existing members

Response

Group updated successfully

id
string
displayName
string
members
object[]
meta
object