User Info

Get claims about the authenticated End-User

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User.

GEThttps://auth.authority.io/unknown/userinfo

Header parameters

Response

200400401

Claims about the authenticated End-User

Body

application/json

substring

Subject - Identifier for the End-User at the Issuer

namestring

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences

given_namestring

Given name(s) or first name(s) of the End-User

family_namestring

Surname(s) or last name(s) of the End-User

middle_namestring

Middle name(s) of the End-User

nicknamestring

Casual name of the End-User that may or may not be the same as the given_name

preferred_usernamestring

Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe

profilestring

URL of the End-User's profile page

picturestring

URL of the End-User's profile picture

websitestring

URL of the End-User's Web page or blog

emailstring

End-User's preferred e-mail address

email_verifiedboolean

User at the time the verification was performed

genderstring

End-User's gender

birthdatestring

End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format

zoneinfostring

String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone

localestring

End-User's locale, represented as a BCP47 [RFC5646] language tag

phone_numberstring

End-User's preferred telephone number

phone_number_verifiedboolean

User at the time the verification was performed

addressstring

End-User's preferred postal address

updated_atinteger

Time the End-User's information was last updated

Request

JavaScriptCurlPython

const response = await fetch('https://auth.authority.io/unknown/userinfo', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200

{
  "sub": "text",
  "name": "text",
  "given_name": "text",
  "family_name": "text",
  "middle_name": "text",
  "nickname": "text",
  "preferred_username": "text",
  "profile": "text",
  "picture": "text",
  "website": "text",
  "email": "text",
  "email_verified": false,
  "gender": "text",
  "birthdate": "text",
  "zoneinfo": "text",
  "locale": "text",
  "phone_number": "text",
  "phone_number_verified": false,
  "address": "text",
  "updated_at": 0
}

Get claims about the authenticated End-User

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User.

POSThttps://auth.authority.io/unknown/userinfo

Body

application/x-www-form-urlencoded

access_token*string

To obtain the requested Claims about the End-User, the Client makes a request to the UserInfo Endpoint using an Access Token obtained through OpenID Connect Authentication

Response

200400401

Claims about the authenticated End-User

Body

application/json

substring

Subject - Identifier for the End-User at the Issuer

namestring

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences

given_namestring

Given name(s) or first name(s) of the End-User

family_namestring

Surname(s) or last name(s) of the End-User

middle_namestring

Middle name(s) of the End-User

nicknamestring

Casual name of the End-User that may or may not be the same as the given_name

preferred_usernamestring

Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe

profilestring

URL of the End-User's profile page

picturestring

URL of the End-User's profile picture

websitestring

URL of the End-User's Web page or blog

emailstring

End-User's preferred e-mail address

email_verifiedboolean

User at the time the verification was performed

genderstring

End-User's gender

birthdatestring

End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format

zoneinfostring

String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone

localestring

End-User's locale, represented as a BCP47 [RFC5646] language tag

phone_numberstring

End-User's preferred telephone number

phone_number_verifiedboolean

User at the time the verification was performed

addressstring

End-User's preferred postal address

updated_atinteger

Time the End-User's information was last updated

Request

JavaScriptCurlPython

const response = await fetch('https://auth.authority.io/unknown/userinfo', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "access_token": "text"
    }),
});
const data = await response.json();

Response

200

{
  "sub": "text",
  "name": "text",
  "given_name": "text",
  "family_name": "text",
  "middle_name": "text",
  "nickname": "text",
  "preferred_username": "text",
  "profile": "text",
  "picture": "text",
  "website": "text",
  "email": "text",
  "email_verified": false,
  "gender": "text",
  "birthdate": "text",
  "zoneinfo": "text",
  "locale": "text",
  "phone_number": "text",
  "phone_number_verified": false,
  "address": "text",
  "updated_at": 0
}