docs/interfaces/management.Management.CreateUserAuthenticationMethodRequestContent.html
{ * 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;
aaguid?: string;
relying_party_identifier?: string;
credential_device_type?: Management.CredentialDeviceTypeEnum;
credential_backed_up?: boolean;
identity_user_id?: string;
user_agent?: string;
user_handle?: string;
transports?: string[];
}
typename?totp_secret?phone_number?email?preferred_authentication_method?key_id?public_key?aaguid?relying_party_identifier?credential_device_type?credential_backed_up?identity_user_id?user_agent?user_handle?transports?
type: Management.CreatedUserAuthenticationMethodTypeEnum
Optionalnamename?: string
A human-readable label to identify the authentication method.
Optionaltotp_secrettotp_secret?: string
Base32 encoded secret for TOTP generation.
Optionalphone_numberphone_number?: string
Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.
Optionalemailemail?: string
Applies to email authentication methods only. The email address used to send verification messages.
Optionalpreferred_authentication_methodpreferred_authentication_method?: Management.PreferredAuthenticationMethodEnum
Optionalkey_idkey_id?: string
Applies to webauthn/passkey authentication methods only. The id of the credential.
Optionalpublic_keypublic_key?: string
Applies to webauthn/passkey authentication methods only. The public key, which is encoded as base64.
Optionalaaguidaaguid?: string
Applies to passkeys only. Authenticator Attestation Globally Unique Identifier
Optionalrelying_party_identifierrelying_party_identifier?: string
Applies to webauthn authentication methods only. The relying party identifier.
Optionalcredential_device_typecredential_device_type?: Management.CredentialDeviceTypeEnum
Optionalcredential_backed_upcredential_backed_up?: boolean
Applies to passkeys only. Whether the credential was backed up.
Optionalidentity_user_ididentity_user_id?: string
Applies to passkeys only. The ID of the user identity linked with the authentication method.
Optionaluser_agentuser_agent?: string
Applies to passkeys only. The user-agent of the browser used to create the passkey.
Optionaluser_handleuser_handle?: string
Applies to passkeys only. The user handle of the user identity.
Optionaltransportstransports?: string[]
Applies to passkeys only. The transports used by clients to communicate with the authenticator.
Member Visibility
ThemeOSLightDark
Properties typenametotp_secretphone_numberemailpreferred_authentication_methodkey_idpublic_keyaaguidrelying_party_identifiercredential_device_typecredential_backed_upidentity_user_iduser_agentuser_handletransports