Anmeldedatenendpunkte
Anmeldedatenendpunkte 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 .
Alle Anmeldedaten-Datensätze abrufen
Um alle zugänglichen Anmeldedaten-Datensätze abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/credentials
.
Anmerkung
Wenn Sie kein Administrator sind, werden die Ergebnisse auf Anmeldedaten beschränkt, auf die Sie Zugriff haben, und die Parameter „view“, „userId“ und „userGroupId“ werden ignoriert.
Parameter
view (Zeichenfolge): optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „Default“ und „Full“. Wenn dieser Parameter auf „Standard“ gesetzt ist, wird ein reduziertes Ansichtsobjekt zurückgegeben. Wenn keine Angaben gemacht werden, wird der Standardwert verwendet.
userId (Zeichenfolge): optional. Um Ergebnisse nach userId zu filtern, geben Sie die ID eines Benutzers ein.
userGroupId (Zeichenfolge): optional. Um Ergebnisse nach userGroupId zu filtern, geben Sie die ID einer Benutzergruppe ein.
Anmeldedaten-Datensatz abrufen
Um Details zu vorhandenen Anmeldedaten abzurufen, verwenden Sie den Endpunkt
GET {baseURL}/v3/credentials/{credentialId}
.
Parameter
credentialId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, um Informationen zu bestimmten Anmeldedaten abzurufen.
Anmeldedaten für einen Benutzer freigeben
Um vorhandene Anmeldedaten für einen vorhandenen Benutzer freizugeben, verwenden Sie den Endpunkt
POST {baseURL}
/v3/credentials/{credentialId}/users
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
credentialId (Zeichenfolge): erforderlich. Geben Sie eine Sammlungs-ID ein, die Sie freigeben möchten.
contract (Text): erforderlich. Geben Sie Folgendes an, um Anmeldedaten für einen Benutzer freizugeben:
userId (Zeichenfolge): erforderlich. Geben Sie die ID eines Benutzers an, für den Sie Anmeldedaten freigeben möchten.
Anmeldedaten für eine Benutzergruppe freigeben
Um vorhandene Anmeldedaten für eine vorhandene Benutzergruppe freizugeben, verwenden Sie den Endpunkt
POST {baseURL}
/v3/credentials/{credentialId}/userGroups
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
credentialId (Zeichenfolge): erforderlich. Geben Sie die Anmeldedaten-ID ein, die Sie freigeben möchten.
contract (Text): erforderlich. Geben Sie Folgendes an, um Anmeldedaten für eine Benutzergruppe freizugeben:
userGroupId (Zeichenfolge): erforderlich. Geben Sie die ID einer Benutzergruppe an, für die Sie Anmeldedaten freigeben möchten.
Berechtigung eines Benutzers zur Verwendung von Anmeldedaten entfernen
Um die Berechtigung eines Benutzers zur Verwendung vorhandener Anmeldedaten zu entfernen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
credentialId (Zeichenfolge): erforderlich. Geben Sie die Anmeldedaten-ID ein, aus der Sie den Benutzer entfernen möchten.
userId (Zeichenfolge): erforderlich. Geben Sie eine Benutzer-ID ein, die Sie aus den Anmeldedaten entfernen möchten.
Berechtigung einer Benutzergruppe zur Verwendung von Anmeldedaten entfernen
Um die Berechtigung einer Benutzergruppe zur Verwendung vorhandener Anmeldedaten zu entfernen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
credentialId (Zeichenfolge): erforderlich. Geben Sie die Anmeldedaten-ID ein, aus der Sie die Benutzergruppe entfernen möchten.
userGroupId (Zeichenfolge): erforderlich. Geben Sie eine Benutzergruppen-ID ein, die Sie aus den Anmeldedaten entfernen möchten.
Anmeldedaten löschen
Um vorhandene Anmeldedaten zu löschen, verwenden Sie den Endpunkt
DELETE {baseURL}/v3/credentials/{credentialId}
.
Anmerkung
Nur Administratoren können diesen API-Endpunkt verwenden.
Parameter
credentialId (Zeichenfolge): erforderlich. Geben Sie die zu löschende Anmeldedaten-ID ein.
force (boolescher Wert): optional. Wählen Sie, ob Sie das Löschen von Anmeldedaten erzwingen möchten, falls Freigaben vorhanden sind. Wenn Sie die Anmeldedaten löschen und alle Freigaben bereinigen möchten, setzen Sie den Parameter „force“ auf „true“. Wenn Sie nichts auswählen, lautet der Standardwert „false“. Dies dient zum Schutz vor einem irrtümlichen Anruf.
Objektbeziehungen
Um Informationen über vorhandene Anmeldedaten-IDs abzurufen, verwenden Sie den Endpunkt GET /v3/credentials . Die abgerufene credentialId kann in folgenden Fällen verwendet werden:
Sie möchten Informationen zu bestimmten Anmeldedaten abrufen .
Sie möchten Anmeldedaten für einen Benutzer freigeben .
Sie möchten Anmeldedaten für eine Benutzergruppe freigeben .
Sie möchten einen Benutzer aus Anmeldedaten entfernen .
Sie möchten eine Benutzergruppe aus Anmeldedaten entfernen .
Sie möchten bestimmte Anmeldedaten löschen .