OneSpan Developer : Authentification adaptative intelligente - Point d'accès aux requêtes des utilisateurs
L'Intelligent Adaptive Authentication (IAA) de OneSpan offre un moyen facile de répertorier les utilisateurs qui ont été enregistrés pour un domaine spécifique. Avec le point de terminaison User Query, vous pouvez obtenir un aperçu de chacun des utilisateurs actuellement enregistrés dans votre compte sandbox. Il existe plusieurs paramètres qui vous permettent de n'interroger que des utilisateurs spécifiques ou de paginer à travers plusieurs instances. Dans ce blog, nous allons examiner le point de terminaison User Query, ses options de paramètres de chemin d'accès et la manière dont vous pouvez le tester à partir de l'API interactive IAA Sandbox.
Avant de commencer : rejoignez la communauté des développeurs OneSpan
Avant d'explorer le service Web de requête des utilisateurs, vous devez d'abord être membre de la communauté OneSpan et vous inscrire à un compte gratuit de bac à sable 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.
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/utilisateurs
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 avec le document interactif de l'API
Afin d'expérimenter l'API de requête des utilisateurs, accédez au document IAA Sandbox Interactive API de votre compte OneSpan Community. Dans l'éditeur Open API Swagger, développez la ressource "Users". Vous trouverez alors une entrée pour la méthode Users Query HTTP Get comme dans l'image ci-dessous
L'API de requête des utilisateurs est assez simple à utiliser. Il n'est pas nécessaire de fournir un corps de requête JSON pour l'appel à la méthode HTTP GET. Il vous suffit de configurer les paramètres de parcours expliqués ci-dessous pour adapter l'appel à des résultats spécifiques.
Paramètres URL
Le tableau ci-dessous présente les différentes options de paramètres de chemin qui sont utilisées pour personnaliser la requête dans l'API de la plate-forme de l'Environnement de travail. Il comprend également la description et l'exemple de chaque paramètre de chemin d'accès pour vous aider à utiliser au mieux le point de terminaison de la requête utilisateur.
| Paramètre | Description | Champ Type de données |
|---|---|---|
| iD utilisateur | ID utilisateur de l'utilisateur à rechercher | Type : string Exemple : "iaa_user1" ou "*" pour lister tous les comptes jusqu'à 100 comptes, il supporte les Wildcards. |
| domaine | Domaine dans lequel rechercher les comptes d'utilisateurs. | Type : chaîne de caractères Exemple : ospanuser-mail |
| verrouillé | Statut de verrouillage du compte utilisateur | Type : booléen Exemple : "True" ou "False" |
| décalage |
Index du premier compte utilisateur retourné. Le paramètre de décalage est le plus important lorsqu'il y a plus de 100 utilisateurs enregistrés, il sera utilisé pour paginer à travers les comptes enregistrés à partir de la valeur spécifiée |
Type : integer |
limite |
Nombre de comptes utilisateurs retournés. Il joue un rôle important avec le paramètre "offset" pour personnaliser la liste retournée lorsque le nombre de comptes dépasse 100 | Type : entier Valeur par défaut : 20 Valeur maximale : 100 Exemple : 20 |
Vous trouverez ci-dessous un exemple simple de ce à quoi ressemblera l'URL de la demande avec certains des paramètres ajoutés :
https://ospanuser-mail.sdb.tid.onespan.cloud/v1/users?locked=false&offset=20&limit=20
Dans l'exemple, le paramètre Offset a été réglé sur 20. Le paramètre Limit a été fixé à 20, et l'attribut boolean Locked a été fixé à False. Cela renverrait 20 utilisateurs débloqués, en commençant par le 20ème utilisateur de votre liste.
Exécution de la demande
À ce stade, nous sommes prêts à effectuer l'appel REST au point de terminaison Users Query en utilisant l'API de l'Environnement de test interactif IAA. Pour appeler le point de terminaison, cliquez sur le bouton "Try it out" illustré dans la capture d'écran ci-dessous et situé à droite de la section de la méthode HTTP GET "/users". 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.
Charge utile de la réponse
Vous trouverez ci-dessous un exemple du corps de réponse renvoyé par un appel réussi à l'API "/users".
@mailinator{ "total" : 20, "offset" : 0, "limit" : 20, "count" : 19, "users" : [ { "created" : "2020-05-08T22:04:35Z", "domain" : "ospanuser-mail", "enabled" : true, "isPasswordSet" : true, "lastModified" : "2020-05-08T22:22:09Z", "lastPasswordUpdate" : "2020-05-08T22:04:35Z", "locked" : false, "userID" : "iaaUser1", "vdpDeliveryMethod" : "Default", "emailAddress" : "[email protected]", "mobilePhoneNumber" : "+1 (555) 555 5555" }, { "created" : "2020-05-27T10:35:52Z", "domain" : "ospanuser-mail", "enabled" : true, "isPasswordSet" : true, "lastModified" : "2020-05-27T10:35:53Z", "lastPasswordUpdate" : "2020-05-27T10:35:52Z", "locked" : false, "userID" : "any.anyl", "vdpDeliveryMethod" : "Default", "authenticators" : [ "VDS0119940", "VDS0119940-2", "VDS0119940-
Le tableau suivant donne des informations plus détaillées sur chacune des propriétés de la charge utile de la réponse ci-dessus.
| Objet de réponse JSON | Description | Type de données |
|---|---|---|
| compte* | Nombre de comptes utilisateurs retournés. | Type : nombre entier Exemple : 19 |
| limite* |
Nombre maximum de comptes utilisateurs demandés. | Type : nombre entier Exemple : 20 |
| décalage* | Index du premier compte utilisateur retourné. | Type : entier Exemple : 0 pour commencer à partir du premier index |
| total* |
Nombre total de comptes d'utilisateurs qui correspondent aux paramètres d'entrée de la requête . |
Type : entier Exemple : 3 |
| utilisateurs* |
Une liste des comptes utilisateurs retournés, chaque objet de la liste est décrit dans le tableau ci-dessous. |
Type : Un tableau JSON des comptes utilisateurs sélectionnés. |
Chaque entrée du tableau des utilisateurs dans le tableau ci-dessus contiendra au moins les champs suivants.
| Champ dans le tableau des utilisateurs | Description | Type de données |
|---|---|---|
| créé* | Horodatage de la création du compte utilisateur | Type : chaîne de caractères Exemple : 2019-02-04T11:42:39Z |
| domaine* |
Domaine dans lequel le compte utilisateur réside. | Type : chaîne de caractères Exemple : ospanuser-mail |
| activé* |
Spécifie si le compte utilisateur est activé ou non. | Type : booléen Exemple : "True" ou "False" |
| isPasswordSet* | Spécifie si le compte utilisateur a un mot de passe statique défini ou non. | Type : booléen Exemple : "True" ou "False" |
| lastModified* |
Horodatage de la dernière modification pour le compte de l'utilisateur. |
Type : chaîne de caractères |
dernière mise à jour du mot de passe |
Horodatage de la dernière mise à jour du mot de passe statique. | Type : chaîne de caractères Exemple : 2019-02-04T11:42:39Z |
| verrouillé* | Spécifie si le compte utilisateur est créé dans un état verrouillé ou non. | Type : booléen Exemple : "True" ou "False" |
| mdcProfile* | Profil du composant de livraison de messages (MDC) pour l'envoi d'OTP virtuels. | Type : chaîne de caractères exemple : EUROPE |
| iD utilisateur* | Identifiant de l'utilisateur. | Type : chaîne de caractères exemple : iaa_user1 |
| vdpDeliveryMethod* (méthode de livraison) | Méthode de livraison pour l'envoi de l'OTP virtuel. |
Type : chaîne de caractères |
| authentificateurs | Une liste des authentificateurs assignés à chaque utilisateur. | Type : JSON Array exemple : ["VDS0119940",...] |
Dans ce blog, nous avons montré comment utiliser le point de terminaison User Query et modifier ses paramètres pour obtenir la liste actuelle des utilisateurs enregistrés dans votre compte sandbox. Restez à l'écoute pour d'autres articles de blog sur l'utilisation de l'API IAA Sandbox. En attendant, si vous avez des questions, 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
- User Unregister Endpoint
- Point final de la mise à jour de l'utilisateur/a>
OneSpan Sign Developer Community
Rejoignez la communauté OneSpan Sign Developer! Forums, blogs, documentation, téléchargements SDK, et plus encore.
Joignez-vous aujourd'hui
