Ajouter des méthodes d’authentification

Créer une méthode d’authentification. Les méthodes d’authentification créées au moyen de ce point de terminaison seront automatiquement confirmées et la vérification doit déjà avoir été effectuée.

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

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    users "github.com/auth0/go-auth0/management/management/users"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &users.CreateUserAuthenticationMethodRequestContent{
        Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
    }
    client.Users.AuthenticationMethods.Create(
        context.TODO(),
        "id",
        request,
    )
}

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 clés d’accès. Identifiant global unique de l’attestation de l’authentificateur

credential_backed_up · boolean

S’applique uniquement aux clés d’accès. Indique si l’information d’identification a été sauvegardée.

credential_device_type · enum<string>

S’applique uniquement aux clés d’accès. Le type d’appareil sur lequel l’information d’identification est stockée, tel que défini par l’admissibilité à la sauvegarde. Les informations d’identification « single_device » ne peuvent pas être sauvegardées ni synchronisées vers un autre appareil, tandis que les informations d’identification « multi_device » peuvent être sauvegardées si l’utilisateur final l’a activé.

Options disponibles: single_device, multi_device

email · string

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

identity_user_id · string

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

key_id · string

S’applique uniquement aux méthodes d’authentification WebAuthn/clé d’accès. L’id de l’information d’identification.

name · string

Libellé en langage clair pour identifier la méthode d’authentification.

phone_number · string

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

Required string length: 2 - 30

preferred_authentication_method · enum<string>

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

Options disponibles: voice, sms

public_key · string

S’applique uniquement aux méthodes d’authentification WebAuthn/clé d’accès. La clé publique, encodée en base64.

relying_party_identifier · string<hostname>

S’applique uniquement aux méthodes d’authentification 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 uniquement aux clés d’accès. Les transports utilisés par les applications pour communiquer avec l’authentificateur.

user_agent · string

S’applique uniquement aux clés d’accès. Le user-agent du navigateur utilisé pour créer la clé d’accès.

user_handle · string

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

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 uniquement aux clés d’accès. 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 uniquement aux clés d’accès. Indique si l’information d’identification a été sauvegardée.

credential_device_type · enum<string>

S’applique uniquement aux clés d’accès. Le type d’appareil sur lequel l’information d’identification est stockée, tel que défini par l’admissibilité à la sauvegarde. Les informations d’identification « single_device » ne peuvent pas être sauvegardées ni synchronisées vers un autre appareil, tandis que les informations d’identification « multi_device » peuvent être sauvegardées si l’utilisateur final l’a activé.

Options disponibles: single_device, multi_device

email · string

S’applique uniquement aux méthodes d’authentification par courriel. L’adresse de 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 uniquement aux clés d’accès. L’ID de l’identité utilisateur liée à la méthode d’authentification.

key_id · string

S’applique uniquement aux authentificateurs WebAuthn. L’id de l’information d’identification.

name · string

Un libellé en langage clair pour identifier la méthode d’authentification.

phone_number · string

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

Required string length: 2 - 30

preferred_authentication_method · enum<string>

Méthode d’authentification par téléphone préférée

Options disponibles: voice, sms

public_key · string

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

relying_party_identifier · string

S’applique uniquement aux authentificateurs 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 uniquement aux clés d’accès. Les transports utilisés par les applications pour communiquer avec l’authentificateur.

user_agent · string

S’applique uniquement aux clés d’accès. Le user-agent du navigateur utilisé pour créer la clé d’accès.

user_handle · string

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