Skip to main content

Endpoint utente

Endpoint e parametri degli utenti

Per ulteriori informazioni sulle relazioni tra oggetti, consulta la sezione Relazioni tra oggetti .

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

Creazione di un nuovo utente

Per creare un nuovo record utente, utilizza l'endpoint POST {baseURL}/v3/users .

Nota

Solo gli amministratori possono usare questo endpoint API.

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

Parametri

  • userContract (corpo): il parametro userContract è obbligatorio per creare un nuovo utente. Specifica i seguenti parametri:

    • firstName (stringa): obbligatorio. Immetti il nome di un utente.

    • lastName (stringa): obbligatorio. Immetti il cognome di un utente.

    • email (stringa): obbligatorio. Immetti l'indirizzo e-mail di un utente.

    • role (stringa): opzionale. È possibile selezionare le seguenti opzioni: NoAccess (Nessun accesso), Viewer (Visualizzatore), Member (Membro), Artisan (Creatore), Curator (Amministratore) e Evaluated (Valutato). Quest'ultimo è il ruolo predefinito valutato in fase di runtime. Per ulteriori informazioni sui ruoli e sulle autorizzazioni, consulta la pagina Ruoli utente e autorizzazioni . Quando non è selezionato alcun ruolo, il valore predefinito è Evaluated (Valutato).

    • defaultWorkerTag (stringa): opzionale. Specifica il tag worker definito nei worker per facilitare l'assegnazione dei processi a determinati nodi worker. In assenza di una specifica, il valore predefinito è "". Per ulteriori informazioni, consulta la pagina di assistenza Worker.

    • canScheduleJobs (booleano): opzionale. Specifica se l'utente può pianificare i processi. In assenza di una specifica, il valore predefinito è false. Per ulteriori informazioni, consulta la pagina di assistenza Processi .

    • canPrioritizeJobs (booleano): opzionale. Specifica se un utente può assegnare priorità ai processi. In assenza di una specifica, il valore predefinito è false. Per ulteriori informazioni, consulta la pagina di assistenza Processi .

    • canAssignJobs (booleano): opzionale. Specifica se un utente può assegnare i processi. In assenza di una specifica, il valore predefinito è false. Per ulteriori informazioni, consulta la pagina di assistenza Processi .

    • canCreateCollections (booleano): opzionale. Specifica se un utente può creare nuove raccolte. In assenza di una specifica, il valore predefinito è false. Per ulteriori informazioni, consulta la pagina di assistenza Raccolte .

    • isApiEnabled (booleano): opzionale. Specifica se l'API è attivata per un utente. In assenza di una specifica, il valore predefinito è false.

    • defaultCredentialId (stringa): opzionale. Questo parametro si riferisce all'ID univoco di un flusso di lavoro assegnato all'utente per impostazione predefinita. In assenza di una specifica, il valore predefinito è "".

    • isActive (booleano): opzionale. Seleziona se un utente è attivo o inattivo. In assenza di una specifica, il valore predefinito è true.

    • timeZone (stringa): opzionale. Immetti il fuso orario, ad esempio Europe/Kiev. In assenza di una specifica, il valore predefinito è "".

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi/v3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'firstName=John' \ --data-urlencode 'lastName=Doe' \ --data-urlencode 'email=John.Doe@emailexample.com'

Disattivazione di un utente

Per disattivare un utente nel sistema, utilizza l'endpoint POST {baseURL}/v3/users/{userId}/deactivate .

Nota

Solo gli amministratori possono usare questo endpoint API.

In risposta, otterrai una serie di ID di gruppi di utenti da cui l'utente disattivato viene rimosso.

Parametri

  • userId (stringa): obbligatorio. Immetti l'ID di un utente da disattivare.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/deactivate' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Invio di un'e-mail di reimpostazione della password a un utente

Per inviare un'e-mail di reimpostazione della password a un utente esistente, utilizza l'endpoint POST {baseURL}/v3/users/{userId}/passwordReset .

Nota

Solo gli amministratori possono usare questo endpoint API.

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

Parametri

  • userId (stringa): obbligatorio. Immetti l'ID di un utente a cui inviare un'e-mail di reimpostazione.

Esempio di richiesta: cURL

curl --location --request POST 'http://localhost/webapi/v3/users/61d57bea3c15317e1a48205b/passwordReset' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recupero di tutti i record utente

Per recuperare tutti i record utente accessibili, utilizza l'endpoint GET {baseURL}/v3/users . Utilizza vari parametri come filtro.

Nota

Solo gli amministratori possono usare questo endpoint API.

Se searchContract.Verbose è impostato su false, viene restituito un oggetto vista ridotto.

Parametri

  • view  (stringa): opzionale. È possibile non specificare alcun valore o selezionare "Default" e "Full". Se il parametro è impostato su "Default", viene restituito un oggetto vista ridotto. Se non è specificato alcun valore, viene utilizzato "Default".

  • active (booleano): opzionale. Seleziona se un utente è attivo o inattivo.

  • email (stringa): opzionale. Inserisci l'indirizzo e-mail dell'utente.

  • role (stringa): opzionale. Seleziona il ruolo dell'utente per circoscrivere la ricerca. 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 .

  • firstName (stringa): opzionale. Immetti il nome dell'utente.

  • lastName (stringa): opzionale. Immetti il cognome dell'utente.

  • createdAfter (data-ora): opzionale. Immetti la data e l'ora dopo le quali è stato creato l'utente. Immetti la data e l'ora in formato ISO8601 .

  • createdBefore (data-ora): opzionale. Immetti la data e l'ora prima delle quali è stato creato l'utente. Immetti la data e l'ora in formato ISO8601 .

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recupero dei dettagli di un utente specifico

Per recuperare i dettagli di un utente esistente, utilizza l'endpoint GET {baseURL}/v3/users/{userId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • userId (stringa): obbligatorio. Immetti l'ID di un utente di cui recuperare i dettagli.

Esempio di richiesta: cURL

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

Recupero di tutte le risorse di proprietà di un utente

Per ottenere un elenco completo delle risorse accessibili di proprietà di un utente esistente, utilizza l'endpoint GET {baseURL}/v3/users/{userId}/assets .

Nota

Solo gli amministratori possono usare questo endpoint API.

Parametri

  • userId (stringa): obbligatorio. Immetti l'ID di un utente per recuperare il relativo elenco delle risorse.

  • assetType (stringa): opzionale. Seleziona i tipi di risorsa che desideri restituire. L'impostazione predefinita è "Tutte".

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32/assets?assetType=Workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Transfer All Assets a User Owns to Another

To transfer all assets (workflows, schedules, and collections) owned by one user to another, use the PUT {baseURL}/v3/users/{userId}/assetTransfer endpoint.

Nota

  • Only Curators can use this API endpoint.

  • If any of the workflows require DCM connections, Server connections, or specific run as credentials to run, these items need to be updated before the workflow can run.

  • If users are not in the same studio and when a workflow is transferred to the new studio, all other users in the new owner's studio will also receive access to the workflow, and all users from the old studio will lose access.

  • Workflows can only be transferred to a user with the Artisan or Curator role.

  • If transferring schedules, the new owner must have access to the scheduled workflow, otherwise you won’t be able to transfer that workflow to the new owner.

  • If transferring schedules, the new owner must have permission to schedule workflows.

  • If the user is deleted, it returns a list of schedule Ids that will be broken or disabled after transfer.

Parameters

  • userId (string): Required. Id of the user to transfer assets from.

  • contract (body):

    • ownerId (string): Specify the Id of the user to transfer assets to (new owner).

    • transferWorkflows (Boolean): Specify whether the workflows should be transferred to the new owner.

    • transferSchedules (Boolean): Specify whether the schedules should be transferred to the new owner.

    • transferCollections (Boolean): Specify whether the collections should be transferred to the new owner.

Request Example: cURL

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ "ownerId": "63d17f6cb049da66d0afd4e2", \ "transferWorkflows": true, \ "transferSchedules": true, \ "transferCollections": true \ }' 'http://localhost/webapi/v3/users/613a523df9199abfc446d19d/assetTransfer'

Aggiornamento di un utente esistente

Per aggiornare i dettagli di un utente esistente, utilizza l'endpoint PUT {baseURL}/v3/users/{userId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

L'ID di updateContract verrà sovrascritto dal valore ID nell'URL.

Parametri

  • userId (stringa): obbligatorio. Immetti l'ID di un utente da aggiornare.

  • updateContract (corpo): obbligatorio. Il parametro updateContract è obbligatorio per aggiornare un utente. Specifica quanto segue:

    • id (stringa): opzionale. Immetti l'ID di un utente per aggiornarlo.

    • firstName (stringa): obbligatorio. Immetti il nome di un utente.

    • lastName (stringa): obbligatorio. Immetti il cognome di un utente.

    • email (stringa): obbligatorio. Immetti l'indirizzo e-mail di un utente.

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

    • defaultWorkerTag (stringa): obbligatorio. Specifica il tag worker definito nei worker per facilitare l'assegnazione dei processi a determinati nodi worker. Per ulteriori informazioni sui worker, consulta la pagina di assistenza Worker .

    • canScheduleJobs (booleano): obbligatorio. Specifica se un utente può pianificare i processi. Per ulteriori informazioni, consulta la pagina di assistenza Processi .

    • canPrioritizeJobs (booleano): obbligatorio. Specifica se un utente può assegnare priorità ai processi. Per ulteriori informazioni, consulta la pagina di assistenza Processi .

    • canAssignJobs (booleano): obbligatorio. Specifica se un utente può assegnare i processi. Per ulteriori informazioni, consulta la pagina di assistenza Processi .

    • canCreateCollections (booleano): opzionale. Specifica se un utente può creare raccolte. Se non è specificato, il valore rimane invariato. Per ulteriori informazioni, consulta la pagina di assistenza Raccolte .

    • isApiEnabled (booleano): obbligatorio. Specifica se l'API è attivata per un utente.

    • defaultCredentialId (stringa): obbligatorio. Questo parametro si riferisce all'ID univoco di un flusso di lavoro assegnato all'utente per impostazione predefinita.

    • isAccountLocked (booleano): obbligatorio. Seleziona se bloccare l'account dell'utente.

    • isActive (booleano): obbligatorio. Seleziona se un utente è attivo o inattivo.

    • isValidated (booleano): obbligatorio. Specifica se l'indirizzo e-mail di un utente è convalidato.

    • timeZone (stringa): obbligatorio. Immetti il fuso orario, ad esempio Europe/Kiev, ecc.

    • language (stringa): obbligatorio. I valori della lingua supportati sono "de-de", "en-us", "es-es", "fr-fr", "it-it", "ja-jp", "pt-br", "zh-cn".

Esempio di richiesta: cURL

curl --location --request PUT 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'firstName=Doe' \ --data-urlencode 'lastName=Jane' \ --data-urlencode 'email=jdoe@alteryx.com' \ --data-urlencode 'role=Artisan' \ --data-urlencode 'defaultWorkerTag=worker' \ --data-urlencode 'canScheduleJobs=true' \ --data-urlencode 'canPrioritizeJobs=true' \ --data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlencode 'isAccountLocked=true' \ --data-urlencode 'isActive=true' \ --data-urlencode 'isValidated=true' \ --data-urlencode 'timeZone=Europe/Prague' \ --data-urlencode 'language=en-us' \ --data-urlencode 'id=61d564361d6d5da7ad461a32'

Eliminazione di un utente

Per eliminare un utente esistente dal sistema, utilizza l'endpoint DELETE {baseURL}/v3/users/{userId} .

Nota

Solo gli amministratori possono usare questo endpoint API.

Se l'utente che desideri eliminare dispone di risorse (flussi di lavoro, pianificazioni, raccolte, insight) o gruppi di utenti assegnati, non può essere eliminato.

Parametri

  • userId (stringa): obbligatorio. Immetti l'ID dell'utente che desideri eliminare.

Esempio di richiesta: cURL

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

Relazioni tra oggetti

Se stai creando un utente , puoi utilizzare gli oggetti creati nel modo seguente:

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

Puoi utilizzarlo come:

Esempi di richiesta Postman

GET /v3/users

Example of the GET request in Postman.

GET /v3/users/{id}/assets

Example of the GET request in Postman.

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

In questa sezione: