Skip to main content

Benutzer-Endpunkte

Benutzer-Endpunkte und Parameter

Weitere Informationen zu den Objektbeziehungen finden Sie im #objektbeziehungen-6518518 Abschnitt Objektbeziehungen.

Weitere Informationen über Benutzer finden Sie auf der Hilfeseite Benutzer- und Gruppenverwaltung.

Einen neuen Benutzer erstellen

Um einen neuen Workflow hochzuladen, verwenden Sie den Endpunkt POST {baseURL}/v3/workflows.

Anmerkung

Dieser Endpunkt kann nur für Server-Instanzen verwendet werden, die für die Windows-Authentifizierung konfiguriert sind.

Parameter

  • UserContract (Body): Um einen neuen Benutzer zu erstellen, ist der Parameter userContract erforderlich. Geben Sie die folgenden Fahrzeitparameter an:

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie den Vornamen eines Benutzers ein.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie den Nachnamen eines Benutzers ein.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die E-Mail-Adresse eines Benutzers ein.

    • role (Zeichenfolge): optional. Sie können aus folgenden Optionen wählen: „NoAccess“, „Viewer“, „Member“, „Artisan“, „Curator“ und „Evaluated“ (die Standardrolle, die zur Laufzeit ausgewertet wird). Weitere Informationen zu Rollen und Berechtigungen finden Sie auf der Seite Benutzerrollen und -berechtigungen. Wenn keine Rolle ausgewählt ist, wird standardmäßig die Rolle „Evaluated“ verwendet.

    • defaultWorkerTag (Zeichenfolge): optional. Geben Sie das in den Workern definierte Worker-Tag an, um Worker-Knoten Aufträge einfacher zuzuweisen. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung "". Weitere Informationen finden Sie auf der Hilfeseite zu Worker.

    • canScheduleJobs (boolescher Wert): optional. Geben Sie an, ob der Benutzer Aufträge planen kann. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung „false“. Weitere Informationen finden Sie auf der Hilfeseite Aufträge.

    • canPrioritizeJobs (boolescher Wert): optional. Geben Sie an, ob ein Benutzer Aufträge priorisieren kann. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung „false“. Weitere Informationen finden Sie auf der Hilfeseite Aufträge.

    • canAssignJobs (boolescher Wert): optional. Geben Sie an, ob ein Benutzer Aufträge zuweisen kann. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung „false“. Weitere Informationen finden Sie auf der Hilfeseite Aufträge.

    • canCreateCollections (boolescher Wert): optional. Geben Sie an, ob ein Benutzer neue Sammlungen erstellen kann. Wenn keine Angabe gemacht wird, lautet die Standardeinstellung „false“. Weitere Informationen finden Sie auf der Hilfeseite Sammlungen.

    • isPublic (boolescher Wert): Optional. Geben Sie an, ob die API für einen Benutzer aktiviert ist. Wenn Sie diese Option nicht ausgewählt haben, lautet der Standardwert „false“.

    • credentialId (Zeichenfolge): Optional. Dieser Parameter bezieht sich auf die eindeutige ID eines Workflows, die dem Benutzer standardmäßig zugewiesen ist. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.

    • force (boolescher Wert): Optional. Wählen Sie, ob ein Benutzer aktiv oder deaktiviert ist. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.

    • direction (Zeichenfolge): Optional. Geben Sie die Zeitzone ein, z. B. Europa/Kiew. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.

Anforderungsbeispiel: 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'

Benutzer deaktivieren

Um einen Benutzer im System zu deaktivieren, verwenden Sie den POST {baseURL}/v3/users/{id}/deactivate endpoint.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, um diesen Benutzer zu deaktivieren.

Anforderungsbeispiel: cURL

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

Zurücksetzen eines Kennworts für einen Benutzer

Verwenden Sie den {baseURL}{id}Endpunkt POST /v3/users/ /passwordReset, um eine E-Mail zum Zurücksetzen des Kennworts für einen bestimmten Benutzer zurückzusetzen und zu senden.

Anmerkung

Dieser Endpunkt kann nur für Server-Instanzen verwendet werden, die für die Windows-Authentifizierung konfiguriert sind.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, um ihr Kennwort zurückzusetzen.

Anforderungsbeispiel: cURL

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

Benutzer suchen

Um nach Benutzern zu suchen, verwenden Sie den {baseURL} Endpunkt GET /v3/users. Verwenden Sie verschiedene Parameter als Filter für die Suche nach Benutzern.

Parameter

  • view (Zeichenfolge): Optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Standard“ und „Vollständig“. Wenn dieser Parameter auf „Standard“ gesetzt ist, wird ein reduziertes Ansichtsobjekt zurückgegeben. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.

  • force (boolescher Wert): Optional. Wählen Sie, ob ein Benutzer aktiv oder deaktiviert ist.

  • limit (Zeichenfolge): Optional. Geben Sie die E-Mail-Adresse des Benutzers ein.

  • role (Zeichenfolge): optional. Wählen Sie die Benutzerrolle aus, um die Suche einzugrenzen. Wählen Sie aus den folgenden Optionen aus: „NoAccess“, „Viewer“, „Member“, „Artisan“, „Curator“ und „Evaluated“. Die Standardrolle („Evaluated“) wird zur Laufzeit ausgewertet. Weitere Informationen zu Rollen und Berechtigungen finden Sie auf der Seite Benutzerrollen und -berechtigungen.

  • versionId (Zeichenfolge): Optional. Geben Sie den Vornamen des Benutzers ein.

  • limit (Zeichenfolge): Optional. Geben Sie den Nachnamen des Benutzers ein.

  • CreatedAfter (Datum-Uhrzeit): Optional. Geben Sie das Datum und die Uhrzeit ein, wonach der Workflow erstellt wurde. Geben Sie Datum und Uhrzeit im ISO8601-Format ein.

  • CreatedBefore (Datum-Uhrzeit): Optional. Geben Sie das Datum und die Uhrzeit ein, wovor der Workflow erstellt wurde. Geben Sie Datum und Uhrzeit im ISO8601-Format ein.

Anforderungsbeispiel: cURL

Curl --location --Request GET 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \ --Header 'Autorisierung: Bearer BearerTokenGoesHere'

Einen Benutzer suchen

Um nach einem bestimmten Benutzer zu suchen, verwenden Sie GET {baseURL}/v3/users/{id} Endpoint.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, um Informationen über diesen Benutzer abzurufen.

Anforderungsbeispiel: cURL

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

Alle Anlagen abrufen, die einem Benutzer gehören

Um eine vollständige Liste der Assets abzurufen, die einem Benutzer gehören, verwenden Sie den {baseURL}{id} Endpunkt GET /v3/users/ /Assets.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, um die Liste der Assets für diesen Benutzer abzurufen.

  • offset (Zeichenfolge): Optional. Wählen Sie die Anlagentypen, die Sie zurückgeben möchten. Der Standardwert ist auf „alle“ gesetzt.

Anforderungsbeispiel: cURL

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

Einen vorhandenen Benutzer aktualisieren

Um einen vorhandenen Benutzer zu aktualisieren, verwenden Sie den PUT {baseURL}/v3/users/{id} Endpunkt.

Anmerkung

Die ID des updateContract wird durch den ID-Wert in der URL überschrieben.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, um diesen Benutzer zu aktualisieren.

  • updateWorkflowContract (Haupttext): Erforderlich. Um einen Benutzer zu aktualisieren, ist der Parameter updateContract erforderlich. Geben Sie Folgendes an:

    • versionId (Zeichenfolge): Optional. Geben Sie eine Benutzer-ID ein, um sie zu aktualisieren.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie den Vornamen eines Benutzers ein.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie den Nachnamen eines Benutzers ein.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die E-Mail-Adresse eines Benutzers ein.

    • role (Zeichenfolge): erforderlich. Sie können aus folgenden Optionen wählen: „NoAccess“, „Viewer“, „Member“, „Artisan“, „Curator“ und „Evaluated“. Weitere Informationen zu Rollen und Berechtigungen finden Sie auf der Seite Benutzerrollen und -berechtigungen.

    • defaultWorkerTag (Zeichenfolge): erforderlich. Geben Sie das in den Workern definierte Worker-Tag an, um Worker-Knoten Aufträge einfacher zuzuweisen. Weitere Informationen zu Workern finden Sie auf der Hilfeseite Worker.

    • canScheduleJobs (boolescher Wert): erforderlich. Geben Sie an, ob ein Benutzer Aufträge planen kann. Weitere Informationen finden Sie auf der Hilfeseite Aufträge.

    • canPrioritizeJobs (boolescher Wert): erforderlich. Geben Sie an, ob ein Benutzer Aufträge priorisieren kann. Weitere Informationen finden Sie auf der Hilfeseite Aufträge.

    • canAssignJobs (boolescher Wert): erforderlich. Geben Sie an, ob ein Benutzer Aufträge zuweisen kann. Weitere Informationen finden Sie auf der Hilfeseite Aufträge.

    • canCreateCollections (boolescher Wert): optional. Geben Sie an, ob ein Benutzer Sammlungen erstellen kann. Wenn keine Angabe gemacht wird, bleibt der Wert unverändert. Weitere Informationen finden Sie auf der Hilfeseite Sammlungen.

    • makePublished (boolescher Wert): Erforderlich. Geben Sie an, ob die API für einen Benutzer aktiviert ist.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Dieser Parameter bezieht sich auf die eindeutige ID eines Workflows, die dem Benutzer standardmäßig zugewiesen ist.

    • makePublished (boolescher Wert): Erforderlich. Wählen Sie, ob dieses Benutzerkonto gesperrt werden soll.

    • makePublished (boolescher Wert): Erforderlich. Wählen Sie, ob ein Benutzer aktiv oder deaktiviert ist.

    • makePublished (boolescher Wert): Erforderlich. Geben Sie an, ob die E-Mail-Adresse eines Benutzers validiert wird.

    • name (Zeichenfolge): Erforderlich. Geben Sie die Zeitzone ein, z. B. Europa/Kiew usw.

    • workflowCredentialType (Zeichenfolge): Erforderlich. Unterstützte Sprachwerte sind „de-de“, „en-US“, „es-es“, „fr-fr“, „IT-it“, „ja-jp“, „pt-br“, „zh-cn“.

Anforderungsbeispiel: 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-Code' 'role-Data-Code' 'true-Data-Jobs' \ \ - Data-Code' 'true-Data-Data-Code' 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-6dlencode=true'

Benutzer löschen

Um einen bestimmten Benutzer aus dem System zu löschen, verwenden Sie den Befehl DELETE {baseURL}/v3/users/{id} Endpoint.

Anmerkung

Wenn dem Benutzer, den Sie löschen möchten, Assets (Workflows, Zeitpläne, Sammlungen, Erkenntnisse) oder Benutzergruppen zugewiesen sind, kann dieser Benutzer nicht gelöscht werden.

Parameter

  • workflowCredentialType (Zeichenfolge): Erforderlich. Geben Sie die Benutzer-ID ein, die Sie löschen möchten.

Anforderungsbeispiel: cURL

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

Objektbeziehungen

Wenn Sie einen Workflow hochladen, können Sie erstellte Objekte wie folgt verwenden:

Objekt erstellt: "workflowId" (z. B. "id": "7917969784f84bd0942f66996ecb8f3")

Sie können sie wie folgt verwenden:

Beispiele für eine Postman-Anforderung

/V3/users ABRUFEN

Example of the GET request in Postman.

RUFEN SIE /v3/users/{id}/Assets AB

Example of the GET request in Postman.

Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden.