Skip to content
GitmoapAPIBeta
Identity & platformscim
PATCH/scim/v2/organizations/{group_id}/Users/{scim_user_id}

Change some of a person's attributes; `active: false` de-provisions them.

patch_scim_user
  • Public
    This operation declares no security requirement: it takes no token.
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Takes add and replace operations on active, userName, displayName and externalId, by path or as an object of values, up to 100 in one request; other attributes are ignored. De-provisioning and reactivation work as in a full replace, and the organization's last owner cannot be de-provisioned.

Parameters

Path
  • group_idGroupId (string · uuid)The organization's top-level group
  • scim_user_idScimUserId (string · uuid)SCIM user ID

Request body

application/json
  • Operationsarray of ScimPatchOperation
  • schemasarray of stringoptional
Request body exampleSynthesized example
{
"Operations": [
{
"op": "op-0e25"
},
{
"op": "op-d10a"
}
]
}

Responses

200The userapplication/json
  • userNamestringThe person's sign-in name — for gitmoap, their email address.
  • activebooleanoptionalfalse takes away the person's access to the organization; true gives it back.
  • displayNamestring or nulloptional
  • emailsarray of ScimEmailoptional
  • externalIdstring or nulloptional
  • groupsarray of ScimMemberRefoptionalThe groups the person is in. Read-only: groups are changed through the group.
  • idstring or nulloptional
  • metaScimMeta or nulloptional
    • The ScimMeta schema
    • createdstring · date-time
    • lastModifiedstring · date-time
    • locationstring
    • resourceTypestring
  • nameScimName or nulloptional
    • The ScimName schema
    • familyNamestring or nulloptional
    • formattedstring or nulloptional
    • givenNamestring or nulloptional
  • schemasarray of stringoptional
200 exampleSynthesized example
{
"userName": "userName-48e1",
"active": true,
"displayName": "displayName-6151",
"emails": [
{
"value": "value-6021"
},
{
"value": "value-82c9"
}
],
"externalId": "externalId-d73d",
"groups": [
{
"value": "value-3590"
}
],
"id": "id-ef7a",
"meta": {
"created": "2026-10-11T21:02:42Z",
"lastModified": "2026-10-10T00:52:20Z",
"location": "location-6bd8",
"resourceType": "resourceType-13a6"
},
"name": {
"familyName": "familyName-fb24",
"formatted": "formatted-74b4",
"givenName": "givenName-7288"
},
"schemas": [
"schemas-e280",
"schemas-7b4f"
]
}
400An unsupported operation, or more than 100application/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • detailstring
  • schemasarray of string
  • statusstringThe HTTP status code, written as text, as the SCIM protocol requires.
  • scimTypestring or nulloptional
400 exampleSynthesized example
{
"detail": "detail-c779",
"schemas": [
"schemas-b33f",
"schemas-58de"
],
"status": "status-8a49"
}
401No valid SCIM token of this organizationapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • detailstring
  • schemasarray of string
  • statusstringThe HTTP status code, written as text, as the SCIM protocol requires.
  • scimTypestring or nulloptional
401 exampleSynthesized example
{
"detail": "detail-2eab",
"schemas": [
"schemas-2408",
"schemas-b888"
],
"status": "status-a659"
}
404User not foundapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • detailstring
  • schemasarray of string
  • statusstringThe HTTP status code, written as text, as the SCIM protocol requires.
  • scimTypestring or nulloptional
404 exampleSynthesized example
{
"detail": "detail-75ff",
"schemas": [
"schemas-8716",
"schemas-f010"
],
"status": "status-03d4"
}
409The person is the organization's last ownerapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • detailstring
  • schemasarray of string
  • statusstringThe HTTP status code, written as text, as the SCIM protocol requires.
  • scimTypestring or nulloptional
409 exampleSynthesized example
{
"detail": "detail-8c73",
"schemas": [
"schemas-f6a5",
"schemas-86e5"
],
"status": "status-9163"
}

CLI

gitmoap scim patch-scim-user

  • --group-ididThe organization's top-level group (id or group path)
  • --scim-user-ididSCIM user ID
  • --Operationsjson
  • --schemasjsonoptional

Used in these guides