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

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

Avant de commencer

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

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

L’Auth0 Management API fournit 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 effectuée au moyen d’une application confidentielle. Pour en savoir plus sur les applications confidentielles et les applications publiques, consultez Applications confidentielles et publiques.

​

Obtenir toutes les méthodes d’authentification

Utilisez le point de terminaison Récupère la liste des méthodes d’authentification pour obtenir la liste de toutes les méthodes d’authentification qu’un utilisateur a complètement ou partiellement configurées.

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, l’Management API renverra 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 seule méthode d’authentification

Utilisez le point de terminaison Obtenir une méthode d’authentification par ID pour récupérer une méthode d’authentification d’un utilisateur en indiquant l’ID de la méthode d’authentification.

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

​

Exemples

La requête suivante renvoie une seule méthode d’authentification pour un utilisateur à partir de l’ID de la méthode d’authentification indiquée.

​

Réponses

Pour chaque requête valide, la Management API renverra 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 Crée une méthode d’authentification pour un utilisateur donné pour créer une méthode d’authentification pour un utilisateur, y compris par SMS, courriel, mot de passe à usage unique (OTP) ou WebAuthn avec clés de sécurité. Pour en savoir plus sur les facteurs d’authentification MFA disponibles, consultez Facteurs d’authentification multifacteur.

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

Les méthodes d’authentification créées par ce point de terminaison seront automatiquement confirmées et disponibles immédiatement. 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 aux utilisateurs par SMS; ils seront ensuite invités à 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, la 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"
}

​

Email

Envoyez un OTP aux utilisateurs par courriel. Ils devront ensuite le saisir avant de pouvoir terminer l’authentification. Le facteur Email n’est pris en charge que lorsqu’un utilisateur n’a aucun autre facteur disponible.

​

Exemples

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

​

Réponses

Pour chaque requête valide, la Management API renverra 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 pour générer un OTP qui change périodiquement et qu’ils devront saisir avant de terminer 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 à FIDO (par exemple, Yubikey ou Google Titan) pour l’authentification multifacteur.

​

Exemples

La requête suivante crée, pour un utilisateur, une méthode d’authentification WebAuthn avec des clés de sécurité.

​

Réponses

Pour chaque requête valide, la 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 les remplaçant par celles fournies pour remplacer toutes les méthodes d’authentification existantes par celles fournies.

Cet 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, la 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 seule méthode d’authentification

Utilisez le point de terminaison Updates an authentication method pour mettre à jour une seule 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 la méthode d’authentification spécifiée.

​

Réponses

Pour chaque requête valide, la Management API renverra 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 Supprimer 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 suivant : delete:authentication_methods.

​

Exemples

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

​

Réponses

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

​

Supprimer une seule 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 précise d’un utilisateur à partir de l’ID de la méthode d’authentification indiquée.

​

Réponses

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

​

En savoir plus

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