Pode aceder às APIs do Orchestrator utilizando tokens em vez de autenticação baseada na sessão. Como superutilizador operador, pode gerir os tokens API. Pode criar vários tokens API para um utilizador.
Nota: Para utilizadores só de leitura da empresa e utilizadores especialistas empresariais do MSP, a autenticação baseada em tokens não está ativada.
Por predefinição, os tokens API estão ativados. Se os quiser desativar, aceda a
Propriedades do sistema (System Properties) no portal do operador e configure o valor da propriedade do sistema
session.options.enableApiTokenAuth
como
Falso (False).
Nota: O superutilizador operador deve eliminar manualmente os utilizadores inativos do fornecedor de identidade (IdP) do Orchestrator para evitar o acesso não autorizado através do token de API.
Os utilizadores podem criar, revogar e transferir os tokens com base nas suas funções.
Para gerir os tokens API:
- No portal do operador, navegue para .
- Selecione um utilizador e clique em Modificar (Modify) ou clique na ligação do nome de utilizador. Aceda à secção Tokens API (API Tokens).
- Clique em Novo token API (New API Token).
- Na janela Novo token (New Token), introduza um Nome (Name) e Descrição (Description) para o token e escolha o Tempo de vida (Lifetime) no menu pendente.
- Clique em Guardar (Save). O novo token é apresentado na tabela Tokens API (API Tokens). Inicialmente, o estado do token é apresentado como Pendente (Pending). Uma vez transferido, o estado muda para Ativado (Enabled).
- Para transferir o token, selecione o token e clique em Transferir token API (Download API Token).
- Para desativar um token, selecione-o e clique em Revogar token API (Revoke API Token). O estado do token é apresentado como Revogado (Revoked).
- Clique em CSV para transferir a lista completa de tokens API num ficheiro em formato .csv.
- Quando a vida útil do token acaba, o estado muda para Expirado (Expired).
Nota: Apenas o utilizador que está associado a um token pode transferi-lo e, após a transferência, é apresentado o ID do token. Só pode transferir um token uma vez. Após a transferência do token, o utilizador pode enviá-lo como parte do cabeçalho de autorização do pedido de acesso à API do Orchestrator.
O exemplo a seguir apresenta um fragmento de amostra do código para aceder a uma API.
curl -k -H "Authorization: Token <Token>" -X POST https://vco/portal/ -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'
Da mesma forma, é possível configurar propriedades adicionais e criar tokens API para Administradores de parceiro, Clientes de empresa e Clientes de parceiro. Para obter mais informações, consulte:
- Tópico “Utilizadores – Cliente” no Guia de administração do VMware SD-WAN
- Tópico “Utilizadores – Parceiro” no Guia de Parceiros do VMware SD-WAN
A seguir, são apresentadas as outras opções disponíveis na secção
Tokens API (API Tokens):
Opção | Descrição |
---|---|
Pesquisar (Search) | Introduza um termo a procurar para procurar o texto correspondente na tabela. Utilize a opção de pesquisa avançada para restringir os resultados da pesquisa. |
Colunas (Columns) | Clique e selecione as colunas a serem mostradas ou ocultadas na página. |
Atualizar (Refresh) | Clique para atualizar a página e visualizar os dados mais atuais. |