Bitwarden API pública

La API pública de Bitwarden proporciona a las organizaciones un conjunto de herramientas para gestionar miembros, colecciones, grupos, registros de eventos y políticas.

La API pública es una API RESTful con URL orientadas a recursos predecibles, acepta cuerpos de solicitud codificados en JSON, devuelve respuestas codificadas en JSON y utiliza códigos de respuesta HTTP estándar, autenticación y verbos.

La API pública es compatible con la Especificación OpenAPI (OAS3) y publica un archivo de definición swagger.json compatible. Explora la especificación OpenAPI utilizando la interfaz de usuario Swagger:

• Para instancias alojadas en la nube pública: https://bitwarden.com/help/api/

• Para instancias autoalojadas: https://your.domain.com/api/docs/

Para alojamiento en la nube, https://api.bitwarden.com o https://api.bitwarden.eu.

Para autoalojado, https://your.domain.com/api.

Para alojamiento en la nube, https://identity.bitwarden.com/connect/token o https://identity.bitwarden.eu/connect/token.

Para autoalojado, https://your.domain.com/identidad/connect/token.

La API utiliza tokens de acceso portador para autenticarse con puntos finales de API protegidos. Bitwarden utiliza un flujo de solicitud de aplicación OAuth2 Client Credentials para otorgar tokens de acceso portador desde el punto final. Las solicitudes de autenticación toman client_id y client_secret como parámetros requeridos.

La clave API client_id y client_secret pueden ser obtenidas por un propietario desde la caja fuerte de la Consola de Administrador navegando a Ajustes → pantalla de Información de la organización y desplazándose hacia abajo hasta la sección de clave API:

Si, como propietario, quieres compartir la clave API con un administrador u otro usuario, utiliza un método de comunicación seguro como Bitwarden Enviar.

Para obtener un token de acceso del tipo portador, haga una solicitud POST con Content-Type: application/x-www-form-urlencoded con su client_id y client_secret al punto final de autenticación. Al utilizar la API para la gestión de la organización, siempre utilizarás grant_type=client_credentials y scope=api.organization. Por ejemplo:

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

Esta solicitud resultará en la siguiente respuesta:

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

En esta respuesta, 3600 representa el valor de expiración (en segundos), lo que significa que este token es válido durante 60 minutos después de ser emitido. Hacer una llamada API con un token caducado devolverá un 401 No autorizado código de respuesta.

La API pública de Bitwarden se comunica con solicitudes y respuestas de application/json, con una excepción:

El punto final de autenticación espera una solicitud application/x-www-form-urlencoded, sin embargo responderá con application/json.

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

Donde es el valor para la clave access_token: en el token de acceso del portador obtenido.

Esta solicitud resultará en una respuesta:

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 tiene una página de estado pública, donde puedes encontrar información sobre la salud del servicio e incidentes para todos los servicios, incluyendo la API pública.

La API pública de Bitwarden utiliza códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud de API:

Para obtener más información sobre cómo usar la API pública de Bitwarden, consulte los siguientes artículos:

• Especificación OAS de la API pública de Bitwarden

• Registro de Eventos