OneSpan Developer : Authentification adaptative intelligente - Point final de la requête des authentificateurs
En raison de leur rôle intégral dans l'Intelligent Adaptive Authentication (IAA) de OneSpan, une section entière a été incluse dans l'API interactive IAA Sandbox sur les authentificateurs Digipass. Cette section comprend chaque point de terminaison pour le traitement des activités liées aux authentificateurs. À titre d'exemple, ces points de terminaison vous permettent de visualiser, d'assigner ou de désassigner des authentificateurs aux comptes utilisateurs et de générer des données d'activation. Dans ce blog, nous allons explorer le point de terminaison Authenticators Query et montrer comment personnaliser les paramètres de son chemin. Pour ce faire, nous allons effectuer un appel HTTP GET pour répertorier tous les authentificateurs qui se rapportent à un compte spécifique et expliquer cet appel par le biais de l'API interactive de l'Environnement de test IAA.
Avant de commencer
Avant d'explorer le service Web Authenticator Query, 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.
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/authenticateurs
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
Faites-en l'expérience avec l'API interactive Sandbox
Afin d'expérimenter l'API Authenticator Query, 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 alors une entrée pour la méthode Authenticators Query HTTP Get comme indiqué dans l'image ci-dessous :
L'API de requête des authentificateurs 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 du chemin pour adapter l'appel à des résultats spécifiques.
Paramètres du chemin URL :
Le point de terminaison de la requête des authentificateurs comprend divers paramètres de chemin qui vous aident à localiser une liste spécifique d'authentificateurs pour personnaliser la requête dans l'API de la plate-forme Sandbox. Le tableau ci-dessous montre les différentes options de paramètres de chemin qui sont utilisées pour personnaliser la requête :
Paramètre du chemin | Description | Champ Type de données |
---|---|---|
numéro de série | Permet de spécifier si l'on veut lister tous les authentificateurs, ou trouver un authentificateur spécifique en fournissant son numéro de série | Type : string Exemple : VDS0091651 ou "*" pour lister tous les comptes jusqu'à 100 comptes, il supporte les Wildcards |
domaine |
Domaine dans lequel rechercher des authentificateurs. | Type : chaîne de caractères Exemple : ospanuser-mail |
type | Type d'authentificateur. | Type : chaîne de caractères exemple : DAL10 |
assigné |
Statut de l'affectation pour filtrer les résultats | Type : booléen Exemple : "True" ou "False" |
décalage | Index du premier authentificateur retourné. Le paramètre de décalage est pratique lorsqu'une pagination dans la liste des authentificateurs est requise | Type : integer Valeur par défaut : 0 Exemple : 10 (ceci listera les authentificateurs à partir du 10ème authentificateur, et le nombre d'authentificateur listé dépendra du paramètre "limit") |
limite | Le nombre d'authentificateurs retournés. Il joue un rôle important avec le paramètre "offset" pour personnaliser la liste retournée des authentificateurs | Type : entier Valeur par défaut : 20 Valeur maximale : 100 Exemple : 4 |
Vous trouverez ci-dessous un exemple de ce à quoi ressemblera l'URL de la demande avec certains des paramètres ajoutés :
https://ospanuser-mail.sdb.tid.onespan.cloud/v1/authenticators ?
type=DAL10&assigned=true&limit=20
Dans l'exemple, le paramètre Type a été réglé sur DAL10. Le paramètre booléen "Assigned" a été défini sur "True" et la "Limit" a été définie sur "20". Cela renvoie un maximum de 20 authentificateurs déjà assignés de type DAL10.
Appeler le point de terminaison
À ce stade, nous sommes prêts à effectuer un appel RESTful vers le point de terminaison Authenticators Query à l'aide de 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 de la méthode HTTP GET "/authenticators". 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
Voici un exemple du corps de réponse renvoyé par un appel réussi à l'API "/authenticators".
{ "total" : 10, "offset" : 0, "limit" : 20, "count" : 10, "authenticators" : [ { "applications" : [ { "name" : "ACTIVATION", "type" : "MA" } ], "created" : "2018-09-07T11:31:02Z", "domain" : "osiaa4-mailinator", "lastModified" : "2020-05-28T18:22:07Z", "serialNumber" : "VDS0028610", "activation" : { "activationsCount" : "4", "lastActivated" : "2020-05-28T18:22:06Z", "locationsCount" : "0", "bound" : false }, "assignedUserID" : "userid100000", "authenticatorType" : "DAL10", "assigned" : true }, ...]
Description des champs de données utiles de la réponse
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 la réponse | Description | Type de données |
---|---|---|
total* |
Il contient le nombre total d'authentificateurs qui correspondent aux paramètres d'entrée de la requête. | Type : entier Exemple : 3 |
décalage* | Index du premier authentificateur retourné. | Type : entier Exemple : 0 pour commencer à partir du premier index |
limite* | Nombre maximum d'authentificateurs d'utilisateurs demandés. | Type : nombre entier Exemple : 20 |
compte* | Nombre d'authentificateurs retournés. | Type : nombre entier Exemple : 19 |
authentificateurs* | Une liste des authentificateurs retournés. Chaque objet de la liste est décrit dans le tableau suivant. | Type : Un tableau JSON des authentificateurs sélectionnés. Exemple : voir les données utiles de la réponse ci-dessus. |
L'objet "authenticators" est la partie la plus importante du corps de réponse JSON. Il contient les informations relatives à chaque authentifiant listé dans la réponse. Dans le tableau ci-dessous, il y a la liste de tous les attributs de l'objet authentificateurs.
Champs de données | Description | Type de données |
---|---|---|
applications* | La liste des applications supportées par l'authentificateur. Cet attribut est un tableau qui contient le nom et le type de chaque authentifiant | Type : liste JSON Exemple : "applications" : [{ { "name" : ACTIVATION", "type" : "MA" } ] |
assigné* |
Ceci indique si cet authentificateur est attribué à un utilisateur. |
Type : booléen Exemple : Vrai ou Faux |
créé* |
L'horodatage de création de l'authentificateur. | Type : chaîne de caractères Exemple : 2019-02-04T11:42:39Z |
domaine* |
Le domaine dans lequel le compte utilisateur réside. | Type : chaîne de caractères Exemple : ospanuser-mail |
lastModified* |
Le dernier horodatage modifié pour l'authentificateur. | Type : chaîne de caractères Exemple : 2019-02-04T11:42:39Z |
numéro de série |
Le numéro de série de l'authentificateur. |
Type : chaîne de caractères Exemple : " VDS0091651 " |
activation |
L'objet d'activation aura trois attributs, "bound" pour indiquer si l'authentificateur est lié à un dispositif spécifique, "activationsCount" pour indiquer le nombre d'activations. "lastActivated" pour afficher l'horodatage de la dernière activation de l'authentificateur. "locationsCount" pour indiquer le nombre de lieux d'activation. | Type : liste JSON Exemple : voir les données utiles de la réponse ci-dessus |
assignedUserID* | L'utilisateur auquel est attribué cet authentifiant. | Type : chaîne de caractères Exemple : "iaa_user1" |
type d'authentificateur | Le type de l'authentificateur. | Type : chaîne de caractères Exemple : "DAL10" |
Dans ce blog, nous avons illustré comment utiliser le point de terminaison Authenticators Query et modifier ses paramètres pour filtrer les authentificateurs disponibles 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 Authenticators :
- Authentificateurs Affectation Point de terminaison
- Authentificateurs Désaffectation du point de terminaison