Ten interfejs API pomaga w tworzeniu kont użytkowników w usłudze Active Directory z poziomu aplikacji.
Format adresu URL zgłoszenia (JSON): http://<hostname>:<port>/RestAPI/CreateUser
Parametry zgłoszenia
| Nazwa parametru | Obowiązkowe | Opis |
| AuthToken | Tak | Token uwierzytelniania uzyskany za pomocą interfejsu API Generuj token uwierzytelniania. |
| domainName | Tak | Domena, w której należy utworzyć obiekt użytkownika |
| inputFormat | Tak | Szczegóły atrybutów kont użytkowników, które mają zostać utworzone. Ten atrybut powinien być ciągiem tablicy JSONArray i powinien być w formacie podanym poniżej.[>, [>, <JSONObject>, <JSONObject>]; — para klucz-wartość atrybutów LDAP i odpowiadających im wartości Przykładowy kod w 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); Uwaga: : Jeśli atrybut „templateName” nie jest zawarty w parze klucz-wartość, zostanie użyty domyślny szablon tworzenia użytkowników przypisany do technika. |
| PRODUCT_NAME | Tak | Nazwa produktu/modułu, z którego jest wysyłane zgłoszenie; będzie ona potrzebna do audytu. |
Odpowiedź:
Odpowiedź będzie ciągiem tablicy JSON, który zawiera listę obiektów JSONObject. Każdy obiekt JSONObject na liście reprezentuje użytkownika wysłanego w atrybucie inputFormat w zgłoszeniu. Każdy obiekt będzie zawierał następujące właściwości dotyczące statusu.
| Nazwa parametru | Opis |
| status | Status operacji tworzenia użytkownika: „SUKCES” w przypadku udanego tworzenia. „POWAŻNY BŁĄD”, jeśli wystąpił błąd. |
| statusMessage | Zawiera komunikat o problemach lub błędach występujących podczas wykonywania określonej czynności. |
| LOG_ON_NAME | Nazwa logowania utworzonego konta użytkownika. Występuje tylko wtedy, gdy operacja tworzenia użytkownika zakończy się powodzeniem. |
| USER_NAME | Nazwa użytkownika utworzonego konta użytkownika. Występuje tylko wtedy, gdy operacja tworzenia użytkownika zakończy się powodzeniem. |
| USER_PASSWORD | Hasło utworzonego konta użytkownika, w postaci zwykłego tekstu. Występuje tylko wtedy, gdy operacja tworzenia użytkownika zakończy się powodzeniem. |
Wejście/wyjście próbki
Żądanie:
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"}]
Odpowiedź:
[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_P ASSWORD":"Test@123","statusMessage":"Successfully created the user."}]
Autoryzacja:
Kiedy technicy wysyłają zgłoszenia interfejsu API, ich autoryzacja zostanie zastosowana do tych zgłoszeń. Oznacza to, że jeśli technik nie ma autoryzacji do tworzenia użytkownika, nie może on również tworzyć kont użytkowników za pomocą interfejsu API.
Limit tworzenia użytkowników na podstawie liczby techników.
Całkowita liczba kont użytkowników, które można utworzyć w ciągu dnia za pomocą interfejsu API Utwórz użytkownika zależy od całkowitej liczby licencjonowanych techników działu pomocy technicznej (HDT).
Maksymalna liczba wywołań interfejsu API, które może wykonać technik HDT wynosi 50/dzień, niezależnie od wykonywanych przez niego zadań. Jeśli masz dwie licencje techników HDT, to łączna liczba wywołań interfejsu API, które możesz wykonać, wynosi 100/dzień, czyli 2*50.
Ponieważ dzienny limit wywołań interfejsu API nie zależy od wykonywanych zadań, możesz wykonać dowolną operację, ale całkowita liczba wywołań nie może przekroczyć 100. Oznacza to, że technik HDT może wykonywać różne operacje, takie jak tworzenie użytkowników, tworzenie jednostek organizacyjnych, resetowanie haseł itp., ale liczba wywołań interfejsu API dla wszystkich zadań razem wziętych nie może przekraczać 100.
UWAGA:
Znaki zastrzeżone obejmują ; / ? : @ = &
Znaki niepewne obejmują < > # % { } | \ ^ ~ [ ] ` "'
Your download is in progress and it will be completed in just a few seconds!
If you face any issues, download manually here