Skip to main content

SCIM

PATCH/v1/orgs/{org_id}/scim/v2/Groups/{group_id}

Patch Group

Apply SCIM PATCH ops to a role-backed group. ``add`` / ``replace`` on the ``members`` path promotes the targeted user to this group's role; ``remove`` demotes them back to ``viewer``.

SCIM bearer tokenscope: scim provisioningoperation_id: scim.patchGroup

Authentication

Send Authorization: Bearer <scim-token>. Mint it via POST /v1/orgs/{org_id}/scim/token (admin only) and store it with your IdP, so the integration can be revoked on its own.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X PATCH "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/scim/v2/Groups/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

null

Schema: any

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired-
group_id#pathstringrequired-

Header parameters

NameTypeRequiredDescription
authorization#headerstring | nulloptional-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

any

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have the required role (admin / editor).-
404Target resource does not exist in this org.-
422Request body failed validation.-