Web API

Press shift + S to search API reference.

Object

SCIM user schema

Endpoints that reference this object:

object

SCIM User objects with optional user metadata.

See SCIM Field Types for more information about optional user metadata.

id
optional<string>

Airtable's unique user ID for this user.

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
optional<null | the below object>

Custom extension, see SCIM Field Types for more

costCenter
optional<string | null>
department
optional<string | null>
division
optional<string | null>
employeeNumber
optional<string | null>
manager
optional<null | the below object>
$ref
optional<string | null>
displayName
optional<string | null>
value
optional<string | null>
organization
optional<string | null>
schemas
array of strings

A list of schemas, including at least SCIM's core user schema URI.

You can add the enterprise extension schema URI if you want to send extra properties for reporting.

See the optional user metadata table for details.

userName
string

Becomes the "email" field in Airtable. It must not be in use already, and the email's domain must match the enterprise account.

active
optional<boolean | null>

Indicates if the user is active or deactivated.

Setting this is possible via the put and patch endpoints.

externalId
optional<string | null>

Provisioning client defined identifier.

addresses
optional<array of the below object | null>
type
optional<"work" | "home" | "other" | null>
country
optional<string | null>
formatted
optional<string | null>
locality
optional<string | null>
postalCode
optional<string | null>
primary
optional<boolean | null>
region
optional<string | null>
streetAddress
optional<string | null>
displayName
optional<string | null>
emails
optional<array of the below object | null>
type
optional<string | null>
value
string
display
optional<string | null>
primary
optional<boolean | null>
entitlements
optional<array of any | null>
groups
optional<array of the below object | null>
value
string
$ref
optional<string | null>
ims
optional<array of the below object | null>
type
optional<string | null>
value
string
display
optional<string | null>
primary
optional<boolean | null>
locale
optional<string | null>
meta
optional<any>
name
optional<null | the below object>
familyName
optional<string | null>

Becomes the "lastName" field in Airtable.

givenName
optional<string | null>

Becomes the "firstName" field in Airtable.

formatted
optional<string | null>
honorificPrefix
optional<string | null>
honorificSuffix
optional<string | null>
middleName
optional<string | null>
nickName
optional<string | null>
password
optional<string | null>
phoneNumbers
optional<array of the below object | null>
type
optional<string | null>
value
string
display
optional<string | null>
primary
optional<boolean | null>
photos
optional<array of the below object | null>
type
optional<"photo" | "thumbnail" | null>
value
string
primary
optional<boolean | null>
preferredLanguage
optional<string | null>
profileUrl
optional<string | null>
roles
optional<array of any | null>
timezone
optional<string | null>
title
optional<string | null>
userType
optional<string | null>