This user object is used in the following places:
- All (ELC) Webhook payloads
- Get All Path Assignments in Date Range
- Get All SCORM Assignments in Date Range
- Get All Guide Assignments in Date Range
Here are the properties of user:
| Field | Type | Description |
|---|---|---|
id | integer | unique identifier of the user |
email | string | email address of the user |
name | string | full name of the user |
createdAt | integer | timestamp when the user was created |
updatedAt | integer | timestamp when the user was last updated |
isAdmin | boolean | user is an admin? |
isDeleted | boolean | user has been deactivated? |
isPermanentlyDeleted | boolean | user has been deleted? |
customAttributes[] | array | custom attributes of the user |
customAttributes[].id | integer | unique identifier of the custom attribute |
customAttributes[].apiName | string | API name of the custom attribute |
customAttributes[].value | various | value of the custom attribute (one of [boolean, date, datetime, float, string]) |
groups[] | array | groups the user is a member of |
groups[].id | integer | unique identifier of the group |
groups[].name | string | name of the group |
managers[] | array | managers of the user |
managers[].id | integer | unique identifier of the manager |
managers[].email | string | email address of the manager |
managers[].name | string | name of the manager |
userIdentifiers[] | array | external identifiers associated with this user |
userIdentifiers[].identifier | string | unique identifier of the user in the external system |
userIdentifiers[].namespace | string | one of [hibob, sso_scim, workday] |
{
"user": {
"id": 1,
"name": "Example User",
"email": "[email protected]",
"isAdmin": true,
"isDeleted": false,
"isPermanentlyDeleted": false,
"createdAt": 1726510395258,
"updatedAt": 1726510395258,
"groups": [
{
"id": 1,
"name": "Ninjas"
}
],
"customAttributes": [
{
"id": 1,
"apiName": "example_attribute",
"value": "something"
}
],
"userIdentifiers": [
{
"identifier": "0e8d3dcfe9c9e4c0b7d351f1e14e878b",
"namespace": "sso_scim"
}
],
"managers": [
{
"id": 3,
"name": "Manager 2",
"email": "[email protected]"
},
{
"id": 2,
"name": "Manager 1",
"email": "[email protected]"
}
]
}
}