1. Docs
  2. API Reference
  3. Update a user with PATCH operations

Update a user with PATCH operations

PATCH/scim/v2/directories/{directoryId}/Users/{id}

SCIM 2.0 (RFC 7644 §3.5.2). Applies PATCH operations to the user. An attribute the operations do not mention is left unchanged; an absent active never reactivates a deprovisioned user. Errors use SCIM's error schema (RFC 7644 §3.12).

Path Parameters

directoryIdstring Required

The directory the SCIM token was minted for.

idstring Required

Request body

application/json

schemasstring[] Required
OperationsScimPatchOperationDto[] Required

Responses

application/scim+json

  • schemasstring[]*
  • idstring*

    This directory's id for the person

  • externalIdstring
  • userNamestring*

    The sign-in email, lowercased

  • nameScimNameDto*
  • emailsScimEmailDto[]*
  • activeboolean*

    Whether the person is active in this directory

  • metaScimMetaDto*

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

Returned object

ScimUserDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/scim/v2/directories/value/Users/value" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
      {
        "op": "add",
        "path": "string",
        "value": "string"
      }
    ]
  }'
Response
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "string",
  "externalId": "string",
  "userName": "string",
  "name": {
    "givenName": "string",
    "familyName": "string"
  },
  "emails": [
    {
      "value": "string",
      "primary": false,
      "type": "work"
    }
  ],
  "active": false,
  "meta": {
    "resourceType": "User",
    "created": "2026-04-20T12:00:00.000Z",
    "lastModified": "2026-04-20T12:00:00.000Z",
    "location": "string",
    "version": "string"
  }
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy