Class UserBase

Namespace

Auth0.ManagementApi.Models

Assembly

Auth0.ManagementApi.dll

Contains common elements used for both constructing User-related requests, and comprising User-related responses.

public abstract class UserBase

Inheritance

object

UserBase

Derived

User

UserCreateRequest

UserUpdateRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AppMetadata

Contains user meta data. The user has read-only access to this.

[JsonProperty("app_metadata")]
public dynamic AppMetadata { get; set; }

Property Value

dynamic

Blocked

Gets or sets whether the user is blocked. True if the user is blocked, otherwise false.

[JsonProperty("blocked")]
public bool? Blocked { get; set; }

Property Value

bool?

Email

Gets or sets the user's email address.

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

Property Value

string

EmailVerified

Gets or sets whether the user's email address is verified.

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

Property Value

bool?

Remarks

True if the email address is verified, otherwise false.

FirstName

The first name of the user (if available).

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

Property Value

string

Remarks

This is the given_name attribute supplied by the underlying API.

FullName

The full name of the user (e.g.: John Foo). ALWAYS GENERATED.

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

Property Value

string

Remarks

This is the name attribute supplied by the underlying API.

LastName

The last name of the user (if available).

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

Property Value

string

Remarks

This is the family_name attribute supplied by the underlying API.

NickName

The Nickname of the user.

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

Property Value

string

PhoneNumber

Gets or sets the user's phone number.

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

Property Value

string

Remarks

This is only valid for users from SMS connections.

PhoneVerified

Gets or sets whether the user's phone is verified.

[JsonProperty("phone_verified")]
public bool? PhoneVerified { get; set; }

Property Value

bool?

Remarks

True if the phone is verified, otherwise false.

Picture

URL pointing to the user picture (if not available, will use gravatar.com with the email). ALWAYS GENERATED

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

Property Value

string

UserMetadata

Contains user meta data. The user has read/write access to this.

[JsonProperty("user_metadata")]
public dynamic UserMetadata { get; set; }

Property Value

dynamic

UserName

Gets or sets the user' username.

[JsonProperty("username")]
public string UserName { get; set; }

Property Value

string

Methods

GetAppMetadata<T>()

Returns AppMetadata as specific type.

public T GetAppMetadata<T>() where T : class

Returns

T

An instance of T.

Type Parameters

T

Type to be returned.

GetUserMetadata<T>()

Returns UserMetadata as specific type.

public T GetUserMetadata<T>() where T : class

Returns

T

An instance of T.

Type Parameters

T

Type to be returned.

SetAppMetadata<T>(T)

Set given appMetadata as AppMetadata.

public void SetAppMetadata<T>(T appMetadata) where T : class

Parameters

appMetadata T

Metadata to set.

Type Parameters

T

Metadata type.

SetUserMetadata<T>(T)

Set given userMetadata as UserMetadata.

public void SetUserMetadata<T>(T userMetadata) where T : class

Parameters

userMetadata T

Metadata to set.

Type Parameters

T

Metadata type.