Skip to main content

Endpoint utente

Endpoint e parametri degli utenti

Per ulteriori informazioni sulle relazioni oggetti, andare alla #relazioni-tra-oggetti-6518518 sezione relazioni 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, utilizzare l' {baseURL} endpoint POST /v3/users.

Nota

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

Parametri

  • UserContract (corpo): Per creare un nuovo utente, è necessario il parametro userContract. Specificare i seguenti parametri:

    • workflowCredentialType (stringa): obbligatorio. Immettere il nome di un utente.

    • workflowCredentialType (stringa): obbligatorio. Immettere il cognome di un utente.

    • workflowCredentialType (stringa): obbligatorio. Immettere 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.

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

    • credentialId (stringa): opzionale. Questo parametro si riferisce all'ID univoco di un flusso di lavoro, assegnato all'utente come predefinito. Se non è specificato nessun valore, viene utilizzato "Predefinita".

    • force (booleano): opzionale. Selezionare se un utente è attivo o disattivato. Se non è specificato nessun valore, viene utilizzato "Predefinita".

    • direction (stringa): opzionale. Immettere il fuso orario, ad esempio Europa/Kiev. Se non è specificato nessun valore, viene utilizzato "Predefinita".

Esempio di richiesta: cURL

Curl --location --request POST 'http://localhost/webapi/v3/users' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'autorizzazione: 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, utilizzare l' {baseURL}{id} endpoint POST /v3/users/ /disable.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID utente per disattivare questo utente.

Esempio di richiesta: cURL

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

Reimpostare una password per un utente

Per reimpostare e inviare un'e-mail di reimpostazione della password per un utente specifico, utilizzare l' {baseURL}{id}endpoint POST /v3/users/ /passwordReset.

Nota

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID utente per reimpostare la password.

Esempio di richiesta: cURL

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

Cerca utenti

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

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

  • force (booleano): opzionale. Selezionare se un utente è attivo o disattivato.

  • limit (stringa): opzionale. Inserire 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.

  • limit (stringa): opzionale. Immettere il nome dell'utente.

  • limit (stringa): opzionale. Immettere il cognome dell'utente.

  • CreatedAfter (data-ora): Facoltativo. Immetti la data e l'ora dopo le quali è stato creato il flusso di lavoro. Specifica la data e l'ora in formato ISO8601.

  • CreatedBefore (data-ora): Facoltativo. Immetti la data e l'ora prima delle quali è stato creato il flusso di lavoro. Specifica 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'

Ricerca utente

Per cercare un utente specifico, usare GET {baseURL}/v3/users/{id} endpoint.

Parametri

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

Esempio di richiesta: cURL

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

Recupera tutte le risorse di proprietà di un utente

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

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID utente per recuperare l'elenco delle risorse per questo utente.

  • offset (stringa): opzionale. Selezionate i tipi di risorsa che desiderate restituire. L'impostazione predefinita è 'tutti'.

Esempio di richiesta: cURL

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

Aggiorna un utente esistente

Per aggiornare un utente esistente, usare PUT {baseURL}/v3/users/{id} endpoint.

Nota

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

Parametri

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

  • updateWorkflowContract (corpo): obbligatorio. Per aggiornare un utente, è necessario il parametro updateContract. Specificare quanto segue:

    • limit (stringa): opzionale. Immettere un ID utente per aggiornarlo.

    • workflowCredentialType (stringa): obbligatorio. Immettere il nome di un utente.

    • workflowCredentialType (stringa): obbligatorio. Immettere il cognome di un utente.

    • workflowCredentialType (stringa): obbligatorio. Immettere 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.

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

    • workflowCredentialType (stringa): obbligatorio. Questo parametro si riferisce all'ID univoco di un flusso di lavoro, assegnato all'utente come predefinito.

    • makePublished (booleano): obbligatorio. Selezionare se bloccare questo account utente.

    • makePublished (booleano): obbligatorio. Selezionare se un utente è attivo o disattivato.

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

    • name (stringa): obbligatorio. Immettere il fuso orario, ad esempio Europa/Kiev, ecc.

    • workflowCredentialType (stringa): obbligatorio. I valori di 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: BearerTokenGoesHere' \ --data-urlencode 'firstName=Doe' \ --data-urlencode 'lastName=Jane' \ --data-urlencode 'email=jdoe@alteryx.com' data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlencode 'isAccountLocked=true' \ -

Eliminazione utente

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

Nota

Se l'utente che si desidera eliminare dispone di risorse (flussi di lavoro, pianificazioni, raccolte, approfondimenti) o gruppi di utenti assegnati, non è possibile eliminare questo utente.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere l'ID utente che si desidera eliminare.

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

OTTIENI /v3/utenti

Example of the GET request in Postman.

OTTIENI /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.