Saltar al contenido principal

Autenticación

:::caution Los productos no comparten credenciales KOBANA_TOKEN guarda la credencial de un producto por vez. Un token de Dashboard Mágico no autentica en ningún otro producto Kobana, y viceversa. kobana auth login es del Gateway Bancario y no emite tokens para Dashboard Mágico. :::

El token​

Dashboard Mágico autentica con un access token RS256 emitido por el servidor de autorización de Kobana (account.kobana.com.br), enviado como Authorization: Bearer <jwt>. El aud del token es https://api.dashboards.kobana.com.br — por eso solo vale para este producto. La API solo verifica el token, no emite ninguno: mira Autenticación de la API para saber cómo obtenerlo.

El claim scope decide lo que puede hacer el token:

ComandoScopes aceptados
Lectura (GET)read, write o all
Escritura (POST, PUT, PATCH)write o all
Eliminación (todo DELETE, incluido data-purges delete)delete o all
Importación (imports create, entities records import create, workspaces import create, backups restore)import o all
Exportación (exports create, exports download, backups download, workspaces export)export o all

Ningún nivel sustituye a otro: write no elimina, no importa ni exporta. Con scopes de recurso (dashboards/{grupo}), el nivel vale solo dentro de los grupos que carga el token — mira Autenticación de la API.

Sin el scope correcto, la respuesta es 403 insufficient_scope. Un token emitido a una persona también queda limitado a lo que su rol permite en el dashboard (403 insufficient_permission); un token de máquina actúa por la organización.

Pon el token en KOBANA_TOKEN antes de llamar al producto — me list muestra a quién pertenece:

export KOBANA_TOKEN=$JWT_DASHBOARDS
kobana dashboards me list

Como la variable es la misma para todos los productos, expórtala por comando (o usa un .env por proyecto) si alternas entre productos en la misma sesión:

KOBANA_TOKEN=$JWT_DASHBOARDS kobana dashboards data-sources list --fields "id,name,status"

Workspace (X-Workspace-Id)​

El token identifica a la organización; sus datos viven en workspaces, y el encabezado X-Workspace-Id dice en cuál actúa la llamada — el id o el public_id que aparecen en Workspaces en el dashboard (o en kobana dashboards workspaces list). Puede omitirse mientras la organización tiene un único workspace; con dos o más, su falta responde 400 workspace_required. Un workspace de otra organización responde 403 unknown_workspace, y un token de persona sin acceso al workspace, 403 workspace_access_denied.

El CLI completa el encabezado a partir de KOBANA_WORKSPACE_ID. Para actuar en otro workspace en una sola llamada, pasa el encabezado en --params, que tiene precedencia sobre la variable:

export KOBANA_WORKSPACE_ID=WORKSPACE_ID
kobana dashboards entities list
kobana dashboards entities list --params '{"X-Workspace-Id": "OTRO_WORKSPACE_ID"}'

--dry-run muestra los encabezados que se enviarían (sin el token), y kobana schema lista los encabezados de cada endpoint en header_params.

Prioridad de resolución​

PrioridadMétodoConfiguración
1Token directoKOBANA_TOKEN
2Archivo de credencialesKOBANA_CREDENTIALS_FILE
3Credenciales guardadaskobana auth login (solo Gateway Bancario)

Ambiente​

Dashboard Mágico tiene un único ambiente, el de producción, que es el valor por defecto del CLI — no hace falta pasar --env.

AmbienteAPI--env
Producciónapi.dashboards.kobana.com.brproduction (por defecto)

Dashboard Mágico no tiene sandbox ni host de desarrollo propio: con --env development el CLI cae en producción.

kobana dashboards workspaces list

Próximos pasos​

  • Uso — sintaxis, recursos, ejemplos.
  • Variables de ambiente — la referencia completa, incluyendo configuración y logs.