Diese API unterstützt Sie dabei, Benutzerkonten im Active Directory direkt aus Ihrer Anwendung heraus zu erzeugen.
Request URL (JSON) Format: http://
Anfrageparameter
| Parametername | Erforderlich | Description |
| Authentifizierungstoken | Ja | Authentifizierungstoken aus AuthToken-erzeugen-API. |
| domainName | Ja | Domäne, in der das Benutzerobjekt erstellt werden muss |
| inputFormat | Ja | Details zu den zu erstellenden Benutzerkontenattributen. Dieses Attribut sollte ein JSONArray-String im untenstehenden Format sein. [>, <JSONObject>, <JSONObject>]; JSONObject - key/value pair of LDAP attributes and their corresponding values Beispielcode in Java: JSONArray 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); Hinweis: Ist das Attribut „templateName“ nicht im Schlüssel-Wert-Paar enthalten, wird die Standardvorlage zur Benutzererzeugung für Techniker verwendet. |
| PRODUCT_NAME | Ja | Produkt- bzw. Modulname, von dem aus die Anfrage gesendet wird; benötigt fürs Auditing. |
Reaktion:
Die Reaktion erfolgt als JSON-Array-String mit Auflistung der JSONObjects. Jedes JSONObject der Liste steht für einen Benutzer, der im Attribut „inputFormat“ in der Anfrage gesendet wurde. Jedes Objekt enthält folgende Eigenschaften zum Status.
| Parametername | Description |
| status | Status der Benutzererzeugungsaktion: ‚SUCCESS‘ bei erfolgreicher Erzeugung. ‚SEVERE‘ bei Fehlern. |
| statusMessage | Enthält eine Mitteilung zu Problemen und Fehlern, die bei der Aktion aufgetreten sind. |
| LOG_ON_NAME | Anmeldename des erstellten Benutzerkontos. Nur bei erfolgreicher Benutzererstellung vorhanden. |
| USER_NAME | Benutzername des erstellten Benutzerkontos. Nur bei erfolgreicher Benutzererstellung vorhanden. |
| USER_PASSWORD | Passwort des erstellten Benutzerkontos in Reintext. Nur bei erfolgreicher Benutzererstellung vorhanden. |
Beispieleingabe/-ausgabe
Anfrage:
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"}]
Reaktion:
[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_PASSWORD":"Test@123","statusMessage":"Successfully created the user."}]
Autorisierung:
Beim Senden von API-Anfragen wird die Autorisierung des sendenden Technikers verwendet. Hat also ein Techniker keine Berechtigung zur Erstellung von Benutzern, ist ihm dies auch nicht mittels API möglich.
Technikerbasiertes Benutzererzeugungslimit.
Die Gesamtzahl der täglich mittels CreateUser-API erzeugbaren Benutzerkonten hängt von der Gesamtzahl der lizensierten Helpdesk-Techniker (HDT) ab.
HDT können unabhängig von den konkreten HDT-Aufgaben maximal 50 API-Aufrufe täglich machen. Bei zwei HDT-Lizenzen beträgt die Gesamtzahl der API-Aufrufe entsprechend 100, also 2x50.
Da das tägliche API-Aufruflimit aufgabenunabhängig ist, sind jegliche Aktionen möglich, jedoch nur 100 pro Tag. HDT können also verschiedenste Aktionen ausführen, beispielsweise Benutzer erzeugen, OE erzeugen, Passwörter zurücksetzen, doch insgesamt können zwei HDT höchstens 100 Mal die API aufrufen.
HINWEIS:
Zu geschützten Zeichen zählen ; / ? : @ = &
Zu unsicheren Zeichen zählen < > # % { } | \ ^ ~ [ ] ` "