Actualizar métodos de autenticación

Reemplace los métodos de autenticación del usuario especificado por los valores proporcionados.

Nota: Los métodos de autenticación proporcionados mediante esta acción no se aplican de forma incremental sobre los métodos existentes. En su lugar, cualquier método que se proporcione sobrescribirá la configuración existente del usuario.

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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.authenticationMethods.set("id", [
        {
            type: "phone",
        },
    ]);
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.authenticationMethods.set("id", [
        {
            type: "phone",
        },
    ]);
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/users/{id}/authentication-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "email": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "totp_secret": "<string>"
  }
]
'

import requests

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

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

response = requests.put(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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'email' => '<string>',
        'name' => '<string>',
        'phone_number' => '<string>',
        'totp_secret' => '<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.put("https://{tenantDomain}/api/v2/users/{id}/authentication-methods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"email\": \"<string>\",\n    \"name\": \"<string>\",\n    \"phone_number\": \"<string>\",\n    \"totp_secret\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

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

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.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

type · enum<string> · requerido

Opciones disponibles: phone, email, totp

email · string

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

Minimum string length: 1

name · string

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

Required string length: 1 - 20

phone_number · string

Se aplica solo a los métodos de autenticación por teléfono. El número de teléfono de destino que se utiliza para enviar códigos de verificación por texto y 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

totp_secret · string

Se aplica solo a los métodos de autenticación TOTP. El secreto codificado en base32 para generar TOTP.

Minimum string length: 1

Respuesta

200

application/json

Todos los métodos de autenticación se actualizaron correctamente.

type · enum<string> · requerido

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

aaguid · string

Se aplica solo a las claves de acceso. Identificador global único de atestación del autenticador.

authentication_methods · object[]

Show child attributes

created_at · string<date-time>

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

email · string

Se aplica solo a los métodos de autenticación por correo electrónico. La dirección de correo electrónico que se utiliza 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 los autenticadores WebAuthn. El id de la credencial.

name · string

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

phone_number · string

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

Required string length: 2 - 30

preferred_authentication_method · enum<string>

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

Opciones disponibles: voice, sms

public_key · string

Se aplica solo a los autenticadores WebAuthn. La clave pública.

relying_party_identifier · string

Se aplica solo a los autenticadores WebAuthn. El identificador de la parte usuaria.

totp_secret · string

Secret codificado en Base32 para la generación de TOTP