L'API ti permette di disabilitare qualsiasi account utente nel tuo Active Directory.
Formato dell'URL (JSON) della richiesta: http://<hostname>:<port>/RestAPI/DisableUser
Parametri della richiesta:
| Nome del parametro | Obbligatorio | Descrizione |
| PRODUCT_NAME | Sì | Nome del prodotto/nome del modulo da cui la richiesta viene inviata; necessario per il controllo. |
| AuthToken | Sì | Token di autenticazione ottenuto utilizzando l'API di generazione dell'AuthToken. |
| domainName | Sì | Nome del dominio degli account utente. |
| inputFormat | Sì | Dettagli di ogni account utente da disabilitare. Questo attributo deve essere una stringa JSONArray e deve essere nel formato indicato più in basso. [<JSONObject>, <JSONObject>, <JSONObject>]; JSONObject - coppia chiave/valore degli attributi ldap e i valori Codice di esempio in java: JSONArray userDetails = new JSONArray(); JSONObject json = new JSONObject(); json.put("sAMAccountName", "John"); userDetails.put(json); json = new JSONObject(); json.put("sAMAccountName", "Mat"); userDetails.put(json); NOTA: Puoi indicare uno qualsiasi dei seguenti attributi come criterio di ricerca per individuare gli oggetti utente utilizzando le richieste API REST:
|
Risposta:
La risposta sarà una stringa JSONArray che contiene l'elenco degli JSONObject. Ogni JSONObject nell'elenco rappresenta un account utente inviato come parametro inputFormat nella richiesta. Ogni oggetto contiene le seguenti proprietà.
| Nome del parametro | Descrizione |
| userPrincipalName | userPrincipalName dell'utente. |
| sAMAccountName | sAMAccountName dell'utente. |
| objectSID | objectSID dell'utente. |
| statusMessage | Contiene il messaggio appropriato se si verifica un problema/errore nell'elaborazione della richiesta. |
Ingresso/uscita di esempio
Richiesta
http://Byron:8080/RestAPI/DisableUser?AuthToken=a70d9e6c-4167-4de4-a6a1-3b3aff50c82e&PRODUCT_NAME=MODULE_NAME&domainName=admanagerplus.com&inputFormat=[{"sAMAccountName":"colin.altonen"}]
Risposta:
[{"userPrincipalName":"colin.altonen@admanagerplus.com","sAMAccountName":"colin.altonen","objectSID":"S-1-5-21-2996321955-1937665885-1535019402-3881","statusMessage":"Successfully modified."}]
Limite di disabilitazione degli utenti in base al tecnico
Il numero totale di account utente che i tecnici possono disabilitare in un giorno utilizzando l'API 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 < > # % { } | \ ^ ~ [ ] ` "'