The metadata for a user
name | data type | type | namespace | min/max occurs | wrapped by | description |
---|---|---|---|---|---|---|
avatar | stringIdLinkPair | element | 0/1 | Information about the user's avatar (profile picture). It has three related links:
|
||
desktop_app_config | desktopAppConfig | element | 0/1 | The user's effective desktop application settings. | ||
disk_space_quota | long | element | 0/1 | The maximum disk space, in bytes, that the user is allowed to have in personal storage. | ||
disk_space_used | long | element | 0/1 | The disk space, in bytes, consumed by the user's personal storage. | ||
file_size_limit | long | element | 0/1 | The maximum file size, in bytes, that the user is allowed to upload. | ||
first_name | string | element | 0/1 | The user's first name. | ||
group | longIdLinkPair | element | 0/unbounded | groups | The groups the user is a member of. | |
hidden_files_folder | longIdLinkPair | element | 0/1 | Information about the user's hidden "My Files" storage folder. | ||
last_name | string | element | 0/1 | The user's last name. | ||
locale | locale | element | 0/1 | The user's locale. | ||
middle_name | string | element | 0/1 | The user's middle name. | ||
mobile_app_config | mobileAppConfig | element | 0/1 | The user's effective mobile application settings. | ||
mobile_device | mobileDevice | element | 0/unbounded | mobile_devices | A list of the user's registered mobile devices. | |
organization | string | element | 0/1 | The user's organization. | ||
phone | string | element | 0/1 | The user's primary phone number. | ||
time_zone | string | element | 0/1 | The user's primary time zone. | ||
workspace | longIdLinkPair | element | 0/1 | Information about the user's workspace. | ||
Properties inherited from principal |
||||||
string | element | 0/1 | The user or group's primary email address. | |||
name | string | element | 1/1 | A unique name for the user or group. For users, this is the user's login name. | ||
Properties inherited from entry |
||||||
entry_type | string | element | 0/1 | The type of entry. Possible values are:
|
||
Properties inherited from definableEntity |
||||||
creation | historyStamp | element | 0/1 | Date and time that the entity was created and the user who created it. | ||
description | description | element | 0/1 | Description of the entity. For replies, this is the text of the comment. | ||
entity_type | string | element | 0/1 | A string identifying the type of this entity. Possible values are user , group ,
folder , workspace and folderEntry . |
||
id | long | element | 0/1 | An ID for the entity. This is guaranteed to be unique for each entity type, but not necessarily unique among all entities.
For example, there will only be 1 user with an ID of 12, but there might also be a folder with an ID of 12. |
||
modification | historyStamp | element | 0/1 | The date and time when the entity was last modified and the user who modified it. | ||
parent_binder | parentBinder | element | 0/1 | Information about the binder where this entity resides. | ||
permalink | link | element | 0/unbounded | permalinks | ||
permalink | string | element | 0/1 | A URL in the web application for this entity. | ||
title | string | element | 0/1 | The title or displayable name of the entity. | ||
Properties inherited from searchableObject |
||||||
doc_type | string | element | 0/1 | The indexed document type. Possible values are:
|
||
Properties inherited from baseRestObject |
||||||
href | string | element | 0/1 | The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest). | ||
link | link | element | 0/unbounded | links | Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs) |
Example
<user> <disk_space_used>...</disk_space_used> <disk_space_quota>...</disk_space_quota> <file_size_limit>...</file_size_limit> <first_name>...</first_name> <last_name>...</last_name> <locale> <country>...</country> <language>...</language> </locale> <middle_name>...</middle_name> <organization>...</organization> <phone>...</phone> <time_zone>...</time_zone> <avatar> <id>...</id> <href>...</href> <links> <link/> </links> </avatar> <hidden_files_folder> <id>...</id> <href>...</href> </hidden_files_folder> <workspace> <id>...</id> <href>...</href> </workspace> <mobile_app_config> <allow_cached_password>...</allow_cached_password> <allow_cached_content>...</allow_cached_content> <force_pin_code>...</force_pin_code> <sync_interval>...</sync_interval> <allow_cut_copy>...</allow_cut_copy> <allow_screen_capture>...</allow_screen_capture> <allow_rooted_devices>...</allow_rooted_devices> <allowed_open_in_apps>...</allowed_open_in_apps> <android_app_whitelist> <app>...</app> </android_app_whitelist> <ios_app_whitelist> <app>...</app> </ios_app_whitelist> </mobile_app_config> <desktop_app_config> <auto_update_url>...</auto_update_url> <allow_cached_password>...</allow_cached_password> <max_file_size>...</max_file_size> <sync_interval>...</sync_interval> <process_config> <allow_unlisted_processes>...</allow_unlisted_processes> <allow_unlisted_process_override>...</allow_unlisted_process_override> <allowed_processes> <name>...</name> </allowed_processes> <blocked_processes> <name>...</name> </blocked_processes> </process_config> </desktop_app_config> <groups> <group> <id>...</id> <href>...</href> </group> </groups> <mobile_devices> <mobile_device> <id>...</id> <description>...</description> <push_token>...</push_token> <last_login>...</last_login> <last_wipe>...</last_wipe> <href>...</href> <links> <link/> </links> </mobile_device> </mobile_devices> <email>...</email> <name>...</name> <entry_type>...</entry_type> </user>