Mettre à jour les méthodes d’authentification

Remplace 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. Elles remplaceront plutôt les paramètres actuels de l’utilisateur.

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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using System.Collections.Generic;

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.SetAsync(
            id: "id",
            request: new List<SetUserAuthenticationMethods>(){
                new SetUserAuthenticationMethods {
                    Type = AuthenticationTypeEnum.Phone
                },
            }
        );
    }

}

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 en question.

Corps

application/jsonapplication/x-www-form-urlencoded

type · enum<string> · requis

Options disponibles: phone, email, totp

email · string

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

Minimum string length: 1

name · string

Libellé lisible par l’humain permettant d’identifier la méthode d’authentification.

Required string length: 1 - 20

phone_number · string

S’applique aux méthodes d’authentification par téléphone uniquement. Le numéro de téléphone de destination utilisé pour envoyer des codes de vérification par texto 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. La méthode de communication privilégiée.

Options disponibles: voice, sms

totp_secret · string

S’applique aux méthodes d’authentification TOTP uniquement. Le Secret encodé en base32 pour la génération de 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 aux passkeys uniquement. 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 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 aux authentificateurs WebAuthn uniquement. L’ID de l’information d’authentification.

name · string

Libellé lisible 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 ou 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 uniquement. La clé publique.

relying_party_identifier · string

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

totp_secret · string

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