> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Autenticação e segurança

> Consulte os campos de autenticação e segurança usados nas APIs da Lerian: tokens OAuth2, assinaturas de webhook, escopos e verificações de saúde de componentes.

## 1. Campos OAuth2 e de autorização

***

| Campo | Descrição | Usado em |
| - | - | - |
| accessToken | Token de acesso JWT | Auth, Pix |
| refreshToken | Token de atualização | Auth |
| idToken | Token de ID do OpenID Connect | Auth |
| tokenType | Tipo de token (Bearer) | Auth, Pix |
| expiresIn | Tempo de expiração (segundos) | Auth, Pix |
| grantType | Tipo de concessão OAuth2 | Auth |
| clientId | ID do cliente OAuth2 | Auth, Pix |
| clientSecret | Segredo do cliente OAuth2 | Auth, Pix |
| username | Nome de usuário | Auth, Identity |
| password | Senha | Auth, Identity |
| scope | Escopo solicitado | Auth, Pix |
| sub | Identificador do subject | Auth |
| aud | Audiência | Auth |
| iss | Emissor | Auth |
| iat | Emitido em | Auth |
| exp | Expiração | Auth |
| nbf | Não válido antes de | Auth |
| jti | ID do JWT | Auth |
| active | Sinalizador de token ativo | Auth |
| authorized | Resultado da autorização | Auth |
| resource | Recurso de destino | Auth |
| action | Ação sobre o recurso | Auth |

## 2. Webhooks e notificações

***

| Campo | Descrição | Usado em |
| - | - | - |
| idReqJdPi | Identificador de requisição do JD | Pix |
| pagador | Pagador Pix | Pix |
| recebedor | Recebedor Pix | Pix |
| valor | Valor do Pix | Pix |
| dtHrOp | Timestamp da operação Pix | Pix |
| descricao | Descrição da operação | Pix |
| endToEndIdOriginal | ID E2E original | Pix |
| endToEndIdDevolucao | ID E2E de devolução | Pix |
| codigoDevolucao | Código do motivo da devolução | Pix |
| motivoDevolucao | Motivo da devolução | Pix |
| refundUrlNotification | URL de notificação de devolução | Pix |

## 3. Saúde e monitoramento

***

| Campo | Descrição | Usado em |
| - | - | - |
| status | Status geral | Pix, JD Mock |
| services | Status dos serviços dependentes | Pix |
| database | Status do banco de dados | Pix |
| redis | Status do Redis | Pix |
| jd | Status da integração com o JD | Pix |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.