Mettre à jour les méthodes d’authentification

Remplacez les méthodes d’authentification de l’utilisateur indiqué par les valeurs fournies.

Remarque : les méthodes d’authentification fournies par cette action ne s’ajoutent pas aux méthodes existantes. Toutes les méthodes transmises remplacent plutôt les paramètres actuels de l’utilisateur.

PUT 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"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := []*management.SetUserAuthenticationMethods{
        &management.SetUserAuthenticationMethods{
            Type: management.AuthenticationTypeEnumPhone,
        },
    }
    client.Users.AuthenticationMethods.Set(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "aaguid": "<string>",
    "authentication_methods": [
      {
        "id": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "id": "<string>",
    "key_id": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "public_key": "<string>",
    "relying_party_identifier": "<string>",
    "totp_secret": "<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 concerné.

Corps

application/jsonapplication/x-www-form-urlencoded

type · enum<string> · requis

Options disponibles: phone, email, totp

email · string

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

Minimum string length: 1

name · string

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

Required string length: 1 - 20

phone_number · string

S’applique uniquement aux méthodes d’authentification par téléphone. 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

totp_secret · string

S’applique uniquement aux méthodes d’authentification TOTP. Le secret encodé en base32 pour générer le TOTP.

Minimum string length: 1

Réponse

200

application/json

Toutes les méthodes d’authentification ont été mises à jour avec succès.

type · enum<string> · requis

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

aaguid · string

S’applique uniquement aux clés d’accès. Identifiant global unique d’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

email · string

S’applique uniquement aux méthodes d’authentification par courriel. 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)

key_id · string

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

name · string

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

phone_number · string

S’applique uniquement aux méthodes d’authentification par téléphone. 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 privilégié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 générer le TOTP