Modo API (api)

Descripción general

El modo api permite ejecutar llamadas directas a la API de Passwork con respuestas en formato JSON.

Sintaxis

shell

passwork-cli api [options]

Parámetros de API

El comando api requiere los siguientes parámetros:

Parámetro	Descripción
--method	Método HTTP (GET, POST, PUT, DELETE, PATCH)
--endpoint	Ruta de API (por ejemplo, v1/vaults)
--params	Cadena JSON con parámetros (opcional)
--field	Nombre del campo a extraer de la respuesta (opcional)

Cómo funciona

1. Autenticación: Se conecta al servidor Passwork;
2. Formación de la solicitud: Crea una solicitud HTTP con la ruta y el método especificados;
3. Envío de la solicitud: Envía la solicitud con los encabezados de autorización necesarios;
4. Procesamiento de la respuesta: Recibe y analiza la respuesta de la API;
5. Filtrado (opcional): Extrae el campo especificado usando --field;
6. Salida: El resultado se genera en formato JSON.

Ejemplos de uso

Obtener una lista de todas las bóvedas:

shell

passwork-cli api --method GET --endpoint "v1/vaults"

Obtener un elemento y extraer solo el nombre:

shell

passwork-cli api --method GET --endpoint "v1/items/password_id" --field "name"

Buscar elementos por etiquetas y obtener los nombres:

shell

passwork-cli api \
  --method GET \
  --endpoint "v1/items/search" \
  --params '{"tags":["api","production"]}' \
  --field "name"

Rotación de accessToken y refreshToken mediante POST /api/v1/sessions/refresh (par completo). Endpoints separados para sesiones API y ejemplos de curl: rotación de token de API.

shell

passwork-cli api \
  --host "https://passwork.example.com" \
  --token "your_expired_token" \
  --refresh-token "your_refresh_token" \
  --method POST \
  --endpoint "v1/sessions/refresh" \
  --field "token"

Uso con un certificado autofirmado:

shell

passwork-cli api --no-ssl-verify --method GET --endpoint "v1/user/profile"

Notas

• Todas las respuestas se devuelven en formato JSON;
• El parámetro --field permite extraer un campo específico de la respuesta;
• El parámetro --params se utiliza para pasar datos en solicitudes POST, PUT, PATCH;
• Para certificados autofirmados, debe utilizar --no-ssl-verify.