Skip to main content

UserInfo Schema

Data structure for User Info objects.

Fields​

FieldTypeRequiredDescriptionNotes
admin_scopeAdminScopeNo-API field: admin_scope
client_apps_enabledbooleanNo-API field: client_apps_enabled
default_adminbooleanNo-API field: default_admin
device_host_name_obfuscatedbooleanNo-API field: device_host_name_obfuscated
device_software_inventory_enabledbooleanNo-API field: device_software_inventory_enabled
device_software_patch_inventory_support_enabledbooleanNo-API field: device_software_patch_inventory_support_enabled
emailstringNo--
idintegerNo--
ip_address_obfuscatedbooleanNo-API field: ip_address_obfuscated
location_obfuscatedbooleanNo-API field: location_obfuscated
login_namestringNo-API field: login_name
namestringNo--
qbr_reports_enabledbooleanNo-API field: qbr_reports_enabled
remote_assistance_availablebooleanNo-API field: remote_assistance_available
role_idintegerNo-API field: role_id
role_namestringNo-API field: role_name
role_permissionsAccessControlEnumRecordNo-API field: role_permissions
role_rankintegerNo-API field: role_rank
role_typestringNo-API field: role_type
super_adminbooleanNo-API field: super_admin
support_sessionbooleanNo-API field: support_session
time_duration_in_hrsintegerNo-API field: time_duration_in_hrs
ucaas_enabledbooleanNo-API field: ucaas_enabled
ucaas_obfuscatedbooleanNo-API field: ucaas_obfuscated
user_name_obfuscatedbooleanNo-API field: user_name_obfuscated
wifi_name_obfuscatedbooleanNo-API field: wifi_name_obfuscated
yengine_enabledbooleanNo-API field: yengine_enabled

Example​

{
"admin_scope": {
"scope_entities": [
{
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
],
"type": "string",
"scope_group_member_entities": [
{
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
]
},
"client_apps_enabled": true,
"default_admin": true,
"device_host_name_obfuscated": true,
"device_software_inventory_enabled": true,
"device_software_patch_inventory_support_enabled": true,
"email": "string",
"id": 123
}
// ... more fields