> ## Documentation Index
> Fetch the complete documentation index at: https://internal.softcrum.com/llms.txt
> Use this file to discover all available pages before exploring further.

# identity.api_key

> La credencial de un sistema externo. Guarda solo el hash del secreto, se rota con solapamiento y nunca se borra.

export const ParamField = ({default: defaultValue, deprecated = false, children, name, required = false, rules, type, unique = false, base = false, visibility = 'public'}) => <div className="pt-2.5 pb-5 my-2.5 border-gray-50 dark:border-gray-800/50 border-b">
    <div className="flex font-mono text-sm group/param-head param-head">
      <div className="flex-1 flex content-start py-0.5 mr-5">
        <div className="flex items-center flex-wrap gap-2">
          <div className="absolute h-0 w-0">
            <a href={`#param-${String(name).replace(/_/g, '-')}`} className="-ml-10 flex items-center opacity-0 border-0 group-hover/param-head:opacity-100 py-2 [.expandable-content_&]:-ml-[2.1rem]" aria-label="Ir a este campo">
              <div className="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20">
                <svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512">
                  <path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path>
                </svg>
              </div>
            </a>
          </div>
          <div id={`param-${String(name).replace(/_/g, '-')}`} className="font-semibold text-primary dark:text-primary-light cursor-pointer">{name}</div>
          <div className="flex items-center space-x-2 text-xs font-medium">
            {type && <span className="px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-gray-600 dark:text-gray-200 font-medium">
                {type}
              </span>}
            {defaultValue && <span className="px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-gray-600 dark:text-gray-200 font-medium">
                <span className="text-gray-400 dark:text-gray-500">default:</span>"{defaultValue}"
              </span>}
            {base && <span className="px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-gray-500 dark:text-gray-400 font-medium">
                base
              </span>}
            {visibility && <span className="px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-blue-600 dark:text-blue-300 font-medium">
                {visibility === 'private' ? 'privado' : 'público'}
              </span>}
            {unique && <span className="px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-blue-600 dark:text-blue-300 font-medium">
                único
              </span>}
            {required && <span className="px-2 py-0.5 rounded-md bg-red-100/50 dark:bg-red-400/10 text-red-600 dark:text-red-300 font-medium">
                obligatorio
              </span>}
            {deprecated && <span className="px-2 py-0.5 rounded-md bg-amber-100/50 dark:bg-amber-400/10 text-amber-600 dark:text-amber-300 font-medium">
                deprecado
              </span>}
          </div>
        </div>
      </div>
    </div>
    {children && <div className="mt-4 prose-sm prose-gray dark:prose-invert [&_.prose>p:first-child]:mt-0 [&_.prose>p:last-child]:mb-0">
        {children}
      </div>}
    {rules && <div className="mt-2 prose-sm prose-gray dark:prose-invert [&_.prose>p:first-child]:mt-0 [&_.prose>p:last-child]:mb-0">
        <b>Reglas</b>: <span>{rules}</span>
      </div>}
  </div>;

**Forma A — dominio con alcance de tenant.** Una API key **lleva roles como los lleva una persona**
(DEC-D5), así que sus permisos se resuelven por el mismo camino y con el mismo código.

La rotación con solapamiento existe porque desplegar una credencial nueva en varios sistemas no es
atómico: durante la ventana autentican la vieja y la nueva; después, solo la nueva.

## Clave primaria

<ParamField default={'uuidv7'} name={'id'} required={true} type={'uuid'} base={true}>
  Identificador de la key.
</ParamField>

## Atributos específicos

<ParamField name={'expires_at'} rules={'Con zona horaria'} type={'timestamptz'}>
  Vencimiento opcional. Nulo significa sin vencimiento, que conviene desalentar en la consola.
</ParamField>

<ParamField name={'kind'} required={true} rules={'Valores: secret, public_write'} type={'varchar'}>
  `secret` es una credencial de servidor con todos sus roles. **`public_write` solo alcanza la
  ingesta de `track`** y ningún otro endpoint, porque vive en el navegador de nuestros clientes.
</ParamField>

<ParamField name={'label'} required={true} rules={'Largo máximo: 120 caracteres'} type={'varchar'}>
  Para qué es la key: "punto de venta", "ERP". Sin esto, rotar una key es adivinar qué se rompe.
</ParamField>

<ParamField name={'last_used_at'} rules={'Con zona horaria'} type={'timestamptz'}>
  Último uso. Se escribe de forma perezosa: **actualizarlo no debe agregar latencia medible al
  request**, y eso es criterio de aceptación.
</ParamField>

<ParamField name={'last_used_ip'} rules={'IPv4 o IPv6'} type={'inet'}>
  Desde dónde se usó por última vez. Es la primera señal de una key filtrada.
</ParamField>

<ParamField name={'overlap_until'} rules={'Con zona horaria'} type={'timestamptz'}>
  Hasta cuándo sigue autenticando la key que esta reemplazó. Nulo fuera de una rotación.
</ParamField>

<ParamField name={'prefix'} required={true} rules={'Largo máximo: 12 caracteres. En claro'} type={'varchar'} unique={true}>
  Prefijo visible de la credencial. Es lo único que devuelve el listado, y es lo que permite
  identificar una key en un log sin exponerla.
</ParamField>

<ParamField name={'revoked_at'} rules={'Con zona horaria'} type={'timestamptz'}>
  Cuándo se revocó. **Efectiva en el siguiente request.** La fila nunca se borra.
</ParamField>

<ParamField name={'secret_hash'} required={true} rules={'Hash Argon2id'} type={'varchar'} visibility={'private'}>
  Hash del secreto. **El secreto se devuelve exactamente una vez**, al crearla; toda lectura
  posterior devuelve solo el prefijo.
</ParamField>

## Claves foráneas

<ParamField name={'organization_id'} required={true} type={'uuid'}>
  [Ref: organization](/schemas/identity/organization)
</ParamField>

<ParamField name={'rotated_from'} type={'uuid'}>
  La key que esta reemplaza. [Ref: api\_key](/schemas/identity/api-key)
</ParamField>

<ParamField name={'tenant_id'} required={true} type={'uuid'} base={true}>
  El tenant dueño. Toda restricción de unicidad de esta tabla lo incluye (`standards/data.md` §2b).
</ParamField>

## Atributos base

<ParamField name={'cell_id'} required={true} type={'uuid'} base={true}>
  Costura de particionamiento regional. Presente desde la primera migración, sin usar hasta
  multi-región.
</ParamField>

<ParamField default={'now()'} name={'created_at'} required={true} rules={'Con zona horaria'} type={'timestamptz'} base={true} />

<ParamField name={'deleted_at'} rules={'Con zona horaria'} type={'timestamptz'} base={true}>
  Las API keys **nunca se borran**: se revocan con `revoked_at` y se conservan para poder investigar un incidente.
</ParamField>

<ParamField default={'now()'} name={'updated_at'} required={true} rules={'Con zona horaria'} type={'timestamptz'} base={true} />

## Restricciones e índices

| Nombre                          | Definición                                                  | Por qué existe                                                                     |
| ------------------------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `uq_api_key_prefix`             | `UNIQUE (prefix)`                                           | El prefijo identifica la key en logs y en la consola, y debe resolver a una sola   |
| `idx_api_key_organization_live` | `(tenant_id, organization_id) WHERE revoked_at IS NULL`     | Listar las keys vigentes de una organización                                       |
| `ck_api_key_overlap`            | `CHECK (rotated_from IS NULL OR overlap_until IS NOT NULL)` | Una rotación sin ventana de solapamiento corta el servicio del cliente al instante |

## RLS y particionamiento

**RLS activa** por `tenant_id`. No particionada.

**Una key de la organización A no puede actuar sobre la B bajo ningún rol**, y ese es un caso de
prueba explícito, no una expectativa.

## Referencias entrantes

[`role_assignment`](/schemas/identity/role-assignment) — con `subject_type = 'api_key'`

## Registro de cambios

| Fecha      | Cambio                                                 | Por qué                                                                                            | Decidido en | Autor                  |
| ---------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | ----------- | ---------------------- |
| 2026-08-17 | Tabla creada, con `prefix` en claro y `secret_hash`    | Poder identificar una key en un log sin exponerla es lo que hace investigable un incidente         | FS-IDN-0006 | daniel + claude-opus-5 |
| 2026-08-17 | Se agregan `rotated_from` y `overlap_until`            | Desplegar una credencial nueva en varios sistemas no es atómico; sin solapamiento, rotar es cortar | FS-IDN-0006 | daniel + claude-opus-5 |
| 2026-08-18 | Renombrada de `identity.api_keys` a `identity.api_key` | Nombre en singular                                                                                 | ADR-024     | daniel + claude-opus-5 |