authentication.
Cada chamada abaixo é enviada à API de gestão de autenticação da sua aplicação. MANAGEMENT_BASE é:
openapi-authentication.json, na tag Setup; os SDKs de servidor são regenerados a partir desse arquivo.
Qual credencial usar
Qualquer uma das três credenciais funciona, e cada uma se limita ao que o titular aprovou.
Essas credenciais são recusadas com
403 em todas as rotas de configuração, independentemente do que a requisição pede:
- O segredo principal da aplicação.
- Um token obtido em
POST /programmatic/login, que é gerado para a aplicação e não para o console. - Uma chave sem o escopo
authentication, inclusive uma chave criada com todos os recursos no nível mais alto: essas chaves aparecem como acesso total, mantêmscopesvazio e não são aceitas nessas rotas. - Uma chave de outra aplicação, uma concessão limitada a
didit:verificatione uma concessão aprovada para outra organização.
401. Uma concessão ou uma chave mantém os próprios limites além desses: a concessão, seus escopos, suas organizações e a função da pessoa; a chave, seus escopos, sua lista de IPs permitidos e sua validade.
Aprovar acesso
Com uma chave de API nomeada
Abra Developers -> API keys no Business Console e crie uma chave para a aplicação que você está configurando. Dê à chave o recursoauthentication com acesso de leitura ou de escrita: a leitura cobre todas as chamadas que leem a configuração (GET); a escrita cobre todas as chamadas que alteram a configuração (POST, PUT, PATCH, DELETE) e também leem a configuração. Veja Chaves de API para expiração, listas de IP permitidos e rotação. Uma chave pertence a uma aplicação e funciona somente para ela.
Por meio de uma conexão MCP
Um agente conectado ao servidor MCP da Didit usa a concessão que o proprietário aprovou na tela de consentimento, comdidit:management. Veja Autenticação MCP.
Para um proprietário sem senha
A concessão por código de dispositivo (RFC 8628) permite que um proprietário que faz login com Google, com uma chave de acesso ou com um código enviado por e-mail aprove o mesmo acesso a partir de qualquer navegador, sem digitar uma senha. Veja Fazer login sem navegador.Ativar código por e-mail
PUT methods/{name}/ aceita enabled, e nenhum outro campo para um método que não exige credenciais.
credential_source: null. Métodos que estão sempre ativos não podem ser desativados: essa requisição responde {"enabled": "always_on"}.
Ativar o Google
Um método social usa as credenciais do seu próprio app OAuth ou o app de teste da Didit em uma aplicação sandbox.Com o seu próprio app do Google
callback_uri retornado na resposta no seu provedor. O segredo é somente de escrita: nenhuma resposta o retorna, e client_id é a única parte que você pode ler de volta. Ativar um método sem credenciais, quando nenhuma foi armazenada antes, responde com {"credentials": "required"}.
Com o app de teste da Didit (didit_test)
Uma aplicação sandbox pode usar os apps sociais da própria Didit em vez dos seus, o que basta para concluir a configuração e comprovar que ela funciona:
didit_test cobre Google, Microsoft, Apple e GitHub, somente em aplicações sandbox:
A requisição
GET à configuração informa os provedores que um app de teste pode atender para esta aplicação em didit_test_credentials, que é false para todos os quatro em uma aplicação de produção.
Consultar a configuração
GET em MANAGEMENT_BASE retorna a configuração completa: cada método com enabled e credential_source, além das URLs de retorno, das regras de sessão e da política de cadastro.
GET mostra o que está ativo e o que não está. enabled no topo é false quando a Autenticação está desativada para a aplicação. Qualquer alteração de configuração feita com uma concessão de gerenciamento ou com uma chave nomeada retorna 409 com {"detail": "product_disabled"}, e nada é gravado. Nenhuma chamada de configuração ativa a Autenticação: uma pessoa a ativa para a aplicação no console, e suas chamadas passam a funcionar a partir daí.
O restante da configuração
Uma permissão ou uma chave tem acesso à configuração e aos contadores, nunca a dados de usuário final:
users/, sessions/, sign-ins/, overview/, organizações de clientes, funções, importações, sessões de agente e e-mails de teste ainda exigem uma sessão no console.
A configuração agent_humans_only se aplica à aplicação inteira. Somente um proprietário ou administrador da organização pode alterá-la. Uma chave nomeada recebe 403 owner_or_admin_required. Ativar a configuração também exige uma passkey cadastrada (passkey_required).