Skip to main content

Leader del gruppo 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 notifica

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

Parametri

Per creare un nuovo gruppo di utenti, specificare il parametro del contratto:

  • updateWorkflowContract  (corpo): obbligatorio. Specificare i parametri per un gruppo di utenti:

    • name  (stringa): obbligatorio. Immetti il Nome gruppo per le notifiche.

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

Rimuovi un utente da un gruppo di utenti

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

Parametri

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

  • workflowCredentialType (stringa): obbligatorio. Immettere l'ID del gruppo di utenti a cui si desidera aggiungere gli utenti.

  • ID utente (corpo): Obbligatorio. Immettere gli ID utente che si desidera aggiungere a questo gruppo di utenti.

Esempio di richiesta: cURL

da aggiungere

Ottieni tutti i gruppi di utenti personalizzati

Per cercare gli utenti, utilizzare l' {baseURL} endpoint GET /v3/usergroups. Utilizzare vari parametri come filtro per la ricerca degli utenti.

Nota

Verranno recuperati solo i gruppi di utenti personalizzati. Nessun gruppo Active Directory verrà restituito.

Parametri

Nessun parametro richiesto.

Esempio di richiesta: cURL

Curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Cercare un gruppo di utenti specifico

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

Nota

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID gruppo utenti per recuperare le informazioni relative a questo gruppo di utenti.

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Crea un Gruppo utenti -

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID gruppo utenti per aggiornare questo gruppo utenti.

  • Contratto (corpo): Obbligatorio. Per aggiornare un gruppo di utenti, il parametro del contratto è obbligatorio. Specificare quanto segue:

    • name  (stringa): obbligatorio. Immetti il Nome gruppo per le notifiche.

    • 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, utilizzare il COMANDO DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId} endpoint.

Nota

Se l'utente non fa parte del gruppo, verrà restituita una risposta OK.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere l'ID del gruppo di utenti da cui si desidera rimuovere l'utente.

  • workflowCredentialType (stringa): obbligatorio. Immettere l'ID utente che si desidera rimuovere dal gruppo di utenti.

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Crea un Gruppo utenti -

Per eliminare un gruppo utente specifico dal sistema, utilizzare l' {baseURL}{id} endpoint DELETE /v3/usergroups/.

Nota

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere l'ID del gruppo di utenti che si desidera eliminare.

  • hasPrivateDataExemption  (booleano): opzionale. Se impostato su True, il gruppo utenti verrà eliminato anche se questo gruppo contiene utenti.

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relazioni tra oggetti

Se stai caricando un flusso di lavoro, puoi utilizzare gli oggetti creati nel modo seguente:

Oggetto creato: " workflowId " (ad esempio, "id": "7917969784f84bd09442f66996ecb8f3")

Puoi utilizzarlo come:

Esempi di richiesta Postman

POST /v3/usergroups

Example of a POST request in Postman.

ELIMINARE /v3/gruppi utenti/{userGroupId}/utenti/{userId}

Example of a DELETE request in Postman.

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