Uso della funzionalità UEM con un'API REST
È possibile configurare le applicazioni esterne in modo che utilizzino la funzionalità di base del prodotto di Workspace ONE UEM integrando le API REST con l'infrastruttura UEM e facilitando la connettività. È inoltre possibile selezionare un URL del token OAuth più vicino al data center per autenticare le chiamate API.
Introduzione alle API REST
Utilizzando l'architettura semplificata del software REST, le API REST di Workspace ONE UEM supportano attualmente più funzionalità, tra cui gruppo, amministrazione della console, applicazione mobile, dispositivo mobile, e-mail, utente di registrazione, profilo, gruppo smart e gestione gruppi utente.
L'utilizzo di API basate su REST offre diversi vantaggi alle aziende, tra cui la riduzione dei costi e dei tempi per lo sviluppo di applicazioni in-house. Le API REST di Workspace ONE UEM dispongono di funzionalità complete e sono pronte per essere integrate nei server, programmi e processi aziendali. Le API REST di Workspace ONE UEM sono più efficienti, possono essere eseguite senza alcuna difficoltà e commercializzate facilmente. Queste API sono destinate agli sviluppatori di applicazioni. Questa guida illustra la progettazione e l'architettura della libreria API e facilita lo sviluppo e l'integrazione personalizzati con Workspace ONE UEM.
Accesso alla documentazione dell'API
Esaminare la documentazione dettagliata dell'API andando alla pagina della Guida relativa all'API di Workspace ONE UEM.
Nella barra degli indirizzi del browser, sostituire "cn" nell'URL con "as", quindi aggiungere /api/help dopo .com.
Ad esempio, la documentazione dell'API per l'URL di un ambiente SaaS di…
https://cn4855.awmdm.com
…è…
https://as4855.awmdm.com/api/help
Data center e URL token per il supporto di OAuth 2.0
Workspace ONE UEM supporta il protocollo OAuth 2.0 standard del settore per l'autenticazione sicura e l'autorizzazione per le chiamate API REST.
Workspace ONE Token Service è l'emittente del token per l'autenticazione OAuth ed è supportato solo negli ambienti SaaS. Gli URL dei token sono specifici per regione.
| Regione | Localizzazione del data center di Workspace ONE UEM SaaS | URL token |
|---|---|---|
| Ohio (Stati Uniti) | Tutto l'ambiente UAT | https://uat.uemauth.vmwservices.com/connect/token |
| Virginia (Stati Uniti) | Stati Uniti | https://na.uemauth.vmwservices.com/connect/token |
| Virginia (Stati Uniti) | Canada | https://na.uemauth.vmwservices.com/connect/token |
| Francoforte (Germania) | Regno Unito | https://emea.uemauth.vmwservices.com/connect/token |
| Francoforte (Germania) | Germania | https://emea.uemauth.vmwservices.com/connect/token |
| Tokyo (Giappone) | India | https://apac.uemauth.vmwservices.com/connect/token |
| Tokyo (Giappone) | Giappone | https://apac.uemauth.vmwservices.com/connect/token |
| Tokyo (Giappone) | Singapore | https://apac.uemauth.vmwservices.com/connect/token |
| Tokyo (Giappone) | Australia | https://apac.uemauth.vmwservices.com/connect/token |
| Tokyo (Giappone) | Hong Kong | https://apac.uemauth.vmwservices.com/connect/token |
Creare un client OAuth da utilizzare per i comandi API (SaaS)
È possibile creare un client OAuth da utilizzare per i comandi API, supportato solo negli ambienti SaaS. Creare un client OAuth per l'ambiente SaaS utilizzando i passaggi seguenti.
- Andare su Gruppi e impostazioni > Configurazioni.
- Immettere
OAuthnella casella di testo di ricerca denominata 'Immetti un nome o una categoria'. - Selezionare la voce Gestione client OAuth visualizzata nei risultati. Viene visualizzata la schermata Gestione client OAuth.
- Selezionare il pulsante Aggiungi.
-
Immettere Nome, Descrizione, Gruppo organizzazione e Ruolo.
Nota: Per ulteriori informazioni sulle autorizzazioni di REST API specifiche per il ruolo selezionato, vedere la sezione di questo argomento intitolata Creazione di un ruolo che possa utilizzare le REST API.
-
Assicurarsi che lo Stato sia Abilitato.
- Seleziona Salva.
-
IMPORTANTE: copiare l'ID cliente e il Codice segreto cliente negli Appunti e salvarli prima di chiudere questa schermata. Selezionare l'icona Copia (
) per inviare il Codice segreto cliente agli Appunti.Non è possibile ritornare a questa schermata per recuperare le informazioni dopo aver selezionato Chiudi.
-
Utilizzare l'ID client, il segreto client e l'URL del token per generare il token di accesso nel formato seguente:
Chiamata API: POST {URL del token specifico per la regione dalla sezione precedente}
Chiave Valore grant_type client_credentials client_id {ID CLIENT generato nella UEM Console} client_secret {SECRET CLIENT generato sulla UEM Console} -
Utilizzare il token di accesso restituito per autorizzare le richieste API future ai server API di Workspace ONE UEM. È necessario formattare il token di accesso nelle intestazioni della richiesta, come indicato di seguito.
Chiamata API: {UEM API}
Chiave Valore Autorizzazione {Token di accesso}
Creazione di un ruolo che possa utilizzare le REST API
Ogni chiamata API ha una risorsa (o autorizzazione) corrispondente che è necessario includere nel ruolo assegnato al client OAuth. Pertanto, le autorizzazioni da includere nel ruolo assegnato si allineano con i tipi di chiamate API che si stanno effettuando.
Utilizzare le informazioni riportate nella tabella seguente per selezionare le autorizzazioni da includere nel ruolo assegnato. Passare quindi alla sezione intitolata Crea ruolo amministratore in Accesso basato sul ruolo per istruzioni sulla creazione di tale ruolo.
| Categoria | Nome | Descrizione | Sola lettura/Modifica |
|---|---|---|---|
| REST > Amministratori | REST API / Gruppi sistema | Consente l'accesso alle informazioni sui gruppi | Modifica |
| REST API / Amministratore del sistema | Consente l'accesso alle informazioni di amministrazione | Modifica | |
| REST API / Utenti del sistema | Consente l'accesso alle informazioni degli utenti | Modifica | |
| REST API / Amministratori /Scrivi | Consente l'accesso a tutte le API di scrittura/aggiornamento nella raccolta Utenti amministratore | Modifica | |
| REST API / Amministratori / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Utenti amministratore | Modifica | |
| REST API / Amministratori / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Utenti amministratore | Modifica | |
| REST API / Amministratori / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta Utenti amministratore | Sola lettura | |
| REST > App | REST API / MAM / Blob | Consente di caricare ed eseguire il download di contenuti | Modifica |
| REST API / Applicazioni MAM | Consente l'accesso alle applicazioni gestite | Modifica | |
| REST API / Applicazioni / Scrivi | Consente l'accesso a tutte le API di scrittura/aggiornamento nella raccolta App | Modifica | |
| REST API / Applicazioni / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta App | Modifica | |
| REST API / Applicazioni / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta App | Modifica | |
| REST API / Applicazioni / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta App | Sola lettura | |
| REST > Criteri di conformità | REST API / Criteri di conformità / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta dei criteri di conformità | Modifica |
| REST API / Criteri di conformità / Esegui | Abilita l'accesso a tutte le API di esecuzione nella raccolta dei criteri di conformità | Modifica | |
| REST API / Criteri di conformità / Scrivi | Consente l'accesso a tutte le API di scrittura nella raccolta dei criteri di conformità | Modifica | |
| REST API / Criteri di conformità / Leggi | Abilita l'accesso a tutte le API di sola lettura nella raccolta dei criteri di conformità | Sola lettura | |
| REST > Attributi personalizzati | REST API / Attributi personalizzati / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta degli attributi personalizzati | Modifica |
| REST API / Attributi personalizzati /Scrivi | Consente l'accesso a tutti le API di scrittura nella raccolta degli attributi personalizzati | Modifica | |
| REST API / Attributi personalizzati / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta degli attributi personalizzati | Modifica | |
| REST API / Attributi personalizzati / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta degli attributi personalizzati | Sola lettura | |
| REST > Dispositivi | REST API / MDM / Gruppi smart | Consente di accedere alle informazioni sui gruppi smart | Modifica |
| REST API / MDM / Gruppi di utenti | Consente di accedere ai gruppi di utenti | Modifica | |
| REST API / MDM / Profili | Consente di inviare comandi di blocco/sblocco | Modifica | |
| REST API / MDM / Dispositivi | Consente di inviare comandi di blocco/sblocco | Modifica | |
| REST API /BLOB / Scrivi | Consente l'accesso a tutte le API di solo scrittura/aggiornamento nella raccolta BLOB | Modifica | |
| REST API / BLOB / Esegui | Consente l'accesso a tutte le API di sola esecuzione nella raccolta BLOB | Modifica | |
| REST API / BLOB / Elimina | Consente l'accesso a tutte le API di sola eliminazione nella raccolta BLOB | Modifica | |
| REST API / Dispositivi / Scrivi | Consente l'accesso a tutte le API di scrittura/aggiornamento nella raccolta Dispositivi | Modifica | |
| REST API / Dispositivi / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Dispositivi | Modifica | |
| REST API / Dispositivi / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Dispositivi | Modifica | |
| REST API / Dispositivi / Avanzati | Consente l'accesso a tutte le API avanzate nella raccolta Dispositivi | Modifica | |
| REST API / BLOB / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta BLOB | Sola lettura | |
| REST API / Dispositivi / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta Dispositivi | Sola lettura | |
| REST > Integrazione di livello aziendale REST | REST API / Integrazione di livello aziendale / Leggi | Consente l'accesso a tutte le API di sola lettura nell'Integrazione di livello aziendale | Sola lettura |
| REST > Gruppi | REST API / Gruppi / Scrivi | Consente l'accesso a tutte le API di scrittura/aggiornamento nella raccolta Gruppo | Modifica |
| REST API / Gruppi / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Gruppo | Modifica | |
| REST API / Gruppi / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Gruppo | Modifica | |
| REST API / Gruppi smart / Scrivi | Consente l'accesso a tutte le API di scrittura nella raccolta Gruppi smart | Modifica | |
| REST API / Gruppi smart / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Gruppi smart | Modifica | |
| REST API / Gruppi smart / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Gruppi smart | Modifica | |
| REST API / Gruppi utenti / Scrivi | Consente l'accesso a tutte le API di scrittura/aggiornamento nei gruppi di utenti | Modifica | |
| REST API / Gruppi utenti / Esegui | Consente l'accesso a tutte le API di esecuzione nei gruppi di utenti | Modifica | |
| REST API / Gruppi utenti / Elimina | Consente l'accesso a tutte le API di eliminazione nei gruppi di utenti | Modifica | |
| REST API / Carrello / Scrivi | REST API per il salvataggio e la modifica dei dati del carrello | Modifica | |
| REST API / Carrello / Elimina | REST API per l'eliminazione dei dati del carrello | Modifica | |
| REST API / Apple School Manager / Scrivi | REST API per attivare la sincronizzazione di Apple School Manager | Modifica | |
| REST API / Apple School Manager / Mappatura | REST API per mappare un utente di registrazione come membro dell'Apple School Manager | Modifica | |
| REST API / Assegnazione classi / Salva | Chiamata REST API per il salvataggio delle assegnazioni delle classi | Modifica | |
| REST API / Classi / Scrivi | REST API per il salvataggio e la modifica dei dati delle classi | Modifica | |
| REST API / Classi / Elimina | REST API per l'eliminazione dei dati delle classi | Modifica | |
| REST API / Impostazioni Education / Scrivi | REST API per il salvataggio e la modifica delle impostazioni di Education | Modifica | |
| REST API / Impostazioni Education / Leggi | REST API per la visualizzazione delle impostazioni di Education | Modifica | |
| REST API / Gruppi / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta Gruppo | Sola lettura | |
| REST API / Gruppi smart / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta Gruppi smart | Sola lettura | |
| REST API / Gruppi utenti / Leggi | Consente l'accesso a tutte le API di sola lettura nei gruppi di utenti | Sola lettura | |
| REST API / Sincronizzazione Apple School Manager / Leggi | REST API per il controllo dello stato di sincronizzazione di Apple School Manager | Sola lettura | |
| REST API / App per dispositivo / Leggi | REST API per la visualizzazione di una lista di app idonee per un dispositivo | Sola lettura | |
| REST API / Classi / Leggi | REST API per la visualizzazione dei dati delle classi | Sola lettura | |
| REST > Prodotti | REST API / Prodotti / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Prodotti | Modifica |
| REST API / Prodotti / Scrivi | Consente l'accesso a tutte le API di scrittura nella raccolta Prodotti | Modifica | |
| REST API / Prodotti / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Prodotti | Modifica | |
| REST API / Prodotti / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta Prodotti | Sola lettura | |
| REST > Profili | Criteri di aggiornamento / Accesso in scrittura | Consente l'accesso a tutte le API di scrittura nella raccolta dei criteri di aggiornamento | Modifica |
| Criteri di aggiornamento / Accesso in esecuzione | Consente l'accesso a tutte le API di esecuzione nella raccolta dei criteri di aggiornamento | Modifica | |
| Criteri di aggiornamento / Accesso in eliminazione | Consente l'accesso a tutte le API di eliminazione nella raccolta dei criteri di aggiornamento | Modifica | |
| REST API / Profili / Scrivi | Consente l'accesso a tutte le API di scrittura nella raccolta Profili | Modifica | |
| REST API / Profili / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Profili | Modifica | |
| REST API / Profili / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Profili | Modifica | |
| Criteri di aggiornamento / Accesso in lettura | Consente l'accesso a tutte le API di sola lettura nella raccolta dei criteri di aggiornamento | Sola lettura | |
| REST API / Profili / Leggi | Consente l'accesso a tutte le API di sola lettura nella raccolta Profili | Sola lettura | |
| REST > Utenti | REST API / Utenti / Scrivi | Consente l'accesso a tutte le API di scrittura/aggiornamento nella raccolta Registrazione utenti | Modifica |
| REST API / Utenti / Esegui | Consente l'accesso a tutte le API di esecuzione nella raccolta Registrazione utenti | Modifica | |
| REST API / Utenti / Elimina | Consente l'accesso a tutte le API di eliminazione nella raccolta Registrazione utenti | Modifica | |
| REST API / Token utenti / Leggi | Consente l'accesso ai token di iscrizione degli utenti per le API nella raccolta Registrazione utenti | Sola lettura | |
| REST API / Utenti / Leggi | Consente l'accesso a tutte le API di sola lettura per la raccolta Registrazione utenti | Sola lettura |
