Skip to main content
POST
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

L’ID de l’utilisateur auquel la nouvelle méthode d’authentification sera attribuée.

Corps

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

Une étiquette compréhensible par un humain pour identifier la méthode d’authentication.

totp_secret
string

Secret encodé en Base32 pour la génération de TOTP.

phone_number
string

S’applique uniquement aux méthodes d’authentication par téléphone. Le numéro de téléphone de destination utilisé pour envoyer les codes de vérification par texto et appel vocal.

Required string length: 2 - 30
email
string

S’applique uniquement aux méthodes d’authentication par courriel. L’adresse courriel utilisée pour envoyer les messages de vérification.

preferred_authentication_method
enum<string>

S’applique uniquement aux méthodes d’authentification par téléphone. La méthode de communication privilégiée.

Options disponibles:
voice,
sms
key_id
string

S’applique uniquement aux méthodes d’authentication webauthn/passkey. L’ID du credential.

public_key
string

S’applique uniquement aux méthodes d’authentication webauthn/passkey. La public key, encodée en base64.

aaguid
string<uuid>

S’applique uniquement aux passkeys. Identifiant globalement unique d’attestation de l’authenticator.

relying_party_identifier
string<hostname>

S’applique uniquement aux méthodes d’authentication webauthn. L’identifiant de la Relying Party.

credential_device_type
enum<string>

S’applique uniquement aux passkeys. Le type d’appareil sur lequel le credential est stocké, tel que défini par l’admissibilité à la sauvegarde. Les credentials "single_device" ne peuvent pas être sauvegardés ni synchronisés sur un autre appareil, tandis que les credentials "multi_device" peuvent être sauvegardés si cette option est activée par l’utilisateur final.

Options disponibles:
single_device,
multi_device
credential_backed_up
boolean

S’applique uniquement aux passkeys. Indique si le credential a été sauvegardé.

identity_user_id
string

S’applique aux clés d’accès seulement. L’ID de l’identité liée à la méthode d’authentification.

user_agent
string

S’applique aux clés d’accès seulement. La chaîne user-agent du navigateur utilisé pour créer la clé d’accès.

user_handle
string

S’applique aux clés d’accès seulement. Le descripteur utilisateur de l’identité.

transports
string[]

S’applique aux clés d’accès seulement. Les transports utilisés par les clients pour communiquer avec l’authentificateur.

Réponse

Méthode d’authentification créée.

La méthode d’authentification créée avec succès.

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

L’ID de la méthode d’authentification nouvellement créée (généré automatiquement par l’application)

name
string

Un libellé convivial permettant d’identifier la méthode d’authentification.

totp_secret
string

Secret encodé en Base32 pour la génération de TOTP

phone_number
string

S’applique aux méthodes d’authentification par téléphone seulement. Le numéro de téléphone de destination utilisé pour envoyer des codes de vérification par message texte ou par appel vocal.

Required string length: 2 - 30
email
string

S’applique aux méthodes d’authentification par courriel seulement. L’adresse courriel utilisée pour envoyer des messages de vérification.

authentication_methods
object[]
preferred_authentication_method
enum<string>

Méthode d’authentification par téléphone privilégiée

Options disponibles:
voice,
sms
key_id
string

S’applique aux authentificateurs WebAuthn seulement. L’ID de la donnée d’authentification.

public_key
string

S’applique aux authentificateurs WebAuthn seulement. La clé publique.

aaguid
string

S’applique aux clés d’accès seulement. L’identifiant global unique de l’attestation de l’authentificateur.

relying_party_identifier
string

S’applique aux authentificateurs WebAuthn seulement. L’identifiant de la partie de confiance.

credential_device_type
enum<string>

S’applique uniquement aux passkeys. Le type d’appareil sur lequel le credential est stocké, tel que défini par l’admissibilité à la sauvegarde. Les credentials "single_device" ne peuvent pas être sauvegardés ni synchronisés sur un autre appareil, tandis que les credentials "multi_device" peuvent être sauvegardés si cette option est activée par l’utilisateur final.

Options disponibles:
single_device,
multi_device
credential_backed_up
boolean

S’applique aux clés d’accès seulement. Indique si la donnée d’authentification a été sauvegardée.

identity_user_id
string

S’applique aux clés d’accès seulement. L’ID de l’identité liée à la méthode d’authentification.

user_agent
string

S’applique aux clés d’accès seulement. La chaîne user-agent du navigateur utilisé pour créer la clé d’accès.

user_handle
string

S’applique aux clés d’accès seulement. Le descripteur utilisateur de l’identité.

transports
string[]

S’applique aux clés d’accès seulement. Les transports utilisés par les clients pour communiquer avec l’authentificateur.

created_at
string<date-time>

Date de création de la méthode d’authentification