> ## 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 Lerian — tokens OAuth2, assinaturas de webhooks, scopes e health checks.

Esta página cobre todos os campos relacionados a fluxos de autenticação, verificações de segurança, assinaturas de webhooks e saúde de componentes.

## 1. Campos OAuth2 e autorização

***

| Campo        | Descrição                     | Usado em           |
| ------------ | ----------------------------- | ------------------ |
| accessToken  | Token de acesso JWT           | Auth, PIX          |
| refreshToken | Token de atualização          | Auth               |
| idToken      | Token ID do OpenID Connect    | Auth               |
| tokenType    | Tipo de token (Bearer)        | Auth, PIX          |
| expiresIn    | Tempo de expiração (segundos) | Auth, PIX          |
| grantType    | Tipo de grant OAuth2          | Auth               |
| clientId     | ID de cliente OAuth2          | Auth, PIX, Flowker |
| clientSecret | Secret de cliente OAuth2      | Auth, PIX          |
| username     | Nome de usuário               | Auth, Identity     |
| password     | Senha                         | Auth, Identity     |
| scope        | Escopo solicitado             | Auth, PIX          |
| scopes       | Lista de escopos              | Flowker            |
| sub          | Identificador do subject      | Auth               |
| aud          | Audience                      | Auth               |
| iss          | Issuer                        | Auth               |
| iat          | Emitido em                    | Auth               |
| exp          | Expiração                     | Auth               |
| nbf          | Não antes de                  | Auth               |
| jti          | ID do JWT                     | Auth               |
| active       | Flag de token ativo           | Auth               |
| authorized   | Resultado da autorização      | Auth               |
| resource     | Recurso alvo                  | Auth               |
| action       | Ação no recurso               | Auth               |
| redirectUri  | URI de redirect OAuth         | Flowker            |
| state        | State opaco OAuth             | Flowker            |

## 2. Webhooks e notificações

***

| Campo                 | Descrição                       | Usado em |
| --------------------- | ------------------------------- | -------- |
| X-Webhook-ID          | Identificador do webhook        | Flowker  |
| X-Webhook-Signature   | Assinatura HMAC do webhook      | Flowker  |
| idReqJdPi             | Identificador de requisição JD  | PIX      |
| pagador               | Pagador PIX                     | PIX      |
| recebedor             | Recebedor PIX                   | PIX      |
| valor                 | Valor 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 reembolso | PIX      |

## 3. Saúde e monitoramento

***

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