Usar a funcionalidade do UEM com uma REST API
É possível configurar aplicativos externos para usar a funcionalidade principal do produto do Workspace ONE UEM ao integrar REST APIs à infraestrutura do UEM, facilitando a conectividade. É possível também selecionar uma URL de token OAuth mais próxima ao centro de dados para autenticar chamadas de API.
Introdução às REST APIs
Usando a arquitetura simplificada do software REST, as REST APIs do Workspace ONE UEM atualmente suportam várias funcionalidades, incluindo grupo organizacional, administração de console, aplicativo móvel, dispositivo móvel, e-mail, usuário de inscrição, perfil, grupo inteligente e gerenciamento de grupo de usuários.
O uso de APIs baseadas em REST oferece vários benefícios para as empresas, incluindo a exclusão do custo e do tempo gastos no desenvolvimento de aplicativos internos. As REST APIs do Workspace ONE UEM estão totalmente aptas e prontas para integrar-se a servidores, programas e processos empresariais. As REST APIs do Workspace ONE UEM são mais eficientes e podem funcionar sem problemas e ser facilmente identificadas pelas empresas. Essas APIs são para desenvolvedores de aplicativos. Este guia fornece uma compreensão do design e da arquitetura da biblioteca de APIs e facilita o desenvolvimento e a integração personalizados com o Workspace ONE UEM.
Como acessar a documentação da API
Consulte a documentação detalhada da API ao acessar a página de Ajuda da API do Workspace ONE UEM.
Na barra de endereços do seu navegador, substitua o “cn” no URL por “as” e depois acrescente /api/help após .com.
Por exemplo, a documentação da API do URL de um ambiente SaaS de…
https://cn4855.awmdm.com
…é…
https://as4855.awmdm.com/api/help
Datacenter e URLs de token para suporte ao OAuth 2.0
O Workspace ONE UEM suporta o protocolo padrão do setor OAuth 2.0 para autenticação e autorização seguras das chamadas REST API.
O serviços de token do Workspace ONE é o emissor do token para autenticação OAuth e só é compatível com ambientes SaaS. Os URLs de token são específicos da região.
| Região | Local do Centro de Dados SaaS do Workspace ONE UEM | URL de token |
|---|---|---|
| Ohio (Estados Unidos) | Todo o ambiente de teste de aceitação do usuário | https://uat.uemauth.vmwservices.com/connect/token |
| Virgínia (Estados Unidos) | Estados Unidos | https://na.uemauth.vmwservices.com/connect/token |
| Virgínia (Estados Unidos) | Canadá | https://na.uemauth.vmwservices.com/connect/token |
| Frankfurt (Alemanha) | Reino Unido | https://emea.uemauth.vmwservices.com/connect/token |
| Frankfurt (Alemanha) | Alemanha | https://emea.uemauth.vmwservices.com/connect/token |
| Tóquio (Japão) | Índia | https://apac.uemauth.vmwservices.com/connect/token |
| Tóquio (Japão) | Japão | https://apac.uemauth.vmwservices.com/connect/token |
| Tóquio (Japão) | Singapura | https://apac.uemauth.vmwservices.com/connect/token |
| Tóquio (Japão) | Austrália | https://apac.uemauth.vmwservices.com/connect/token |
| Tóquio (Japão) | Hong Kong | https://apac.uemauth.vmwservices.com/connect/token |
Criar um cliente OAuth para usar nos comandos da interface de programação de aplicativos (SaaS)
Você pode criar um cliente OAuth para usar comandos de interface de programação de aplicativos compatíveis somente com ambientes SaaS. Crie um cliente OAuth para seu ambiente SaaS seguindo as etapas a seguir.
- Navegue até Grupos e Configurações > Configurações.
- Digite
OAuthna caixa de texto de pesquisa chamada “Digite um nome ou categoria”. - Selecione Gerenciamento do cliente OAuth que aparece nos resultados. A tela Gerenciamento do cliente OAuth é exibida.
- Selecione o botão Adicionar.
-
Digite Nome, Descrição, Grupos organizacionais e Função.
Observação: Para obter mais informações sobre permissões de REST API específicas para a função selecionada, consulte a seção neste tópico chamada Criar função que permita o uso de uma REST API.
-
Verifique se o Status está Ativado.
- Selecione Salvar.
-
IMPORTANTE: copie a ID do Cliente e o Segredo do Cliente na área de transferência e salve-os antes de fechar essa tela. Selecione o ícone de Copiar (
) para enviar Segredo do Cliente para a área de transferência.Não é possível retornar a essa tela para recuperar essas informações após você selecionar Fechar.
-
Usar o ID do cliente, Segredo do cliente e URL do token para gerar o token de acesso no seguinte formato:
Chamada da API: POST {URL do Token Específico da Região da seção acima}
Chave Valor grant_type client_credentials client_id {ID DO CLIENTE gerado no UEM console} client_secret {SECREDO DO CLIENTE gerado no UEM console} -
Use o token de acesso retornado para autorizar solicitações de API futuras para os servidores de API do Workspace ONE UEM. Você deve formatar o token de acesso nos cabeçalhos da solicitação da seguinte maneira.
Chamada da API: {API do UEM}
Chave Valor Autorização {Token de Acesso}
Criar função que permita o uso de uma REST API
Cada chamada de API tem um recurso correspondente (ou permissão) que deve ser incluído na função que será atribuída ao Cliente OAuth. Portanto, as permissões para inclusão na função atribuída se alinham aos tipos de chamadas de API sendo feitas.
Use as informações na tabela a seguir para ajudá-lo a selecionar quais permissões devem ser incluídos na função que atribuiu. Em seguida, acesse a seção Criar Função do Administrador em Acesso Baseado em Função para obter instruções sobre como criar essa função.
| Categoria | Nome | Descrição | Somente leitura/edição |
|---|---|---|---|
| REST > Administradores | REST API Grupos de sistema | Acesso à informação do grupo de organização | Editar |
| REST API Administração de sistemas | Acesso à informação administrativa | Editar | |
| REST API Usuários do sistema | Acesso às informações de usuários | Editar | |
| REST API Gravar administradores | Habilita o acesso a todas as APIs de gravação/atualização na coleção Usuários administradores | Editar | |
| REST API Executar administradores | Habilita o acesso a todas as APIs de execução na coleção Usuários administradores | Editar | |
| REST API Excluir administradores | Habilita o acesso a todas as APIs de exclusão na coleção Usuários administradores | Editar | |
| REST API Ler administradores | Habilita o acesso a todas as APIs somente LEITURA na coleção Usuários administradores | Somente leitura | |
| REST > Aplicativos | REST API Blob MAM | Carregar/fazer download de conteúdo | Editar |
| REST API Aplicativos MAM | Acesso a aplicativos gerenciados | Editar | |
| REST API Gravar aplicativos | Habilita o acesso a todas as APIs de gravação/atualização na coleção Aplicativos | Editar | |
| REST API Executar aplicativos | Habilita o acesso a todas as APIs de execução na coleção Aplicativos | Editar | |
| REST API Excluir aplicativos | Habilita o acesso a todas as APIs de exclusão na coleção Aplicativos | Editar | |
| REST API Ler aplicativos | Habilita o acesso a todas as APIs somente LEITURA na coleção Aplicativos | Somente leitura | |
| REST > Política de Conformidade | REST API Excluir política de conformidade | Habilita o acesso a todas as APIs de exclusão na coleção Política de conformidade | Editar |
| REST API Executar política de conformidade | Habilita o acesso a todas as APIs de execução na coleção Política de conformidade | Editar | |
| REST API Gravar política de conformidade | Habilita o acesso a todas as APIs de gravação na coleção Política de conformidade | Editar | |
| REST API Ler política de conformidade | Habilita o acesso a todas as APIs somente LEITURA na coleção Política de conformidade | Somente leitura | |
| REST > Atributos Personalizados | REST API Executar atributos personalizados | Habilita o acesso a todas as APIs de execução na coleção Atributos personalizados | Editar |
| REST API Gravar atributos personalizados | Habilita o acesso a todas as APIs de gravação na coleção Atributos personalizados | Editar | |
| REST API Excluir atributos personalizados | Habilita o acesso todas as APIs de exclusão na coleção Atributos personalizados | Editar | |
| REST API Ler atributos personalizados | Habilita o acesso a todas as APIs somente LEITURA na coleção Atributos personalizados | Somente leitura | |
| REST > Dispositivos | REST API Grupos inteligentes MDM | Acesso às informações de grupos inteligentes | Editar |
| REST API Grupos de usuários MDM | Acesso aos grupos de usuários | Editar | |
| REST API Perfis MDM | Enviar comandos de bloqueio/desbloqueio | Editar | |
| REST API Dispositivos MDM | Enviar comandos de bloqueio/desbloqueio | Editar | |
| REST API Gravar BLOBS | Habilita o acesso a todas as APIs somente gravação/atualização na coleção BLOBS | Editar | |
| REST API Executar BLOBS | Habilita o acesso a todas as APIs somente execução na coleção BLOBS | Editar | |
| REST API Excluir BLOBS | Habilita o acesso a todas as APIs somente exclusão na coleção BLOBS | Editar | |
| REST API Gravar dispositivos | Habilita o acesso a todas as APIs de gravação/atualização na coleção Dispositivos | Editar | |
| REST API Executar dispositivos | Habilita o acesso a todas as APIs de execução na coleção Dispositivos | Editar | |
| REST API Excluir dispositivos | Habilita o acesso a todas as APIs de exclusão na coleção Dispositivos | Editar | |
| REST API Dispositivos avançados | Habilita o acesso a todas as APIs avançadas na coleção Dispositivos | Editar | |
| REST API Ler BLOBS | Habilita o acesso a todas as APIs somente leitura na coleção BLOBS | Somente leitura | |
| REST API Ler dispositivos | Habilita o acesso a todas as APIs somente LEITURA na coleção Dispositivos | Somente leitura | |
| REST > Integração Empresarial REST | REST API Ler integração empresarial | Habilita o acesso a todas as APIs somente LEITURA na Integração empresarial | Somente leitura |
| REST > Grupos | REST API Gravar grupos | Habilita o acesso a todas as APIs de gravação/atualização na coleção Grupos organizacionais | Editar |
| REST API Executar grupos | Habilita o acesso a todas as APIs de execução na coleção Grupos organizacionais | Editar | |
| REST API Excluir grupos | Habilita o acesso a todas as APIs de exclusão na coleção Grupos organizacionais | Editar | |
| REST API Gravar grupos inteligentes | Habilita o acesso a todas as APIs de gravação na coleção Grupos inteligentes | Editar | |
| REST API Executar grupos inteligentes | Habilita o acesso a todas as APIs de execução na coleção Grupos inteligentes | Editar | |
| REST API Excluir grupos inteligentes | Habilita o acesso a todas as APIs de exclusão na coleção Grupos inteligentes | Editar | |
| REST API Gravar grupos de usuários | Habilita o acesso a todas as APIs de gravação/atualização em Grupos de usuários | Editar | |
| REST API Executar grupos de usuários | Habilita o acesso a todas as APIs de execução em Grupos de usuários | Editar | |
| REST API Excluir grupos de usuários | Habilita o acesso a todas as APIs de exclusão em Grupos de usuários | Editar | |
| REST API Gravar carrinho | REST API para salvar e editar dados do Carrinho | Editar | |
| REST API Excluir carrinho | REST API para excluir dados do Carrinho | Editar | |
| REST API Gravar Apple School Manager | REST API para iniciar a sincronização do Apple School Manager | Editar | |
| REST API Mapear Apple School Manager | REST API para mapear uma inscrição de usuário de um membro do Apple School Manager | Editar | |
| REST API Salvar atribuições de classe | Chamada REST API para salvar atribuições de classe | Editar | |
| REST API Gravar classes | REST API para salvar e editar dados de classes | Editar | |
| REST API Excluir classes | REST API para excluir dados de classes | Editar | |
| REST API Gravar configurações de educação | REST API para salvar e editar configurações de educação | Editar | |
| REST API Ler configurações de educação | REST API para visualizar configurações de educação | Editar | |
| REST API Ler grupos | Habilita o acesso a todas as APIs somente LEITURA na coleção Grupos organizacionais | Somente leitura | |
| REST API Ler grupos inteligentes | Habilita o acesso a todas as APIs somente LEITURA na coleção Grupos inteligentes | Somente leitura | |
| REST API Ler grupos de usuários | Habilita o acesso a todas as APIs somente LEITURA em Grupos de usuários | Somente leitura | |
| REST API Ler sincronização do Apple School Manager | REST API para verificar o estado de sincronização do Apple School Manager | Somente leitura | |
| REST API Ler aplicativos para dispositivos | REST API para obter uma lista de aplicativos elegíveis para um dispositivo | Somente leitura | |
| REST API Ler classes | REST API para visualizar dados de classes | Somente leitura | |
| REST > Produtos | REST API Executar produtos | Habilita o acesso a todas as APIs de execução na coleção Produtos | Editar |
| REST API Gravar produtos | Habilita o acesso a todas as APIs de gravação na coleção Produtos | Editar | |
| REST API Excluir produtos | Habilita o acesso a todas as APIs de exclusão na coleção Produtos | Editar | |
| REST API Ler produtos | Habilita o acesso a todas as APIs somente LEITURA na coleção Produtos | Somente leitura | |
| REST > Perfis | Acesso de gravação de políticas de atualização | Habilita o acesso a todas as APIs de GRAVAÇÃO na coleção Políticas de atualização | Editar |
| Acesso de execução de políticas de atualização | Habilita o acesso a todas as APIs de EXECUÇÃO na coleção Políticas de atualização | Editar | |
| Acesso de exclusão de políticas de atualização | Habilita o acesso a todas as APIs de EXCLUSÃO na coleção Políticas de atualização | Editar | |
| REST API Gravar perfis | Habilita o acesso a todas as APIs de gravação na coleção Perfis | Editar | |
| REST API Executar perfis | Habilita o acesso a todas as APIs de execução na coleção Perfis | Editar | |
| REST API Excluir perfis | Habilita o acesso a todas as APIs de exclusão na coleção Perfis | Editar | |
| Acesso de leitura de políticas de atualização | Habilita o acesso a todas as APIs somente LEITURA na coleção Políticas de atualização | Somente leitura | |
| REST API Ler perfis | Habilita o acesso a todas as APIs somente LEITURA na coleção Perfis | Somente leitura | |
| REST > Usuários | REST API Gravar usuários | Habilita o acesso a todas as APIs de gravação/atualização na coleção Usuários de inscrição | Editar |
| REST API Executar usuários | Habilita o acesso a todas as APIs de execução na coleção Usuários de inscrição | Editar | |
| REST API Excluir usuários | Habilita o acesso a todas as APIs de exclusão na coleção Usuários de inscrição | Editar | |
| REST API Ler tokens de usuários | Habilita o acesso a tokens de Usuários de inscrição de APIs na coleção Usuários de inscrição | Somente leitura | |
| REST API Ler usuários | Habilita o acesso a todas as APIs somente LEITURA na coleção Usuários de inscrição | Somente leitura |
