• management
• Management
• CreateUserAuthenticationMethodRequestContent

Interface CreateUserAuthenticationMethodRequestContent

Example

{ * type: "phone" * }Copy

interface CreateUserAuthenticationMethodRequestContent {
type: Management.CreatedUserAuthenticationMethodTypeEnum;
name?: string;
totp_secret?: string;
phone_number?: string;
email?: string;
preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum;
key_id?: string;
public_key?: string;
relying_party_identifier?: string;
}

Index

Properties

typename?totp_secret?phone_number?email?preferred_authentication_method?key_id?public_key?relying_party_identifier?

Properties

type

type: Management.CreatedUserAuthenticationMethodTypeEnum

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.

Optionalpreferred_authentication_method

preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum

Optionalkey_id

key_id?: string

Applies to webauthn authentication methods only. The id of the credential.

Optionalpublic_key

public_key?: string

Applies to webauthn authentication methods only. The public key, which is encoded as base64.

Optionalrelying_party_identifier

relying_party_identifier?: string

Applies to webauthn authentication methods only. The relying party identifier.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties typenametotp_secretphone_numberemailpreferred_authentication_methodkey_idpublic_keyrelying_party_identifier