Saltar al contenido principal

Inquilinos y Claves API

Administration → Tenants & API Keys es la superficie de administración de plataforma de Beak Hub. Registra los inquilinos con permiso para usar el Hub y gestiona las claves API con las que sus servicios se autentican. La descripción de la página dice "Register tenants and manage the API keys their services use to authenticate with Hub."

Todo lo demás en Hub es un catálogo que las personas pueden explorar. Esta es la única página que determina quién puede llamar al Hub en absoluto.

Acceso​

Esta página requiere el rol de platform admin. Los operadores que no lo tienen ven Admin access required, con la explicación de que se necesita ese rol y que deben solicitarlo a un administrador. Los usuarios del Hub a nivel de inquilino nunca la ven, lo cual es intencional — emitir una credencial de Hub es una acción de plataforma, no de inquilino.

Registrar un inquilino​

Register tenant registra un inquilino en el Hub con un nombre para mostrar, por ejemplo Acme Corp. El identificador del inquilino puede asignarse de forma explícita o dejarse en auto-assign.

Un inquilino debe estar registrado antes de que se pueda emitir cualquier clave para él. Hasta que exista al menos uno, la página muestra No tenants registered con la explicación de que registrar uno es la forma de comenzar la emisión de claves.

Emitir una clave API​

Las claves se generan por inquilino y se les asigna un nombre que describe qué las usará — por ejemplo, Runtime deploy key o CI pipeline. El nombre es lo único que distingue una clave de otra posteriormente, por lo que vale la pena escribirlo pensando en la persona que lo leerá dentro de seis meses, no en uno mismo hoy.

Nota: El valor de la clave se muestra en el momento en que se genera y no puede recuperarse después. Captúrelo en ese momento; si se pierde, revóquelo y genere un reemplazo en lugar de intentar recuperarlo.

La lista de claves​

Las claves de cada inquilino se listan con:

  • Name — Para qué se emitió la clave.
  • Prefix — Los caracteres iniciales de la clave, suficientes para identificarla en un registro o archivo de configuración sin exponer el secreto.
  • Status — Si la clave es válida actualmente.
  • Created — Cuándo fue emitida.
  • Last used — Cuándo se autenticó por última vez. Esta es la columna que identifica las claves que ya nadie necesita.
  • Actions — Revocación.

Un inquilino sin claves muestra No API keys yet.

Revocar una clave​

La revocación solicita confirmación (Revoke API key?) porque tiene efecto inmediato y no puede deshacerse. Cualquier servicio que aún presente esa clave dejará de poder acceder al Hub de inmediato — por lo tanto, revoque durante una ventana de cambios a menos que esté respondiendo a un incidente, donde lo inmediato es precisamente el objetivo.

Buenas Prácticas​

  • Nombre las claves según el consumidor, no la persona — CI pipeline sobrevive a un cambio de propietario; Priya's key no.
  • Emita una clave por servicio consumidor — Una clave compartida no puede revocarse sin interrumpir todo lo que la comparte, lo que en la práctica significa que nunca se revoca.
  • Use Last used como señal de retiro — Una clave que no se ha autenticado en meses está muerta o es una credencial que nadie supervisa. Ambas son razones para revocarla.
  • Registre el valor de la clave en el momento de su generación — No es recuperable después.
  • Mantenga el rol de platform admin restringido — Es el rol que decide qué inquilinos pueden acceder al Hub en absoluto.

Páginas Relacionadas​