A full representation of a user, as can be returned from any user API endpoint.
"11446498"
The unique identifier for this user
"user"
user
Value is always user
"900 Jefferson Ave, Redwood City, CA 94063"
255
The user’s address
"https://www.box.com/api/avatar/large/181216415"
URL of the user’s avatar image
true
Whether the user can see other enterprise users in their contact list
"2012-12-12T10:53:43-08:00"
When the user object was created
Representation of the user’s enterprise
"11446498"
The unique identifier for this enterprise.
"enterprise"
enterprise
Value is always enterprise
"Acme Inc."
The name of the enterprise
"my-user-1234"
An 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
true
Whether to exempt the user from Enterprise device limits
true
Whether the user must use two-factor authentication
true
Whether the user is allowed to collaborate with users outside their enterprise
true
Whether the user is an App User
true
Whether the user can use Box Sync
"CEO"
100
The user’s job title
"ceo@example.com"
The primary email address of this user
2147483648
The maximum individual file size in bytes the user can have
"2012-12-12T10:53:43-08:00"
When 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 Levie"
50
The 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.com"
The email address to send the notifications to.
true
Specifies if this email address has been confirmed.
"6509241374"
100
The user’s phone number
"admin"
The user’s enterprise role
Value is one of admin
,coadmin
,user
11345156112
The user’s total available space amount in bytes
1237009912
The amount of space in use by the user
"active"
The user's account status
Value is one of active
,inactive
,cannot_delete_edit
,cannot_delete_edit_upload
"Africa/Bujumbura"
The 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_code"
tracking_code
Value is always tracking_code
"department"
The name of the tracking code, which must be preconfigured in the Admin Console
"Sales"
The value of the tracking code
{
"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": [
{
"type": "tracking_code",
"name": "department",
"value": "Sales"
}
]
}