Chaves de API
Listar Chaves de API
Obter todas as chaves de API do usuário e tenant atuais.
GET /api/api-keys
Retorna todas as chaves de API pertencentes ao usuário autenticado no tenant ativo, ordenadas pela data de criação (mais recente primeiro).
Auth: Necessária — permissão api-key:manage
Exemplo
curl -X GET https://api.reten.ai/api/api-keys \
-H "Authorization: Bearer <token>" \
-H "x-tenant-id: <tenant-id>"const response = await fetch("https://api.reten.ai/api/api-keys", {
headers: {
"Authorization": "Bearer <token>",
"x-tenant-id": "<tenant-id>",
},
});
const keys = await response.json();import requests
response = requests.get(
"https://api.reten.ai/api/api-keys",
headers={
"Authorization": "Bearer <token>",
"x-tenant-id": "<tenant-id>",
},
)
keys = response.json()Resposta 200 OK
[
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "CI/CD Pipeline Key",
"keyPrefix": "rtn_sk_a1b2c3d4",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"tenantId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"projectId": "3f6c2b1a-8d4e-4f7a-9b2c-5e1d0a7f6c34",
"isActive": true,
"permissions": ["commerce:manage", "activity:view"],
"expiresAt": "2026-12-31T23:59:59.000Z",
"lastUsedAt": "2026-02-26T16:45:00.000Z",
"createdAt": "2026-02-26T14:30:00.000Z",
"revokedAt": null
},
{
"id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
"name": "Monitoring Service",
"keyPrefix": "rtn_sk_e5f6g7h8",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"tenantId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"projectId": null,
"isActive": false,
"permissions": ["activity:view"],
"expiresAt": null,
"lastUsedAt": "2026-02-20T10:00:00.000Z",
"createdAt": "2026-02-01T09:00:00.000Z",
"revokedAt": "2026-02-25T12:00:00.000Z"
}
]Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | string | UUID da chave de API |
name | string | Rótulo legível |
keyPrefix | string | Prefixo de exibição para identificação (ex.: rtn_sk_a1b2c3d4) |
userId | string | UUID do usuário que criou a chave |
tenantId | string | UUID do tenant associado |
projectId | string | null | UUID do projeto ao qual a chave pertence (chave de projeto), ou null para uma chave de tenant — veja Criar Chave de API |
isActive | boolean | true se a chave está ativa, false se foi revogada |
permissions | string[] | Nomes das permissões concedidas a esta chave |
expiresAt | string | null | Data de expiração em formato ISO 8601, ou null se não houver expiração |
lastUsedAt | string | null | Carimbo de data/hora ISO 8601 do último uso, ou null se nunca foi usada |
createdAt | string | Carimbo de data/hora de criação em formato ISO 8601 |
revokedAt | string | null | Carimbo de data/hora de revogação em formato ISO 8601, ou null se estiver ativa |
Respostas de Erro
| Status | Descrição |
|---|---|
400 | Nenhum contexto de tenant ativo |
401 | Token de autenticação ausente ou inválido |
403 | Permissões insuficientes |