Skip to navigation
Dropbox APIUser EndpointsOpenID

Userinfo

Preview
View as Markdown

This route is used for refreshing the info that is found in the id_token during the OIDC flow. This route doesn’t require any arguments and will use the scopes approved for the given access token.

Required scope: openid

Endpoint format: RPC

Authentication: User

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Headers

Dropbox-API-Select-UserstringOptional

Acts on behalf of a team member for supported user-auth operations. Pass a team member ID such as dbmid:.... When used with a team token, that token must also include the team_data.member scope.

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Request

This endpoint expects a nullable object.

Response headers

X-Dropbox-Request-IdstringOptional
A unique identifier for the request, useful for debugging and support.

Response

Successful response
emailstring or nullOptional

The user’s email address. Be aware it’s possible that the user has since lost access to their email. Note: email is not a unique or stable identifier for a Dropbox account. Users can change their email, and emails can be reused by different accounts. Apps should not use email as a key for account identification; use sub instead.

email_verifiedboolean or nullOptional
If the user's email address is verified.
family_namestring or nullOptional
Last name of the user.
given_namestring or nullOptional
First name of the user.
issstringOptional

Issuer of the token (in this case Dropbox).

substringOptional

An identifier for the user. This is the Dropbox account_id, a string value such as dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc. The account_id is a unique and stable identifier for a Dropbox account, suitable for use as a key in authentication and account management.

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error