• management
• Management
• SetUserAuthenticationMethodResponseContent

Interface SetUserAuthenticationMethodResponseContent

The successfully created authentication method.

interface SetUserAuthenticationMethodResponseContent {
id?: string;
type: Management.CreatedAuthenticationMethodTypeEnum;
name?: string;
totp_secret?: string;
phone_number?: string;
email?: string;
authentication_methods?: UserAuthenticationMethodProperties[];
preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum;
key_id?: string;
public_key?: string;
aaguid?: string;
relying_party_identifier?: string;
created_at?: string;
}

Index

Properties

id?typename?totp_secret?phone_number?email?authentication_methods?preferred_authentication_method?key_id?public_key?aaguid?relying_party_identifier?created_at?

Properties

Optionalid

id?: string

The ID of the newly created authentication method (automatically generated by the application)

type

type: Management.CreatedAuthenticationMethodTypeEnum

Optionalname

name?: string

A human-readable label to identify the authentication method.

Optionaltotp_secret

totp_secret?: string

Base32 encoded secret for TOTP generation

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 authentication methods only. The email address used to send verification messages.

Optionalauthentication_methods

authentication_methods?: UserAuthenticationMethodProperties[]

Optionalpreferred_authentication_method

preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum

Preferred phone authentication method

Optionalkey_id

key_id?: string

Applies to webauthn authenticators only. The id of the credential.

Optionalpublic_key

public_key?: string

Applies to webauthn authenticators only. The public key.

Optionalaaguid

aaguid?: string

Applies to passkeys only. Authenticator Attestation Globally Unique Identifier.

Optionalrelying_party_identifier

relying_party_identifier?: string

Applies to webauthn authenticators only. The relying party identifier.

Optionalcreated_at

created_at?: string

Authentication method creation date

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties idtypenametotp_secretphone_numberemailauthentication_methodspreferred_authentication_methodkey_idpublic_keyaaguidrelying_party_identifiercreated_at