Contrat d'API de consultation d'inscription

Modifier en ligne

Presque chaque intégration MFA externe doit prendre en charge la capacité d'ISV Verify à rechercher toutes les fonctions de facteur MFA actuellement disponibles pour un utilisateur spécifique. Lors de l'exécution, Verify s'attend à ce que la réponse contienne une liste d'objets JSON où chaque objet identifie et représente une fonction MFA de l'utilisateur.

L'exemple suivant illustre une requête type envoyée par Verify à la enrollments ressource du webhook en temps réel. En fonction de la configuration du webhook, ce même contenu peut être envoyé directement au fournisseur MFA cible ou transformé en une demande de client d'API acceptable pour le fournisseur cible.
POST '/enrollments' \
'Content-Type: application/json' \
'Accept: application/json' \

{
    "username": "<<external MFA username>>"
}
Remarque : l'URL /enrollmentsHTTP indiquée dans cet exemple varie en fonction de la configuration du webhook.

Détails de la demande de consultation d'inscriptions

Elément Descriptif
Demande HTTP POST
En-tête HTTP - Content-Type Le type de contenu du contenu de la demande est toujours application/json.
En-tête HTTP - Accept Le type de contenu attendu du contenu de la réponse est toujours application/json.
Contenu Objet JSON qui identifie l'utilisateur pour lequel des inscriptions sont demandées.
username (nom d'utilisateur) Obligatoire. Nom d'un utilisateur dans le système fournisseur externe pour lequel les données d'inscription sont demandées.
L'échantillon suivant est un exemple de contenu de réponse enrollment lookup.
[
    {
        "attributes": {
            "authExecutionFlow": "init_then_poll",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. push>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "init_then_validate",
            "deliveryAddress": "<<e.g. phone number or email address>>",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. smsotp>>",
        "id": "<<factor or device identifier from external provider>>"
    },
    {
        "attributes": {
            "authExecutionFlow": "validate",
            "deviceName": "<<Device name if available>>",
        },
        "capability": "<<factor capability name, e.g. totp>>",
        "id": "<<factor or device identifier from external provider>>"
    }
]

Détails de la demande de consultation d'inscriptions

Eléments Descriptif
Type de contenu Tableau JSON d'inscriptions MFA externes.
Code d'état HTTP Consultez l'état de l' HTTP.
id

Obligatoire. Identificateur unique de la fonction de facteur MFA inscrite ou enregistrée de l'utilisateur.
capability

Obligatoire. La valeur est une chaîne de caractères valide. Elle doit correspondre à l'une des fonctions qui sont configurées pour le fournisseur MFA associé au webhook.
attributes

Obligatoire. Attributs supplémentaires renvoyés au client Verify public qui a déclenché la consultation des inscriptions. D'autres attributs et valeurs peuvent être présents.
attributes.authExecutionFlow Obligatoire. Informe Verify du MFA pattern pris en charge par la fonction de facteur. Les valeurs correctes incluent :
  • validate - valider uniquement le modèle.
  • init_then_validate - initier le modèle de validation.
  • init_then_poll - initier puis attendre le modèle d'achèvement. Cet attribut est utilisé par la demande d'authentification d'exécution MFA externe Verify, UI/UX et structure, pour l'exécution de l'exécution.
attributes.deliveryAddress

Facultatif. Si le modèle d'exécution inclut une distribution de jeton MFA ou expérience similaire, cet attribut est affiché par Verify lors de la sélection de l'utilisateur MFA. Ce modèle peut aider et informer le choix de l'utilisateur sur les sélections MFA proposées.
attributes.deviceName

Facultatif. Si le modèle d'exécution inclut une expérience de distribution de jeton MFA, ou bien inclut un type d'appareil ou de jeton d'authentification distinct et appartenant à l'utilisateur, cet attribut est affiché par Verify lors de la sélection de l'utilisateur MFA. Ce modèle peut aider et informer le choix de l'utilisateur sur les sélections MFA proposées.