> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Obter configuração OpenID | API de Autenticação da Didit > GET /.well-known/openid-configuration retorna a descoberta OpenID Connect da sua aplicação Didit: issuer, endpoints, grants, ES256 e claims. > [!WARNING] > > A autenticação é nova. Estes endpoints são fornecidos pelo issuer da sua aplicação, como `https://.auth.didit.me`, e nunca recebem a sua chave de API da Didit. Busque o discovery no issuer que você configurou, nunca em uma URL lida em um token. A resposta pode ficar em cache por 5 minutos. Consulte [Tokens e JWKS](https://docs.didit.me/pt-br/authentication/tokens-and-jwks.md#descoberta-e-chaves) para saber o que cada campo significa para a sua integração. ## OpenAPI ````yaml pt-br/openapi-authentication.json GET /.well-known/openid-configuration openapi: 3.0.3 info: title: Didit Authentication API version: 1.0.0 description: >- Os endpoints voltados ao servidor do Didit Authentication, o produto de login para os usuários finais da sua aplicação. O Authentication é **novo** e chega à produção na versão de 2026-11-01. ## URL base Cada aplicação é o seu próprio emissor OpenID Connect, e todos os endpoints abaixo são servidos na raiz desse emissor: - `https://.auth.didit.me` para uma aplicação de produção, ou `https://.sandbox.auth.didit.me` para uma aplicação de sandbox. - O seu próprio domínio personalizado, depois de ativado. Ele passa então a substituir o host padrão como emissor: novos tokens o indicam em `iss`, o discovery aponta para ele e a chave publicável muda. Tokens de acesso emitidos sob o host padrão falham em `/session/`, `/step-up/` e `/monitoring-token/` até serem renovados. Produção e sandbox são aplicações separadas, portanto são emissores separados, com chaves separadas. A chave publicável é `pk_live_` (produção) ou `pk_test_` (sandbox) seguida da codificação base64url sem preenchimento do emissor, sem barra final: decodifique-a para descobrir o emissor. Ela é um identificador público, não uma credencial. Os mesmos endpoints JSON também são servidos em `https://apx.didit.me/auth/v2/authentication/{application_id}/`. Os tokens sempre indicam o emissor acima, seja qual for o endereço que os emitiu. ## Credenciais Estes endpoints nunca recebem a sua chave de API do Didit nem um token do console. - O discovery, o JWKS e `POST /token/` não recebem credencial. Os clientes são públicos: não há client secret, e um código de autorização fica vinculado ao seu verificador PKCE (`S256`). O `client_id` é o ID da sua aplicação. - `/session/`, `/step-up/` e `/monitoring-token/` recebem o token de acesso da pessoa: `Authorization: Bearer `. Cada chamada bem-sucedida conta como atividade na sessão, então reinicia o tempo limite de inatividade da sessão. ## Corpos de requisição Todo endpoint que recebe um corpo aceita corpos JSON, form-encoded e multipart. Este documento lista JSON, além de form-encoded para `POST /token/`, como os clientes OAuth o enviam. Um campo que o endpoint não aceita recebe `400 {"": "unknown_field"}`. ## Tokens - **Token de acesso**: um JWT ES256 com o cabeçalho `typ: at+jwt`, válido por no máximo 5 minutos e nunca por mais tempo que a sua sessão. Claims: `AccessTokenClaims`. - **ID token**: um JWT ES256 com o cabeçalho `typ: JWT`. Claims: `IDTokenClaims`. Ele nunca é aceito como token de acesso. - **Refresh token**: uma string aleatória que é rotacionada a cada uso. Enviar novamente um refresh token já usado revoga a sessão. Verifique um token com as chaves de `GET /.well-known/jwks.json`: o algoritmo deve ser `ES256`, `typ` deve corresponder ao tipo de token, `iss` deve ser igual ao emissor que você configurou e `aud` ao ID da sua aplicação. A verificação offline só percebe uma sessão revogada quando o token de acesso dela expira; `GET /session/` é a verificação instantânea. ## Erros | Corpo | Quando | | --- | --- | | `{"error": ""}` | Erros de `POST /token/`, todos com status `400`, no formato de corpo da [RFC 6749, seção 5.2](https://www.rfc-editor.org/rfc/rfc6749#section-5.2): `invalid_grant`, `invalid_client` e o `mfa_required` do Didit. Erros de serviço: `temporarily_unavailable`, `monitoring_unavailable`, `monitoring_disabled`. | | `{"": [""]}` ou `{"": ""}` | Um campo da requisição falhou na validação. `non_field_errors` indica uma regra que envolve vários campos, e `unknown_field`, um campo que o endpoint não aceita. | | `{"detail": ""}` | `401` (`invalid_token`), `403` (`origin_not_allowed`), `404` (aplicação ou step-up desconhecidos) e `429` (limite de requisições). Também `400` para um corpo que não pode ser interpretado (`JSON parse error - ...`), `405` para um método que o endpoint não atende e `415` para um `Content-Type` não suportado. | Um `401` também traz `WWW-Authenticate: Bearer`, e um `429` traz `Retry-After` em segundos. Duas recusas não são JSON. Um endereço que não é um emissor é recusado antes de chegar a estes endpoints, por exemplo com um `404` vazio para um nome `*.auth.didit.me` não utilizado. Um `step_up_id` que não é um UUID recebe uma página `404`. ## Limites de requisições Uma requisição precisa passar por duas camadas. **Limites por endpoint**, contados por endereço IP do cliente, por aplicação e por endpoint: - Discovery e JWKS: 1.200 requisições por minuto e 12.000 por hora. - Todos os demais endpoints: 30 requisições por minuto e 300 por hora. `GET` e `DELETE /session/` compartilham a mesma contagem. Acima de um limite: `429 {"detail": "Too many requests from this IP address. Please wait before trying again. Expected available in 60 seconds."}`, ou `3600 seconds` para o limite por hora. **Proteção contra bots**, em todo `POST` e `DELETE`. Seus buckets são compartilhados por todas as requisições `POST` e `DELETE` da aplicação, incluindo as etapas de login hospedadas, e são reabastecidos continuamente: - 60 requisições por minuto por endereço IP do cliente. - 30 requisições por minuto por dispositivo, para requisições que identificam o seu dispositivo, como fazem os SDKs de navegador e nativos. - 1.000 requisições por minuto para a aplicação inteira, somando todos os endereços IP. Acima de um bucket: `429 {"detail": "rate_limited Expected available in N seconds."}` (`1 second.` quando N é 1). O bucket por IP abrange vários endpoints, então um único endereço que mistura chamadas de token, step-up e logout pode esgotá-lo antes de atingir qualquer limite por endpoint. O bucket da aplicação conta todos os clientes da aplicação, incluindo navegadores. As duas camadas respondem antes de o endpoint ser executado, então uma requisição que recebeu `429` não foi executada: tente novamente depois de `Retry-After`, inclusive no caso de uma renovação. ## Requisições do navegador Uma requisição que traz um cabeçalho `Origin` deve vir de uma das origens da própria aplicação ou de suas origens permitidas; caso contrário, recebe `403 origin_not_allowed`. Requisições de servidor para servidor não enviam `Origin`. ## Fora do escopo deste documento Estas rotas atendem às páginas hospedadas, aos SDKs de navegador e nativos e a agentes de IA. Elas não fazem parte do contrato de servidor, e os SDKs de servidor não as chamam: - Etapas de login: `POST /authorize/`, `POST /password/`, `/email/*`, `/phone/*`, `/password-reset/*`, `/passkeys/*`, `/mfa/*`, `/social/*` e `/protection/complete/`. - Páginas hospedadas e callbacks: `/sign-in`, `/magic`, `/invite`, `/reset`, `/verify/`, `/sso/*`, `/wallet/callback/`, `/logo/` e os arquivos de associação de apps nativos em `/.well-known/`. - Acesso de agentes: `/agents/*` e `/grants/`, incluindo `GET /agents/session/`, a verificação em tempo real do token de acesso de um agente de IA. O acesso de agentes não faz parte desta versão do contrato. - A API de gerenciamento do console para o Authentication, que recebe sessões do console. Os eventos do Authentication ainda não são entregues como webhooks, por isso este documento não define nenhum webhook. servers: - url: https://{issuer} description: 'O emissor da sua aplicação: a origem do login.' variables: issuer: default: your-app.auth.didit.me description: >- O host do emissor: `.auth.didit.me` (produção), `.sandbox.auth.didit.me` (sandbox) ou o seu domínio personalizado ativo. security: [] tags: - name: Issuer description: Chaves de descoberta e de assinatura, para verificar tokens. - name: Tokens description: Os grants de código de autorização e de refresh. - name: Sessions description: Verifica e encerra a sessão vinculada a um token de acesso. - name: Step-ups description: Verificação antes de uma ação sensível. - name: Monitoring description: Credenciais do dispositivo para eventos de monitoramento de transações. paths: /.well-known/openid-configuration: get: tags: - Issuer summary: Obter a configuração OpenID description: >- O documento de descoberta do emissor: seus endpoints, grants, algoritmo de assinatura e claims. Busque-o no emissor que você configurou, nunca a partir de uma URL encontrada em um token. Armazene-o em cache por até 5 minutos, conforme indicado em `Cache-Control`. operationId: authentication_get_openid_configuration responses: '200': description: O documento de descoberta. headers: Cache-Control: description: >- `public, max-age=300`: você e caches compartilhados podem manter uma resposta bem-sucedida por 5 minutos, o tempo de vida de um access token. schema: type: string example: public, max-age=300 content: application/json: schema: $ref: '#/components/schemas/OpenIDConfiguration' examples: Discovery: summary: Uma aplicação em produção value: issuer: https://your-app.auth.didit.me authorization_endpoint: https://your-app.auth.didit.me/sign-in token_endpoint: https://your-app.auth.didit.me/token/ jwks_uri: https://your-app.auth.didit.me/.well-known/jwks.json response_types_supported: - code response_modes_supported: - query grant_types_supported: - authorization_code - refresh_token subject_types_supported: - public id_token_signing_alg_values_supported: - ES256 token_endpoint_auth_methods_supported: - none code_challenge_methods_supported: - S256 scopes_supported: - openid - email - phone - profile - offline_access claims_supported: - iss - aud - sub - sid - auth_time - nonce - vendor_data - amr - org - verified - act - email - email_verified - name - phone_number '403': $ref: '#/components/responses/OriginNotAllowed' '404': $ref: '#/components/responses/ApplicationNotFound' '429': $ref: '#/components/responses/RateLimited' '503': $ref: '#/components/responses/TemporarilyUnavailable' security: - {} components: schemas: OpenIDConfiguration: type: object description: >- O documento de descoberta OpenID Connect do emissor. Leia os endpoints a partir dele em vez de construí-los. required: - issuer - authorization_endpoint - token_endpoint - jwks_uri - response_types_supported - response_modes_supported - grant_types_supported - subject_types_supported - id_token_signing_alg_values_supported - token_endpoint_auth_methods_supported - code_challenge_methods_supported - scopes_supported - claims_supported properties: issuer: type: string format: uri description: >- O emissor: a origem de login da aplicação, sem barra no final. O `iss` de todo token é igual a ele. example: https://your-app.auth.didit.me authorization_endpoint: type: string format: uri description: A página de login hospedada (`/sign-in`). example: https://your-app.auth.didit.me/sign-in token_endpoint: type: string format: uri example: https://your-app.auth.didit.me/token/ jwks_uri: type: string format: uri example: https://your-app.auth.didit.me/.well-known/jwks.json response_types_supported: type: array items: type: string example: - code response_modes_supported: type: array items: type: string example: - query grant_types_supported: type: array items: type: string example: - authorization_code - refresh_token subject_types_supported: type: array items: type: string example: - public id_token_signing_alg_values_supported: type: array items: type: string example: - ES256 token_endpoint_auth_methods_supported: type: array items: type: string description: '`none`: os clientes são públicos e não enviam segredo.' example: - none code_challenge_methods_supported: type: array items: type: string example: - S256 scopes_supported: type: array items: type: string example: - openid - email - phone - profile - offline_access claims_supported: type: array items: type: string example: - iss - aud - sub - sid - auth_time - nonce - vendor_data - amr - org - verified - act - email - email_verified - name - phone_number Detail: type: object required: - detail properties: detail: type: string example: invalid_token OAuthError: title: OAuth error type: object description: Um erro OAuth (RFC 6749, seção 5.2) ou um erro de serviço. required: - error properties: error: type: string example: invalid_grant responses: OriginNotAllowed: description: >- A requisição trouxe um `Origin` que não é o da própria aplicação nem está entre suas origens permitidas. Requisições de servidor não enviam `Origin`. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: OriginNotAllowed: summary: Origem não permitida value: detail: origin_not_allowed ApplicationNotFound: description: >- O endereço pertence a uma aplicação, mas a Autenticação não está ativa para ela. No endereço `apx.didit.me`, isso indica que o ID da aplicação é desconhecido. Um endereço que não pertence a nenhuma aplicação é recusado antes de chegar ao endpoint, e essa resposta não é JSON. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: ApplicationNotFound: summary: Aplicação desconhecida value: detail: No Configuration matches the given query. RateLimited: description: >- Muitas requisições deste endereço IP para este endpoint ou, em um `POST` ou `DELETE`, um bucket de proteção contra bots está vazio. Nada foi executado: aguarde `Retry-After` segundos e tente novamente. headers: Retry-After: description: Segundos de espera antes de tentar novamente. schema: type: integer example: 60 Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/Detail' examples: RateLimited: summary: Limite do endpoint value: detail: >- Too many requests from this IP address. Please wait before trying again. Expected available in 60 seconds. BotProtection: summary: Limite de proteção contra bots (POST e DELETE) value: detail: rate_limited Expected available in 2 seconds. TemporarilyUnavailable: description: >- Um serviço do qual a requisição depende está temporariamente indisponível. Tente novamente com backoff. headers: Cache-Control: description: 'Sempre `no-store`: nunca armazene esta resposta em cache.' schema: type: string example: no-store Pragma: description: Sempre `no-cache`. schema: type: string example: no-cache content: application/json: schema: $ref: '#/components/schemas/OAuthError' examples: TemporarilyUnavailable: summary: Tentar novamente mais tarde value: error: temporarily_unavailable ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.