Table of Contents

Class UserInfo

Namespace
Auth0.AuthenticationApi.Models
Assembly
Auth0.AuthenticationApi.dll

Represents user information returned from a standard OpenID Connect /userinfo endpoint.

public class UserInfo
Inheritance
UserInfo
Inherited Members
Extension Methods

Remarks

See http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims for more details.

Properties

AdditionalClaims

Additional claims about the user.

[Obsolete("Use AdditionalClaimsJson. AdditionalClaims will be removed in a future major version.")]
[JsonIgnore]
public IDictionary<string, JToken> AdditionalClaims { get; }

Property Value

IDictionary<string, JToken>

Remarks

Computed on each access from AdditionalClaimsJson; the returned dictionary is a snapshot, so mutating it does not persist back onto the UserInfo instance.

AdditionalClaimsJson

Additional claims about the user, captured as raw JSON elements.

[JsonExtensionData]
public IDictionary<string, JsonElement> AdditionalClaimsJson { get; set; }

Property Value

IDictionary<string, JsonElement>

Address

User's preferred postal/mailing address.

[JsonPropertyName("address")]
public UserInfoAddress Address { get; set; }

Property Value

UserInfoAddress

Birthdate

User's birthday, ISO 8601:2004 YYYY-MM-DD format.

[JsonPropertyName("birthdate")]
public string Birthdate { get; set; }

Property Value

string

Email

User's preferred e-mail address.

[JsonPropertyName("email")]
public string Email { get; set; }

Property Value

string

EmailVerified

Whether the user's email address has been verified or not.

[JsonPropertyName("email_verified")]
public bool? EmailVerified { get; set; }

Property Value

bool?

FirstName

Given name(s) or first name(s) of the user.

[JsonPropertyName("given_name")]
public string FirstName { get; set; }

Property Value

string

FullName

Full name of the user in displayable form.

[JsonPropertyName("name")]
public string FullName { get; set; }

Property Value

string

Gender

User's gender.

[JsonPropertyName("gender")]
public string Gender { get; set; }

Property Value

string

LastName

Surname(s) or last name(s) of the user.

[JsonPropertyName("family_name")]
public string LastName { get; set; }

Property Value

string

Locale

User's locale, represented as a BCP47 language tag.

[JsonPropertyName("locale")]
[JsonConverter(typeof(StringOrObjectAsStringConverter))]
public string Locale { get; set; }

Property Value

string

MiddleName

Middle name(s) of the user.

[JsonPropertyName("middle_name")]
public string MiddleName { get; set; }

Property Value

string

NickName

Casual name of the user.

[JsonPropertyName("nickname")]
public string NickName { get; set; }

Property Value

string

PhoneNumber

User's preferred telephone number.

[JsonPropertyName("phone_number")]
public string PhoneNumber { get; set; }

Property Value

string

PhoneNumberVerified

Whether the user's phone number has been verified or not.

[JsonPropertyName("phone_number_verified")]
public bool? PhoneNumberVerified { get; set; }

Property Value

bool?

Picture

URL of the user's profile picture.

[JsonPropertyName("picture")]
public string Picture { get; set; }

Property Value

string

PreferredUsername

Shorthand name by which the user wishes to be referred to at the RP.

[JsonPropertyName("preferred_username")]
public string PreferredUsername { get; set; }

Property Value

string

Profile

URL of the user's profile page.

[JsonPropertyName("profile")]
public string Profile { get; set; }

Property Value

string

UpdatedAt

Time and date the user's information was last updated.

[JsonPropertyName("updated_at")]
[JsonConverter(typeof(FlexibleDateTimeConverter))]
public DateTime? UpdatedAt { get; set; }

Property Value

DateTime?

UserId

Subject-Identifier for the user at the issuer. A unique value to identify the user.

[JsonPropertyName("sub")]
public string UserId { get; set; }

Property Value

string

Website

URL of the user's Web page or blog.

[JsonPropertyName("website")]
public string Website { get; set; }

Property Value

string

ZoneInformation

User's time zone as a "tz database name".

[JsonPropertyName("zoneinfo")]
public string ZoneInformation { get; set; }

Property Value

string