Este artigo é para:
- Administradores de segurança da organização
Criar uma concessão de API
Para acessar qualquer API da Workiva, os usuários precisarão de uma concessão de API para autorização. Como Org Security Admin, se você criar uma concessão de API para um usuário, poderá editar os detalhes da concessão ou excluir a concessão. No entanto, somente o usuário poderá visualizar o segredo de sua concessão ao regenerar a concessão em seu perfil de usuário.
Para começar a criar uma concessão de API:
- No canto superior direito, clique no ícone do usuário e selecione Admin no menu suspenso.
- Em seguida, selecione Organization admin no menu suspenso.
- Na página Organization Admin, selecione Security no painel do menu à esquerda e, em seguida, selecione a guia Provisioning.
- Em Create Identity Provider or API Grant, clique em Add Identity or API.
-
Selecione API Grant no menu suspenso.
As instruções a seguir são para uma concessão de API. Para um provedor de identidade, consulte Gerenciar e provisionar usuários com o SCIM.
- Digite as seguintes informações para a concessão da API:
- Em Client Name, digite um nome que o ajudará a identificar esse subsídio.
- Em Workspace, insira o espaço de trabalho|workspace ao qual essa concessão será atribuída.
-
Em Workiva Username, digite o nome de usuário do usuário que precisa da concessão para a API.
Somente esse usuário pode visualizar o segredo dessa concessão de API em My profile > Security.Observação: Para fins de segurança, a alteração do nome de usuário Workiva invalida o segredo atual, e somente o novo nome de usuário terá acesso ao novo segredo.
- Em Escopos, especifique a(s) ação(ões) que o sistema pode realizar em nome do usuário.
Por exemplo, para a API Spreadsheets, adicione Spreadsheets (Read) e Spreadsheets (Write) para que o usuário possa acessar e editar planilhas. - Em Expires, defina quando a concessão deve expirar, com base nas políticas e preferências de segurança de sua organização.
- (Opção) Você pode inserir uma lista separada por vírgulas de endereços IP na IP Allowlist para a concessão.
- Clique em Add Grant para concluir.
Gerenciar concessões de API
Você pode editar os detalhes de uma concessão específica ou excluir uma concessão clicando na respectiva ação na lista suspensa Actions para essa concessão.
Exibir segredo de concessão da API
Para exibir o segredo da API,
- No canto superior direito, clique no ícone do usuário e selecione My profile na lista suspensa.
- Clique na guia Security.
- Localize a concessão da API para a qual você deseja obter o segredo.
- Clique em Regenerate na lista suspensa Actions ao lado da concessão.
Notas importantes
- Somente o usuário especificado nos detalhes da concessão da API pode exibir o segredo da concessão.
- Você só pode exibir o segredo uma vez, portanto, precisará copiar o segredo em um local seguro.
Se você perder o segredo, precisará gerá-lo novamente e, em seguida, preencher todos os locais que o exigem com o novo segredo. - Dica: O segredo começa com "wk_secret:"