DocumentaçãoWorkfrontGuia do Workfront

Gerenciar chaves de API

Last update: Wed Aug 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Administrador

Para minimizar as vulnerabilidades de segurança da API, os administradores do Adobe Workfront podem gerenciar as Chaves de API usadas para permitir que os aplicativos acessem o Workfront em nome de um usuário.

Você pode redefinir ou remover sua Chave de API do administrador atual, configurar as Chaves de API para expirar e remover as Chaves de API para todos os usuários.

Exemplos de aplicativos que usam a API do Workfront são:

  • Integrações de documentos, como Dropbox, Google Drive e Workfront DAM
  • aplicativos móveis Workfront
IMPORTANT
Ao redefinir ou remover uma Chave de API, qualquer aplicativo que use a API do Workfront e seja autenticado no Workfront por meio dessa Chave de API deve ser reconfigurado para recuperar o acesso ao Workfront.

Requisitos de acesso

Expanda para visualizar os requisitos de acesso para a funcionalidade neste artigo.

Você deve ter o seguinte acesso para executar as etapas deste artigo:

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
plano do Adobe Workfront Qualquer
Licença do Adobe Workfront Plano
Configurações de nível de acesso

Você deve ser um administrador do Workfront.

OBSERVAÇÃO: se você ainda não tiver acesso, pergunte ao administrador do Workfront se ele definiu restrições adicionais no seu nível de acesso. Para obter informações sobre como um administrador do Workfront pode modificar seu nível de acesso, consulte Criar ou modificar níveis de acesso personalizados.

Chaves de API do Workfront

Cada usuário no Workfront tem uma chave de API exclusiva. Essa chave é gerada com base no usuário no momento em que o usuário acessa uma integração que aproveita a API do Workfront (como o aplicativo móvel Workfront ou uma integração de documentos).

NOTE
As chaves de API geradas no ambiente de produção são copiadas para o ambiente de Pré-visualização durante a atualização semanal. Quaisquer chaves de API geradas no ambiente de Pré-visualização serão substituídas pelas chaves de API de produção durante a atualização semanal.

Os administradores do Workfront também têm uma chave de API exclusiva. Quando um aplicativo usa uma chave de API de administrador para acessar o Workfront, ele tem acesso de administrador ao Workfront.

Gerenciar uma chave de API do administrador

Você pode gerar, redefinir ou remover a Chave de API da conta de usuário administrador.

NOTE
Você também pode gerar uma Chave de API por meio da API. Para obter mais informações, consulte a seção API de Assinatura de Evento em API de Assinatura de Evento.

  1. Clique no ícone Menu Principal Menu Principal no canto superior direito do Adobe Workfront ou (se disponível) clique no ícone Menu Principal Menu Principal no canto superior esquerdo e clique no ícone Instalação Instalação .

  2. Clique em Sistema > Informações do Cliente.

  3. (Condicional) Execute uma das seguintes ações:

    Para gerar uma Chave de API: Na seção Configurações da Chave de API, clique em Gerar Chave de API.

    Ou
    Para redefinir uma Chave de API: Na seção Configurações da Chave de API, clique em Redefinir e depois em Redefinir.

    Ou

    Para remover a Chave de API: Na seção Configurações da Chave de API, clique em Remover e depois em Remover.

Gerar uma chave de API para usuários não administradores

Você pode gerar e gerenciar chaves de API para usuários em funções diferentes da de administrador do Workfront.

NOTE
Isso não estará disponível se a instância Workfront da sua organização estiver habilitada com o Adobe IMS. Consulte o administrador de rede ou de TI se precisar de mais informações.

  1. (Condicional) Se sua organização usar o gerenciamento de acesso de Logon único (SSO), desative temporariamente a opção que exige autenticação SSO.

  2. Clique no ícone Menu Principal Menu Principal no canto superior direito do Adobe Workfront ou (se disponível) clique no ícone Menu Principal Menu Principal no canto superior esquerdo e clique no ícone Instalação Instalação .

    1. Expanda Sistema e clique em Logon Único (SSO).

    2. No campo Tipo, selecione o tipo de SSO que sua organização usa.

    3. Com o tipo selecionado, role para baixo e desmarque a caixa de seleção Habilitar.

    4. Clique em Salvar.

  3. Na barra de endereços de um navegador, insira a seguinte chamada de API:

    <domain>.my.workfront.com/attask/api/v7.0/user?action=generateApiKey&username= ​username​ &password= ​password**&method=PUT

    Substitua <domain> pelo nome de domínio, nome de usuário e senha do Workfront pelas credenciais Workfront do usuário.

  4. (Condicional) Ative a opção que exige autenticação SSO se ela tiver sido desativada na Etapa 1.

  5. Clique no ícone Menu Principal Menu Principal no canto superior direito do Adobe Workfront ou (se disponível) clique no ícone Menu Principal Menu Principal no canto superior esquerdo e clique no ícone Instalação Instalação .

    1. Expanda Sistema e clique em Logon Único (SSO).

    2. Selecione seu método SSO no menu suspenso Type.

    3. Marque a caixa de seleção que requer autenticação SSO.

Configurar quando as chaves de API expiram

Você pode configurar as Chaves de API para expirarem para todos os usuários em seu sistema. Quando a chave de API de um usuário expira, o usuário deve se autenticar novamente em qualquer aplicativo que use a API do Workfront para acessar o Workfront. Você pode alterar a frequência com que as Chaves de API expiram. Você também pode configurar se as Chaves de API expiram quando a senha de um usuário expira.

  1. Clique no ícone Menu Principal Menu Principal no canto superior direito do Adobe Workfront ou (se disponível) clique no ícone Menu Principal Menu Principal no canto superior esquerdo e clique no ícone Instalação Instalação .

  2. Clique em Sistema > Informações do cliente.

  3. Na área Configurações da Chave de API, na lista suspensa Após a criação, as chaves de API expiram em, selecione o período em que deseja que as chaves de API expirem.

    Ao alterar essa opção, o novo período começa a partir do momento em que você fez a alteração. Por exemplo, se você alterar esta opção de 1 mês para 6 meses, as Chaves de API expirarão em 6 meses a partir do momento em que você fizer a alteração.

    Por padrão, as Chaves de API expiram a cada mês.

  4. Para configurar as Chaves de API para expirarem no momento em que as senhas dos usuários expirarem, selecione Remover chave de API quando a senha de um usuário expirar.

    Por padrão, essa opção não está selecionada.

    Para obter informações sobre como configurar senhas de usuário para expirar, consulte Configurar preferências de segurança do sistema.

  5. Clique em Salvar.

Remover as chaves de API de todos os usuários

Se você estiver preocupado com uma violação de segurança específica em relação ao seu sistema Workfront, poderá remover as Chaves de API simultaneamente para todos os usuários.

IMPORTANT
Remover as chaves de API de todos os usuários invalida TODAS as chaves de API de todos os usuários do sistema. Essa ação causará falha em todas as suas integrações no Workfront até que você gere uma nova Chave de API no Workfront e atualize todas as suas integrações.

  1. Clique no ícone Menu Principal Menu Principal no canto superior direito do Adobe Workfront ou (se disponível) clique no ícone Menu Principal Menu Principal no canto superior esquerdo e clique no ícone Instalação Instalação .

  2. Expanda Sistema e clique em Informações do cliente.

  3. Na área Configurações da Chave de API, clique em Remover todas as chaves de API e em Remover Tudo.

Restrição de logons da API com um certificado X.509

IMPORTANT
O procedimento descrito nesta seção se aplica apenas a organizações que ainda não foram integradas à Plataforma de negócios Adobe. Fazer logon no Workfront por meio da API do Workfront não estará disponível se sua organização tiver sido integrada à Plataforma comercial Adobe.
Para obter uma lista de procedimentos que diferem com base no fato de sua organização ter sido integrada à Plataforma Comercial Adobe, consulte Diferenças de administração baseadas em plataforma (Adobe Workfront/Adobe Business Platform).

Aplicativos de terceiros podem se comunicar com o Workfront por meio da API. Para aumentar a segurança do site do Workfront, você pode configurar o Workfront para restringir solicitações de logon da API fazendo upload de um certificado X.509 no Workfront. Depois de habilitada, todas as solicitações de logon por meio da API devem incluir um certificado de cliente, além do nome de usuário e da senha.

NOTE
Isso não estará disponível se a instância Workfront da sua organização estiver habilitada com o Adobe IMS. Consulte o administrador de rede ou de TI se precisar de mais informações.

Obter o certificado X.509 obtain-the-x-509-certificate

Obtenha um certificado X.509 válido de uma Autoridade de certificação confiável (como a Verisign) e coloque-o em um local temporário na sua estação de trabalho.

Fazer upload do certificado para o Workfront upload-the-certificate-to-workfront

Depois de obter o certificado X.509 da sua autoridade de certificação, é necessário carregá-lo no Workfront.

  1. Clique no ícone do Menu Principal no canto superior direito do Adobe Workfront e em Configurar .

  2. Expanda Sistema e clique em Informações do cliente.

  3. Na área Configurações da Chave de API, selecione Habilitar Certificado X.509.

  4. Na estação de trabalho, navegue até o certificado X.509 que você baixou anteriormente e selecione-o.

  5. (Opcional) Clique em Exibir Detalhes ao lado do nome do certificado para exibir os seguintes detalhes sobre o certificado:

    • Nome comum do assunto
    • Organização do assunto
    • Unidade da organização do assunto
    • Nome comum do emissor
    • Organização emissora
    • Unidade da organização emissora
    • Número de série
    • Data de emissão
    • Data de expiração

  6. Clique em Salvar.

Verifique se as chamadas de logon da API são restritas verify-api-login-calls-are-restricted

Antes de configurar sua instância do Workfront para exigir um certificado X.509, execute uma solicitação de API para o ponto de extremidade /login usando parâmetros válidos de nome de usuário e senha. Você receberá uma resposta 200 que contém uma sessionID.

Depois de fazer do certificado X.509 um requisito por meio da página de informações do cliente em sua instância do Workfront, faça outra tentativa de logon. Desta vez você receberá uma resposta de erro 500 com a seguinte mensagem: "Solicitação não confiável. Entre em contato com o administrador do sistema e anexe um certificado."

Depois de confirmar que o certificado X.509 é necessário, execute a mesma solicitação de logon com um parâmetro adicional para apiCertificate definido como o valor do seu certificado. Se essa operação tiver sido executada corretamente, você receberá uma resposta 200 que contém uma sessionID válida.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43