Get User Info

Get the user’s profile information using the OpenID Connect UserInfo endpoint. This endpoint returns claims about the authenticated user.

Authentication: Requires a valid access token obtained from an authentication flow that included the openid scope.

Returned claims depend on:

• The scope requested during authentication (profile, email, address, phone)
• Custom claims added via Rules or Actions
• The API (audience) the access token was issued for

GET https://{yourDomain}/userinfo

Get User Info

cURL

curl --request GET \
  --url https://{yourDomain}/userinfo \
  --header 'Authorization: Bearer <token>'

200

{
  "sub": "auth0|507f1f77bcf86cd799439011",
  "name": "Jane Doe",
  "given_name": "Jane",
  "family_name": "Doe",
  "nickname": "jane",
  "email": "[e-mail]",
  "email_verified": true,
  "picture": "https://s.gravatar.com/avatar/abc123.png",
  "updated_at": "2023-11-15T14:30:00.000Z"
}

Authorizations

Authorization · string · header · required

Access token obtained from the authentication flow

Response

200

application/json

User information retrieved successfully

sub · string · required

The user's unique identifier (subject)

name · string

The user's full name

given_name · string

The user's given (first) name

family_name · string

The user's family (last) name

middle_name · string

The user's middle name

nickname · string

The user's nickname

preferred_username · string

The user's preferred username

profile · string<uri>

URL of the user's profile page

picture · string<uri>

URL of the user's profile picture

website · string<uri>

URL of the user's website

email · string<email>

The user's email address

email_verified · boolean

Whether the user's email address has been verified

gender · string

The user's gender

birthdate · string<date>

The user's birthday

zoneinfo · string

The user's time zone

locale · string

The user's locale

phone_number · string

The user's phone number

phone_number_verified · boolean

Whether the user's phone number has been verified

address · object

The user's address

Show child attributes

updated_at · string<date-time>

Time the user's information was last updated