Quem está chamando
Responde quem é a credencial com que esta requisição se autenticou: o tipo, a organização, os escopos que ela tem e os projetos (tenants) a que está vinculada. É a forma mais simples de conferir uma chave de API nova antes de usá-la. Escopo necessário: connections:read.
Respostas
| Código | Erro e descrição |
|---|---|
| 200 | A credencial que chamou: kind (apiKey, user ou platform), user (o usuário conectado; null para uma chave de API), organization (a organização em nome de quem a credencial age: a do projeto da chave, ou a organização atual do usuário), role (o papel do usuário na organização; null para uma chave), scopes, tenantIds (os projetos a que a chave está vinculada; null: todos os projetos da organização) e apiKey (id e expiresAt da chave; null fora de uma chave). |
| 401 | Sem chave de API, ou com uma chave inválida: desconhecida, revogada, expirada ou de um projeto desativado. O corpo é {"error": "Unauthorized"}. |
| 403 | A credencial não tem o escopo connections:read; a mensagem cita o escopo (This credential lacks the connections:read scope). |
| 429 | Requisições demais deste IP de origem (por padrão, 600 por minuto), ou autenticações com falha demais (por padrão, 20 a cada 5 minutos; o corpo é {"error": "Too many failed authentication attempts"}): espere os segundos de Retry-After. Veja Limites.Cabeçalho: Retry-After |
Detalhes
Uma chave de API alcança só os projetos de tenantIds: toda chave é vinculada a um único projeto, então a lista traz um só id. user e role vêm null, e apiKey traz o id da chave e o expiresAt dela (null quando ela não expira).
Um usuário do painel (kind: user, conectado com o cookie de sessão do painel) alcança todos os projetos da organização e das organizações filhas dela, com os escopos do papel do usuário (owner, admin ou member): tenantIds e apiKey vêm null. kind: platform é o operador do gateway.
scopes lista só os escopos que valem para a credencial: um escopo que uma chave não pode ter não aparece, mesmo que tenha sido gravado nela. Veja Escopos.
Guia: Autenticação