Passer au contenu principal
PATCH
C#

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id
string
requis

The ID of the user in question.

authentication_method_id
string
requis

The ID of the authentication method to update.

Corps

name
string

A human-readable label to identify the authentication method.

preferred_authentication_method
enum<string>

Preferred phone authentication method

Options disponibles:
voice,
sms

Réponse

Authentication method updated.

The successfully created authentication method.

type
enum<string>
requis
Options disponibles:
phone,
email,
totp,
webauthn-roaming
id
string<authenticator-id>

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

name
string

A human-readable label to identify the authentication method.

totp_secret
string

Base32 encoded secret for TOTP generation

phone_number
string

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

Required string length: 2 - 30
email
string

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

authentication_methods
object[]
preferred_authentication_method
enum<string>

Applies to phone authentication methods only. The preferred communication method.

Options disponibles:
voice,
sms
key_id
string

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

public_key
string

Applies to webauthn authentication methods only. The public key.

aaguid
string

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

relying_party_identifier
string

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

confirmed
boolean

Whether the authentication method has been confirmed.

created_at
string<date-time>

Authentication method creation date