Patch a user

Performs a SCIM PATCH operation on a user. Supports:

Replacement of specific attributes using the 'path' parameter
Full or partial update using the 'value' parameter without a path
Setting 'active' to false to delete the user (returns 204 No Content)
Removing attributes using the 'remove' operation. Only optional attributes can be removed.

Scoped OAuth requires: users.write

Authorization

apiKey bearerToken

Authorization<token>

A General Access API Key with format Token token=<API_KEY>

In: header

AuthorizationBearer <token>

An App OAuth Token with format Bearer <TOKEN>

In: header

Path Parameters

id*string

The ID of the user targeted in this request.

Request Body

application/json

SCIM Patch Operation

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM patch request body

Operations*array<>

Array of one or more patch operations to be applied to the resource.

Items1 <= items

schemas*array<>

URIs that indicate the schemas used in data

Items1 <= items

Default

[  "urn:ietf:params:scim:api:messages:2.0:PatchOp"]

Response Body

`application/scim+json`

curl -X PATCH "https://example.com/Users/AGKWDNQ24N4SXBBWYENPROSIYQ" \  -H "Content-Type: application/json" \  -d '{    "Operations": [      {        "op": "replace",        "value": {          "active": false        }      },      {        "op": "replace",        "path": "displayName",        "value": "Updated User Display Name"      },      {        "op": "remove",        "path": "title"      }    ],    "schemas": [      "urn:ietf:params:scim:api:messages:2.0:PatchOp"    ]  }'

{  "active": true,  "displayName": "Fake User",  "entitlements": [    {      "type": "license",      "value": "PABC123"    }  ],  "externalId": "00ujl29u0le5T6Aj10h7",  "id": "AGKWDNQ24N4SXBBWYENPROSIYQ",  "meta": {    "resourceType": "User"  },  "roles": [    {      "primary": true,      "type": "base",      "value": "user"    }  ],  "schemas": [    "urn:ietf:params:scim:schemas:core:2.0:User"  ],  "timezone": "America/New_York",  "title": "Software Developer",  "userName": "fake.user@example.com"}

Patch a user

Authorization

Path Parameters

Request Body

Response Body

200application/scim+json

204

400application/scim+json

401application/scim+json

403application/scim+json

404application/scim+json

500application/scim+json

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`