authentication.
Todos os pedidos abaixo são enviados para a API de gestão de autenticação da sua aplicação. MANAGEMENT_BASE é:
openapi-authentication.json, na etiqueta Setup, a partir do qual os SDK de servidor são regenerados.
Qual credencial usar
Qualquer uma das três credenciais funciona, e cada uma está limitada ao que o seu titular aprovou.
Estas credenciais são recusadas com
403 em todos os endpoints de configuração, independentemente do que o pedido solicita:
- O segredo principal da aplicação.
- Um token obtido em
POST /programmatic/login, que é emitido para a aplicação e não para a consola. - Uma chave sem o âmbito
authentication, incluindo uma chave criada com todos os recursos no nível mais alto: esses aparecem listados como acesso total, mantêmscopesvazio e não são aceites nestes endpoints. - Uma chave de outra aplicação, uma concessão limitada a
didit:verificatione uma concessão aprovada para outra organização.
401. Além disso, uma concessão ou uma chave mantém os seus próprios limites: a concessão mantém os seus âmbitos, organizações e a função da pessoa; a chave mantém os seus âmbitos, a lista de IP permitidos e a validade.
Aprovar acesso
Com uma chave de API com nome
Abra Developers -> API keys na Business Console e crie uma chave para a aplicação que está a configurar. Atribua-lhe o recursoauthentication com permissão de leitura ou de escrita: a leitura cobre todas as chamadas que leem a configuração (GET); a escrita cobre todas as chamadas que a alteram (POST, PUT, PATCH, DELETE) e também a leem. Consulte Chaves de API para a validade, as listas de permissão de IP e a rotação; uma chave pertence a uma só aplicação e funciona apenas para essa aplicação.
Através de uma ligação MCP
Um agente ligado ao servidor MCP da Didit usa a autorização que o respetivo proprietário aprovou no ecrã de consentimento, comdidit:management. Consulte Autenticação MCP.
Para um proprietário sem palavra-passe
A autorização por código de dispositivo (RFC 8628) permite que um proprietário que inicie sessão com o Google, uma chave de acesso ou um código enviado por e-mail aprove o mesmo acesso a partir de qualquer navegador, sem introduzir uma palavra-passe. Consulte iniciar sessão sem navegador.Ativar o código por e-mail
Quando o método não requer credenciais,PUT methods/{name}/ aceita enabled e nada mais.
credential_source: null. Os métodos que estão sempre ativos não podem ser desativados: esse pedido responde {"enabled": "always_on"}.
Ativar o Google
Um método social exige as credenciais da sua própria aplicação OAuth ou da aplicação de teste da Didit numa aplicação sandbox.Com a sua própria aplicação Google
callback_uri devolvido na resposta no seu fornecedor. O segredo é só de escrita: nenhuma resposta o devolve, e o client_id é a única parte que pode ser lida novamente. Ativar um método sem credenciais, quando não existiam credenciais guardadas antes, responde com {"credentials": "required"}.
Com a aplicação de teste da Didit (didit_test)
Uma aplicação sandbox pode usar as aplicações sociais da própria Didit em vez das suas, o que basta para concluir a configuração e comprovar que funciona:
didit_test abrange Google, Microsoft, Apple e GitHub, apenas em aplicações sandbox:
O
GET à configuração indica em didit_test_credentials os fornecedores que uma aplicação de teste pode servir para esta aplicação. O valor é false para os quatro numa aplicação de produção.
Ler a configuração
GET em MANAGEMENT_BASE serve para ler a configuração: todos os métodos, com enabled e credential_source, bem como os URLs de retorno, as regras de sessão e a política de registo.
GET indica 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 à configuração feita com uma concessão de gestão ou uma chave de API nomeada devolve então 409 com {"detail": "product_disabled"}, e nada é gravado. Nenhuma chamada de configuração ativa a Autenticação: é uma pessoa que a ativa para a aplicação na consola, e as suas chamadas passam a funcionar a partir daí.
O restante da configuração
Uma concessão ou uma chave tem acesso à configuração e aos respetivos contadores, nunca dados do utilizador final:
users/, sessions/, sign-ins/, overview/, organizações de clientes, funções, importações, sessões de agentes e e-mails de teste continuam a exigir uma sessão na consola.
A definição agent_humans_only aplica-se a toda a aplicação. Apenas um proprietário ou administrador da organização pode alterá-la. Uma chave nomeada recebe 403 owner_or_admin_required. Ativar a definição exige também uma passkey registada (passkey_required).