Mettre à jour les méthodes d’authentification par ID de méthode d’authentification

Modifiez la méthode d’authentification correspondant à l’ID fourni pour l’utilisateur spécifié. Pour en savoir plus, consultez Manage Authentication Methods with Management API.

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

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.UpdateAsync(
            id: "id",
            authenticationMethodId: "authentication_method_id",
            request: new UpdateUserAuthenticationMethodRequestContent()
        );
    }

}

200

{
  "aaguid": "<string>",
  "authentication_methods": [
    {
      "id": "<string>"
    }
  ],
  "confirmed": true,
  "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é.

authentication_method_id · string · requis

L’ID de la méthode d’authentification à mettre à jour.

Corps

application/jsonapplication/x-www-form-urlencoded

name · string

Un libellé lisible pour identifier la méthode d’authentification.

preferred_authentication_method · enum<string>

Phone authentication method préférée

Options disponibles: voice, sms

Réponse

200

application/json

Méthode d’authentification mise à jour.

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

type · enum<string> · requis

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

aaguid · string

S’applique uniquement aux méthodes d’authentification par passkey. Identifiant globalement unique d’attestation de l’authenticator.

authentication_methods · object[]

Show child attributes

confirmed · boolean

Indique si la méthode d’authentification a été confirmée.

created_at · string<date-time>

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

email · string

S’applique uniquement aux Email authentication methods. L’adresse courriel utilisée pour envoyer les 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 méthodes d’authentification webauthn. L’ID du credential.

name · string

Un libellé lisible pour identifier la méthode d’authentification.

phone_number · string

S’applique uniquement aux Phone authentication methods. Le numéro de téléphone de destination utilisé pour envoyer les verification codes par message texte ou 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’authentification webauthn. La clé publique.

relying_party_identifier · string

S’applique uniquement aux méthodes d’authentification webauthn. L’identifiant du Relying Party.

totp_secret · string

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