Skip to main content

UserProfile Schema

Data structure for User Profile objects.

Fields​

FieldTypeRequiredDescriptionNotes
login_namestringYes-API field: login_name
display_namestringYes-API field: display_name
first_namestringNo-API field: first_name
last_namestringNo-API field: last_name
primary_emailstringYes-API field: primary_email
secondary_emailstringNo-API field: secondary_email
departmentRefPubRespNo--
statusbooleanYes--
custom_attrs_infoStringRecordNo-API field: custom_attrs_info
idstringYes--
sourcestringYes--
idpRefPubRespYes--

Example​

{
"login_name": "string",
"display_name": "string",
"first_name": "string",
"last_name": "string",
"primary_email": "string",
"secondary_email": "string",
"department": {
"name": "string",
"display_name": "string",
"id": "string"
},
"status": true
}
// ... more fields