Questa API aiuta nella creazione degli account degli utenti di Active Directory dalla tua applicazione.
Formato dell'URL della richiesta (JSON): http://<hostname>:<port>/RestAPI/CreateUser
Parametri della richiesta
| Nome del parametro | Obbligatorio | Descrizione |
| AuthToken | Sì | Token di autenticazione ottenuto utilizzando l'API di generazione dell'AuthToken. |
| domainName | Sì | Dominio in cui l'oggetto utente deve essere creato |
| inputFormat | Sì | Dettagli degli attributi degli account utente da creare. L'attributo deve essere una stringa JSONArray e deve essere nel formato indicato di seguito. [>, <JSONObject>, <JSONObject>]; JSONObject - coppia di chiavi/valori degli attributi LDAP e dei valori corrispondenti Esempio di codice 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); Nota: Se l'attributo "templateName" non viene incluso nella coppia di chiavi/valori, viene utilizzato per il tecnico il modello predefinito assegnato di creazione degli utenti. |
| PRODUCT_NAME | Sì | Nome del prodotto/nome del modulo da cui la richiesta viene inviata; necessario per il controllo. |
Risposta:
La risposta sarà una stringa matrice JSON che contiene l'elenco degli JSONObject. Ogni JSONObject nell'elenco rappresenta un utente inviato nell'attributo inputFormat nella richiesta. Ogni oggetto contiene le seguenti proprietà relative allo stato.
| Nome del parametro | Descrizione |
| status | Stato delle operazioni di creazione degli utenti: "SUCCESS" in caso di creazione avvenuta correttamente. "SEVERE" se si è verificato un errore. |
| statusMessage | Contiene il messaggio sui problemi o errori che si verificano effettuando l'azione indicata. |
| LOG_ON_NAME | Nome di accesso dell'account utente creato. È presente solo se l'operazione di creazione dell'utente avviene correttamente. |
| USER_NAME | Nome utente dell'account utente creato. È presente solo se l'operazione di creazione dell'utente avviene correttamente. |
| USER_PASSWORD | Password dell'account utente creato, in solo testo. È presente solo se l'operazione di creazione dell'utente avviene correttamente. |
Ingresso/uscita di esempio
Richiesta:
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"}]
Richiesta:
[{"status":"SUCCESS","LOG_ON_NAME":"ByronTest","USER_NAME":"ByronTest","USER_P ASSWORD":"Test@123","statusMessage":"Successfully created the user."}]
Autorizzazione:
Quando i tecnici inviano richieste API, la loro autorizzazione viene applicata a queste richieste. Se un tecnico non ha l'autorizzazione per la creazione degli utenti, il tecnico non può creare gli account utente utilizzando neanche l'API.
Limite di creazione degli utenti in base al tecnico.
Il numero totale di account utente che possono essere creati in un giorno utilizzando l'API CreateUser dipende dal numero totale di tecnici del servizio di assistenza con licenza (HDT).
Il numero massimo di chiamate API che un HDT può effettuare è di 50/giorno, indipendentemente dalle attività che l'HDT effettua. Se hai due licenze HDT, il numero totale di chiamate API che puoi effettuare è 100/giorno, che è 2*50.
Dato che il limite di API al giorno non dipende dalla specifica attività, puoi effettuare qualsiasi operazione, ma il numero totale di chiamate API non può superare 100. Un HDT può effettuare diverse operazioni come la creazione degli utenti, la reimpostazione delle password, ecc. ma il numero di chiamate API per tutte le attività messe insieme non può superare 100.
NOTA:
I caratteri riservati includono ; / ? : @ = &
I caratteri non sicuri includono < > # % { } | \ ^ ~ [ ] ` "'