Développeur OneSpan : Méthode de correction des mises à jour de l'utilisateur

Hakim Aldaoub, février 16, 2021

Dans toute institution, les profils des utilisateurs peuvent nécessiter des modifications pour une ou plusieurs raisons. Il peut s'agir de l'adresse postale de l'utilisateur, de son numéro de téléphone ou simplement de ses préférences. La fonction de mise à jour est l'une des opérations CRUD, et elle est essentielle aux applications centrées sur l'utilisateur. OneSpan Intelligent Adaptive Authentication (IAA ) fournit le point de terminaison de mise à jour de l'utilisateur pour modifier les propriétés du compte de l'utilisateur par le biais de l'API interactive de l'Environnement de test. Aujourd'hui, nous allons expliquer comment mettre à jour un ou plusieurs champs dans un profil d'utilisateur à l'aide d'un seul appel RESTful.

Avant de commencer

Avant d'explorer comment mettre à jour un profil utilisateur, 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.

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/users/{[email protected]}

Vous n'aurez pas besoin de fournir cette URL pendant le tutoriel. Nous l'avons inclus ici uniquement à titre d'exemple de la structure de l'URL. L'URL de votre demande réelle sera automatiquement attribuée dans l'API interactive lors de l'appel du service web.

Essayez-le

Afin d'expérimenter l'API de validation des événements, accédez au document IAA Sandbox Interactive API dans 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 Patch HTTP de mise à jour des utilisateurs, comme le montre l'image ci-dessous :

OneSpan-BlogImage [UserUpdatePatchMethod]1.png

Paramètres du chemin URL :

Aux fins de l'appel de patch de mise à jour de cet utilisateur, un paramètre de chemin d'accès est requis pour l'identifiant unique de l'utilisateur. Le paramètre du chemin d'accès est formaté comme suit : [email protected], qui comprend l'identifiant de l'utilisateur qui a été activé sur le dispositif de confiance ainsi que le domaine de l'utilisateur suivant le signe "@". Remplacez le domaine de l'utilisateur par la chaîne "Sandbox User" indiquée ci-dessous. Vous trouverez cette chaîne dans la section des détails de votre Sandbox, sous l'onglet "Intelligent Adaptive Authentication" de la page d'accueil de votre Sandbox.

OneSpan-BlogImage [UserUpdatePatchMethod]2

Corps de la demande de mise à jour des utilisateurs

Le corps de la requête ressemblera à l'exemple ci-dessous. Notez qu'il pourrait s'agir d'une seule des lignes ci-dessous pour mettre à jour le champ spécifié pour le compte utilisateur spécifié par ID dans le paramètre path.

{ "emailAddress" : "[email protected]", "enabled" : true, "mdcProfile" : "EUROPE", "mobilePhoneNumber" : "+1 (508) 366 3437", "phoneNumber" : "+1 (508) 366 3437", "staticPassword" : "TestABCD", "vdpDeliveryMethod" : "Email" }

Charge utile de la demande

Remarque : il n'y a pas de champs obligatoires dans les données utiles JSON, car l'objectif du point de terminaison est de mettre à jour un ou plusieurs champs selon les besoins de l'application appelante.

Vous trouverez ci-dessous une liste des champs qui peuvent être mis à jour à l'aide du point de terminaison :

Champs de données obligatoires JSON Description Champ Type de données
adresse électronique L'adresse e-mail à mettre à jour pour l'utilisateur final.

Type : string
maxLength : 64
Exemple : "[email protected]"

activé Ce champ permet de déterminer si le compte de l'utilisateur final sera activé ou désactivé. En attribuant True, le compte sera activé et false, désactivé. Type : booléen
Exemple : Vrai
mdcProfile Le profil spécifique du composant de livraison de messages pour les messages Digipass virtuels pour un utilisateur spécifique. Il a la priorité sur le profil MDC spécifié dans la stratégie utilisateur. Type : string
maxLength : 100
exemple : EUROPE
numéro de téléphone mobile Le numéro de téléphone mobile de l'utilisateur final. Type : chaîne de caractères
Modèle : ^[\+\-\(\)0-9 ]{0,20}$
Longueur maximale : 64
Exemple : "+1 (508) 366 3437&quot
numéro de téléphone Le numéro de téléphone de l'utilisateur final. Type : chaîne de caractères
Modèle : ^[\+\-\(\)0-9 ]{0,20}$
Longueur maximale : 64
Exemple : "+1 (508) 366 3437&quot
staticPassword Le mot de passe statique de l'utilisateur. Type : String
MinLength : 8
MaxLength : 255
Exemple : TestABCD
vdpDeliveryMethod Le mode de livraison pour l'envoi du Digipass virtuel. Il peut s'agir d'un courriel, d'un SMS ou d'un message vocal.
 
Type : String
Exemple : Email

 

Appeler le point de terminaison

Nous sommes maintenant prêts à effectuer un appel RESTful pour mettre à jour le profil de l'utilisateur à l'aide de l'API de l'Environnement de test interactif 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 PATCH. 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 la réponse renvoyée avec un code de réponse 200 qui indique que la demande a abouti.

{ "created" : "2021-02-11T02:02:54Z", "domain" : "osiaa4-mailinator", "enabled" : true, "isPasswordSet" : true, "lastModified" : "2021-02-11T03:17:16Z", "lastPasswordUpdate" : "2021-02-11T02:02:54Z", "locked" : false, "mdcProfile" : "EUROPE", "userID" : "iaaend1", "vdpDeliveryMethod" : "SMS", "authenticators" : [ "VDS0058266", "VDS0058266-2", "VDS0058266-1" ], "emailAddress" : "[email protected]", "mobilePhoneNumber" : "+1 (508) 366 3437", "phoneNumber" : "+1 (508) 366 3437" }

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
créé * L'horodatage de la création du compte utilisateur.

Type : chaîne de caractères
Exemple : "2021-02-11T02:02:54Z"

domaine * Le domaine dans lequel réside le compte utilisateur à mettre à jour. Type : string
minLength : 1
maxLength : 255
exemple : ospanuser-mail
activé * Le champ qui spécifie si le compte utilisateur est activé ou non. Type : booléen
exemple : vrai
isPasswordSet * Le champ qui spécifie si le compte utilisateur a un mot de passe statique défini ou non. Type : booléen
exemple : vrai
lastModified* L'horodatage de la dernière modification de l'authentificateur. Type : chaîne de caractères
Exemple : 2019-02-04T11:42:39Z
dernière mise à jour du mot de passe L'horodatage de la dernière mise à jour du mot de passe statique par l'administrateur ou l'utilisateur final. Type : chaîne de caractères
Exemple : 2019-02-04T11:42:39Z
Verrouillé* Ce champ indique si le compte utilisateur est créé dans un état verrouillé ou non.
 
Type : booléen
exemple : vrai
mdcProfile* Le profil du MDC (Message Delivery Component) pour l'envoi de l'OTP virtuel.
 
Type : chaîne de caractères
exemple : Europe
Identifiant de l'utilisateur L'ID utilisateur auquel l'authentificateur est attribué.
 
Type : chaîne de caractères
Exemple : " iaa_user1 "
vdpDeliveryMethod* (méthode de livraison) Le mode de livraison préféré pour l'envoi de l'OTP virtuel.
 
Type : chaîne de caractères
Exemple : "SMS"

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 utilisateur est mis à jour.
400 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 utilisateur n'a pas pu être mis à jour.
500 Erreur interne, défaillance du service secondaire, panne du serveur.

Aujourd'hui, nous avons vu comment mettre à jour une ou plusieurs propriétés d'un profil d'utilisateur existant. Nous avons également expliqué comment effectuer cette demande à l'aide de l'API interactive OneSpan. Si vous avez des questions, n'hésitez pas à les poser sur les forums du portail communautaire OneSpan.

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

 

OneSpan Sign Developer Community

OneSpan Sign Developer Community

Rejoignez la communauté OneSpan Sign Developer! Forums, blogs, documentation, téléchargements SDK, et plus encore.

Joignez-vous aujourd'hui