Endpoint dei gruppi di utenti
Endpoint e parametri dei gruppi di utenti
Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti .
Per ulteriori informazioni sui gruppi personalizzati, consulta la pagina di assistenza Gestione di utenti e gruppi .
Creazione di un nuovo gruppo di utenti
Per creare un nuovo record userGroup, utilizza l'endpoint
POST {baseURL}/v3/usergroups
.
Parametri
Per creare un nuovo gruppo di utenti, specifica il parametro contract:
contract (corpo): obbligatorio. Specifica i parametri per un gruppo di utenti:
name (stringa): obbligatorio. Immetti il nome di un gruppo di utenti.
role (stringa): obbligatorio. Immetti un ruolo per il gruppo di utenti. Seleziona una delle seguenti opzioni: NoAccess (Nessun accesso), Viewer (Visualizzatore), Member (Membro), Artisan (Creatore), Curator (Amministratore) e Evaluated (Valutato). Il ruolo predefinito, Evaluated (Valutato), viene valutato in fase di runtime. Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni .
Esempio di richiesta: cURL
curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
Aggiunta di un utente a un gruppo di utenti
Per aggiungere uno o più utenti a un gruppo di utenti, utilizza l'endpoint
POST {baseURL}/v3/usergroups/{id}/users
.
Parametri
Per aggiungere utenti a un gruppo di utenti, specifica i seguenti parametri:
id (stringa): obbligatorio. Immetti l'ID del gruppo di utenti a cui desideri aggiungere gli utenti.
userIds (corpo): obbligatorio. Immetti gli ID degli utenti che desideri aggiungere al gruppo di utenti.
Esempio di richiesta: cURL
Da aggiungere.
Recupero di tutti i gruppi di utenti personalizzati
Per cercare gli utenti, utilizza l'endpoint
GET {baseURL}/v3/usergroups
. Utilizza vari parametri come filtro per la ricerca degli utenti.
Nota
Verranno recuperati solo i gruppi di utenti personalizzati. Non verrà restituito nessun gruppo Active Directory.
Parametri
Nessun parametro richiesto.
Esempio di richiesta: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Ricerca di un gruppo di utenti specifico
Per recuperare informazioni su un gruppo di utenti specifico, utilizza l'endpoint
GET {baseURL}/v3/usergroups/{id}
.
Nota
Funziona solo per i gruppi di utenti personalizzati. I gruppi Active Directory non possono essere recuperati da questo endpoint.
Parametri
id (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti di cui desideri recuperare le informazioni.
Esempio di richiesta: cURL
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Aggiornamento di un gruppo di utenti
Per aggiornare il nome e il ruolo di un gruppo di utenti esistente, utilizza l'endpoint
PUT {baseURL}/v3/usergroups/{id}
.
Parametri
id (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti da aggiornare.
contract (corpo): obbligatorio. Il parametro contract è obbligatorio per aggiornare un gruppo di utenti. Specifica quanto segue:
name (stringa): obbligatorio. Immetti il nome di un gruppo di utenti.
role (stringa): obbligatorio. È possibile selezionare le seguenti opzioni: NoAccess (Nessun accesso), Viewer (Visualizzatore), Member (Membro), Artisan (Creatore), Curator (Amministratore) e Evaluated (Valutato). Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni .
Esempio di richiesta: cURL
curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
Rimuovi un utente da un gruppo di utenti
Per rimuovere un utente specifico da un gruppo di utenti, utilizza l'endpoint
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Nota
Se l'utente non fa parte del gruppo, viene restituita una risposta OK.
Parametri
userGroupId (stringa): obbligatorio. Immetti l'ID del gruppo di utenti da cui desideri rimuovere l'utente.
userId (stringa): obbligatorio. Immetti l'ID dell'utente che desideri rimuovere dal gruppo di utenti.
Esempio di richiesta: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Eliminazione di un gruppo di utenti
Per eliminare un determinato gruppo di utenti dal sistema, utilizza l'endpoint
DELETE {baseURL}/v3/usergroups/{id}
.
Nota
Viene restituito il messaggio di errore "400 Richiesta non valida" se il gruppo di utenti non è vuoto e il parametro di query forceDelete è false.
Parametri
id (stringa): obbligatorio. Immetti l'ID del gruppo di utenti che desideri eliminare.
forceDelete (booleano): opzionale. Se è impostato su true, il gruppo di utenti verrà eliminato anche se non è vuoto.
Esempio di richiesta: cURL
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relazioni tra oggetti
Se stai creando un gruppo di utenti, puoi utilizzare gli oggetti creati nel modo seguente:
Oggetto creato: " id " (ad esempio, "id": "619158e57e607d0011ac3009")
Puoi utilizzarlo come:
userGroupId se stai aggiungendo un gruppo di utenti a una raccolta .
userGroupId se stai aggiornando le autorizzazioni del gruppo di utenti di una raccolta .
userGroupId se stai rimuovendo un gruppo di utenti da una raccolta .
userGroupId se desideri condividere una credenziale con un gruppo di utenti .
userGroupId se desideri rimuovere un gruppo di utenti da una credenziale .
userGroupId se desideri aggiungere un gruppo di utenti a una connessione dati .
userGroupId se desideri rimuovere un gruppo di utenti da una connessione dati .
Esempi di richiesta Postman
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman .