Actualizar parcialmente los métodos de autenticación mediante el id del método de autenticación

Modifique el método de autenticación con el ID proporcionado del usuario especificado. Para obtener más información, consulte Manage Authentication Methods with Management API.

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

Go

Go

package example

import (
    context "context"

    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.UpdateUserAuthenticationMethodRequestContent{}
    client.Users.AuthenticationMethods.Update(
        context.TODO(),
        "id",
        "authentication_method_id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.authenticationMethods.update("id", "authentication_method_id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.authenticationMethods.update("id", "authentication_method_id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/users/{id}/authentication-methods/{authentication_method_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/users/{id}/authentication-methods/{authentication_method_id}"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/users/{id}/authentication-methods/{authentication_method_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/users/{id}/authentication-methods/{authentication_method_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/users/{id}/authentication-methods/{authentication_method_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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>"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

El ID del usuario en cuestión.

authentication_method_id · string · requerido

El ID del método de autenticación que se debe actualizar.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

name · string

Una etiqueta descriptiva para identificar el método de autenticación.

preferred_authentication_method · enum<string>

Método de autenticación por teléfono preferido

Opciones disponibles: voice, sms

Respuesta

200

application/json

Método de autenticación actualizado.

El método de autenticación se creó correctamente.

type · enum<string> · requerido

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

aaguid · string

Se aplica solo a métodos de autenticación con clave de acceso. Identificador global único de atestación del autenticador.

authentication_methods · object[]

Show child attributes

confirmed · boolean

Si el método de autenticación ha sido confirmado.

created_at · string<date-time>

Fecha de creación del método de autenticación

email · string

Se aplica solo a métodos de autenticación por correo electrónico. La dirección de correo electrónico que se usa para enviar mensajes de verificación.

id · string<authenticator-id>

El ID del método de autenticación recién creado (generado automáticamente por la aplicación)

key_id · string

Se aplica solo a métodos de autenticación WebAuthn. El id de la credencial.

name · string

Una etiqueta descriptiva para identificar el método de autenticación.

phone_number · string

Se aplica solo a métodos de autenticación por teléfono. El número de teléfono de destino que se usa para enviar códigos de verificación por SMS y llamada de voz.

Required string length: 2 - 30

preferred_authentication_method · enum<string>

Se aplica solo a métodos de autenticación por teléfono. Es el método de comunicación preferido.

Opciones disponibles: voice, sms

public_key · string

Se aplica solo a métodos de autenticación WebAuthn. La clave pública.

relying_party_identifier · string

Se aplica solo a métodos de autenticación WebAuthn. El identificador de la parte usuaria.

totp_secret · string

Secreto codificado en Base32 para la generación de TOTP