Bitwarden Public API

Bitwarden Public API ger organisationer en uppsättning verktyg för att hantera medlemmar, samlingar, grupper, händelseloggar och policyer.

Public API är ett RESTful API med förutsägbara resursorienterade webbadresser, accepterar JSON-kodade begärandekroppar, returnerar JSON-kodade svar och använder vanliga HTTP-svarskoder, autentisering och verb.

Public API är kompatibelt med OpenAPI Specification (OAS3) och publicerar en kompatibel swagger.json definitionsfil. Utforska OpenAPI-specifikationen med Swagger-gränssnittet:

• För offentliga molnbaserade instanser: https://bitwarden.com/help/api/

• För egenvärdiga instanser: https://your.domain.com/api/docs/

För molnvärd, https://api.bitwarden.com eller https://api.bitwarden.eu.

För egen värd, https://din.domän.com/api.

För molnvärd, https://identity.bitwarden.com/connect/token eller https://identity.bitwarden.eu/connect/token.

För egen värd, https://your.domain.com/identity/connect/token.

API:et använder bäraråtkomsttokens för att autentisera med skyddade API-slutpunkter. Bitwarden använder ett begärandeflöde för OAuth2 Client Credentials-applikationer för att ge bäraråtkomsttokens från slutpunkten. Autentiseringsbegäranden tar client_id och client_secret som nödvändiga parametrar.

API-nyckeln client_id och client_secret kan erhållas av en ägare från Admin Console-valvet genom att navigera till Inställningar → Organisationsinformationsskärmen och rulla ner till API-nyckelsektionen:

Om du som ägare vill dela API-nyckeln med en administratör eller annan användare, använd en säker kommunikationsmetod som Bitwarden Send.

För att få en bäraråtkomsttoken, gör en POST-begäran med Content-Type: application/x-www-form-urlencoded med ditt client_id och client_secret till autentiseringens slutpunkt. När du använder API:et för organisationshantering kommer du alltid att använda grant_type=client_credentials och scope=api.organization. Till exempel:

BashCopy
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>'

Denna begäran kommer att resultera i följande svar:

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

I detta svar representerar 3600 utgångsvärdet (i sekunder), vilket betyder att denna token är giltig i 60 minuter efter att den utfärdats. Om du gör ett API-anrop med en utgången token returneras en 401 obehörig svarskod.

Bitwarden Public API kommunicerar med ansökan/json-förfrågningar och svar, med ett undantag:

Autentiseringens slutpunkt förväntar sig en application/x-www-form-urlencoded begäran, men kommer att svara med application/json.

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

Där<TOKEN> är värdet för access_token: nyckeln i den erhållna bäraråtkomsttoken.

Denna begäran kommer att resultera i ett svar:

BashCopy
{
  "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 har en offentlig statussida, där du kan hitta information om tjänstens hälsa och incidenter för alla tjänster inklusive Public API.

Bitwarden Public API använder konventionella HTTP-svarskoder för att indikera framgång eller misslyckande för en API-begäran:

För mer information om hur du använder Bitwarden Public API, se följande artiklar:

• Bitwarden Public API OAS-specifikation

• Händelseloggar