← Voltar para a visão geral

OAuth

3 endpoints

Emissão, introspecção e revogação de tokens

POST/api/v1/oauth/token

Troca client_id + client_secret por um access token vinculado ao condomínio

Sem autenticação
Headers
Content-TypeObrigatórioapplication/json
Idempotency-KeyRecomendadoULID, janela de 24h
X-Request-IdOpcionalEcoado na resposta
Corpo da requisição*
CampoTipoRestriçõesDescrição
grant_type*stringclient_credentials—
client_id*string——
client_secret*string——
scopestring—Lista de escopos separados por espaço
condominium_idstring—Public id do condomínio ao qual o token será vinculado
Respostas
POST/api/v1/oauth/token/introspect

Consulta o estado de um access token (active, scope, exp), RFC 7662

Sem autenticação
Headers
Content-TypeObrigatórioapplication/json
Idempotency-KeyRecomendadoULID, janela de 24h
X-Request-IdOpcionalEcoado na resposta
Corpo da requisição*
CampoTipoRestriçõesDescrição
token*string——
client_id*string——
client_secret*string——
Respostas
POST/api/v1/oauth/token/revoke

Revoga um access token imediatamente (RFC 7009)

Sem autenticação
Headers
Content-TypeObrigatórioapplication/json
Idempotency-KeyRecomendadoULID, janela de 24h
X-Request-IdOpcionalEcoado na resposta
Corpo da requisição*
CampoTipoRestriçõesDescrição
token*string——
client_id*string——
client_secret*string——
Respostas