Publier des méthodes d’authentification

Crée une méthode d’authentification. Les méthodes d’authentification créées au moyen de cet endpoint seront automatiquement confirmées et leur vérification devra déjà avoir été effectuée.

POST https://{tenantDomain}/api/v2/users/{id}/authentication-methods

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Users;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Users.AuthenticationMethods.CreateAsync(
            id: "id",
            request: new CreateUserAuthenticationMethodRequestContent {
                Type = CreatedUserAuthenticationMethodTypeEnum.Phone
            }
        );
    }

}

201

{
  "aaguid": "<string>",
  "authentication_methods": [
    {
      "id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "credential_backed_up": true,
  "email": "<string>",
  "id": "<string>",
  "identity_user_id": "<string>",
  "key_id": "<string>",
  "name": "<string>",
  "phone_number": "<string>",
  "public_key": "<string>",
  "relying_party_identifier": "<string>",
  "totp_secret": "<string>",
  "transports": [
    "<string>"
  ],
  "user_agent": "<string>",
  "user_handle": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

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

application/jsonapplication/x-www-form-urlencoded

type · enum<string> · requis

Options disponibles: phone, email, totp, webauthn-roaming, passkey

aaguid · string<uuid>

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

credential_backed_up · boolean

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

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

email · string

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

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.

key_id · string

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

name · string

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

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

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

public_key · string

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

relying_party_identifier · string<hostname>

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

totp_secret · string

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

transports · string[]

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

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é.

Réponse

201

application/json

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

aaguid · string

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

authentication_methods · object[]

Show child attributes

created_at · string<date-time>

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

credential_backed_up · boolean

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

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

email · string

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

id · string<authenticator-id>

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

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.

key_id · string

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

name · string

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

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

preferred_authentication_method · enum<string>

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

Options disponibles: voice, sms

public_key · string

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

relying_party_identifier · string

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

totp_secret · string

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

transports · string[]

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

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é.