Criar aplicativos OAuth2 para integrações de Workfront
Criado para:
- Administrador
Como administrador Adobe Workfront, você pode criar aplicativos OAuth2 para sua instância do Workfront, que permitem que outros aplicativos acessem Workfront. Seus usuários podem conceder permissão a esses outros aplicativos para acessar os dados do Workfront. Dessa forma, é possível integrar com aplicativos de sua escolha, incluindo aplicativos internos.
Ao criar um aplicativo OAuth2, você gera uma ID do cliente e um Segredo do cliente. Seus usuários podem usar a ID do cliente em chamadas de API para integrar com o aplicativo criado.
NOTE- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo de código de autorização.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 usando a autenticação de servidor (fluxo JWT), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo JWT.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 usando o PKCE, consulte Configurar e usar os aplicativos OAuth 2 personalizados de sua organização usando o fluxo de PKCE.
Requisitos de acesso
Você deve ter o seguinte acesso para executar as etapas deste artigo:
Novo: Padrão
Ou
Atual:Plano
Para obter mais detalhes sobre as informações nesta tabela, consulte Requisitos de acesso na documentação do Workfront.
Visão geral do OAuth2
Imagine que um aplicativo deve obter algumas informações específicas de Workfront. Um aplicativo que solicita informações é chamado de cliente. Para este exemplo, o nome do cliente é ClientApp. O ClientApp precisa acessar as informações de um usuário específico e, portanto, deve acessar Workfront como esse usuário. Se o usuário fornecer ao ClientApp o nome de usuário e a senha, ele poderá acessar todos os dados que o usuário puder acessar. Esse é um risco de segurança, pois o ClientApp precisa apenas de um conjunto pequeno e específico de informações.
Ao criar um aplicativo OAuth2 para ClientApp, você basicamente diz a Workfront que o ClientApp tem permissão para acessar Workfront, mas somente se o usuário cuja conta o ClientApp está acessando conceder permissão para o acesso.
Criar um aplicativo OAuth2
Ao criar um aplicativo OAuth2, escolha o tipo de aplicativo que melhor atenda às necessidades de sua integração.
Melhor para CLIs, daemons ou scripts em execução no servidor
Exemplos:
-
Shell
-
Python
Melhor para aplicativos web móveis ou de página única
Exemplos:
-
Javascript
-
Angular
-
React
-
Vue
Melhor para aplicativos do lado do servidor que lidam com credenciais e tokens no servidor
Exemplos:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
NOTECriar um aplicativo OAuth2 usando autenticação de servidor (fluxo JWT)
-
Clique no ícone Menu Principal
-
No painel de navegação esquerdo, clique em Sistema e selecione Aplicativos OAuth2.
-
Clique em Criar integração de aplicativo.
A caixa Novo aplicativo OAuth2 é exibida. -
Na caixa Novo aplicativo OAuth2, selecione Computador para Aplicativo de Computador.
-
Digite um nome para o novo aplicativo, como "Workfront para ClientApp."
-
Clique em Criar.
-
Preencha os campos do novo aplicativo.
ID do ClienteEste campo é gerado automaticamente.Segredo do clienteEste campo é gerado automaticamente
IMPORTANTE:
Copie o conteúdo desse campo para outro arquivo seguro antes de fechar esta página. Você não poderá ver essa chave secreta novamente.
Se você perder essa chave, exclua-a e crie um Segredo do cliente.
-
Clique no ícone
-
Clique em Adicionar segredo do cliente para gerar um novo Segredo do Cliente.
Chaves PúblicasOs aplicativos de servidor para servidor usam chaves públicas e privadas para autenticação. Siga um destes procedimentos:
-
Clique em Adicionar uma chave pública e insira a chave pública do outro aplicativo.
-
Clique em Gerar um par de chaves públicas/privadas e compartilhe a chave pública com o outro aplicativo.
NomeEste é o mesmo nome que você deu ao aplicativo. Este campo não pode estar vazio.DescriçãoInsira uma descrição para a integração. -
-
Clique em Salvar.
Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo JWT.
Criar um aplicativo OAuth2 usando credenciais do usuário (Fluxo de código de autorização)
NOTEhttps://app.workfrontfusion.com/oauth/cb/workfront-workfronthttps://app-eu.workfrontfusion.com/oauth/cb/workfront-workfront(Centro de dados da UE)https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront(Data Center do Azure)
-
Clique no ícone Menu Principal
-
No painel de navegação esquerdo, clique em Sistema e selecione Aplicativos OAuth2.
-
Clique em Criar integração de aplicativo.
O Novo aplicativo OAuth2 é exibido.
-
Na caixa Novo aplicativo OAuth2, selecione Aplicativo Web.
-
Digite um nome para o novo aplicativo OAuth2, como "Workfront para ClientApp."
-
Clique em Criar.
-
Preencha os campos do novo aplicativo.
ID do ClienteEste campo é gerado automaticamente.Segredo do clienteEste campo é gerado automaticamente
IMPORTANTE:
Copie o conteúdo desse campo para outro arquivo seguro antes de fechar esta página. Você não poderá ver essa chave secreta novamente.
Se você perder essa chave, exclua-a e crie um Segredo do cliente.
-
Clique no ícone
-
Clique em Adicionar segredo do cliente para gerar um novo Segredo do Cliente.
Redirecionar URLsOs usuários serão redirecionados para este caminho após a autenticação com Workfront.Atualizar rotação de tokenHabilite esta opção para emitir um novo token de atualização sempre que o token de atualização for usado. Seu aplicativo deve armazenar o novo token de atualização após cada atualização.Expiração de token de atualização absolutaSelecione por quanto tempo você deseja que um token de atualização exista antes de expirar. Quando ela expirar, os usuários deverão fazer logon na integração novamente. Selecione "Sem expiração" se não quiser que o token de atualização expire.Expiração do token para atualizar inatividadeSelecione o tempo após o qual, se o usuário não tiver estado ativo no sistema, o token de atualização expirará.
Por exemplo, se a expiração do token de atualização de inatividade for de seis meses e o usuário não fizer logon por seis meses, o token de atualização expirará mesmo que a expiração do token de atualização absoluta possa ser definida por mais tempo.
LogotipoVocê pode adicionar um logotipo para tornar este aplicativo mais identificável.NomeEste é o mesmo nome que você deu ao aplicativo. Este campo não pode estar vazio.DescriçãoInsira uma descrição para a integração.URL da Descrição do AplicativoPode ser um link para uma página "Sobre nós" ou uma página com mais informações sobre a integração. -
-
Clique em Salvar.
Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo de código de autorização.
Criar um aplicativo web de página única OAuth2 usando PKCE
-
Clique no ícone Menu Principal
-
No painel de navegação esquerdo, clique em Sistema e selecione Aplicativos OAuth2.
-
Clique em Criar integração de aplicativo.
A caixa Novo aplicativo OAuth2 é exibida.
-
Na caixa Novo aplicativo OAuth2, selecione Aplicativo Web de Página Única.
-
Digite um nome para o novo aplicativo OAuth2, como "Workfront para ClientApp."
-
Clique em Criar.
-
Preencha os campos do novo aplicativo.
ID do ClienteEste campo é gerado automaticamente.Redirecionar URLsOs usuários serão redirecionados para esse caminho após a autenticação com o Workfront.Girar token de atualização sempre que for usadoHabilite esta opção para emitir um novo token de atualização sempre que o token de atualização for usado. Seu aplicativo deve armazenar o novo token de atualização após cada atualização.Expiração absolutaSelecione por quanto tempo você deseja que um token de atualização exista antes de expirar. Quando ela expirar, os usuários deverão fazer logon na integração novamente. Selecione "Sem expiração" se não quiser que o token de atualização expire.Expiração de inatividadeSelecione o tempo após o qual, se o usuário não tiver estado ativo no sistema, o token de atualização expirará.
Por exemplo, se a expiração do token de atualização de inatividade for de seis meses e o usuário não fizer logon por seis meses, o token de atualização expirará mesmo que a expiração do token de atualização absoluta possa ser definida por mais tempo.
LogotipoVocê pode adicionar um logotipo para tornar este aplicativo mais identificável.NomeEste é o mesmo nome que você deu ao aplicativo. Este campo não pode estar vazio.DescriçãoInsira uma descrição para a integração.Nome do desenvolvedorEsse é o nome do desenvolvedor que está configurando o aplicativo OAuth2.Endereço de email do desenvolvedorEsse é o endereço de email do desenvolvedor que está configurando o aplicativo OAuth2.URL da política de privacidadeEsse é o link para onde sua organização armazena a política de privacidade. -
Clique em Salvar.
Configurar e usar o aplicativo OAuth2 criado
A configuração e o uso adicionais do aplicativo OAuth2 criado exigem algum conhecimento técnico, incluindo chamadas de API.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo de código de autorização.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 usando a autenticação de servidor (fluxo JWT), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo JWT.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 usando o PKCE, consulte Configurar e usar os aplicativos OAuth 2 personalizados de sua organização usando o fluxo de PKCE.
Processos OAuth2 para fluxo de código de autorização
NOTEAutorização com um código de autorização e um token de acesso
-
O ClientApp precisa de algumas informações de Workfront, por isso envia uma solicitação para o ponto de extremidade
/authorizeda API Workfront. A solicitação inclui o response_typecode, que indica que a solicitação deve retornar um código de autorização. -
Isso aciona Workfront para enviar um prompt de autenticação ao usuário. O usuário pode inserir suas credenciais no prompt, que fornece a Workfront permissão para se comunicar com o ClientApp. Se o usuário já estiver conectado ao Workfront, esta etapa pode ser ignorada.
-
A API Workfront envia um código de autorização para o ClientApp.
-
O ClientApp envia as seguintes informações em uma solicitação para a API Workfront
/tokenendpoint:- O código de autorização enviado ao ClientApp na etapa 3. Isso identifica a instância específica da permissão do usuário.
- O Segredo do Cliente gerado ao configurar o aplicativo OAuth2 do ClientApp em Workfront. Isso permite que Workfront saiba que a solicitação vem do ClientApp.
-
Se o código de autorização e o segredo do cliente estiverem corretos, Workfront enviará um token de acesso ao ClientApp. Este token de acesso é enviado diretamente de Workfront para ClientApp e não pode ser visualizado, copiado ou usado por nenhum outro usuário ou aplicativo cliente.
-
O ClientApp envia o token de acesso a Workfront junto com a solicitação específica de informações.
-
Como o token de acesso está correto, Workfront envia as informações para o ClientApp.
Atualização de tokens de acesso
Por questões de segurança, os tokens de acesso expiram após um curto período. Para obter novos tokens de acesso sem precisar inserir credenciais todas as vezes, OAuth2 usa tokens de atualização. Os tokens de atualização são armazenados pelo cliente.
O processo para aquisição de um token de atualização é o mesmo que o procedimento discutido na seção Autorização com um código de autorização e token de acesso. A solicitação do código de autorização inclui o escopo offline_access, que indica que a solicitação deve retornar um token de solicitação juntamente com o código de autorização.