Ir para o conteúdo principal
Adaptive Planning
Última atualização: 2023-06-23
Autenticar com o OAuth

Autenticar com o OAuth

Você pode autenticar sua fonte de dados em nuvem personalizada com um provedor de serviços OAuth configurando uma credencial OAuth. Designers de dados que pretendem usar uma fonte de dados em nuvem personalizada devem se conectar e autorizar uma solicitação de acesso.
Se você criou uma credencial do Workday, pode usá-la para autenticar sua fonte de dados em nuvem personalizada.

Pré-requisitos

  • Não sabe o que é uma fonte de dados em nuvem personalizada? Consulte Conceito: fonte de dados em nuvem personalizada e Definir fonte de dados em nuvem personalizada (CCDS).
  • Permissões obrigatórias para definir e autenticar uma fonte de dados em nuvem personalizada com o OAuth:
    desenvolvedor de integração
    em
    Administração > Conjunto de permissões
  • Permissões obrigatórias para solicitar autorização para uma fonte de dados em nuvem personalizada:
    Designer de dados
    em
    Administração > Conjunto de permissões
  • Crie uma fonte de dados em nuvem personalizada ou selecione uma fonte de dados em nuvem personalizada existente.

Navegação

Compass.png No menu de navegação, acesse
Integração
>
Design de integrações
.

Definir e configurar um OAuth

Crie e gerencie configurações do OAuth usando o painel
Credenciais
na
Biblioteca de componentes
.
  1. Selecione
    Criar nova credencial
    no painel
    Credenciais
    .
  2. Selecione
    OAuth1.0a
    ou
    OAuth 2.0
    , insira um nome para a credencial e clique em
    Criar
    . As credenciais OAuth 1.0a e OAuth 2.0 usam ícones diferentes para fins de identificação.
  3. Preencha as
    Configurações:
    As configurações
    do OAuth 1.0a
    têm estes campos:
    • Chave do cliente
      : ID do cliente ou identificador do cliente, emitido para o cliente durante o processo de registro. A
      chave do consumidor
      e a
      chave secreta cliente
      formam o par de credenciais para identificar e autenticar o cliente que está fazendo uma solicitação.
    • Chave secreta cliente
      : a chave secreta do cliente.
    • Método de assinatura com suporte
      : o método de assinatura predefinido é "HMAC-SHA1" e não pode ser alterado.
    • Solicitar método HTTP de serviço de token
      : selecione GET ou POST no menu suspenso.
    • Solicitar ponto de extremidade de serviços de token
      : usado pelo cliente para solicitar um conjunto de credenciais de token.
    • Autorizar redirecionamento de URL
      : URL para obter as credenciais temporárias para identificação de solicitação de delegação.
    • Acessar método HTTP de serviço de token
      : selecione GET ou POST de acordo com os requisitos de serviço de token de acesso externo.
    • Acessar ponto de extremidade de serviço de token
      : URL para buscar o token de acesso a recursos protegidos.
    • Adicionar parâmetros OAuth para solicitar URLs
      : URL para identificar um recurso dentro do escopo da autoridade de nomenclatura e do esquema do URI.
    As configurações
    do OAuth 2.0
    têm estes campos adicionais:
    • Chave do cliente
      : ID do cliente ou identificador do cliente, emitido para o cliente durante o processo de registro. A
      chave do consumidor
      e a
      chave secreta cliente
      formam o par de credenciais para identificar e autenticar o cliente que está fazendo uma solicitação.
    • Chave secreta cliente
      : a chave secreta do cliente.
    • Redirecionar URI
      : redireciona o usuário após a autorização. Desenvolvedores de integrações usam esse URI durante a definição do aplicativo OAuth 2.0 no servidor de terceiros. Esse campo não pode ser alterado.
    • Escopo
      : o escopo de serviços ou objetos para solicitações de acesso de autorização.
    • Cabeçalho de autorização obrigatório
      : marque essa caixa de seleção se o provedor de serviços terceirizado exige o cabeçalho de autorização na solicitação ao solicitar ou atualizar o token de acesso após a autorização.
    • Token de acesso renovável
      : marque essa caixa de seleção se o processo de autorização inicial busca os tokens originais de acesso e atualização para renovação e se o token de acesso no servidor de terceiros foi renovado automaticamente.
    • Autorizar redirecionamento de URL
      : URL para obter as credenciais temporárias para identificação de solicitação de delegação.
    • Acessar método HTTP de serviço de token
      : selecione GET ou POST de acordo com os requisitos de serviço de token de acesso externo.
    • Acessar ponto de extremidade de serviço de token
      : URL para buscar o token de acesso a recursos protegidos.
    • Validade por padrão do token (segundos)
      : validade por padrão em segundos para tokens de acesso sem expiração.
  4. Clique em
    Salvar
    no painel
    Ações
    .
Consulte Protocolo OAuth 1.0 e Estrutura de autorização OAuth 2.0 para obter mais informações.

Autenticar sua fonte de dados em nuvem personalizada com o OAuth

Estas etapas são para desenvolvedores de integrações.
  1. Selecione sua fonte de dados em nuvem personalizada no painel
    Fontes de dados
    .
  2. Selecione
    Credenciais obrigatórias
    na guia
    Configurações de dados
    .
  3. Escolha sua credencial OAuth no menu suspenso
    Credenciais
    .
  4. Atualize o script na guia
    Scripts
    para incluir sua credencial OAuth. Por exemplo,
    response=ai.authorizedRequest(url,method,body,headers)
    .
  5. Clique em
    Salvar
    no painel
    Ações
    .

Solicitar autorização

Estas etapas são para designers de dados.
  1. Selecione sua fonte de dados em nuvem personalizada no painel
    Fontes de dados
    .
  2. Selecione
    Solicitar autorização
    no painel
    Ações
    para gerar a solicitação de autorização da fonte de dados em nuvem personalizada.
    Uma nova janela do navegador é aberta para autorizar o site de terceiros. Após a conclusão da autorização, o OAuth 1.0a se conecta a sua conta para acessar dados. Se o site de terceiros permitir, o OAuth 2.0 pode indicar o escopo completo dos serviços que você inseriu no campo do OAuth 2.0
    Settings-
    Scope
    .
  3. Atualizar o
    Adaptive Planning
    Página Fontes de dados em nuvem personalizada. Observe que todos os itens de menu no painel
    Ações
    são habilitados.
A guia
Configurações de fonte de dados
exibe o
Status de autorização
com o ID de autorização de terceiros e a data da autorização. As datas de vencimento da autorização variam de um provedor para outro. Preste atenção na data em que a sua autorização expira.
Clique em
Redefinir autorização
no painel
Ações
para autorizar novamente quando necessário. Você pode usar
Redefinir autorização
para fornecer credenciais de autorização diferentes a um site de terceiros.