Web API

Press shift + S to search API reference.

SCIM

Patch user

patchhttps://airtable.com/scim/v2/Users/{userId}

Perform a list of SCIM patch operations in sequence on an existing user.

See SCIM specification for more.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.scim.usersAndGroups:manage
User role

Enterprise admin

Admins of multiple enterprises should use a service account's token when calling this route.
Billing plansBusiness, Enterprise (pre-2023.08 legacy plan), Enterprise Scale

Path parameters

userId
string

Request body

schemas
array of strings

A list of schemas, including at least SCIM's PatchOp schema.

Operations
array of the below object

A list of SCIM patch operations to perform.

See the SCIM PATCH protocol for details.

path
string

Path for a SCIM user field.

value
optional<string | any>

Replacment value. Not used when performing the 'remove' operation.

op
"add" | "replace" | "remove"

Response format

SCIM user schema
Request (example)
Copy
$
curl -X PATCH "https://airtable.com/scim/v2/Users/{userId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"Operations": [
{
"op": "replace",
"path": "title",
"value": "Manager"
}
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
]
}'
200 – Response (example)
{
"active": true,
"displayName": "Jane Doe",
"emails": [
{
"primary": true,
"type": "work",
"value": "jane.doe@example.com"
}
],
"externalId": "00u19pelnizu7vExD0h8",
"groups": [],
"id": "usrogvSbotRtzdtZW",
"locale": "en-US",
"meta": {
"created": "2022-06-29T18:16:07.990Z",
"lastModified": "2022-07-06T17:36:19.513Z",
"location": "/scim/v2/Users/usr00000000000000",
"resourceType": "User"
},
"name": {
"familyName": "Doe",
"givenName": "Jane"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"title": "Manager",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"costCenter": "Example Cost Center",
"department": "Example Department",
"division": "Example Division"
},
"userName": "jane.doe@example.com"
}