Vous pouvez configurer des applications externes pour utiliser la fonctionnalité principale de Workspace ONE UEM en intégrant les API REST à l'infrastructure UEM et en facilitant la connectivité. Vous pouvez également sélectionner une URL de jeton OAuth la plus proche de votre centre de données pour authentifier les appels d'API.

Prise en main des API REST

À l'aide de l'architecture logicielle REST simplifiée, les API REST de Workspace ONE UEM prennent actuellement en charge plusieurs fonctionnalités, notamment le groupe organisationnel, l'administration de la console, l'application mobile, le terminal mobile, la messagerie, l'utilisateur de l'inscription, le profil, le Smart Group et la gestion de groupe d'utilisateurs.

L'utilisation d'API basées sur REST offre plusieurs avantages aux entreprises, notamment la suppression des coûts et du temps passé à développer des applications en interne. Les API REST de Workspace ONE UEM sont entièrement capables et prêtes à être intégrées aux serveurs, aux programmes et aux processus d'entreprise. En outre, les API REST de Workspace ONE UEM sont plus efficaces, peuvent s'exécuter sans problème et être facilement personnalisées pour les entreprises. Ces API sont destinées aux développeurs d'applications, et ce guide fournit des connaissances sur la conception et l'architecture de la bibliothèque d'API pour faciliter le développement et l'intégration personnalisés avec Workspace ONE UEM.

Accès à la documentation de l'API

Examinez la documentation détaillée de l'API en accédant à la page d'aide de l'API de Workspace ONE UEM.

Pour ce faire, dans les environnements SaaS, remplacez le « cn » dans votre URL par « as », puis ajoutez /api/help après .com.

Par exemple, la documentation de l'API pour l'URL d'un environnement SaaS
https://cn4855.awmdm.com
est
https://as4855.awmdm.com/api/help

URL du centre de données et du jeton pour la prise en charge d'OAuth 2.0

Workspace ONE UEM prend en charge le protocole OAuth 2.0 standard dans l'industrie pour l'authentification et l'autorisation sécurisées pour les appels API REST.

Workspace ONE Token Service émet des jetons pour l'authentification OAuth. Ce service est uniquement pris en charge dans les environnements SaaS pour le moment. Les URL de jeton sont spécifiques à la région.

Tableau 1. URL de jeton spécifiques à la région
Région Emplacement du centre de données SaaS de Workspace ONE UEM URL de jeton
Ohio (États-Unis) Tout l'environnement UAT https://uat.uemauth.vmwservices.com/connect/token
Virginie (États-Unis) États unis https://na.uemauth.vmwservices.com/connect/token
Virginie (États-Unis) Canada https://na.uemauth.vmwservices.com/connect/token
Francfort (Allemagne) Royaume-Uni https://emea.uemauth.vmwservices.com/connect/token
Francfort (Allemagne) Allemagne https://emea.uemauth.vmwservices.com/connect/token
Tokyo (Japon) Inde https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japon) Japon https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japon) Singapour https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japon) Australie https://apac.uemauth.vmwservices.com/connect/token
Tokyo (Japon) Hong Kong https://apac.uemauth.vmwservices.com/connect/token

Créer un client OAuth à utiliser pour les commandes API (SaaS)

Vous pouvez créer un client OAuth à utiliser pour les commandes API (uniquement disponible dans les environnements SaaS). Créez un client OAuth pour votre environnement SaaS en suivant les étapes ci-dessous.

  1. Accédez à Groupes et paramètres > Configurations.
  2. Saisissez OAuth dans la zone de texte de recherche nommée « Saisissez un nom ou une catégorie ».
  3. Sélectionnez Gestion des clients OAuth qui apparaît dans les résultats. L'écran Gestion des clients OAuth s'affiche.
  4. Cliquez sur le bouton Ajouter ;
  5. Saisissez le Nom, la Description, le Groupe organisationnel et le Rôle.
    Note : Pour plus d'informations sur les autorisations spécifiques d'API REST pour le rôle que vous sélectionnez, reportez-vous à la section Créer un rôle pouvant utiliser les API REST de cette rubrique.
  6. Assurez-vous que l'État est défini sur Activé.
  7. Cliquez sur Enregistrer.
  8. IMPORTANT : copiez l'ID client et la Clé secrète du client dans le presse-papiers et enregistrez-les avant de fermer cet écran. Cliquez sur l'icône du presse-papiers () pour envoyer la Clé secrète du client vers le presse-papiers.

    Vous ne pouvez pas revenir ici pour récupérer ces informations après avoir sélectionné Fermer.

  9. Utilisez l'ID client, la clé secrète du client et l'URL du jeton pour générer le jeton d'accès au format suivant :

    Appel d'API : POST {Region-Specific Token URL from section above}

    Clé Valeur
    grant_type client_credentials
    client_id {ID CLIENT généré sur UEM console}
    client_secret {CLIENT SECRET generated on UEM console}
  10. Utilisez le jeton d'accès qui a été renvoyé pour autoriser de futures demandes d'API sur les serveurs API Workspace ONE UEM. Le jeton d'accès doit être fourni dans les en-têtes de demande au format suivant.

    Appel d'API : {UEM API}

    Clé Valeur
    Autorisation {Access Token}

Créer un rôle pouvant utiliser les API REST

Chaque appel d'API que vous prévoyez d'effectuer dispose d'une ressource (ou autorisation) correspondante à inclure dans le rôle que vous attribuez au client OAuth. Par conséquent, les autorisations à inclure dans le rôle que vous attribuez correspondent aux types d'appels d'API que vous effectuez.

Utilisez les informations du tableau suivant pour vous aider à sélectionner les autorisations que vous devez inclure dans le rôle que vous attribuez. Rendez-vous ensuite sur Créer un rôle administrateur pour obtenir des instructions sur la création de ce rôle.
Tableau 2. Autorisations de rôle d'API REST
Catégorie Nom Description Lecture seule/Modifier
REST > Administrateurs Groupes de systèmes d'API REST Accès aux informations du groupe organisationnel Modifier
Administrateur système d'API REST Accès aux informations d'administration Modifier
Utilisateurs système d'API REST Accès aux informations de l'utilisateur Modifier
Écriture des administrateurs d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour dans la collection d'administrateurs Modifier
Exécution des administrateurs d'API REST Permet d'accéder à toutes les API d'exécution dans la collection d'utilisateurs Admin Modifier
Suppression des administrateurs d'API REST Permet d'accéder à toutes les API de suppression dans la collection d'utilisateurs Admin Modifier
Lecture des administrateurs d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection d'utilisateurs Admin Lecture seule
REST > Applications Blob MAM d'API REST Charger/Télécharger du contenu Modifier
Applications MAM d'API REST Accès aux applications gérées Modifier
Écriture des applications d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour dans la collection d'applications Modifier
Exécution des applications d'API REST Permet d'accéder à toutes les API d'exécution dans la collection d'applications Modifier
Suppression des applications d'API REST Permet d'accéder à toutes les API de suppression dans la collection d'applications Modifier
Lecture des applications d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection d'applications Lecture seule
REST > Stratégie de conformité Suppression de la stratégie de conformité d'API REST Permet d'accéder à toutes les API de suppression dans la collection de stratégies de conformité Modifier
Exécution de la stratégie de conformité d'API REST Permet d'accéder à toutes les API d'exécution dans la collection de stratégies de conformité Modifier
Écriture de la stratégie de conformité d'API REST Permet d'accéder à toutes les API d'écriture dans la collection de stratégies de conformité Modifier
Lecture de la stratégie de conformité d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de stratégies de conformité Lecture seule
REST > Attributs personnalisés Exécution des attributs personnalisés d'API REST Permet d'accéder à toutes les API d'exécution dans la collection d'attributs personnalisés Modifier
Écriture des attributs personnalisés d'API REST Permet d'accéder à toutes les API d'écriture dans la collection d'attributs personnalisés Modifier
Suppression d'attributs personnalisés d'API REST Permet d'accéder à toutes les API de suppression dans la collection d'attributs personnalisés Modifier
Lecture d'attributs personnalisés d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection d'attributs personnalisés Lecture seule
REST > Terminaux Smart Groups MDM d'API REST Accès aux informations du Smart Group Modifier
Groupes d'utilisateurs MDM d'API REST Accès aux groupes d'utilisateurs Modifier
Profils MDM d'API REST Envoyer les commandes de verrouillage/déverrouillage Modifier
Terminaux MDM d'API REST Envoyer les commandes de verrouillage/déverrouillage Modifier
Écriture des BLOBS d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour seule dans la liste de BLOBS Modifier
Exécution des BLOBS d'API REST Permet d'accéder à toutes les API d'exécution seule dans la liste de BLOBS Modifier
Suppression des BLOBS d'API REST Permet d'accéder à toutes les API de suppression seule dans la liste de BLOBS Modifier
Écriture des terminaux d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour dans la collection de terminaux Modifier
Exécution des terminaux d'API REST Permet d'accéder à toutes les API d'exécution dans la collection de terminaux Modifier
Suppression des terminaux d'API REST Permet d'accéder à toutes les API de suppression dans la collection de terminaux Modifier
Avancées des terminaux d'API REST Permet d'accéder à toutes les API avancées dans la collection de terminaux Modifier
Lecture des BLOBS d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de BLOBS Lecture seule
Lecture des terminaux d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de terminaux Lecture seule
REST > REST de l'intégration d'entreprise Lecture des API REST dans l'intégration d'entreprise Permet d'accéder à toutes les API de lecture seule dans l'intégration d'entreprise Lecture seule
REST > Groupes Écriture des groupes d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour dans la collection de groupes organisationnels Modifier
Exécution des groupes d'API REST Permet d'accéder à toutes les API d'exécution dans la collection de groupes organisationnels Modifier
Suppression des groupes d'API REST Permet d'accéder à toutes les API de suppression dans la collection de groupes organisationnels Modifier
Écriture des Smart Groups d'API REST Permet d'accéder à toutes les API d'écriture dans la collection de Smart Groups Modifier
Exécution des Smart Groups d'API REST Permet d'accéder à toutes les API d'exécution dans les collections de Smart Groups Modifier
Suppression des Smart Groups d'API REST Permet d'accéder à toutes les API de suppression dans la collection de Smart Groups Modifier
Écriture des groupes d'utilisateurs d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour dans les groupes d'utilisateurs Modifier
Exécution des groupes d'utilisateurs d'API REST Permet d'accéder à toutes les API d'exécution dans les groupes d'utilisateurs Modifier
Suppression des groupes d'utilisateurs d'API REST Permet d'accéder à toutes les API de suppression dans les groupes d'utilisateurs Modifier
Écriture du chariot d'API REST API REST pour l'enregistrement et la modification des données du chariot Modifier
Suppression du chariot d'API REST API REST pour la suppression des données du chariot Modifier
Écriture Apple School Manager d'API REST API REST pour l'initialisation de la synchronisation d'Apple School Manager Modifier
Mappage d'Apple School Manager d'API REST API REST pour le mappage d'un utilisateur d'enrôlement avec un membre d'Apple School Manager Modifier
Enregistrement des attributions de classe d'API REST Appel d'API REST pour enregistrer les attributions de classe Modifier
Écriture de classe d'API REST API REST pour enregistrer et modifier les données de classe Modifier
Suppression de classe d'API REST API REST pour supprimer les données de classe Modifier
Écriture des paramètres Éducation d'API REST API REST d'enregistrement et de modification des paramètres Education Modifier
Lecture des paramètres Éducation d'API REST API REST d'affichage des paramètres Éducation Modifier
Groupe de lecture d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de groupes organisationnels Lecture seule
Lecture des Smart Groups d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de Smart Groups Lecture seule
Lecture des groupes d'utilisateurs d'API REST Permet d'accéder à toutes les API de lecture seule dans les groupes d'utilisateurs Lecture seule
Lecture de la synchronisation d'Apple School Manager d'API REST API REST pour la vérification de l'état de synchronisation d'Apple School Manager Lecture seule
Applications d'API REST pour la lecture de terminal API REST pour l'obtention d'une liste d'applications valables pour un terminal Lecture seule
Lecture de classe d'API REST API REST pour afficher les données de classe Lecture seule
REST > Produits Exécution des produits d'API REST Permet d'accéder à toutes les API d'exécution dans la collection de produits Modifier
Écriture de produits d'API REST Permet d'accéder à toutes les API d'écriture dans la collection de produits Modifier
Suppression de produits d'API REST Permet d'accéder à toutes les API de suppression dans la collection de produits Modifier
Lecture de produits d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de produits Lecture seule
REST > Profils Accès en écriture des stratégies de mise à jour Autorise l'accès à toutes les API ÉCRITURE dans la collection de stratégies de mise à jour Modifier
Accès à l'exécution des stratégies de mise à jour Autorise l'accès à toutes les API EXÉCUTER dans la collection de stratégies de mise à jour Modifier
Accès à la suppression des stratégies de mise à jour Autorise l'accès à toutes les API SUPPRIMER dans la collection de stratégies de mise à jour Modifier
Écriture des profils d'API REST Permet d'accéder à toutes les API d'écriture dans la collection de profils Modifier
Exécution des profils d'API REST Permet d'accéder à toutes les API d'exécution dans la collection de profils Modifier
Suppression des profils d'API REST Permet d'accéder à toutes les API de suppression dans la collection de profils Modifier
Accès en lecture des stratégies de mise à jour Autorise l'accès à toutes les API LECTURE seule dans la collection de stratégies de mise à jour Lecture seule
Lecture des profils d'API REST Permet d'accéder à toutes les API de lecture seule dans la collection de profils Lecture seule
REST > Utilisateurs Écriture des utilisateurs d'API REST Permet d'accéder à toutes les API d'écriture/mise à jour dans la collection d'utilisateurs d'enrôlement Modifier
Exécution des utilisateurs d'API REST Permet d'accéder à toutes les API d'exécution dans la collection d'utilisateurs d'enrôlement Modifier
Suppression des utilisateurs d'API REST Permet d'accéder à toutes les API de suppression dans la collection d'utilisateurs d'enrôlement Modifier
Lecture des jetons d'utilisateurs d'API REST Permet d'accéder aux jetons d'utilisateur d'enrôlement pour les API dans la collection d'utilisateurs d'enrôlement Lecture seule
Lecture des utilisateurs d'API REST Permet d'accéder à toutes les API de lecture seule pour la collection d'utilisateurs d'enrôlement Lecture seule