Obtener los métodos de autenticación

Recupera una lista detallada de los métodos de autenticación asociados a un usuario específico.

GET 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.ListUserAuthenticationMethodsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Users.AuthenticationMethods.List(
        context.TODO(),
        "id",
        request,
    )
}

200

[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "aaguid": "<string>",
    "authentication_methods": [
      {
        "id": "<string>"
      }
    ],
    "confirmed": true,
    "credential_backed_up": true,
    "credential_device_type": "<string>",
    "email": "<string>",
    "enrolled_at": "2023-11-07T05:31:56Z",
    "identity_user_id": "<string>",
    "key_id": "<string>",
    "last_auth_at": "2023-11-07T05:31:56Z",
    "link_id": "<string>",
    "name": "<string>",
    "phone_number": "<string>",
    "public_key": "<string>",
    "relying_party_identifier": "<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 en cuestión.

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0. El valor predeterminado es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 0 <= x <= 100

include_totals · boolean

Devuelve los resultados dentro de un objeto que contiene el recuento total de resultados (true) o como un array directo de resultados (false, valor predeterminado).

Respuesta

200

application/json

Se recuperaron los métodos de autenticación del usuario.

object[]

object

created_at · string<date-time> · requerido

Fecha de creación del autenticador

id · string · requerido

El ID del método de autenticación (generado automáticamente)

type · enum<string> · requerido

Opciones disponibles: recovery-code, totp, push, phone, email, email-verification, webauthn-roaming, webauthn-platform, guardian, passkey, password

aaguid · string

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

authentication_methods · object[]

Show child attributes

confirmed · boolean

El estado del método de autenticación

credential_backed_up · boolean

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

credential_device_type · string

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

email · string

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

enrolled_at · string<date-time>

Fecha de inscripción

identity_user_id · string

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

key_id · string

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

last_auth_at · string<date-time>

Última autenticación

link_id · string

El ID de un método de autenticación vinculado. Los métodos de autenticación vinculados se eliminarán juntos.

name · string

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

Maximum string length: 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 usa para enviar códigos de verificación por mensaje de texto y llamada de voz.

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 WebAuthn. La clave pública.

relying_party_identifier · string

Se aplica solo a los métodos de autenticación WebAuthn/clave de acceso. El identificador de parte de confianza de la credencial.

transports · string[]

Se aplica solo a las claves de acceso. Los transportes usados por 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.