Web API

Press shift + S to search API reference.

SCIM

Create user

posthttps://airtable.com/scim/v2/Users

Create a new user from a SCIM User object.

The response is the SCIM user object representing the newly created user. On creation, the user will always be marked active, and the emails array will include a single entry that matches the username. See the SCIM User schema for details.

WARNING: As the user is provisioned without a password, the use of this endpoint is only intended on environments with SSO Active.

WARNING: If your enterprise is not capturing the user's email domain, it is possible this will fail with a conflict against an already created user that is not a member of your enterprise (and this not visible when listing users). If this occurs, it is recommended you add the user to your enterprise (e.g. add them to a workspace and then claim them).

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

Request body

SCIM user schema

Response format

SCIM user schema
Request (example)
Copy
$
curl -X POST "https://airtable.com/scim/v2/Users" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"name": {
"familyName": "Jane",
"givenName": "Doe"
},
"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",
"manager": {
"displayName": "John Doe",
"value": "foo@bam.com"
},
"organization": "Example organization"
},
"userName": "foo@bar.com"
}'
200 – Response (example)
{
"active": true,
"id": "usrogvSbotRtzdtZW",
"meta": {
"created": "2021-06-02T07:37:19.000Z",
"location": "/scim/v2/Users/usr00000000000000",
"resourceType": "User"
},
"name": {
"familyName": "Jane",
"givenName": "Doe"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "foo@bar.com"
}