Attente du contrat d'API de résultat pour initiate+wait pour le modèle de résultat

Modifier en ligne

La ressource result est appelée par les composants Verify internes lors d'une demande d'authentification MFA d'exécution quand le facteur utilisé prend en charge le modèle d'intégration "initiate+wait for result".

Par exemple, push. Verify s'attend à ce que la réponse contienne un status indiquant le succès, l'échec, ou l'état en attente de la demande d'authentification MFA, que l'utilisateur effectue séparément. L'exemple de code suivant est un exemple de requête envoyée par Verify à la result 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 '/result' \
'Content-Type: application/json' \
'Accept: application/json' \

{
  "capability":  "<<factor capability name, e.g. totp>>",
  "id": "<<factor or device identifier from external provider>>",
  "transactionId": "<<provider transaction identifier>>"
  "attributes":
  {
    "username": "<<external MFA username>>"
  }
}
Remarque : l'URL /resultHTTP dans cet exemple varie en fonction de la configuration du webhook.

Détails de résultat de la demande

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 représentant la valeur de jeton ou de passe à valider. Le contenu identifie également l'utilisateur et son inscription ou enregistrement MFA associé.
id

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

Obligatoire. Identifie le type de fonction du facteur MFA. 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.
transactionId

Facultatif. Transaction ou autre descripteur d'état de la demande d'authentification du fournisseur MFA. Cette valeur est présente si la validation est effectuée dans le cadre du flux de modèle "initiate+validate". Sa valeur est identique à celle incluse dans la réponse "initiate" précédente.
attributes

Obligatoire. Valider des attributs supplémentaires spécifiques à la demande.
attributes.username

Obligatoire. Nom d'un utilisateur dans le système fournisseur externe pour lequel la validation est demandée.
attributes.passvalue

Obligatoire. Jeton ou valeur à valider.
L'échantillon de code suivant est un exemple de contenu de réponse result.
{
    "attributes": {
        "<<any name>>": "<<any value>>"
    },
    "status": "PENDING"
}

Détails de résultat de la réponse

Eléments Descriptif
Type de contenu Objet JSON représentant le statut de la tentative de validation.
Code d'état HTTP Consultez l'état de l' HTTP.
status Obligatoire. Statut d'achèvement ou d'exécution de résultat MFA. Valeurs admises : SUCCESS, PENDING, TIMEOUT, CANCELED et FAILED
attributes Facultatif. Attributs supplémentaires renvoyés au client Verify public qui a déclenché la demande d'authentification MFA. Tous les attributs et valeurs supplémentaires peuvent être présents.