# SCIM user schema

[SCIM User](https://datatracker.ietf.org/doc/html/rfc7643#section-4.1) objects with optional user metadata.

See [SCIM Field Types](https://airtable.com/developers/web/api/scim-overview.md#scim-user-objects) for more information about optional
user metadata.

## Endpoints that reference this object

- [Create user](https://airtable.com/developers/web/api/create-scim-user.md)
- [Get user](https://airtable.com/developers/web/api/get-scim-user.md)
- [List users](https://airtable.com/developers/web/api/list-scim-users.md)
- [Patch user](https://airtable.com/developers/web/api/patch-scim-user.md)
- [Put user](https://airtable.com/developers/web/api/put-scim-user.md)

- `id: string` — optional

  Airtable's unique user ID for this user.

- `urn:airtable:params:scim:schemas:extension:sso:2.0:User: object | null` — optional

  Airtable-specific extension for routing provisioning through a particular
  SSO identity provider when the enterprise has multiple IdPs configured. See [SCIM Field
  Types](https://airtable.com/developers/web/api/scim-overview.md#scim-user-objects) for more.

- `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: object | null` — optional

  Custom extension, see [SCIM Field Types](https://airtable.com/developers/web/api/scim-overview.md#scim-user-objects) for more

- `schemas: array<string>` — required

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

  You can add the [enterprise extension](https://datatracker.ietf.org/doc/html/rfc7643#section-4.3)
  schema URI if you want to send extra properties for reporting.

  See the optional user metadata table for details.

- `userName: string` — required

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

- `active: boolean | null` — optional

  Indicates if the user is active or deactivated.

  Setting this is possible via the put and patch endpoints.

- `externalId: string | null` — optional

  Provisioning client defined identifier.

- `addresses: array<object> | null` — optional

- `displayName: string | null` — optional

- `emails: array<object> | null` — optional

- `entitlements: array<unknown> | null` — optional

- `groups: array<object> | null` — optional

- `ims: array<object> | null` — optional

- `locale: string | null` — optional

- `meta: unknown` — optional

- `name: object | null` — optional

- `nickName: string | null` — optional

- `password: string | null` — optional

- `phoneNumbers: array<object> | null` — optional

- `photos: array<object> | null` — optional

- `preferredLanguage: string | null` — optional

- `profileUrl: string | null` — optional

- `roles: array<unknown> | null` — optional

- `timezone: string | null` — optional

- `title: string | null` — optional

- `userType: string | null` — optional