• management
• Management
• UserAuthenticationMethod

Interface UserAuthenticationMethod

interface UserAuthenticationMethod {
id: string;
type: Management.AuthenticationMethodTypeEnum;
confirmed?: boolean;
name?: string;
authentication_methods?: UserAuthenticationMethodProperties[];
preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum;
link_id?: string;
phone_number?: string;
email?: string;
key_id?: string;
public_key?: string;
created_at: string;
enrolled_at?: string;
last_auth_at?: string;
credential_device_type?: string;
credential_backed_up?: boolean;
identity_user_id?: string;
user_agent?: string;
aaguid?: string;
relying_party_identifier?: string;
}

Index

Properties

idtypeconfirmed?name?authentication_methods?preferred_authentication_method?link_id?phone_number?email?key_id?public_key?created_atenrolled_at?last_auth_at?credential_device_type?credential_backed_up?identity_user_id?user_agent?aaguid?relying_party_identifier?

Properties

id

id: string

The ID of the authentication method (auto generated)

type

type: Management.AuthenticationMethodTypeEnum

Optionalconfirmed

confirmed?: boolean

The authentication method status

Optionalname

name?: string

A human-readable label to identify the authentication method

Optionalauthentication_methods

authentication_methods?: UserAuthenticationMethodProperties[]

Optionalpreferred_authentication_method

preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum

Optionallink_id

link_id?: string

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

Optionalphone_number

phone_number?: string

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

Optionalemail

email?: string

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

Optionalkey_id

key_id?: string

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

Optionalpublic_key

public_key?: string

Applies to webauthn authentication methods only. The public key.

created_at

created_at: string

Authenticator creation date

Optionalenrolled_at

enrolled_at?: string

Enrollment date

Optionallast_auth_at

last_auth_at?: string

Last authentication

Optionalcredential_device_type

credential_device_type?: string

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.

Optionalcredential_backed_up

credential_backed_up?: boolean

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

Optionalidentity_user_id

identity_user_id?: string

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

Optionaluser_agent

user_agent?: string

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

Optionalaaguid

aaguid?: string

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

Optionalrelying_party_identifier

relying_party_identifier?: string

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

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties idtypeconfirmednameauthentication_methodspreferred_authentication_methodlink_idphone_numberemailkey_idpublic_keycreated_atenrolled_atlast_auth_atcredential_device_typecredential_backed_upidentity_user_iduser_agentaaguidrelying_party_identifier