Cette API permet de créer un compte utilisateur dans Active Directory à partir de votre application.
Format de l’URL de la demande (JSON) : http://<hostname>:<port>/RestAPI/CreateUser
Paramètres de la demande
| Nom du paramètre | Obligatoire | Description |
| AuthToken | Oui | Jeton d'authentification obtenu à l'aide de l'API « Generate AuthToken ». |
| domainName | Oui | Domaine dans lequel l'objet utilisateur doit être créé |
| inputFormat | Oui | Détails des attributs des comptes utilisateurs à créer. Cet attribut doit être une chaîne JSONArray et doit avoir le format mentionné ci-dessous. [>, <JSONObject>, <JSONObject>] ; JSONObject - paire clé/valeur d'attributs LDAP et leurs valeurs correspondantes Exemple de code en java :JSO NArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("givenName", "John"); json.put("initials", "mat"); json.put("sn", "Martin"); json.put("password", "Martin@12"); json.put("templateName", "User Creation Template"); userDetails.put(json); json = new JSONObject(); json.put("givenName", "Damien"); json.put("initials", "S"); json.put("sn", "David"); json.put("password", "Test@123"); json.put("templateName", "User Creation Template"); userDetails.put(json); Remarque: i l'attribut « templateName » n'est pas inclus dans la paire clé/valeur, le modèle de création d'utilisateur par défaut attribué au technicien sera utilisé. |
| PRODUCT_NAME | Oui | Nom du produit/module à partir duquel la demande est envoyée ; nécessaire pour l'audit. |
Réponse:
La réponse est une chaîne de tableau JSON contenant la liste des JSONObjects. Chaque JSONObject de la liste représente un utilisateur envoyé dans l'attribut inputFormat de la requête. Chaque objet contient les propriétés suivantes concernant l'état.
| Nom du paramètre | Description |
| status | Statut de l'opération de création d'un utilisateur : « SUCCESS » pour une création réussie. « SEVERE » en cas d’erreur. |
| statusMessage | Contient le message sur les problèmes ou les erreurs qui se produisent lors de l'exécution de l'action spécifiée. |
| LOG_ON_NAME | Nom de connexion du compte utilisateur créé. Ne sera présent que si l'opération de création de l'utilisateur est réussie. |
| USER_NAME | Nom d'utilisateur du compte d'utilisateur créé. Ne sera présent que si l'opération de création de l'utilisateur est réussie. |
| USER_PASSWORD | Mot de passe du compte utilisateur créé, en texte brut. Ne sera présent que si l'opération de création de l'utilisateur est réussie. |
Entrée / Sortie de l'échantillon
Demande:
http://Byron:8080/RestAPI/CreateUser?domainName=admanagerplus.com&AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e&PRODUCT_NAME=MODULE_NAME&inputFormat=[{"givenName":"ByronTest", "password":"Test@123", "templateName":"User Creation Template"}]
Réponse:
[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_P ASSWORD":"Test@123","statusMessage":"Successfully created the user."}]
Autorisation:
Si les techniciens envoient des demandes d'API, leur autorisation est appliquée à ces demandes. En d'autres termes, si un technicien n'est pas autorisé à créer un utilisateur, il ne peut pas créer non plus de comptes d'utilisateur à l'aide de l'API.
Limite de création d'utilisateurs basée sur les techniciens.
Le nombre total de comptes d'utilisateur qui peuvent être créés en une journée à l'aide de l'API CreateUser dépend du nombre total de techniciens du service d'assistance (HDT) sous licence.
Le nombre maximum d'appels API qu'un HDT peut effectuer est de 50/jour, indépendamment des tâches qu'il effectue. Si vous avez deux licences HDT, le nombre total d'appels API que vous pouvez effectuer est de 100/jour, soit 2*50.
Comme la limite d'appels API par jour n'est pas spécifique à une tâche, vous pouvez effectuer n'importe quelle opération mais le nombre total d'appels API ne doit pas dépasser 100. En d'autres termes, un HDT peut effectuer diverses opérations telles que la création d'un utilisateur, la création d’une UO, la réinitialisation d'un mot de passe, etc., mais le nombre d'appels API pour toutes les tâches réunies ne doit pas dépasser 100.
REMARQUE:
Les caractères réservés incluent ; / ? : @ = &
Les caractères non sûrs incluent < > # % { } | \ ^ ~ [ ] ` "'
Votre téléchargement est en cours et il sera terminé en quelques secondes seulement !
Si vous rencontrez des problèmes, téléchargez manuellement ici