API Claves

Las API claves se utilizan para autenticar solicitudes a la Capgo API. Las claves son específicas de la organización y se pueden asignar roles de control de acceso RBAC para un control de acceso fino. Cada clave también puede tener una fecha de vencimiento opcional y se puede crear como una clave “segura” (hashada) donde el valor en texto plano solo se muestra una vez.

Usando una API clave

Utilice el encabezado de autenticación documentado por el punto final. Para solicitudes con claves API-clave, authorization es aceptado:

curl -H "authorization: YOUR_API_KEY" https://api.capgo.app/...

Algunos puntos finales también aceptan un encabezado de clave dedicado. Canales API acepta authorization o capgkeyo

utilice uno de esos encabezados para la automatización de canal de previsualización.

API keys use the same role-based access control (RBAC) system as user accounts. When creating or managing keys through the web app or API, you assign roles at two levels:

• Las llaves __CAPGO_KEEP_0__ utilizan el mismo sistema de control de acceso basado en roles (RBAC) que las cuentas de usuario. Al crear o administrar llaves a través de la aplicación web o __CAPGO_KEEP_1__, asigna roles a dos niveles: Rol de organización org_admin — Define las permisos básicos de la llave en toda la organización (por ejemplo, org_member).
• o Rol de aplicación app_admin, app_developer, app_uploader, app_readero, o app_preview).

Si una clave API tiene vinculaciones de rol explícitas, solamente se evalúan esas vinculaciones para verificaciones de permisos. Las permisos personales del propietario de la clave no se heredan por la clave.

Automatización de canal de previsualización

Vincular app_preview solamente a la aplicación de previsualización para CI que crea un canal de previsualización temporal, no público, sube y promueve un paquete, y luego elimina ambos.

{
  "name": "PR preview key",
  "hashed": true,
  "bindings": [
    {
      "role_name": "app_preview",
      "scope_type": "app",
      "org_id": "<OWNING_ORG_UUID>",
      "app_id": "<APP_UUID>"
    }
  ]
}

org_id es la UUID de la organización propietaria de la aplicación. app_id es el UUID interno del registro de la aplicación, no el identificador público de la aplicación utilizado por los comandos CLI (por ejemplo, com.example.app) La vinculación sigue siendo organización-vinculada incluso cuando la clave no tiene un rol organización-vinculado.

El nivel de la aplicación app_preview incluye solo app.read, app.read_bundles, app.upload_bundle, y app.create_channel. Cuando esa clave crea un canal, Capgo agrega automáticamente una channel_preview vinculación en el canal creado recientemente. Esa vinculación de hijo concede channel.read, channel.promote_bundle, y channel.delete solo para el canal que la clave creó.

app_preview retiene app.read, por lo que no es una aislación de lectura de canales estricta: la clave puede enumerar metadatos de canal en la aplicación seleccionada. La vinculación de hijo automática limita mutaciones de ciclo de vida a solo el canal que la clave creó.

Capgo registra la clave de vista previa de la aplicación que subió cada paquete. La clave puede promover solo su propio paquete a cada canal de vista previa que crea. No tiene acceso a la vida de ciclo de un canal existente por defecto/main, un canal creado por otra clave de vista previa o un paquete de otra clave. Para este flujo de trabajo, omita public y nunca utilice --default.

Use channel delete <preview-channel> <public-app-id> --delete-bundle para la limpieza. Esta es una ruta de limpieza de visor previa atómica, verificada por propiedad de propiedad; elimina solo el canal de visor previa y el paquete vinculado de la clave que llama. app_preview no concede permisos generales bundle.delete.

Para la configuración de la consola y un ejemplo completo de CLI, consulte Use una clave de visor de aplicación para flujos de trabajo de visor.

Nota

Las claves sin vinculaciones de rol recaen en un sistema basado en modos de legado (read, upload, write, allLa permiso de creación de organización

Organization creation permission

La creación de organizaciones con una clave API ahora utiliza un permiso global explícito: org.create.

Este permiso es separado de las vinculaciones de roles de org/app normales porque una nueva organización no existe aún cuando POST /organization/ se llama. Para crear organizaciones con una clave API:

• La clave API debe incluir org.create en global_permissions.
• La misma clave API también debe tener una organización-scoped org_admin o org_super_admin ¿Qué pasa con las nuevas claves __CAPGO_KEEP_0__?
• New API keys do not receive org.create por defecto. Activa Permitir la creación de organizaciones al crear o editar una clave de RBAC API en la consola.
• Las claves de administrador de escritura de organización/existente administrador de super organización API se rellenaron con org.create para que las integraciones existentes puedan seguir creando organizaciones.

Cuando una clave API crea una organización, Capgo asigna automáticamente la misma clave API a org_super_admin en la organización recién creada. Esto permite a la integración gestionar la organización que acaba de crear sin necesidad de una vinculación de rol manual separada.

Si crea una clave API a través de API, incluya global_permissions junto con la vinculación de administrador de organización:

{
  "name": "Provisioning key",
  "hashed": true,
  "bindings": [
    {
      "role_name": "org_admin",
      "scope_type": "org",
      "org_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "global_permissions": ["org.create"]
}

org.create solo se aplica a la creación de organizaciones. Eliminar una organización sigue requiriendo permiso de eliminación en la organización objetivo, típicamente a través de org_super_admin.

Claves Seguras (Hashed)

Al crear una clave segura, el servidor genera el material de la clave y devuelve el valor en claro una vez. Solo se almacena una hash. Esto significa:

• La clave de texto plano no se puede recuperar después de la creación.
• La regeneración produce una nueva clave de texto plano (mostrada una vez) y actualiza el hash almacenado.
• Se recomiendan claves hashadas para el uso en producción.

Algunas organizaciones obligan claves hashadas mediante la enforce_hashed_api_keys póliza de la organización.

Vencimiento

Las claves pueden tener una fecha de vencimiento opcional. Las claves vencidas se rechazan en el nivel de verificación de permisos.

Las pólizas de organización pueden obligar:

• Expiración obligatoria (require_apikey_expiration) — Todas las nuevas claves deben tener una fecha de caducidad.
• Tiempo de Vida Máximo (max_apikey_expiration_days) — La fecha de caducidad no puede ser más allá de N días de ahora.

Prácticas de Seguridad

1. Principio de Menor Privilegio: Asignar el rol más restrictivo que aún permita que tu integración funcione
2. Rotación Regular: Regenera tus API claves periódicamente utilizando la característica de regeneración
3. Almacenamiento Seguro: Almacena las API claves de manera segura y nunca las comitas a control de versiones
4. Uso de Claves HasheadasCrea claves seguras (hash) para integraciones de producción
5. Establecer ExpiraciónSiempre establece una fecha de expiración en claves utilizadas para acceso temporal o CI/CD
6. Restricciones de ÁmbitoRestringe claves a aplicaciones específicas con el rol mínimo requerido

Uso Común

1. Integración de CI/CDCrear claves con ámbito específico para aplicaciones con el app_uploader o app_developer role, y establece una fecha de expiración
2. Canales de Vista Previa de PR: Utilice app_preview en la aplicación de previsualización o aplicaciones solo cuando la CI necesite subir un paquete, crear un canal temporal y eliminar automáticamente su propio canal y paquete.
3. Automatización de Despliegue: Utilice claves con el app_developer rol para scripts de automatización de despliegue.
4. Herramientas de Monitoreo: Crea claves con el app_reader rol para integraciones de monitoreo externas.
5. Acceso Administrativo: Utilice claves con el org_admin rol con moderación para herramientas administrativas.
6. Integraciones de TercerosCrear claves restringidas a aplicaciones específicas con el rol mínimo requerido.
7. Provisión de OrganizaciónUsar un org_admin o org_super_admin ¿Qué alternativas hay para actualizar en vivo? org.create Clave de RBAC con solo para automatización confiable que necesita crear organizaciones.

Siga desde Claves API

Si está utilizando Claves __CAPGO_KEEP_0__ para planificar la autenticación y los flujos de cuentas, conéctelo con @API/__CAPGO_KEEP_1__-login-social ¿Otra cosa? @capgo/capacitor-social-login para el detalle de implementación en @capgo/capacitor-login-social, @capgo/capacitor-clave-privada para el detalle de implementación en @capgo/capacitor-clave-privada, @capgo/capacitor-autenticación-biometrica-nativa para el detalle de implementación en @capgo/capacitor-autenticación-biometrica-nativa, Autenticación de dos factores para el detalle de implementación en la autenticación de dos factores, y SSO (Empresas) para el detalle de implementación en SSO (Empresas).