• management
• Management
• CreateUserAuthenticationMethodResponseContent

Interface CreateUserAuthenticationMethodResponseContent

The successfully created authentication method.

interface CreateUserAuthenticationMethodResponseContent {
id?: string;
type: Management.CreatedUserAuthenticationMethodTypeEnum;
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;
credential_device_type?: Management.CredentialDeviceTypeEnum;
credential_backed_up?: boolean;
identity_user_id?: string;
user_agent?: string;
user_handle?: string;
transports?: 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?credential_device_type?credential_backed_up?identity_user_id?user_agent?user_handle?transports?created_at?

Properties

Optionalid

id?: string

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

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.

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.

Optionalcredential_device_type

credential_device_type?: Management.CredentialDeviceTypeEnum

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.

Optionaluser_handle

user_handle?: string

Applies to passkeys only. The user handle of the user identity.

Optionaltransports

transports?: string[]

Applies to passkeys only. The transports used by clients to communicate with the authenticator.

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_identifiercredential_device_typecredential_backed_upidentity_user_iduser_agentuser_handletransportscreated_at