Esta é a documentação para oPersonalizationHandshake. Os passos para configurar oOAuthAuthenticationHandshakesão ligeiramente diferentes.

Se você tem um servidor OAuth existente que suporta o fluxo PKCE, você pode integrar com o Mintlify para uma experiência de login perfeita.

​
Implementação

1

Crie sua API de Informações

Crie um endpoint de API que possa ser acessado com um token de acesso OAuth e responda com uma carga JSON seguindo o formatoUser. Tome nota do escopo ou escopos necessários para acessar este endpoint.

2

Configure suas configurações de Personalização

Vá para suasconfigurações do painel, selecione a opção OAuth e preencha os campos obrigatórios:

  • URL de Autorização: A URL base para a solicitação de autorização, à qual adicionaremos os parâmetros de consulta apropriados.
  • ID do Cliente: Um ID para o cliente OAuth 2.0 a ser usado.
  • Escopos: Uma matriz de escopos que serão solicitados.
  • URL do Token: A URL base para a solicitação de troca de token.
  • URL da API de Informações: O endpoint que será acessado para recuperar informações do usuário.
3

Configure seu cliente OAuth

Copie a URL de Redirecionamento listada nasconfigurações do painele adicione-a como uma URL de redirecionamento autorizada para o seu servidor OAuth.

​
Exemplo

Eu tenho um servidor OAuth existente que suporta o fluxo PKCE. Quero configurar a autenticação para meus documentos hospedados emfoo.com/docs.

Para configurar a autenticação com o Mintlify, crio um endpointapi.foo.com/docs/user-infoque requer um token de acesso OAuth com o escopodocs-user-info, e responde com os dados personalizados do usuário de acordo com a especificação do Mintlify.

Em seguida, vou para as configurações do painel, navego até as configurações de Personalização, seleciono OAuth e insiro os valores relevantes para o fluxo OAuth e o endpoint da API de Informações:

  • URL de Autorização:https://auth.foo.com/authorization
  • ID do Cliente:ydybo4SD8PR73vzWWd6S0ObH
  • Escopos:['docs-user-info']
  • URL do Token:https://auth.foo.com/exchange
  • URL da API de Informações:https://api.foo.com/docs/user-info

Por fim, copio a URL de Redirecionamento exibida nas configurações do painel e a adiciono como uma URL de redirecionamento autorizada nas configurações do meu cliente OAuth.