Web API

Press shift + S to search API reference.

Overview

SCIM

Retrieve, add, and modify users and groups.

We support a subset of the specification for System for Cross-domain Identity Management, or SCIM. We support a select list of user attributes.

Note: SCIM user management is only available for the Business, Enterprise, and Enterprise Scale plans, while SCIM group management is only available for the Enterprise and Enterprise Scale plans. SSO is a prerequisite for creating and updating users, since we don't allow setting passwords with SCIM. Only managed users can be retrieved and managed using the SCIM API.

SCIM User Objects

Airtable FieldSCIM AttributeRequired
id, userIdidFalse
emailuserNameTrue
firstNamegivenNameTrue
lastNamefamilyNameTrue
state
"provisioned" | "deactivated"
active
boolean
True
Optional user metadata

These attributes are stored and saved for reporting purposes only. We store them when they're sent via SCIM endpoints, and we return them as part of user CSV downloads from the Enterprise Admin Panel.

Airtable FieldSCIM AttributeRequired
External IDexternalId
ID in the identity provider's system
False
TitletitleFalse

Enterprise user schema extension fields, which are nested inside an object property with the key:
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

Airtable FieldSCIM AttributeRequired
Cost centercostCenterFalse
DepartmentdepartmentFalse
DivisiondivisionFalse
OrganizationorganizationFalse
Manager display namemanager.displayNameFalse
Managermanager.valueFalse

SCIM Group Objects

Airtable FieldSCIM AttributeRequired
id, groupIdidTrue
namedisplayNameTrue
members[].userIdmembers[].valueTrue