Back to DropboxUsers - Get Current Account
Get information about the current user's account.
Output
type: object
description: >
Detailed information about the current user's account.
account_id: The user's unique Dropbox ID.
name: Details of a user's name.
email: The user's e-mail address. Do not rely on this without checking the
:field:`email_verified` field. Even then, it's possible that the user has
since lost access to their e-mail.
email_verified: Whether the user has verified their e-mail address.
disabled: Whether the user has been disabled.
locale: The language that the user specified. Locale tags will be :link:`IETF
language tags http://en.wikipedia.org/wiki/IETF_language_tag`.
referral_link: The user's :link:`referral link
https://www.dropbox.com/referrals`.
is_paired: Whether the user has a personal and work account. If the current
account is personal, then :field:`team` will always be :val:`null`, but
:field:`is_paired` will indicate if a work account is linked.
account_type: What type of account this user has.
root_info: The root info for this account.
profile_photo_url: URL for the photo representing the user, if one is set.
country: The user's two-letter country code, if available. Country codes are
based on :link:`ISO 3166-1 http://en.wikipedia.org/wiki/ISO_3166-1`.
team: If this account is a member of a team, information about that team.
team_member_id: This account's unique team member id. This field will only be
present if :field:`team` is present.
properties:
referral_link:
type: string
description: The user's :link:`referral link https://www.dropbox.com/referrals`.
account_type:
type: object
description: |
What type of account this user has.
basic: The basic account type.
pro: The Dropbox Pro account type.
business: The Dropbox Business account type.
properties:
.tag:
title: Choice of AccountType
type: string
enum:
- basic
- pro
- business
account_id:
type: string
description: The user's unique Dropbox ID.
locale:
type: string
description: >-
The language that the user specified. Locale tags will be :link:`IETF
language tags http://en.wikipedia.org/wiki/IETF_language_tag`.
email_verified:
type: boolean
description: Whether the user has verified their e-mail address.
team_member_id:
type: string
description: >-
This account's unique team member id. This field will only be present if
:field:`team` is present.
root_info:
type: object
description: >
Information about current user's root.
root_namespace_id: The namespace ID for user's root namespace. It will be
the namespace ID of the shared team root if the user is member of a team
with a separate team root. Otherwise it will be same as
:field:`RootInfo.home_namespace_id`.
home_namespace_id: The namespace ID for user's home namespace.
properties:
root_namespace_id:
type: string
description: >-
The namespace ID for user's root namespace. It will be the namespace
ID of the shared team root if the user is member of a team with a
separate team root. Otherwise it will be same as
:field:`RootInfo.home_namespace_id`.
home_namespace_id:
type: string
description: The namespace ID for user's home namespace.
disabled:
type: boolean
description: Whether the user has been disabled.
is_paired:
type: boolean
description: >-
Whether the user has a personal and work account. If the current account
is personal, then :field:`team` will always be :val:`null`, but
:field:`is_paired` will indicate if a work account is linked.
team:
type: object
description: |
Detailed information about a team.
id: The team's unique ID.
name: The name of the team.
sharing_policies: Team policies governing sharing.
office_addin_policy: Team policy governing the use of the Office Add-In.
properties:
sharing_policies:
type: object
description: >
Policies governing sharing within and outside of the team.
shared_folder_member_policy: Who can join folders shared by team
members.
shared_folder_join_policy: Which shared folders team members can join.
shared_link_create_policy: Who can view shared links owned by team
members.
properties:
shared_folder_join_policy:
type: object
description: >
Policy governing which shared folders a team member can join.
from_team_only: Team members can only join folders shared by
teammates.
from_anyone: Team members can join any shared folder, including
those shared by users outside the team.
other: None
properties:
.tag:
title: Choice of SharedFolderJoinPolicy
type: string
enum:
- from_team_only
- from_anyone
- other
shared_folder_member_policy:
type: object
description: >
Policy governing who can be a member of a folder shared by a team
member.
team: Only a teammate can be a member of a folder shared by a team
member.
anyone: Anyone can be a member of a folder shared by a team
member.
other: None
properties:
.tag:
title: Choice of SharedFolderMemberPolicy
type: string
enum:
- team
- anyone
- other
shared_link_create_policy:
type: object
description: >
Policy governing the visibility of shared links. This policy can
apply to newly created shared links, or all shared links.
default_public: By default, anyone can access newly created shared
links. No login will be required to access the shared links unless
overridden.
default_team_only: By default, only members of the same team can
access newly created shared links. Login will be required to
access the shared links unless overridden.
team_only: Only members of the same team can access all shared
links. Login will be required to access all shared links.
other: None
properties:
.tag:
title: Choice of SharedLinkCreatePolicy
type: string
enum:
- default_public
- default_team_only
- team_only
- other
office_addin_policy:
type: object
description: |
disabled: Office Add-In is disabled.
enabled: Office Add-In is enabled.
other: None
properties:
.tag:
title: Choice of OfficeAddInPolicy
type: string
enum:
- disabled
- enabled
- other
id:
type: string
description: The team's unique ID.
name:
type: string
description: The name of the team.
country:
type: string
description: >-
The user's two-letter country code, if available. Country codes are based
on :link:`ISO 3166-1 http://en.wikipedia.org/wiki/ISO_3166-1`.
email:
type: string
description: >-
The user's e-mail address. Do not rely on this without checking the
:field:`email_verified` field. Even then, it's possible that the user has
since lost access to their e-mail.
profile_photo_url:
type: string
description: URL for the photo representing the user, if one is set.
name:
type: object
description: >
Representations for a person's name to assist with internationalization.
given_name: Also known as a first name.
surname: Also known as a last name or family name.
familiar_name: Locale-dependent name. In the US, a person's familiar name
is their :field:`given_name`, but elsewhere, it could be any combination
of a person's :field:`given_name` and :field:`surname`.
display_name: A name that can be used directly to represent the name of a
user's Dropbox account.
abbreviated_name: An abbreviated form of the person's name. Their initials
in most locales.
properties:
familiar_name:
type: string
description: >-
Locale-dependent name. In the US, a person's familiar name is their
:field:`given_name`, but elsewhere, it could be any combination of a
person's :field:`given_name` and :field:`surname`.
surname:
type: string
description: Also known as a last name or family name.
display_name:
type: string
description: >-
A name that can be used directly to represent the name of a user's
Dropbox account.
given_name:
type: string
description: Also known as a first name.
abbreviated_name:
type: string
description: >-
An abbreviated form of the person's name. Their initials in most
locales.