teseladb admin apikey
Cómo se usa teseladb admin apikey, con sus opciones y sus ejemplos.
Uso
teseladb admin --node <addr> apikey create --user <usuario> --db <db> [--role <rol>@<db>] [--expires-after-days <n>]
teseladb admin --node <addr> apikey list [--user <usuario>]
teseladb admin --node <addr> apikey revoke <keyId>Descripción
Crea claves de API para la API REST y el servidor MCP, lista las que hay y revoca las que ya no uses.
Opciones
| Opción | Por defecto | Descripción |
|---|---|---|
--node | 127.0.0.1:27200 | Puerto de administración del nodo al que se pregunta. |
--format | Escribe la salida en JSON. Sin esta opción, la escribe como texto. | |
--dbpath | Directorio de datos del nodo. En teseladb admin, el directorio de cuya PKI se toman las credenciales. | |
--tlsCertificateKeyFile | los de la PKI | Certificado y clave en PEM. En un nodo, sustituyen a los de la PKI; en admin y mcp, son los del cliente. |
--tlsCAFile | la de la PKI | CA en PEM. En un nodo, la que verifica los certificados de cliente; en admin y mcp, la que firmó el certificado del nodo. |
--user | Usuario dueño de la clave. En apikey list, muestra solo sus claves. | |
--db | Base de datos donde está definido el usuario. | |
--role | Limita la clave a un rol, escrito <rol>@<db>, si el usuario lo tiene. Se puede repetir; sin ninguno, la clave lleva los roles del usuario. | |
--expires-after-days | Días hasta que la clave caduca, de 1 a 365; el máximo lo cambia httpOptions.apiKeys.maxExpiresAfterDays. Sin esta opción, caduca a los 90 días. |
Ejemplos
Crear una clave para un usuario
Shell
teseladb admin apikey create --user agente --db admin --role read@ventas --expires-after-days 30Listar las claves
Shell
teseladb admin apikey listRevocar una clave
Shell
teseladb admin apikey revoke <keyId>Códigos de salida
0La orden terminó bien.1La orden falló al ejecutarse; el error dice por qué.2La orden se escribió mal, porque falta un argumento o sobra una opción.