Deze API helpt bij het aanmaken van een gebruikersaccount in Active Directory vanaf uw toepassing.
Aanvraag-URL (JSON)-formaat: http://<hostname>:<port>/RestAPI/CreateUser
Aanvraagparameters
Parameternaam | Verplicht | Beschrijving |
AuthToken | Ja | Verificatietoken verkregen met AuthToken API genereren. |
domainName | Ja | Domein waarin het gebruikersobject moet worden gemaakt |
inputFormat | Ja | Details van de kenmerken van gebruikersaccounts die moeten worden gemaakt. Dit kenmerk moet een JSONArray-tekenreeks zijn en moet in de hieronder vermelde opmaak zijn. [>, <JSONObject>, <JSONObject>]; JSONObject - sleutel/waarde-paar van LDAP-kenmerken en hun overeenkomende waarden Voorbeeldcode 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); Opmerking: Als het kenmerk "templateName" niet is opgenomen in het sleutel/waarde-paar, wordt de standaardsjabloon die aan de technici is toegewezen voor het aanmaken van de gebruiker gebruikt. |
PRODUCT_NAME | Ja | Productnaam/modulenaam van waar de aanvraag wordt verzonden; zal nodig zijn voor de controle. |
Respons:
De respons zal een JSON array-tekenreeks zijn die de lijst van JSONObjects bevat. Elk JSONObject in de lijst staat voor een gebruiker die is verzonden in het inputFormat-kenmerk in de aanvraag. Elk object zal de volgende eigenschappen over de status bevatten.
Parameternaam | Beschrijving |
status | Status van de bewerking voor het aanmaken van de gebruiker: 'GELUKT' als de aanmaak gelukt is. 'ERNSTIG' als er een fout is. |
statusMessage | Bevat het bericht over de problemen of fouten die optreden tijdens het uitvoeren van de opgegeven actie. |
LOG_ON_NAME | Aanmeldingsnaam van de gebruikersaccount aangemaakt. Zal alleen aanwezig zijn als het aanmaken van de gebruiker gelukt is. |
USER_NAME | Gebruikersnaam van de gebruikersaccount aangemaakt. Zal alleen aanwezig zijn als het aanmaken van de gebruiker gelukt is. |
USER_PASSWORD | Wachtwoord van de gebruikersaccount aangemaakt, in platte tekst. Zal alleen aanwezig zijn als het aanmaken van de gebruiker gelukt is. |
Voorbeeld invoer/uitvoer
Aanvraag:
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"}]
Respons:
[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_P ASSWORD":"Test@123","statusMessage":"Successfully created the user."}]
Machtiging:
Wanneer technici API-aanvragen verzenden, wordt hun autorisatie toegepast op die aanvragen. Dit betekent dat, als een gebruiker niet geautoriseerd is om een gebruiker aan te maken, de technicus evenmin gebruikersaccounts kan aanmaken met de API.
Op technicus gebaseerde limiet voor het aanmaken van gebruiker.
Het totale aantal gebruikersaccounts dat per dag kan worden gemaakt met de CreateUser API is afhankelijk van het totale aantal gelicentieerde helpdesktechnici (HDT).
Een HDT kan per dag maximaal 50 API-oproepen uitvoeren, ongeacht de taken die de HDT uitvoert. Als u twee HDT-licenties hebt, is het totale aantal API-oproepen is 2x50, dus 100 per dag.
Omdat de API-oproeplimiet per dag niet taakspecifiek is, kunt u elke bewerking uitvoeren, maar het totale aantal API-oproepen mag niet hoger zijn dan 100. Dit betekent dat een HDT verschillende bewerkingen kan uitvoeren, zoals het aanmaken van gebruikers of OU's, het opnieuw instellen van wachtwoorden enz., maar dat het aantal API-oproepen van alle taken samen niet hoger mag zijn dan 100.
OPMERKING:
Gereserveerde tekens omvatten ; / ? : @ = &
Onveilige tekens omvatten < > # % { } | \ ^ ~ [ ] ` "'
Your download is in progress and it will be completed in just a few seconds!
If you face any issues, download manually here