OAuth 2 - Authorization Code com PKCE

Para cadastrar uma autorização do tipo OAuth 2.0 Authorization Code com PKCE, acesse a tela Authorizations pelo menu lateral esquerdo ou pelo cartão correspondente na tela Welcome.

Para entender as diferenças entre os tipos de autorização do Sensedia Integrations, acesse nosso Glossário.

Na tela de Authorizations, clique em + AUTHORIZATIONS no canto superior direito para fazer seu novo cadastro.

Em CREATE AUTHORIZATION, selecione o tipo OAuth 2 e clique em CONFIRM:

create authorization

Para configurar a autorização, preencha os campos a seguir:

  • Name: nome da autorização. Campo alfanumérico que permite caracteres especiais e espaços vazios, com limite de 1024 caracteres.

  • Description (opcional): descrição da autorização. Campo alfanumérico que permite caracteres especiais e espaços vazios, com limite de 1024 caracteres.

  • Grant Type: selecione a concessão Authorization Code with PKCE.

A seguir, selecione o ambiente que deseja configurar:

  • Staging

  • Production

Os dados cadastrados no ambiente de Staging serão utilizados na execução do Test Mode.

Se necessário, você pode selecionar e configurar os dois ambientes. Para cada ambiente, preencha os seguintes campos:

  • Redirect URL: campo bloqueado. Para copiar a URL, clique no botão 'icone de copia" à direita. A URL deve ser copiada e configurada em seu servidor de autenticação sempre que a autenticação OAuth 2 for utilizada.

  • Authorization URL: informe a URL do servidor de autorização.

  • Token URL: informe a URL do token.

  • Client ID: informe o client ID registrado no provedor de API.

  • Client Secret (opcional): informe o client secret registrado no provedor de API. Para visualizar o valor, clique no botão icone de olho à direita.

  • Code Challenge Method: campo bloqueado. Por padrão, apresenta o valor “SHA-256”.

  • Scopes (opcional): informe quais valores de escopos deseja enviar na requisição de autorização. Limite de 250 caracteres por valor. Máximo de 500 valores. Para excluir um valor de escopo específico, clique no x do lado direito da tag. Para excluir todos os valores, clique no X do lado direito do campo.

  • Client Authentication: apresenta as seguintes opções:

    • Send as Basic Auth header (padrão): a solicitação de autenticação do Auth será enviada no cabeçalho da requisição.

    • Send client credentials in body: a solicitação de autenticação do Client Credentials será enviada no corpo da requisição.

oauth2 pkce

Para validar os dados inseridos e fazer uma requisição ao servidor gerando um novo token, clique em CONNECT. No novo pop-up, faça login com suas credenciais para permitir o acesso.

Se os dados forem validados com sucesso, o botão mudará para CONNECTED.

Caso ocorram novas alterações nos dados inseridos, você deverá clicar novamente em CONNECT.

Para salvar as configurações de autorização, clique em SAVE.

O botão SAVE salva as configurações do ambiente selecionado. Caso você configure um ambiente e inicie a configuração de outro, o botão ficará bloqueado até que todos os campos do segundo ambiente tenham sido preenchidos.

Para sair sem salvar suas alterações, clique em CANCEL e confirme a ação.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]