Interfaz de línea de comandos

La interfaz de línea de comandos (CLI) de keenauth llama a la API de gestión desde una terminal o un script. Cada comando envuelve un método tipado del SDK de Go, por lo que la CLI y la API se comportan de la misma manera. Todavía no hay un paquete de instalación.

Autenticación y destino

La CLI lee sus credenciales solo desde el entorno. La clave de API nunca se acepta como indicador, de modo que no queda en el historial de su shell.

En lugar de una clave de API, puede iniciar sesión con su cuenta del panel: keenauth login, y luego keenauth env use <environment_id>. La sesión se usa solo cuando KEENAUTH_API_KEY no está definida, y la dirección del entorno se obtiene entonces del plano de control (consulte Iniciar sesión con keenauth login).

El indicador --base-url anula KEENAUTH_BASE_URL para un comando. La CLI nunca muestra la clave de API; si una respuesta del servidor la repite, se reemplaza por [redacted].

Comandos

Los comandos siguen el patrón keenauth <group> <action> [arguments] [flags]. Ejecute keenauth --help o keenauth <group> --help para ver la lista completa.

Los comandos de listado aceptan --limit, --after, --before y --order. Cuando hay más resultados, el siguiente cursor se imprime en stderr como more results: --after <cursor>.

Formato de salida

--output (-o) selecciona table, json o yaml. Sin el indicador, la CLI imprime una tabla en una terminal y JSON en caso contrario. JSON y YAML contienen la respuesta de la API sin cambios y nunca se traducen, para que los scripts puedan confiar en ellos. Los resultados van a stdout; los errores, las sugerencias y la línea etag van a stderr.

Cuerpos de solicitud

Los comandos que envían un cuerpo aceptan un indicador por cada campo plano, con el nombre de la clave JSON con guiones (phone_number se convierte en --phone-number). Los objetos anidados se indican con --data:

• --data @file.json lee el cuerpo desde un archivo.
• --data - lee el cuerpo desde la entrada estándar.

Los indicadores sobrescriben los campos del archivo. Un cuerpo está limitado a 4 MiB.

keenauth users create --email ada@example.com
keenauth apis create --data @api.json
echo '{"name":"Orders"}' | keenauth apis update api_123 --data - --if-match '"v3"'

Concurrencia optimista: --if-match y el etag

Los comandos de actualización y eliminación de aplicaciones, API y conexiones requieren --if-match; users update lo acepta. El valor es el ETag de la versión que desea modificar. El servidor rechaza la solicitud si el recurso cambió entretanto. identity-settings update también lo requiere. environment-settings update también lo requiere. Las escrituras del borrador de marca (branding update, branding applications put, branding organizations put, branding css put, branding page-template put) también lo requieren.

Cada comando get (users, applications, apis, connections, identity-settings, environment-settings) imprime la respuesta ETag en stderr, para que stdout quede limpio:

$ keenauth apis get api_123
{ ... }
etag: "v3"
$ keenauth apis update api_123 --name Orders --if-match '"v3"'

La línea etag no se añade a la salida JSON ni YAML.

Comandos destructivos y --yes

Los comandos que eliminan o bloquean piden confirmación ([y/N]) en una terminal. Si la rechaza, el comando termina con el código 1 e imprime aborted. Cuando la entrada estándar no es una terminal, el comando se niega a ejecutarse a menos que pase --yes (-y); termina con el código 2 antes de enviar cualquier solicitud.

Códigos de salida

Para los errores del servidor, la CLI imprime error, code, status, detail, request_id y una línea field por cada error de validación en stderr. Cite el request_id cuando contacte con soporte.

Idioma

El texto legible por personas (ayuda, avisos, errores, encabezados de tabla) está disponible en turco (tr), inglés (en), francés (fr), alemán (de), coreano (ko), japonés (ja), italiano (it) y español (es). El idioma se toma del primer conjunto de estas variables: KEENAUTH_LANG, LC_ALL, LC_MESSAGES, LANG (por ejemplo, tr_TR.UTF-8 selecciona tr). Un valor vacío o no compatible selecciona inglés, y un mensaje que falte en un idioma recurre al inglés.

La salida legible por máquinas nunca se traduce: los nombres y valores de los campos JSON y YAML, el code del problema y las etiquetas code, status y request_id permanecen iguales en todos los idiomas. Los mensajes que provienen del servidor se muestran tal como los envió el servidor.

KEENAUTH_LANG=de keenauth users list --help

Credenciales de aplicación

keenauth applications credentials list|create|delete gestiona los secretos de cliente y las claves públicas registradas de una aplicación. Estos comandos no usan --if-match.

keenauth applications credentials create app_123 --type client-secret --expires-at 2027-01-01T00:00:00Z
keenauth applications credentials create app_123 --type public-key --jwk-file key.pub.jwk
keenauth applications credentials delete app_123 cred_456 --yes

Un secreto de cliente se imprime una sola vez, en stdout, junto con una advertencia única en stderr. --jwk-file acepta una única JWK pública (como máximo 16 KiB); un archivo con miembros privados se rechaza antes de enviar cualquier solicitud.

Claves de API

keenauth api-keys list|get|create|rotate|revoke gestiona las claves de API de gestión del entorno. Estos comandos no usan --if-match.

keenauth api-keys create --name ci --type restricted --permissions users:read,users:write --expires-at 2027-10-01T00:00:00Z
keenauth api-keys rotate key_123 --overlap-hours 24
keenauth api-keys revoke key_123 --reason leaked --yes

La clave sin procesar de create y rotate se imprime una sola vez, en stdout, junto con una advertencia única en stderr; no puede volver a recuperarse. list y get imprimen solo metadatos.