Skip to main content

User Schema

Data structure for User objects.

Fields​

FieldTypeRequiredDescriptionNotes
admin_userbooleanNo-API field: admin_user
commentsstringNo--
deletedbooleanNo--
departmentDepartmentNo--
disabledbooleanNo--
emailstringNo--
groupsGroupWrapperCollectionNo--
idintegerNo--
is_non_editablebooleanNo-API field: is_non_editable
namestringNo--
passwordstringNo--
pilot_userbooleanNo-API field: pilot_user
pwd_last_modified_timeintegerNo-API field: pwd_last_modified_time
system_defined_groupsGroupWrapperCollectionNo-API field: system_defined_groups
temp_auth_emailstringNo-API field: temp_auth_email
typestringNo--
user_risk_scoreUserRiskScoreNo-API field: user_risk_score

Example​

{
"admin_user": true,
"comments": "string",
"deleted": true,
"department": {
"comments": "string",
"deleted": true,
"id": 123
},
"disabled": true,
"email": "string",
"groups": [
{
"comments": "string",
"id": 123,
"idp_id": 123
}
],
"id": 123
}
// ... more fields