POST Métodos de autenticación

Crea un método de autenticación. Los métodos de autenticación creados mediante este endpoint se confirmarán automáticamente y ya deberían tener la verificación completada.

POST 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"
    users "github.com/auth0/go-auth0/management/management/users"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &users.CreateUserAuthenticationMethodRequestContent{
        Type: management.CreatedUserAuthenticationMethodTypeEnumPhone,
    }
    client.Users.AuthenticationMethods.Create(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/users/{id}/authentication-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aaguid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credential_backed_up": true,
  "email": "<string>",
  "identity_user_id": "<string>",
  "key_id": "<string>",
  "name": "<string>",
  "phone_number": "<string>",
  "public_key": "<string>",
  "relying_party_identifier": "<string>",
  "totp_secret": "<string>",
  "transports": [
    "<string>"
  ],
  "user_agent": "<string>",
  "user_handle": "<string>"
}
'

import requests

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

payload = {
    "aaguid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "credential_backed_up": True,
    "email": "<string>",
    "identity_user_id": "<string>",
    "key_id": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "public_key": "<string>",
    "relying_party_identifier": "<string>",
    "totp_secret": "<string>",
    "transports": ["<string>"],
    "user_agent": "<string>",
    "user_handle": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'aaguid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'credential_backed_up' => true,
    'email' => '<string>',
    'identity_user_id' => '<string>',
    'key_id' => '<string>',
    'name' => '<string>',
    'phone_number' => '<string>',
    'public_key' => '<string>',
    'relying_party_identifier' => '<string>',
    'totp_secret' => '<string>',
    'transports' => [
        '<string>'
    ],
    'user_agent' => '<string>',
    'user_handle' => '<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.post("https://{tenantDomain}/api/v2/users/{id}/authentication-methods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"aaguid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credential_backed_up\": true,\n  \"email\": \"<string>\",\n  \"identity_user_id\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"public_key\": \"<string>\",\n  \"relying_party_identifier\": \"<string>\",\n  \"totp_secret\": \"<string>\",\n  \"transports\": [\n    \"<string>\"\n  ],\n  \"user_agent\": \"<string>\",\n  \"user_handle\": \"<string>\"\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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"aaguid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"credential_backed_up\": true,\n  \"email\": \"<string>\",\n  \"identity_user_id\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"public_key\": \"<string>\",\n  \"relying_party_identifier\": \"<string>\",\n  \"totp_secret\": \"<string>\",\n  \"transports\": [\n    \"<string>\"\n  ],\n  \"user_agent\": \"<string>\",\n  \"user_handle\": \"<string>\"\n}"

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

201

{
  "aaguid": "<string>",
  "authentication_methods": [
    {
      "id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "credential_backed_up": true,
  "email": "<string>",
  "id": "<string>",
  "identity_user_id": "<string>",
  "key_id": "<string>",
  "name": "<string>",
  "phone_number": "<string>",
  "public_key": "<string>",
  "relying_party_identifier": "<string>",
  "totp_secret": "<string>",
  "transports": [
    "<string>"
  ],
  "user_agent": "<string>",
  "user_handle": "<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 al que se asignará el nuevo método de autenticación.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

type · enum<string> · requerido

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

aaguid · string<uuid>

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

credential_backed_up · boolean

Se aplica solo a las claves de acceso. Indica si se hizo una copia de seguridad de la credencial.

credential_device_type · enum<string>

Se aplica solo a las claves de acceso. El tipo de dispositivo en el que se almacena la credencial, según lo definido por la aptitud para copia de seguridad. Las credenciales "single_device" no pueden copiarse ni sincronizarse con otro dispositivo; las credenciales "multi_device" pueden copiarse si el usuario final lo habilita.

Opciones disponibles: single_device, multi_device

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 usa para enviar mensajes de verificación.

identity_user_id · string

Se aplica solo a las claves de acceso. El ID de la identidad de usuario vinculada al método de autenticación.

key_id · string

Se aplica solo a los métodos de autenticación con WebAuthn/clave de acceso. 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 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 los métodos de autenticación con WebAuthn/clave de acceso. La clave pública, codificada en base64.

relying_party_identifier · string<hostname>

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

totp_secret · string

Secret codificado en Base32 para generar TOTP.

transports · string[]

Se aplica solo a las claves de acceso. Los transportes que usan los clientes para comunicarse con el autenticador.

user_agent · string

Se aplica solo a las claves de acceso. El user-agent del navegador usado para crear la clave de acceso.

user_handle · string

Se aplica solo a las claves de acceso. El identificador de usuario de la identidad del usuario.

Respuesta

201

application/json

Método de autenticación creado.

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

type · enum<string> · requerido

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

aaguid · string

Se aplica solo a las claves de acceso. Identificador global único de la 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

credential_backed_up · boolean

Se aplica solo a las claves de acceso. Indica si se hizo una copia de seguridad de la credencial.

credential_device_type · enum<string>

Se aplica solo a las claves de acceso. El tipo de dispositivo en el que se almacena la credencial, según lo definido por la aptitud para copia de seguridad. Las credenciales "single_device" no pueden copiarse ni sincronizarse con otro dispositivo; las credenciales "multi_device" pueden copiarse si el usuario final lo habilita.

Opciones disponibles: single_device, multi_device

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

identity_user_id · string

Se aplica solo a las claves de acceso. El ID de la identidad de usuario vinculada al método de autenticació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 usa para enviar códigos de verificación por SMS y llamada de 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 generar TOTP

transports · string[]

Se aplica solo a las claves de acceso. Los transportes que usan los clientes para comunicarse con el autenticador.

user_agent · string

Se aplica solo a las claves de acceso. El user-agent del navegador usado para crear la clave de acceso.

user_handle · string

Se aplica solo a las claves de acceso. El identificador de usuario de la identidad del usuario.