Gestionar métodos de autenticación con Management API

Aprenda a usar la Management API de Auth0 para gestionar los métodos de autenticación MFA de sus usuarios.

Antes de comenzar

• Configure una aplicación de máquina a máquina (M2M) y otórguele acceso a la Management API de Auth0 con los siguientes alcances:

  • create:authentication_methods
  • read:authentication_methods
  • update:authentication_methods
  • delete:authentication_methods

La Management API de Auth0 proporciona varios endpoints que puede usar para administrar los métodos de autenticación de MFA de sus usuarios.

Este método se basa en la autenticación mediante una aplicación confidencial. Para obtener más información sobre las aplicaciones confidenciales y públicas, consulte Aplicaciones confidenciales y públicas.

​

Obtener todos los métodos de autenticación

Usa el endpoint Gets a list of authentication methods para obtener una lista de todos los métodos de autenticación en los que un usuario se ha inscrito de forma total o parcial.

Este endpoint requiere el scope: read:authentication_methods.

​

Ejemplos

La siguiente solicitud devuelve una lista de todos los métodos de autenticación de un usuario especificado.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

[
  {
    "id": "totp|dev_XXXXXXXXXXXXXXXX",
    "type": "totp",
    "confirmed": true,
    "created_at": "2021-09-23T22:57:30.206Z",
    "last_auth_at": "2021-09-23T22:57:51.652Z"
  }
]

​

Obtener un método de autenticación individual

Utilice el endpoint Obtiene un método de autenticación por ID para obtener un método de autenticación individual de un usuario especificado por el ID del método de autenticación.

Este endpoint requiere el scope: read:authentication_methods.

​

Ejemplos

La siguiente solicitud devuelve un único método de autenticación de un usuario según el id del método de autenticación especificado.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

{
    "id": "totp|dev_XXXXXXXXXXXXXXXX",
    "type": "totp",
    "confirmed": true,
    "created_at": "2021-09-23T22:57:30.206Z",
    "last_auth_at": "2021-09-23T22:57:51.652Z"
}

​

Crear un método de autenticación

Utilice el endpoint Crear un método de autenticación para un usuario determinado para crear un método de autenticación para un usuario, incluidos SMS, correo electrónico, contraseña de un solo uso (OTP) o WebAuthn con claves de seguridad. Para obtener más información sobre los factores de autenticación de MFA disponibles, consulte Factores de autenticación multifactor.

Este endpoint requiere el scope: create:authentication_methods.

Los métodos de autenticación creados a través de este endpoint se confirmarán automáticamente y estarán disponibles de inmediato. Verifique con el usuario que el método de autenticación esté configurado correctamente y siga siendo válido.

​

SMS

Envíe a los usuarios un OTP por SMS, que luego deberán introducir antes de poder completar la autenticación.

​

Ejemplos

La siguiente solicitud crea un método de autenticación por SMS para un usuario.

​

Respuestas

Para cada solicitud válida, la Management API devolverá una respuesta en formato JSON.

{
    "type": "phone",
    "name": "SMS",
    "created_at": "2023-01-01T00:00:00.000Z",
    "phone_number": "[e-mail]",
    "id": "phone|dev_XXXXXXXXXXXXXXXX"
}

​

Correo electrónico

Envíe a los usuarios un OTP por correo electrónico, que luego deberán introducir antes de poder completar la autenticación. El factor de correo electrónico solo se admite cuando un usuario no tiene otros factores disponibles.

​

Ejemplos

La siguiente solicitud crea un método de autenticación por correo electrónico para el usuario.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

{
    "type": "email",
    "name": "Email Factor",
    "created_at": "2023-01-01T00:00:00.000Z",
    "email": "[e-mail]",
    "id": "email|dev_XXXXXXXXXXXXXXXX"
}

​

Contraseñas de un solo uso (OTP)

Permita que los usuarios usen una aplicación de autenticación, como Google Authenticator, en su dispositivo personal para generar una OTP que cambia periódicamente y que se les solicita introducir antes de completar la autenticación.

​

Ejemplos

La siguiente solicitud crea un método de autenticación con OTP para un usuario.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

{
    "type": "totp",
    "name": "OTP Application",
    "created_at": "2023-01-01T00:00:00.000Z",
    "email": "[e-mail]",
    "id": "totp|dev_XXXXXXXXXXXXXXXX"
}

​

WebAuthn con claves de seguridad

Permita que los usuarios usen claves de seguridad compatibles con FIDO (por ejemplo, Yubikey o Google Titan) para realizar la autenticación multifactor.

​

Ejemplos

La siguiente solicitud crea un método de autenticación de WebAuthn con claves de seguridad para un usuario.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

{
    "type": "webauthn-roaming",
    "name": "WebAuthn with security keys",
    "relyingPartyIdentifier": "example-tenant.auth0.com",
    "keyId": "X9FrwMfmzj...",
    "publicKey": "bXktcHVibGljLWtle...",
    "created_at": "2023-03-09T17:33:47.545Z",
    "id": "webauthn-roaming|dev_XXXXXXXXXXXXXXXX"
}

​

Reemplazar todos los métodos de autenticación

Use el endpoint Updates all authentication methods by replacing them with the given ones para sustituir todos los métodos de autenticación existentes por los proporcionados.

Este endpoint requiere el scope: update:authentication_methods.

​

Ejemplos

La siguiente solicitud reemplaza todos los métodos de autenticación existentes para un usuario.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

[
  {
    "id": "phone|dev_XXXXXXXXXXXXXXXX",
    "type": "phone",
    "name": "SMS",
    "phone_number": "+00000000000",
    "created_at": "2023-03-09T17:53:23.647Z",
    "preferred_authentication_method": "sms",
    "authentication_methods": [
      {
        "id": "sms|dev_XXXXXXXXXXXXXXXX",
        "type": "sms"
      }
    ]
  }
]

​

Actualizar un método de autenticación individual

Usa el endpoint Actualizar un método de autenticación para actualizar un método de autenticación individual de un usuario.

Este endpoint requiere el scope: update:authentication_methods.

​

Ejemplos

La siguiente solicitud actualiza un único método de autenticación de un usuario en función del ID del método de autenticación específico.

​

Respuestas

Para cada solicitud válida, la Management API devuelve una respuesta en formato JSON.

{
    "type": "phone",
    "name": "Mobile SMS",
    "created_at": "2023-01-12T00:03:52.855Z",
    "last_auth_at": "2023-01-12T00:04:05.157Z",
    "phone_number": "+00000000000",
    "preferred_authentication_method": "sms",
    "id": "phone|dev_XXXXXXXXXXXXXXXX",
    "authentication_methods": [
        {
            "id": "phone|dev_XXXXXXXXXXXXXXXX",
            "type": "phone"
        }
    ]
}

​

Eliminar todos los métodos de autenticación

Use el endpoint Elimina todos los métodos de autenticación del usuario especificado para eliminar todos los métodos de autenticación de un usuario.

Este endpoint requiere el scope: delete:authentication_methods.

​

Ejemplos

La siguiente solicitud elimina todos los métodos de autenticación de un usuario.

​

Respuestas

Para cada solicitud válida, Management API devolverá una respuesta con el código de estado 204 y un cuerpo vacío.

​

Eliminar un método de autenticación

Use el endpoint Eliminar un método de autenticación por ID para eliminar un método de autenticación de un usuario.

​

Ejemplos

La siguiente solicitud elimina un único método de autenticación de un usuario en función del ID del método de autenticación especificado.

​

Respuestas

Para cada solicitud válida, la Management API devolverá una respuesta con el código de estado 204 y sin contenido en el cuerpo.

​

Más información

• Factores de la autenticación multifactor
• Registrar aplicaciones de máquina a máquina
• Obtener tokens de acceso para producción de la Management API
• Aplicaciones confidenciales y públicas