User (Full)
A full representation of a user, as can be returned from any user API endpoint.
11446498The unique identifier for this user.
userThe value will always be user.
Value is always user
900 Jefferson Ave, Redwood City, CA 94063255The user’s address.
https://www.box.com/api/avatar/large/181216415URL of the user’s avatar image.
trueWhether the user can see other enterprise users in their contact list.
2012-12-12T10:53:43-08:00When the user object was created.
Representation of the user’s enterprise.
11446498The unique identifier for this enterprise.
enterpriseThe value will always be enterprise.
Value is always enterprise
Acme Inc.The name of the enterprise.
my-user-1234An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.
https://example.app.box.com/The root (protocol, subdomain, domain) of any links that need to be generated for the user.
trueWhether to exempt the user from Enterprise device limits.
trueWhether the user must use two-factor authentication.
trueWhether the user is allowed to collaborate with users outside their enterprise.
trueWhether the user is an App User.
trueWhether the user can use Box Sync.
CEO100The user’s job title.
ceo@example.comThe primary email address of this user.
2147483648The maximum individual file size in bytes the user can have.
2012-12-12T10:53:43-08:00When the user object was last modified.
["important"]Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.
Aaron Levie50The display name of this user.
An alternate notification email address to which email notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of to the primary email address.
notifications@example.comThe email address to send the notifications to.
trueSpecifies if this email address has been confirmed.
6509241374100The user’s phone number.
adminThe user’s enterprise role.
Value is one of admin,coadmin,user
11345156112The user’s total available space amount in bytes.
1237009912The amount of space in use by the user.
activeThe user's account status.
Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload
Africa/BujumburaThe user's timezone.
Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
tracking_codeThe value will always be tracking_code.
Value is always tracking_code
departmentThe name of the tracking code, which must be preconfigured in the Admin Console.
SalesThe value of the tracking code.
Response Example
{
"id": "11446498",
"type": "user",
"address": "900 Jefferson Ave, Redwood City, CA 94063",
"avatar_url": "https://www.box.com/api/avatar/large/181216415",
"can_see_managed_users": true,
"created_at": "2012-12-12T10:53:43-08:00",
"enterprise": {
"id": "11446498",
"type": "enterprise",
"name": "Acme Inc."
},
"external_app_user_id": "my-user-1234",
"hostname": "https://example.app.box.com/",
"is_exempt_from_device_limits": true,
"is_exempt_from_login_verification": true,
"is_external_collab_restricted": true,
"is_platform_access_only": true,
"is_sync_enabled": true,
"job_title": "CEO",
"language": "en",
"login": "ceo@example.com",
"max_upload_size": 2147483648,
"modified_at": "2012-12-12T10:53:43-08:00",
"my_tags": [
"important"
],
"name": "Aaron Levie",
"notification_email": {
"email": "notifications@example.com",
"is_confirmed": true
},
"phone": "6509241374",
"role": "admin",
"space_amount": 11345156112,
"space_used": 1237009912,
"status": "active",
"timezone": "Africa/Bujumbura",
"tracking_codes": [
{
"name": "department",
"type": "tracking_code",
"value": "Sales"
}
]
}