Class UserAuthenticationMethod

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

[Serializable]
public record UserAuthenticationMethod : IJsonOnDeserialized, IEquatable<UserAuthenticationMethod>

Inheritance

object

UserAuthenticationMethod

Implements

IJsonOnDeserialized

IEquatable<UserAuthenticationMethod>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Properties

Aaguid

Applies to passkey authentication methods only. Authenticator Attestation Globally Unique Identifier.

[JsonPropertyName("aaguid")]
public string? Aaguid { get; set; }

Property Value

string

AdditionalProperties

[JsonIgnore]
public ReadOnlyAdditionalProperties AdditionalProperties { get; }

Property Value

ReadOnlyAdditionalProperties

AuthenticationMethods

[JsonPropertyName("authentication_methods")]
public IEnumerable<UserAuthenticationMethodProperties>? AuthenticationMethods { get; set; }

Property Value

IEnumerable<UserAuthenticationMethodProperties>

Confirmed

The authentication method status

[JsonPropertyName("confirmed")]
public bool? Confirmed { get; set; }

Property Value

bool?

CreatedAt

Authenticator creation date

[JsonPropertyName("created_at")]
public required DateTime CreatedAt { get; set; }

Property Value

DateTime

CredentialBackedUp

Applies to passkeys only. Whether the credential was backed up.

[JsonPropertyName("credential_backed_up")]
public bool? CredentialBackedUp { get; set; }

Property Value

bool?

CredentialDeviceType

Applies to passkeys only. The kind of device the credential is stored on as defined by backup eligibility. "single_device" credentials cannot be backed up and synced to another device, "multi_device" credentials can be backed up if enabled by the end-user.

[JsonPropertyName("credential_device_type")]
public string? CredentialDeviceType { get; set; }

Property Value

string

Email

Applies to email and email-verification authentication methods only. The email address used to send verification messages.

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

Property Value

string

EnrolledAt

Enrollment date

[JsonPropertyName("enrolled_at")]
public DateTime? EnrolledAt { get; set; }

Property Value

DateTime?

Id

The ID of the authentication method (auto generated)

[JsonPropertyName("id")]
public required string Id { get; set; }

Property Value

string

IdentityUserId

Applies to passkeys only. The ID of the user identity linked with the authentication method.

[JsonPropertyName("identity_user_id")]
public string? IdentityUserId { get; set; }

Property Value

string

KeyId

Applies to webauthn authentication methods only. The ID of the generated credential.

[JsonPropertyName("key_id")]
public string? KeyId { get; set; }

Property Value

string

LastAuthAt

Last authentication

[JsonPropertyName("last_auth_at")]
public DateTime? LastAuthAt { get; set; }

Property Value

DateTime?

LinkId

The ID of a linked authentication method. Linked authentication methods will be deleted together.

[JsonPropertyName("link_id")]
public string? LinkId { get; set; }

Property Value

string

Name

A human-readable label to identify the authentication method

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

Property Value

string

PhoneNumber

Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.

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

Property Value

string

PreferredAuthenticationMethod

[JsonPropertyName("preferred_authentication_method")]
public PreferredAuthenticationMethodEnum? PreferredAuthenticationMethod { get; set; }

Property Value

PreferredAuthenticationMethodEnum?

PublicKey

Applies to webauthn authentication methods only. The public key.

[JsonPropertyName("public_key")]
public string? PublicKey { get; set; }

Property Value

string

RelyingPartyIdentifier

Applies to webauthn/passkey authentication methods only. The credential's relying party identifier.

[JsonPropertyName("relying_party_identifier")]
public string? RelyingPartyIdentifier { get; set; }

Property Value

string

Type

[JsonPropertyName("type")]
public required AuthenticationMethodTypeEnum Type { get; set; }

Property Value

AuthenticationMethodTypeEnum

UserAgent

Applies to passkeys only. The user-agent of the browser used to create the passkey.

[JsonPropertyName("user_agent")]
public string? UserAgent { get; set; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.