Users data model
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
schemas | enum | No | Values: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User, urn:ietf:params:scim:schemas:extension:peakon:2.0:User |
externalId | string | No | |
userType | string | No | 'Employee','Super Admin', 'General Admin', 'Account Manager', 'User Manager', 'Workflow Manager', 'Experience Manager', 'Author','Reporter','Contractor,'Intern','Temp','External','Unknown'] |
userName | string | No | |
name | object | No | |
name.formatted | string | No | |
name.familyName | string | No | |
name.givenName | string | No | |
name.middleName | string | No | |
name.honorificPrefix | string | No | |
name.honorificSuffix | string | No | |
displayName | string | No | |
nickName | string | No | |
profileUrl | string | No | |
title | string | No | |
preferredLanguage | string | No | |
locale | string | No | |
timezone | string | No | |
active | boolean | No | |
password | string | No | |
phoneNumbers | ScimPhoneNumber[] | No | |
phoneNumbers[].type | enum | No | Values: work, home, other, mobile, fax, pager |
phoneNumbers[].value | string | No | |
phoneNumbers[].display | string | No | |
phoneNumbers[].primary | boolean | No | |
emails | ScimEmail[] | No | |
emails[].type | enum | Yes | Values: work, home, other |
emails[].value | string | No | |
emails[].primary | boolean | No | |
emails[].display | string | No | |
ims | ScimIms[] | No | |
ims[].type | enum | No | Values: aim, qtalk, icq, xmpp, msn, skype, qq, yahoo |
ims[].value | string | No | |
ims[].display | string | No | |
ims[].primary | boolean | No | |
photos | ScimPhoto[] | No | |
photos[].value | string | No | URL |
photos[].display | string | No | |
photos[].type | enum | No | Values: photo, thumbnail |
photos[].primary | boolean | No | |
addresses | ScimAddress[] | No | |
addresses[].formatted | string | No | |
addresses[].streetAddress | string | No | could be multi-line |
addresses[].locality | string | No | city |
addresses[].region | string | No | stateprovince |
addresses[].postalCode | string | No | |
addresses[].country | string | No | |
addresses[].type | enum | No | Values: work, home, other |
groups | ScimUserGroups[] | No | |
groups[].value | string | Yes | ID |
groups[].$ref | string | No | |
groups[].display | string | No | |
groups[].type | enum | No | Values: direct, indirect |
entitlements | ScimEntitlement[] | No | |
entitlements[].value | string | Yes | |
entitlements[].display | string | No | |
entitlements[].type | string | No | |
entitlements[].primary | boolean | No | |
roles | ScimRole[] | No | Student, Faculty, ... |
roles[].value | string | Yes | value of the role |
roles[].display | string | No | |
roles[].type | string | No | |
roles[].primary | boolean | No | |
x509Certificates | ScimRole[] | No | |
x509Certificates[].value | string | Yes | value of the role |
x509Certificates[].display | string | No | |
x509Certificates[].type | string | No | |
x509Certificates[].primary | boolean | No | |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | object | No | an organization. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.employeeNumber | string | No | |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.costCenter | string | No | Identifies the name of a cost center. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.organization | string | No | Identifies the name of an organization. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division | string | No | Identifies the name of a division. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department | string | No | Identifies the name of a department. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager | ScimUser_urn_ietf_params_scim_schemas_extension_enterprise_2_0_User_manager | No | "id" attribute of another User. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.value | string | No | The "id" of the SCIM resource representing the user's manager. RECOMMENDED. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.managerId | string | No | alias for value? |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.$ref | string | No | The URI of the SCIM resource representing the User's manager. RECOMMENDED. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.displayName | string | No | The displayName of the user's manager. This attribute is OPTIONAL, and mutability is "readOnly". |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.type | enum | No | Values: direct, indirect |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers | ScimManager[] | No | |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].value | string | No | The "id" of the SCIM resource representing the user's manager. RECOMMENDED. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].managerId | string | No | alias for value? |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].$ref | string | No | The URI of the SCIM resource representing the User's manager. RECOMMENDED. |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].displayName | string | No | The displayName of the user's manager. This attribute is OPTIONAL, and mutability is "readOnly". |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.additionalManagers[].type | enum | No | Values: direct, indirect |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.level | string | No | |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.startDate | string (date-time) | No | 2011-03-25 |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.endDate | string (date-time) | No | 2022-02-25 |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.birthday | string (date-time) | No | 1985-07-20 |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.gender | enum | No | Values: male, female |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.location | string | No | Berlin |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.currency | string | No | User currency |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User | object | No | |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.startDate | string (date-time) | No | "2022-03-08", |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.birthDate | string (date-time) | No | "1987-10-06", |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.gender | enum | No | Values: male, female |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.sexualOrientation | enum | No | Values: Queer, Heterosexual, Straight |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.ethnicity | enum | No | Values: Caucasian, East Asian, Middle Eastern, Black, Biracial (South Asian & Caucasian), Filipino, South Asian, Indian, White, Asian |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.People Manager (Reviews) | string | No | 'People Manager', |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Salary Information | string | No | '130000', |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Remote Work - Location | string | No | 'Ontario', |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Job Level | string | No | 'M3', |
urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User.Sub Departments | string | No | |
urn:ietf:params:scim:schemas:extension:peakon:2.0:User | object | No | |
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.Gender | enum | No | Values: Female, Male |
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.Team | string | No | |
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.Manager | string | No | |
urn:ietf:params:scim:schemas:extension:peakon:2.0:User.Date of Birth | string (date-time) | No |
Are we missing anything? Let us know
Was this page helpful?