Développeur OneSpan : Authentification adaptative intelligente - Authenticator Unassign
L'API OneSpan Intelligent Adaptive Authentication Sandbox vous permet de gérer tous les aspects liés aux authentificateurs Digipass. Dans le blog précédent, nous avons montré comment attribuer un authentifiant à un utilisateur spécifique à l'aide de l'API interactive de l'Environnement de travail. Ici, nous allons explorer le point de terminaison "Authenticator Unassign" et montrer comment il est facile de libérer une instance d'authentification qui a déjà été assignée à un utilisateur.
Avant de commencer :
Avant d'explorer l'API pour désassigner un authentificateur Digipass, vous devez d'abord rejoindre la communauté OneSpan et vous inscrire à un compte sandbox gratuit d'Intelligent Adaptive Authentication. Consultez notre précédent blog OneSpan Cloud Solutions In Action - MyBank Web Portal Demo, Part1 pour savoir comment procéder.
Vous devez également vous assurer d'avoir au moins un utilisateur enregistré avant d'essayer cet appel. Pour savoir comment enregistrer un utilisateur, consultez le document OneSpan Developer : Intelligent Adaptive Authentication - User Registration.
URL du point de terminaison
L'URL de la demande pour cet appel API ressemblera à l'exemple ci-dessous :
https://{votre_ID_locataire}.sdb.tid.onespan.cloud/v1/authenticators/{serial_Number}/unassign
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 webservice
Essayez-le
Afin d'expérimenter l'API Authenticators Unassign, accédez au document IAA Sandbox Interactive API dans votre compte OneSpan Community. Dans l'éditeur Open API Swagger, développez la ressource "Authenticators". Vous trouverez ensuite une entrée pour la méthode Authenticators Unassign HTTP Post comme indiqué dans l'image ci-dessous :
Paramètres du chemin URL :
Le seul paramètre de chemin d'accès requis pour la désaffectation d'un authentificateur spécifique est son numéro de série. Même si cet authentificateur est lié à un utilisateur spécifique, nous n'avons pas besoin de fournir l'ID utilisateur ou le domaine dans la requête HTTP
La variable serialNumber
est de type String. Il s'agit d'un identifiant unique composé de trois lettres et de sept chiffres. Par exemple, un numéro de série peut être VDS0066822
.
La meilleure façon de trouver le numéro de série de l'authentificateur requis comme paramètre de chemin est de passer par le point de terminaison Authenticators Query. Lors de l'interrogation, il sera plus facile de trouver un authentificateur lié si nous mettons la propriété assignée
à True
. De cette façon, nous n'obtiendrons que la liste des authentificateurs déjà attribués à un utilisateur. Pour une référence complète du point de requête, vous pouvez visiter OneSpan Developer : Intelligent Adaptive Authentication - Authenticators Query Endpoint
Voici un exemple de ce à quoi ressemblera l'URL de la demande après avoir ajouté le numéro de série de l'authentificateur et le domaine
https://ospanuser-mail.sdb.tid.onespan.cloud/v1/authenticators/VDS0066822/unassign
Dans l'exemple ci-dessus, l'authentificateur portant le numéro de série VDS0066822 ne sera pas attribué par l'utilisateur final.
Appeler le point de terminaison
À ce stade, nous sommes prêts à effectuer un appel RESTful vers le point de terminaison Authenticator Unassign en utilisant l'API Sandbox interactive IAA. Pour effectuer l'appel, cliquez sur le bouton "Try it out" illustré dans la capture d'écran ci-dessous et situé à droite de la section relative à la méthode HTTP POST. 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.
Authenticator Unassign HTTP Response :
Le code de réponse qui devrait être renvoyé à la suite d'un appel réussi de désassignation d'authentificateur est 204
(Authenticator unassigned).
La réponse HTTP de cet appel ne contiendra pas de données utiles, il s'agira principalement de l'en-tête de réponse d'une balise d'entité fournie par le serveur pour la version actuelle de l'état de l'entité. Cet ETag doit être traité comme opaque, et il pourrait être utilisé pour faire des demandes de suivi conditionnelles.
Vous trouverez ci-dessous un exemple de l'en-tête de réponse renvoyé lors d'un appel réussi à l'API "Authenticators Unassign".
Codes d'état de la réponse HTTP :
Le tableau ci-dessous présente les codes de réponse potentiels lors d'une tentative de désassignation d'un authentificateur avec une requête HTTP Post.
Code d'état de la réponse | Signification |
---|---|
204 | Authentificateur non assigné |
400 | Erreurs de données d'entrée. |
403 | La commande est interdite pour le compte admin du locataire. |
404 | L'authentificateur lié au numéro de série est introuvable. |
409 | L'authentifiant lié au numéro de série n'est pas attribué. |
500 | Erreur interne, défaillance du service secondaire, panne du serveur. |
Dans ce blog, nous avons exploré comment désassigner une instance d'authentification qui a déjà été liée à un compte d'utilisateur final. Restez à l'écoute pour d'autres blogs, car je continue à parcourir les différents points de terminaison de l'API. Si vous avez des questions concernant le contenu, n'hésitez pas à nous contacter sur les forums du portail communautaire OneSpan
Découvrez d'autres points de terminaison de la catégorie Authenticators :