Skip to main content

Anmeldedatenendpunkte

Anmeldedaten-Endpunkte und Parameter

Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen .

Weitere Informationen zu Anmeldedaten finden Sie auf der Hilfeseite Anmeldedaten .

Anmerkung

Es ist nicht zulässig, dass Anmeldedaten über die API erstellt werden. Um als Administrator Anmeldedaten zu erstellen, verwenden Sie die Server-Benutzeroberfläche .

Datensatz mit Anmeldedaten abrufen

Um Informationen zu allen Workflow-Datensätzen abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/ .

Anmerkung

Wenn Sie kein Curator sind, werden die Ergebnisse auf Zugangsdaten beschränkt, auf die Sie Zugriff haben, und die Parameter View, USER-ID und userGroupId werden ignoriert.

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.

  • ownerId  (Zeichenfolge): Optional. Um Ergebnisse nach Benutzer-ID zu filtern, geben Sie die ID eines Benutzers ein.

  • versionId  (Zeichenfolge): Optional. Um Ergebnisse nach userGroupId zu filtern, geben Sie die ID einer Benutzergruppe ein.

Datensatz mit Anmeldedaten abrufen

TUm Informationen über einen spezifischen Workflow abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{credentialId} .

Parameter

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, um Informationen zu bestimmten Zugangsdaten abzurufen.

Anmeldedaten für einen Benutzer freigeben

Um Zugangsdaten für einen Benutzer freizugeben, verwenden Sie den {baseURL} {credentialId} Endpunkt POST /v3/credentials/ /users.

Parameter

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie eine Sammlungs-ID ein, die Sie freigeben möchten.

  • Vertrag (Körper): Erforderlich. Geben Sie Folgendes an, um Zugangsdaten für einen Benutzer freizugeben:

    • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie die ID eines Benutzers an, für den Sie Zugangsdaten freigeben möchten.

Anmeldedaten für Benutzergruppen freigeben

Um Zugangsdaten für eine Benutzergruppe freizugeben, verwenden Sie den {baseURL} {credentialId} Endpunkt POST /v3/credentials/ /usergroups.

Parameter

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie eine ID der Zugangsdaten ein, die Sie freigeben möchten.

  • Vertrag (Körper): Erforderlich. Geben Sie Folgendes an, um Zugangsdaten für eine Benutzergruppe freizugeben:

    • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie die ID einer Benutzergruppe an, für die Sie Zugangsdaten freigeben möchten.

Entfernt einen Benutzer aus den Anmeldedaten

Um einen Benutzer aus den Zugangsdaten zu entfernen, verwenden Sie den {baseURL}{credentialId}{userId} Endpunkt DELETE /v3/credentials/ /users/.

Parameter

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie die Workflow-ID ein, für die Sie die Informationen abrufen möchten.

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie eine Benutzer-ID ein, die Sie aus den Zugangsdaten entfernen möchten.

Einen Benutzer oder eine Gruppe aus einer Sammlung entfernen

Um eine Benutzergruppe aus Zugangsdaten zu entfernen, verwenden Sie den Befehl DELETE {baseURL}/v3/credentials/{credentialId}/usergroups/{userGroupId} Endpunkt.

Parameter

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie die ID der Zugangsdaten ein, aus der Sie die Benutzergruppe entfernen möchten.

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Geben Sie eine Benutzergruppen-ID ein, die Sie aus den Zugangsdaten entfernen möchten.

Anmeldedaten löschen

Um einen spezifischen Workflow zu löschen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/workflows/{credentialId} .

Parameter

  • workflowCredentialType  (Zeichenfolge): Erforderlich. Wählen Sie die zu löschenden Anmeldedaten aus.

  • force  (boolescher Wert): Optional. Wählen Sie, ob Sie das Löschen von Zugangsdaten erzwingen möchten, falls Freigaben vorhanden sind. Wenn Sie die Zugangsdaten löschen und alle Shares bereinigen möchten, setzen Sie den Force-Parameter auf TRUE. Wenn Sie diese Option nicht ausgewählt haben, lautet der Standardwert „false“. Dies dient zum Schutz vor einem irrtümlichen Anruf.

Objektbeziehungen

TUm Informationen über einen spezifischen Workflow abzurufen, verwenden Sie den Endpunkt GET /v3/workflows/ . Die CredentialId , die Sie erhalten, kann verwendet werden, wenn:

In diesem Abschnitt: