Openbare API van Bitwarden
De Bitwarden Public API biedt organisaties een reeks tools voor het beheren van leden, collecties, groepen, gebeurtenislogboeken en beleidsregels.
tip
Met deze API is het niet mogelijk om individuele kluisitems te beheren. Als je dit wilt bereiken, gebruik dan de Vault Management API.
De Public API is een RESTful API met voorspelbare resource-georiënteerde URL's, accepteert JSON-gecodeerde request bodies, retourneert JSON-gecodeerde responses en gebruikt standaard HTTP response codes, authenticatie en verbs.
De openbare API is compatibel met de OpenAPI Specification (OAS3) en publiceert een compatibele swagger.json definitiebestand. Verken de OpenAPI-specificatie met de Swagger UI:
Voor publieke cloud-gehoste instanties:
https://bitwarden.com/help/api/
Voor zelf gehoste instanties:
https://your.domain.com/api/docs/
noot
Toegang tot de Bitwarden Public API is beschikbaar voor klanten van alle Enterprise- en Teams-organisaties. Voor meer informatie, zie Over Bitwarden Plannen.
Voor cloud-hosted, https://api.bitwarden.com
of https://api.bitwarden.eu.
Voor zelf gehost, https://your.domain.com/api.
Voor cloud-hosted, https://identity.bitwarden.com/connect/token
of https://identity.bitwarden.eu/connect/token.
Voor zelf gehost, https://your.domain.com/identity/connect/token.
De API maakt gebruik van tokens om zich te authenticeren bij beschermde API-eindpunten. Bitwarden gebruikt een OAuth2 Client Credentials aanvraagstroom om tokens toe te kennen vanaf het eindpunt. Authenticatieverzoeken hebben client_id
en client_secret
als vereiste parameters.
tip
De API-sleutel die wordt gebruikt voor verificatie met de Openbare API is niet dezelfde als de persoonlijke API-sleutel. API-sleutels voor organisaties hebben een client_id
met het formaat "organization.ClientId",
terwijl persoonlijke API-sleutels een client_id
hebben met het formaat "user.clientId".
De API Key client_id
en client_secret
kunnen door een eigenaar worden verkregen via de Admin Console vault door te navigeren naar Instellingen → Organisatie info scherm en naar beneden te scrollen naar de API key sectie:
![Verkrijg een organisatie API sleutel](https://res.cloudinary.com/bw-com/image/upload/f_auto/v1/ctf/7rncvj1f8mw7/1Mq824Xunm2wmzd8f905AJ/792cca9c6edddee71abfc350479ec813/Screenshot_2024-02-28_at_2.43.34_PM.png?_a=BAJFJtWI0)
Als u als eigenaar de API-sleutel wilt delen met een beheerder of andere gebruiker, gebruik dan een veilige communicatiemethode zoals Bitwarden Send.
waarschuwing
De API-sleutel van je organisatie geeft volledige toegang tot je organisatie. Houd je API-sleutel privé. Als u denkt dat uw API-sleutel gecompromitteerd is, selecteer dan Instellingen > Organisatie info > Draai API-sleutel knop op dit scherm. Actieve implementaties van uw huidige API-sleutel moeten voor gebruik opnieuw worden geconfigureerd met de nieuwe sleutel.
Om een token voor toegang tot de drager te verkrijgen, doe je een POST-verzoek
met Content-Type: application/x-www-form-urlencoded
met je client_id
en client_secret
naar het authenticatie-eindpunt. Als je de API gebruikt voor organisatiebeheer, gebruik je altijd grant_type=client_credentials
en scope=api.organization
. Bijvoorbeeld:
Bashcurl -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>'
Dit verzoek resulteert in het volgende antwoord:
Bash