OneSpan Developer : Authentification adaptative intelligente - Désinscription de l'utilisateur

L'API OneSpan Intelligent Adaptive Authentication Sandbox vous permet de gérer tous les aspects associés à un compte utilisateur. Dans le blog précédent "OneSpan Developer : Intelligent Adaptive Authentication - User Registration" nous avons montré comment enregistrer un nouvel utilisateur pour OneSpan Intelligent Adaptive Authentication (IAA). Dans cet article, nous allons explorer le point de terminaison "User Unregister", et montrer comment il est facile de supprimer un utilisateur qui a été précédemment enregistré. Nous allons montrer comment construire l'URL du point de terminaison, un exemple de corps de requête et les valeurs de réponse possibles pour la requête HTTP Post et OneSpan Risk Analytics.

Avant de commencer

Avant d'explorer le service Web User Unregister, vous devez d'abord être membre de la communauté OneSpan et vous inscrire à un compte sandbox gratuit 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

L'API User Unregister vous permet de supprimer un compte utilisateur existant du serveur OneSpan Intelligent Adaptive Authentication. Si la suppression du compte utilisateur a réussi, un code d'état 200-OK sera renvoyé. En outre, vous recevrez également un code de réponse de Risk Analytics pour indiquer si la désinscription a réussi ou si une authentification supplémentaire est nécessaire pour confirmer la suppression du compte utilisateur indiqué. Une liste complète des codes de réponse au risque attendus sera décrite plus loin dans le tutoriel. En outre, si la demande n'a pas abouti pour une raison quelconque, un code de réponse d'erreur HTTP sera renvoyé avec un message significatif. Ce message permettra d'expliquer la cause de l'erreur et facilitera son débogage.

Exemple de la structure de l'URL de l'API d'enregistrement des utilisateurs :

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

https://{votre_ID_locataire}.sdb.tid.onespan.cloud/v1/users/{userID@domain}/unregister

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

Accédez à l'API interactive "User Unregister" :

Afin d'expérimenter l'API de désinscription des utilisateurs, il faut d'abord qu'un utilisateur ait déjà été enregistré dans le système. Naviguez vers l'API IAA Interactive Sandbox de votre compte OneSpan Community. Dans l'éditeur OpenAPI Swagger, développez la ressource "Users". Vous trouverez alors une entrée pour la méthode User Unregister HTTP Post comme indiqué dans l'image ci-dessous.  

Paramètres du chemin URL :

Pour les besoins de l'appel API "User Unregister", un paramètre de chemin d'accès est requis pour l'identifiant unique de l'utilisateur. Il sera formaté comme suit : userID@domain. Un exemple de l'ID utilisateur est "iaa_user". Il s'agit de l'ID utilisateur qui a été choisi précédemment lors de l'enregistrement du compte utilisateur qui est maintenant supprimé. La partie du paramètre qui suit le signe "@" est le domaine de l'utilisateur. Cette entrée doit être remplacée par la chaîne "Sandbox User" présentée ci-dessous, qui est présente dans la section des détails de votre Sandbox sous l'onglet "Intelligent Adaptive Authentication" de la page d'accueil de votre Sandbox.

Corps de la demande de l'API "User Unregister" :

Dans la section "Request Body" du point final User Unregister, sélectionnez le type d'objet "AdaptiveUnregisterUserInput" dans le menu déroulant comme indiqué ci-dessous. Ce type d'objet est utilisé pour supprimer l'utilisateur sélectionné dans le paramètre du chemin. Vous obtiendrez alors un exemple de la charge utile JSON pour désenregistrer un utilisateur. Il sera alimenté par un échantillon des objets JSON requis par l'API du type d'objet " AdaptiveUnregisterUserInput "

 

Le corps de la demande ressemblera à l'exemple ci-dessous des champs obligatoires du point de terminaison "users/unregister".

Charge utile de la demande

{ "objectType" : "AdaptiveUnregisterUserInput", "cddc" : { "browserCDDC" : { "fingerprintRaw" : "{browser:{\"userAgent\":Mozilla/5.0 (Windows NT 6.1 ; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.181 Safari/537.36},support:{\"ajax\":true,\"boxModel\":undefined,\"changeBubbles\":undefined,\"checkClone\":true,\"checkOn\":true,\"cors\":true,\"cssFloat\":undefined,\"hrefNormalized\":undefined,\"htmlSerialize\":undefined,\"leadingWhitespace\":undefined,\"noCloneChecked\":true,\"noCloneEvent\":undefined,\"opacity\":undefined,\"optDisabled\":undefined,\"style\":undefined,\"submitBubbles\":undefined,\"tbody\":undefined},computer:{\"screenWidth\":2560,\"screenHeight\":1440,\"OS\":\"Microsoft Windows\",\"platform\":\"Win32\"},additional:{}}", "fingerprintHash" : "e96dadc9651f5fe8f071110eb174fe8e7a17a9d7a96b3b1980c13e5b4af3a4d7" } }, "clientIP" : "192.168.0.1", "relationshipRef" : "userid33", "sessionID" : "4ED23EA44F23" }

 

 

Description des champs obligatoires de la charge utile de la demande

Champs de données obligatoires JSON	Description	Champ Type de données
cddc*	Métadonnées du collecteur de données du dispositif client. Les deux champs "browserCDDC" et "mobileCDDC" sont mutuellement exclusifs et collectivement exhaustifs.	Type : chaîne de caractères Exemple : "browserCDDC" ou "mobileCDDC"
relationRef*	La référence relationnelle de l'ID utilisateur à supprimer.	Type : string minLength : 1 maxLength : 150 Exemple : iaa_user
identifiant de la session	Identifiant de session de l'application, formaté sous forme de chaîne hexadécimale ; commun à toutes les transactions liées à la même session.	Type : string pattern : ^[0-9a-fA-F]+$ minLength : 2 maxLength : 100 example : 4ed23ea44f23

 

Appeler le point de terminaison de désenregistrement de l'utilisateur

À ce stade, nous sommes prêts à effectuer l'appel REST pour désenregistrer l'utilisateur spécifié à l'aide de l'API Sandbox interactive IAA. Pour appeler le point de terminaison, cliquez sur le bouton "Try it out" montré dans la capture d'écran ci-dessous et situé à droite de la section "/users/unregister" 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 réponse de l'appel API de désenregistrement de l'utilisateur

Voici un exemple du corps de réponse renvoyé par un appel réussi à l'API "/users/unregister".

{ "riskResponseCode" : 0 }

"riskResponseCode" est le code de réponse de Risk Analytics, la valeur '0' dans la réponse ci-dessus indique que la demande a été acceptée et que l'utilisateur a été supprimé du système. Vous trouverez ci-dessous une liste des valeurs qui peuvent être renvoyées par Risk Analytics. En outre, des valeurs supplémentaires peuvent être configurées par le biais du service de présentation de Risk Analytics.

Comportement d'analyse des risques	Code de réponse au risque (nombre entier)
Accepter	0
Déclin	1
Défi	2
ChallengeSMS	3
ChallengeDevice2FA	5
ChallengeEmail	8
DéfiCronto	11
ChallengeNoPIN	21
DéfiPIN	22
ChallengeEmpreinte digitale	23
ChallengeFace	24

 

Codes d'état de la réponse HTTP

Le tableau ci-dessous montre les codes de réponse attendus lors d'une tentative de suppression d'un compte utilisateur

Code d'état de la réponse	Signification
200	Le compte de l'utilisateur n'est pas enregistré.
204	Le compte de l'utilisateur n'est pas enregistré.
402	Erreurs de données d'entrée.
403	La commande est interdite pour le compte admin du locataire.
404	Le compte d'utilisateur n'est pas trouvé.
409	Le compte d'utilisateur n'a pas pu être désenregistré.
500	Erreur interne, défaillance du service secondaire, panne du serveur.

 

Dans ce blog, nous avons montré comment désenregistrer un nouvel utilisateur à l'aide de l'API interactive de l'IAA Sandbox. Nous avons également exploré la structure et les exemples des charges utiles de la demande et de la réponse, qui sont requises par le point de terminaison "/users/unregister". Nous avons ensuite conclu en décrivant le code de réponse au risque attendu et les codes d'état HTTP pour l'API User Unregister. Grâce à ce tutoriel, vous pouvez garder votre liste d'utilisateurs en ordre et vous assurer qu'il n'y a pas de comptes inutilisés. Si vous avez des questions concernant ce tutoriel, n'hésitez pas à nous contacter sur les forums du portail communautaire OneSpan

Découvrez d'autres points de terminaison de la catégorie "Utilisateurs" :

• Enregistrement de l'utilisateur Endpoint
• Users Query Endpoint
• Point final de mise à jour de l'utilisateur