Bitwarden Öffentliche API

Die Bitwarden Öffentliche API bietet Organisationen eine Reihe von Tools zum Verwalten von Mitgliedern, Sammlungen, Gruppen, Ereignisprotokollen und Richtlinien.

Die Öffentliche API ist eine RESTful API mit vorhersehbaren ressourcenorientierten URLs, akzeptiert JSON-kodierte Anforderungskörper, gibt JSON-kodierte Antworten zurück und verwendet standardmäßige HTTP-Antwortcodes, Authentifizierung und Verben.

Die öffentliche API ist kompatibel mit der OpenAPI-Spezifikation (OAS3) und veröffentlicht eine konforme swagger.json Definitionsdatei. Erkunden Sie die OpenAPI-Spezifikation mit der Swagger UI:

• Für öffentlich gehostete Cloud-Instanzen: https://bitwarden.com/help/api/

• Für selbst gehostete Instanzen: https://your.domain.com/api/docs/

Für Cloud-gehostet, https://api.bitwarden.com oder https://api.bitwarden.eu.

Für selbst gehostet, https://your.domain.com/api.

Für Cloud-gehostet, https://identity.bitwarden.com/connect/token oder https://identity.bitwarden.eu/connect/token.

Für selbst gehostet, https://your.domain.com/identität/connect/token.

Die API verwendet Bearer-Zugriffstoken zur Authentifizierung mit geschützten API-Endpunkten. Bitwarden verwendet einen OAuth2 Client Credentials Anwendungsanforderungsfluss, um Bearer-Zugriffstoken vom Endpunkt zu gewähren. Authentifizierungsanfragen nehmen client_id und client_secret als erforderliche Parameter.

Der API-Schlüssel client_id und client_secret kann von einem Eigentümer aus dem Administrator-Konsole Tresor abgerufen werden, indem man zu Einstellungen → Organisationsinformationen navigiert und bis zum Abschnitt API-Schlüssel herunterscrollt:

Wenn Sie als Eigentümer den API-Schlüssel mit einem Administrator oder einem anderen Benutzer teilen möchten, verwenden Sie eine sichere Kommunikationsmethode wie Bitwarden Senden.

Um ein Bearer-Zugriffstoken zu erhalten, machen Sie eine POST-Anfrage mit Content-Typ: application/x-www-form-urlencoded mit Ihrer client_id und client_secret an den Authentifizierung-Endpunkt. Bei der Verwendung der API zur Verwaltung der Organisation verwenden Sie immer grant_type=client_credentials und scope=api.organization. Zum Beispiel:

Bash
curl -X POST \
  https://identity.bitwarden.com/connect/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=client_credentials&scope=api.organization&client_id=<ID>&client_secret=<SECRET>'

Diese Anfrage wird die folgende Antwort hervorrufen:

Bash
{
  "access_token": "<TOKEN>",
  "expires_in": 3600,
  "token_type": "Bearer"
}

In dieser Antwort steht 3600 für den Ablaufwert (in Sekunden), was bedeutet, dass dieses Token 60 Minuten nach Ausstellung gültig ist. Ein API-Aufruf mit einem abgelaufenen Token gibt einen 401 Unauthorized Antwortcode zurück.

Die Bitwarden Öffentliche API kommuniziert mit application/json Anfragen und Antworten, mit einer Ausnahme:

Der Authentifizierung-Endpunkt erwartet eine application/x-www-form-urlencoded Anfrage, wird jedoch mit application/json antworten.

Bash
curl -X GET \
  https://api.bitwarden.com/public/collections \
  -H 'Authorization: Bearer <TOKEN>'

Wo der Wert für den access_token: Schlüssel im erhaltenen Bearer Access Token ist.

Diese Anfrage wird zu einer Antwort führen:

Bash
{
  "object": "list",
  "data": [
    {
      "object": "event",
      "type": 1000,
      "itemId": "string",
      "collectionId": "string",
      "groupId": "string",
      "policyId": "string",
      "memberId": "string",
      "actingUserId": "string",
      "date": "2020-11-04T15:01:21.698Z",
      "device": 0,
      "ipAddress": "xxx.xx.xxx.x"
    }
  ],
  "continuationToken": "string"
}

Bitwarden hat eine öffentliche Statusseite, auf der Sie Informationen über den Servicezustand und Vorfälle für alle Dienste, einschließlich der öffentlichen API, finden können.

Die Bitwarden Öffentliche API verwendet herkömmliche HTTP-Antwortcodes, um den Erfolg oder Misserfolg einer API-Anfrage anzuzeigen:

Für weitere Informationen zur Nutzung der Bitwarden Öffentlichen API, siehe die folgenden Artikel:

• Bitwarden Öffentliche API OAS Spezifikation

• Ereignisprotokolle