Get current user
Retrieves information about the user who is currently authenticated.
In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.
In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.
Use the As-User header to change who this API call is made on behalf of.
Request
Query Parameters
id,type,nameA comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
Response
Returns a single user object.
An unexpected client error.
Request Example
curl -i -X GET "https://api.box.com/2.0/users/me" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.users.getUserMe();client.users.get_user_me()await client.Users.GetUserMeAsync();try await client.users.getUserMe()BoxUser user = BoxUser.getCurrentUser(api);
BoxUser.Info info = user.getInfo();current_user = client.user().get()BoxUser currentUser = await client.UsersManager.GetCurrentUserInformationAsync();client.users.get(client.CURRENT_USER_ID)
.then(currentUser => {
/* currentUser -> {
type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com',
created_at: '2012-03-26T15:43:07-07:00',
modified_at: '2012-12-12T11:34:29-08:00',
language: 'en',
space_amount: 5368709120,
space_used: 2377016,
max_upload_size: 262144000,
status: 'active',
job_title: 'Employee',
phone: '5555555555',
address: '555 Office Drive',
avatar_url: 'https://app.box.com/api/avatar/deprecated' }
*/
});client.users.getCurrent(fields: ["name", "login"]) { (result: Result<User, BoxSDKError>) in
guard case let .success(user) = result else {
print("Error getting user information")
return
}
print("Authenticated as \(user.name), with login \(user.login)")
}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"
}
]
}