The metadata for a user
name | data type | description |
---|---|---|
disk_space_used | number | The disk space, in bytes, consumed by the user's personal storage. |
disk_space_quota | number | The maximum disk space, in bytes, that the user is allowed to have in personal storage. |
file_size_limit | number | The maximum file size, in bytes, that the user is allowed to upload. |
first_name | string | The user's first name. |
last_name | string | The user's last name. |
locale | Locale | The user's locale. |
middle_name | string | The user's middle name. |
organization | string | The user's organization. |
phone | string | The user's primary phone number. |
time_zone | string | The user's primary time zone. |
avatar | StringIdLinkPair | Information about the user's avatar (profile picture). It has three related links:
|
hidden_files_folder | LongIdLinkPair | Information about the user's hidden "My Files" storage folder. |
workspace | LongIdLinkPair | Information about the user's workspace. |
mobile_app_config | MobileAppConfig | The user's effective mobile application settings. |
desktop_app_config | DesktopAppConfig | The user's effective desktop application settings. |
groups | array of LongIdLinkPair | The groups the user is a member of. |
mobile_devices | array of MobileDevice | A list of the user's registered mobile devices. |
Properties inherited from Principal |
||
string | The user or group's primary email address. | |
name | string | A unique name for the user or group. For users, this is the user's login name. |
Properties inherited from Entry |
||
entry_type | string | The type of entry. Possible values are:
|
Properties inherited from DefinableEntity |
||
permalinks | array of Link | |
creation | HistoryStamp | Date and time that the entity was created and the user who created it. |
description | Description | Description of the entity. For replies, this is the text of the comment. |
entity_type | string | A string identifying the type of this entity. Possible values are user , group ,
folder , workspace and folderEntry . |
id | number | 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 | The date and time when the entity was last modified and the user who modified it. |
parent_binder | ParentBinder | Information about the binder where this entity resides. |
permalink | string | A URL in the web application for this entity. |
title | string | The title or displayable name of the entity. |
Properties inherited from SearchableObject |
||
doc_type | string | The indexed document type. Possible values are:
|
Properties inherited from BaseRestObject |
||
href | string | The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest). |
links | array of Link | Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs) |
Example
{ "disk_space_used" : 12345, "disk_space_quota" : 12345, "file_size_limit" : 12345, "first_name" : "...", "last_name" : "...", "locale" : { "country" : "...", "language" : "..." }, "middle_name" : "...", "organization" : "...", "phone" : "...", "time_zone" : "...", "avatar" : { "id" : "...", "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }, "hidden_files_folder" : { "id" : 12345, "href" : "..." }, "workspace" : { "id" : 12345, "href" : "..." }, "mobile_app_config" : { "allow_cached_password" : true, "allow_cached_content" : true, "force_pin_code" : true, "sync_interval" : 12345, "allow_cut_copy" : true, "allow_screen_capture" : true, "allow_rooted_devices" : true, "allowed_open_in_apps" : "...", "android_app_whitelist" : [ "...", "..." ], "ios_app_whitelist" : [ "...", "..." ] }, "desktop_app_config" : { "auto_update_url" : "...", "allow_cached_password" : true, "max_file_size" : 12345, "sync_interval" : 12345, "process_config" : { "allow_unlisted_processes" : true, "allow_unlisted_process_override" : true, "allowed_processes" : [ "...", "..." ], "blocked_processes" : [ "...", "..." ], "href" : "...", "links" : [ { }, { } ] } }, "groups" : [ { "id" : 12345, "href" : "..." }, { "id" : 12345, "href" : "..." } ], "mobile_devices" : [ { "id" : "...", "description" : "...", "push_token" : "...", "last_login" : 12345, "last_wipe" : 12345, "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }, { "id" : "...", "description" : "...", "push_token" : "...", "last_login" : 12345, "last_wipe" : 12345, "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] } ], "email" : "...", "name" : "...", "entry_type" : "...", "permalinks" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ], "creation" : { "principal" : { "id" : 12345, "href" : "..." }, "date" : 12345 }, "description" : { "text" : "...", "format_str" : "..." }, "entity_type" : "...", "id" : 12345, "modification" : { "principal" : { "id" : 12345, "href" : "..." }, "date" : 12345 }, "parent_binder" : { "path" : "...", "id" : 12345, "href" : "..." }, "permalink" : "...", "title" : "...", "doc_type" : "...", "href" : "...", "links" : [ { "href" : "...", "rel" : "..." }, { "href" : "...", "rel" : "..." } ] }