SCIM User Attributes
When integrating with Firstup's SCIM-based User Management API, it is important to distinguish between legacy or internal attribute aliases and the official SCIM attribute names used in API payloads.
Internal vs SCIM Naming
In some areas of our platform—such as Studio, legacy CSV imports, or auto-generated documentation—you may encounter attribute names in snake_case (e.g., display_name, first_name). These aliases are intended for readability or legacy compatibility and are not used in the SCIM API payloads.
The SCIM API strictly follows the SCIM 2.0 specification (RFC 7643), which requires:
- All attribute names to use
camelCase. - Nested fields to follow the SCIM object structure (e.g.,
name.givenName). - Custom attributes to be properly namespaced under SCIM extensions, such as the Enterprise User Schema.
To ensure compatibility, always use the SCIM-compliant attribute names when constructing API requests to /scim/v2/Users.
We recommend including these standard and required user attributes:
Core Identity Attributes
| Firstup Attribute Name | SCIM Attribute Name | Requirement | Format | Description |
|---|---|---|---|---|
universal_identifier | userName | Required | String | Unique identifier for the user. Used as the login/username in Firstup. |
external_id | externalId | Optional | String | Identifier for the user in an external system. |
active | active | Optional | Boolean | Indicates whether the user is active. |
display_name | displayName | Optional | String | The name displayed for the user. |
preferred_name | nickName | Optional | String | The user's preferred name or nickname. |
roles | roles | Optional | Array of Strings | Roles assigned to the user. See Roles for more info. |
Refer to User Provisioning for detailed information on creating users, including a breakdown of the different names associated with a user.
Refer to User Roles and Access for detailed information on creator Studio roles and how to apply them to users.
Name and Contact Information
| Firstup Attribute Name | SCIM Attribute Name | Requirement | Format | Description |
|---|---|---|---|---|
first_name | name.givenName | Recommended | String | The user's first name. |
last_name | name.familyName | Recommended | String | The user's last name. |
emails | emails.value | Recommended | Array of Strings | The user's email addresses. |
primary_email | emails.primary | Recommended | Boolean | Indicates the user's primary email. |
work_phone | phoneNumbers[type eq "work"].value | Optional | String | The user's work phone number. |
mobile_phone | phoneNumbers[type eq "mobile"].value | Optional | String | The user's mobile phone number. |
street_address | addresses.streetAddress | Optional | String | The user's street address. |
city | addresses.locality | Optional | String | The user's city or locality. |
state | addresses.region | Optional | String | The user's state or region. |
postal_code | addresses.postalCode | Optional | String | The user's postal or ZIP code. |
country | addresses.country | Optional | String | The user's country. |
locale | locale | Optional | String | The user's locale (e.g., en-US). |
preferred_language | preferredLanguage | Optional | String | The user's preferred communication language. |
timezone | timezone | Optional | String | The user's time zone. |
Employment and Organisational Information
| Firstup Attribute Name | SCIM Attribute Name | Requirement | Format | Description |
|---|---|---|---|---|
job_title | title | Optional | String | The user's job title. |
employee_type | userType | Optional | String | The user's employment type (e.g., Full-Time, Contractor). |
gender | gender | Optional | String | The user's gender. |
department | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department | Optional | String | The department the user belongs to. |
division | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division | Optional | String | The user's division. |
business_unit | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.businessUnit | Optional | String | The user's business unit. |
company | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.organization | Optional | String | The user's organization or company. |
cost_center | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.costCenter | Optional | String | The user's cost center. |
work_location | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.workLocation | Optional | String | The user's work location. |
manager_name | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.displayName | Optional | String | The user's manager's display name. |
Lifecycle and Timeline Attributes
| Firstup Attribute Name | SCIM Attribute Name | Requirement | Format | Description |
|---|---|---|---|---|
birthdate | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.birthDate | Optional | String (ISO 8601) | The user's date of birth. |
start_date | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.hireDate | Optional | String (ISO 8601) | The user's hire date. |
promotion_date | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.promotionDate | Optional | String (ISO 8601) | The user's last promotion date. |
requisition_approval_date | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.requisitionApprovalDate | Optional | String (ISO 8601) | The user's requisition approval date. |
- ISO 8601 example:
"hireDate": "2024-04-08T00:00:00.000Z", - Refer to the SCIM RFC 7643 schema for full definitions of standard attributes. Only include attributes your SCIM client supports and map accordingly in your provisioning system.