Au cours des dernières semaines, nous avons montré comment tirer parti de divers points de terminaison de l'Intelligent Adaptive Authentication (IAA) de OneSpan par le biais de l'API Interactive Sandbox. Dans le blog de cette semaine, nous poursuivons la série en cours et expliquons comment vérifier le statut d'activation d'un nouvel utilisateur lors de son inscription. À cette fin, nous utiliserons le point de terminaison "/registrations/check-status" dans l'éditeur Open API Swagger.

Avant de commencer :

Avant d'explorer le service Web "/registrations/check-status", vous devez d'abord être membre de la communauté OneSpan et vous inscrire à un compte sandbox gratuit d'Intelligent Adaptive Authentication. Voici des instructions étape par étape sur la manière de le faire.

Vous devez également vous assurer d'avoir au moins un utilisateur enregistré avant d'essayer cet appel. Pour apprendre comment enregistrer un utilisateur, consultez ce blog détaillé sur l'enregistrement d'un utilisateur.

Introduction

Le point de terminaison "/registrations/check-status" vous permet de vérifier l'état d'activation actuel du dispositif de confiance d'un nouvel utilisateur. Cela vous permettra de savoir si le SDK d'orchestration intégré à votre application a terminé son activation sur le périphérique de confiance, ou si d'autres actions sont nécessaires pour achever le processus d'activation. Au fur et à mesure que nous avançons dans ce tutoriel, vous remarquerez que le point de terminaison "check-status" est assez facile à exploiter et donc facile à intégrer à votre solution.

Naviguez jusqu'à Check-Status Endpoint :

Afin d'expérimenter le point de terminaison "check-status", accédez à l'API interactive IAA Sandbox de votre compte OneSpan Community. Dans l'éditeur Open API Swagger, développez la ressource "Provisioning". Vous trouverez alors une entrée pour la méthode HTTP Post "check-status" comme le montre l'image ci-dessous.

URL du point de contrôle de l'état d'avancement

L'URL de la demande pour cet appel API ressemblera à l'URL ci-dessous :

https:// {votre_identifiant_locataire}.sdb.tid.onespan.cloud/v1/registres/check-status

Vous n'aurez pas besoin de fournir cette URL pendant le tutoriel. Il s'agit uniquement de montrer la structure de l'URL. L'URL sera automatiquement attribuée dans l'API interactive lors de l'appel du service web

Vérifier le statut d'activation en action

Enregistrer un utilisateur

Pour les besoins de l'exemple, nous devrons enregistrer un nouveau compte utilisateur, puis vérifier l'état de son activation. Pour une explication complète sur la façon d'enregistrer un utilisateur, consultez le blog "OneSpan Developer : Intelligent Adaptive Authentication - User Registration".

Après un enregistrement réussi, vous obtiendrez un code d'état de réponse 200-OK indiquant l'enregistrement réussi de l'utilisateur. A partir de là, nous allons poursuivre l'exemple et vérifier le statut d'activation de l'utilisateur sur le dispositif de confiance.

Corps de la demande de contrôle d'état

Le corps de la requête de l'appel au point de terminaison check-status contient trois objets JSON. Seul le champ "Login" est obligatoire, tandis que les deux autres sont facultatifs. Voir le tableau ci-dessous pour la description des champs :

Champs de données JSON	Description	Champ Type de données
connexion*	Identifiant de l'utilisateur pour lequel il faut effectuer un contrôle d'activation.	Type : string minLength : 1 maxLength : 255 Exemple : iaa_user
domaine	Domaine dans lequel le compte utilisateur réside.	Type : string minLength : 1 maxLength : 255 Exemple : ospanuser-mail
timeoutSeconds	Le temps après lequel la demande est temporisée pour l'appel synchrone du point de terminaison, si ce champ n'est pas fourni, le point de terminaison sera automatiquement appelé de manière asynchrone.	Type : nombre entier exemple : 10

 

Le corps de la requête au format JSON du point de terminaison "registrations/check-status" ressemblera à l'exemple ci-dessous

 
{ "login" : "userid1", "Domain" : "ospanuser-mail", "timeoutSeconds" : 10 }

Synchrone vs Asynchrone

La vérification de l'état d'activation peut se faire de manière ssynchrone ou asynchrone. Si elle est synchrone, le champ "timeoutSeconds" est obligatoire. Lorsqu'il est fourni, l'appel au point de terminaison check-status sera automatiquement synchrone. Cela signifie que la vérification de l'état d'activation se poursuivra pendant la durée indiquée en secondes. Dans une méthode asynchrone, le point de terminaison vérifiera l'état de l'activation instantanément lors de l'appel. Pour effectuer un appel asynchrone, le champ "timeoutSeconds" doit être omis dans les données utiles de la demande du point de terminaison "check-status". C'est ce qui différencie l'invocation des deux mécanismes

Appeler le point de terminaison de contrôle d'état :

Il est maintenant temps de vérifier le statut d'activation du nouvel utilisateur pour OneSpan IAA. Pour effectuer l'appel API, cliquez sur le bouton "Try it out" illustré dans la capture d'écran ci-dessous, sur le côté droit de la section "registrations/check-status" Post method. Une fois la demande effectuée, vous recevrez le corps de la réponse en retour au format JSON. Il sera similaire à la charge utile de la réponse décrite dans la section suivante.

Corps de la réponse à l'appel API sur l'état d'activation :

Vous trouverez ci-dessous un exemple de corps de réponse renvoyé par l'appel API "registrations/check-status".

 
{"activationStatus" : "pending" }

 

Types d'état d'activation

Le seul champ renvoyé dans les données utiles de la réponse est "activationStatus". Il est de type String et sa valeur sera l'un des états d'activation du dispositif ci-dessous :

Type d'état d'activation	Signification
inconnu	Aucune activation en attente n'a été trouvée pour l'utilisateur indiqué dans le champ "login" des données utiles de la demande.
en attente de	Le processus d'activation est en cours pour le compte utilisateur indiqué dans le champ "login" de la charge utile de la demande.
activé	Le processus d'activation a été achevé sur le dispositif de confiance du compte utilisateur indiqué dans le champ "login" de la charge utile de la demande.
délai d'attente	Le processus d'activation a été interrompu avant que l'activation ne soit terminée.

 

Lors de l'enregistrement, l'état d'activation sera affiché comme "En attente" jusqu'à ce que l'utilisateur termine l'activation. Si l'activation n'a pas eu lieu dans les 10 minutes, la session expirera et l'état d'activation deviendra "Inconnu".

Dans ce blog, nous avons montré comment vérifier l'état d'activation d'un compte d'utilisateur final à l'aide du point de terminaison check-status de l'API interactive de l'IAA Sandbox. À présent, vous devriez avoir les connaissances nécessaires pour l'utiliser et l'intégrer à votre solution. Si vous avez des questions, n'hésitez pas à nous contacter sur les forums du portail communautaire OneSpan.