Este artigo é para:
- Administradores de segurança da organização
- Administradores do espaço de trabalho da organização
- Proprietários de espaços de trabalho
Para acessar qualquer API da Workiva, os usuários precisarão de uma concessão de API para autorização. Depois de criar uma concessão de API para um usuário, você 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.
Criar uma concessão de API
Para começar a criar uma concessão de API:
- Nas configurações do espaço de trabalho, acesse a guia Security e selecione Create API Grant.
- Digite as seguintes informações para a concessão da API:
-
- Em Client Name, digite um nome que o ajude a identificar esse subsídio.
- Para Workspace, digite o espaço de trabalho ao qual essa concessão será atribuída.
-
Para Workiva Username, digite o nome de usuário do usuário que precisa da concessão para a API. Somente esse usuário poderá visualizar o segredo dessa concessão de API em My profile > Security.
Nota:: Por motivos de segurança, se você alterar posteriormente o Workiva Username, o segredo atual se tornará inválido e somente o novo usuário terá acesso ao novo segredo.
-
Para Scopes, especifique a(s) ação(ões) que o sistema pode realizar em nome do usuário.
Nota: Para saber mais sobre escopos, consulte nossa discussão Understanding API Grant Scopes.
Para atribuir escopos de organização (organization:read ou organization:write), consulte Criar e gerenciar concessões de API no administrador da organização. - Para Expires, defina quando a concessão deve expirar, com base nas políticas e preferências de segurança de sua organização.
- Se necessário, insira uma lista de endereços IP separados por vírgula 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 a concessão clicando na respectiva ação no menu suspenso Actions .
Exibir segredo de concessão da API
Somente o usuário especificado nos detalhes da concessão da API pode visualizar o segredo da concessão acessando My Profile, selecionando a guia Security e clicando em Regenerate no menu suspenso Actions ao lado da concessão. O usuário só pode visualizar o segredo uma vez, portanto, ele precisará copiá-lo em um local seguro. Se eles perderem o segredo, precisarão regenerá-lo novamente.
Observação: O segredo começa com "wk_secret:"