Skip to main content

UserResource Schema

Data structure for User Resource objects.

Fields​

FieldTypeRequiredDescriptionNotes
modified_timeintegerNo-API field: modified_time
creation_timeintegerNo-API field: creation_time
modified_bystringNo-API field: modified_by
idstringNo--
microtenant_idlongNo-API field: microtenant_id
microtenant_namestringNo-API field: microtenant_name
usernamestringYes--
display_namestringNo-API field: display_name
emailstringNo--
customer_idstringNo-API field: customer_id
timezonestringNo--
is_deletedintegerNo-API field: is_deleted
passwordstringYes--
tmp_passwordstringNo-API field: tmp_password
role_idstringNo-API field: role_id
commentsstringNo--
language_codestringNo-API field: language_code
eulastringNo--
group_idsstringCollectionNo-API field: group_ids
is_enabledbooleanNo-API field: is_enabled
force_pwd_changebooleanNo-API field: force_pwd_change
two_factor_auth_enabledbooleanNo-API field: two_factor_auth_enabled
two_factor_auth_typestringNo-API field: two_factor_auth_type
token_idstringNo-API field: token_id
phone_numberstringNo-API field: phone_number
local_login_disabledbooleanNo-API field: local_login_disabled
pin_sessionbooleanNo-API field: pin_session
is_lockedbooleanNo-API field: is_locked
sync_versionlongNo-API field: sync_version
delivery_taglongNo-API field: delivery_tag
one_identity_userbooleanNo-API field: one_identity_user
operation_typestringNo-API field: operation_type

Example​

{
"modified_time": 123,
"creation_time": 123,
"modified_by": "string",
"id": "string",
"microtenant_id": 123,
"microtenant_name": "string",
"username": "string",
"display_name": "string"
}
// ... more fields