Gérer les méthodes d’authentification avec Auth0 Management API

Découvrez comment utiliser Auth0 Management API pour gérer les méthodes d’authentification MFA de vos utilisateurs.

Avant de commencer

• Configurez une application machine à machine (M2M), puis accordez-lui l’accès à Auth0 Management API avec les scopes suivants :

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

L’Auth0 Management API offre plusieurs points de terminaison que vous pouvez utiliser pour gérer les méthodes d’authentification MFA de vos utilisateurs.

Cette méthode repose sur une authentification au moyen d’une application confidentielle. Pour en savoir plus sur les applications confidentielles et publiques, consultez Confidential and Public Applications.

​

Obtenir toutes les méthodes d’authentification

Utilisez le point de terminaison Obtenir la liste des méthodes d’authentification pour récupérer la liste de toutes les méthodes d’authentification auxquelles un utilisateur est inscrit, entièrement ou partiellement.

Ce point de terminaison nécessite le scope : read:authentication_methods.

​

Exemples

La requête suivante renvoie la liste de toutes les méthodes d’authentification d’un utilisateur donné.

​

Réponses

Pour chaque requête valide, la Management API renvoie une réponse au format 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"
  }
]

​

Obtenir une méthode d’authentification unique

Utilisez le point de terminaison Gets an authentication method by ID pour récupérer une méthode d’authentification unique pour un utilisateur, à partir de l’id de la méthode d’authentification.

Ce point de terminaison exige le scope : read:authentication_methods.

​

Exemples

La requête suivante renvoie une méthode d’authentification unique pour un utilisateur, en fonction de l’ID de la méthode d’authentification spécifiée.

​

Réponses

Pour chaque requête valide, le Management API renvoie une réponse au format 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"
}

​

Créer une méthode d’authentification

Utilisez le point de terminaison Creates an authentication method for a given user pour créer une méthode d’authentification pour un utilisateur, notamment par SMS, courriel, mot de passe à usage unique (OTP) ou WebAuthn avec des clés de sécurité. Pour en savoir plus sur les facteurs d’authentification MFA disponibles, consultez Multi-Factor Authentication Factors.

Ce point de terminaison nécessite le scope : create:authentication_methods.

Les méthodes d’authentification créées par ce point de terminaison sont automatiquement confirmées et immédiatement disponibles. Vérifiez auprès de l’utilisateur que la méthode d’authentification est correctement configurée et qu’elle est toujours valide.

​

SMS

Envoyez un OTP par SMS aux utilisateurs, puis demandez-leur de le saisir avant de pouvoir terminer l’authentification.

​

Exemples

La requête suivante crée une méthode d’authentification par SMS pour un utilisateur.

​

Réponses

Pour chaque requête valide, le Management API renvoie une réponse au format JSON.

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

​

Courriel

Envoyez aux utilisateurs un OTP par courriel, qu’ils devront ensuite saisir avant de pouvoir terminer l’authentification. Le facteur par courriel n’est pris en charge que lorsqu’un utilisateur ne dispose d’aucun autre facteur.

​

Exemples

La requête suivante crée une méthode d’authentification par courriel pour l’utilisateur.

​

Réponses

Pour chaque requête valide, le Management API renvoie une réponse au format JSON.

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

​

Mots de passe à usage unique (OTP)

Permettez aux utilisateurs d’utiliser une application d’authentification, comme Google Authenticator, sur leur appareil personnel afin de générer un OTP qui change périodiquement et qu’ils devront saisir avant la fin de l’authentification.

​

Exemples

La requête suivante crée une méthode d’authentification OTP pour un utilisateur.

​

Réponses

Pour chaque requête valide, la Management API renvoie une réponse au format JSON.

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

​

WebAuthn avec des clés de sécurité

Permettez aux utilisateurs d’utiliser des clés de sécurité conformes à la norme FIDO (par exemple, Yubikey ou Google Titan) pour effectuer une authentification multifacteur.

​

Exemples

La requête suivante crée une méthode d’authentification WebAuthn à l’aide de clés de sécurité pour un utilisateur.

​

Réponses

Pour chaque requête valide, le Management API renvoie une réponse au format 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"
}

​

Remplacer toutes les méthodes d’authentification

Utilisez le point de terminaison Met à jour toutes les méthodes d’authentification en remplaçant les méthodes existantes par celles indiquées pour remplacer toutes les méthodes d’authentification existantes par celles indiquées.

Ce point de terminaison nécessite le scope : update:authentication_methods.

​

Exemples

La requête suivante remplace toutes les méthodes d’authentification existantes d’un utilisateur.

​

Réponses

Pour chaque requête valide, le Management API renvoie une réponse au format 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"
      }
    ]
  }
]

​

Mettre à jour une méthode d’authentification

Utilisez le point de terminaison Updates an authentication method pour mettre à jour une méthode d’authentification d’un utilisateur.

Ce point de terminaison nécessite le scope : update:authentication_methods.

​

Exemples

La requête suivante met à jour une seule méthode d’authentification pour un utilisateur en fonction de l’id de cette méthode d’authentification.

​

Réponses

Pour chaque requête valide, la Management API renvoie une réponse au format 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"
        }
    ]
}

​

Supprimer toutes les méthodes d’authentification

Utilisez le point de terminaison Supprime toutes les méthodes d’authentification de l’utilisateur spécifié pour supprimer toutes les méthodes d’authentification d’un utilisateur.

Ce point de terminaison nécessite le scope : delete:authentication_methods.

​

Exemples

La requête suivante supprime toutes les méthodes d’authentification associées à un utilisateur.

​

Réponses

Pour chaque requête valide, la Management API renvoie une réponse avec le code d’état 204 et un corps vide.

​

Supprimer une méthode d’authentification

Utilisez le point de terminaison Deletes an authentication method by ID pour supprimer une méthode d’authentification d’un utilisateur.

​

Exemples

La requête suivante supprime une méthode d’authentification unique pour un utilisateur en fonction de l’ID de la méthode d’authentification spécifiée.

​

Réponses

Pour chaque requête valide, la Management API renvoie une réponse avec le code d’état 204 et un corps vide.

​

En savoir plus

• Facteurs d’authentification multifacteur
• Enregistrer des applications de machine à machine
• Obtenir des jetons d’accès pour la Management API en production
• Applications confidentielles et publiques