openidconnect

Show user profile details

Shows <a href="https://openid.net/connect/">OpenID Connect</a> user profile information for <a href="https://openid.net/specs/openid-connect-basic-1_0.html#StandardClaims">standard claims</a>. The attributes that are returned depend on the scopes associated with the client ID.

get/v1/identity/openidconnect/userinfo

Request

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows OpenID Connect user profile information.

user_idstring

The user ID of the user.

substring

The subject ID for the end user at the issuer.

namestring

The full name of the user.

given_namestring

The given, or first, name of the user.

family_namestring

The surname or family name of the user. Also known as the last name. Use also to store multiple surnames including the matronymic, or mother's, surname.

middle_namestring

The middle name of the user. Use also to store multiple middle names including the patronymic, or father's, middle name.

picturestring

The URL of the profile picture of the user.

emailstring

The internationalized email address.

email_verifiedboolean

Indicates whether the user's email address is verified.

genderstring

The user's gender.

birthdatestring date-time

The user's birthday, in YYYY-MM-DD format. See Internet date and time format. The year MAY be 0000, which indicates its omission. To represent only the year, use YYYY format.

zoneinfostring

The time zone of the user.

localestring

The locale of the user.

phone_numberstring

The preferred telephone number of the user.

verified_accountboolean

Indicates whether the account is verified.

age_rangestring

The account holder's age range.

Changes

No recorded changes to this operation across all 1 revision of this API.