Skip to main content

Endpoint dei gruppi di utenti

Endpoint e parametri dei gruppi di utenti di Server

Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti .

Per ulteriori informazioni sui gruppi di utenti di Server, consulta la pagina di assistenza Gestione di utenti e gruppi di utenti .

Creazione di un nuovo gruppo di utenti di Server

Per creare un nuovo gruppo di utenti di Server, utilizza l'endpoint POST {baseURL}/v3/usergroups .

Parametri

Per creare un nuovo gruppo di utenti di Server, specifica il parametro contract:

  • contract (corpo): obbligatorio. Specifica i parametri per un gruppo di utenti di Server:

    • name  (stringa): obbligatorio. Immetti il nome di un gruppo di utenti di Server.

    • role (stringa): obbligatorio. Immetti un ruolo per il gruppo di utenti di Server. 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 di Server

Per aggiungere uno o più utenti a un gruppo di utenti di Server, utilizza l'endpoint POST {baseURL}/v3/usergroups/{id}/users .

Parametri

Per aggiungere utenti a un gruppo di utenti di Server, specifica i seguenti parametri:

  • id (stringa): obbligatorio. Immetti l'ID del gruppo di utenti di Server a cui desideri aggiungere gli utenti.

  • userIds (corpo): obbligatorio. Immetti gli ID degli utenti che desideri aggiungere al gruppo di utenti di Server.

Aggiunta di un gruppo Active Directory come membro di un gruppo di utenti di Server

Per aggiungere un gruppo Active Directory come membro di un gruppo di utenti di Server, utilizza l'endpoint POST /v3/usergroups/{id}/activedirectorygroups .

Nota

Questo endpoint può essere utilizzato solo per le istanze di Server configurate con l'autenticazione di Windows.

Parametri

  • id (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti di Server esistente a cui desideri aggiungere un gruppo Active Directory.

  • sid (stringa): obbligatorio. Immetti l'ID di sicurezza (SID) del gruppo Active Directory. È necessario indicare il valore tra virgolette, ad esempio "S-My-SID".

Recupero di tutti i gruppi di utenti di Server

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 di Server. 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 di Server specifico

Per recuperare informazioni su un gruppo di utenti di Server specifico, utilizza l'endpoint GET {baseURL}/v3/usergroups/{id} .

Nota

Funziona solo per i gruppi di utenti di Server. I gruppi Active Directory non possono essere recuperati da questo endpoint.

Parametri

  • id (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti di Server 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 di Server

Per aggiornare il nome e il ruolo di un gruppo di utenti di Server esistente, utilizza l'endpoint PUT {baseURL}/v3/usergroups/{id} .

Parametri

  • id (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti di Server da aggiornare.

  • contract (corpo): obbligatorio. Il parametro contract è obbligatorio per aggiornare un gruppo di utenti di Server. Specifica quanto segue:

    • name  (stringa): obbligatorio. Immetti il nome di un gruppo di utenti di Server.

    • 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'

Rimozione di un utente da un gruppo di utenti di Server

Per rimuovere un utente specifico da un gruppo di utenti di Server, 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 di Server da cui desideri rimuovere l'utente.

  • userId (stringa): obbligatorio. Immetti l'ID dell'utente che desideri rimuovere dal gruppo di utenti di Server.

Esempio di richiesta: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Esclusione di un gruppo Active Directory da un gruppo di utenti di Server

Per escludere un gruppo Active Directory da un gruppo di utenti di Server, utilizza l'endpoint DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid} .

Nota

Questo endpoint può essere utilizzato solo per le istanze di Server configurate con l'autenticazione di Windows.

Parametri

  • userGroupId (stringa): obbligatorio. Immetti l'ID del gruppo di utenti di Server da cui desideri rimuovere il gruppo Active Directory.

  • adGroupSid (stringa): obbligatorio. Immetti l'ID di sicurezza (SID) del gruppo Active Directory che desideri rimuovere dal gruppo di utenti di Server.

Eliminazione di un gruppo di utenti di Server

Per eliminare un determinato gruppo di utenti di Server dal sistema, utilizza l'endpoint DELETE {baseURL}/v3/usergroups/{id} .

Nota

Il messaggio di errore "400 Richiesta non valida" viene visualizzato se il gruppo di utenti di Server non è vuoto e il parametro di query forceDelete è false.

Parametri

  • id (stringa): obbligatorio. Immetti l'ID del gruppo di utenti di Server che desideri eliminare.

  • forceDelete  (booleano): opzionale. Se è impostato su true, il gruppo di utenti di Server 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 di Server, puoi utilizzare gli oggetti creati nel modo seguente:

Oggetto creato: " id " (ad esempio, "id": "619158e57e607d0011ac3009")

Puoi utilizzarlo come:

Esempi di richiesta Postman

POST /v3/usergroups

Example of a POST request in Postman.

DELETE /v3/usergroups/{userGroupId}/users/{userId}

Example of a DELETE request in Postman.

Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman .