Utiliser la fonctionnalité UEM avec une API REST

Vous pouvez configurer des applications externes pour utiliser la fonctionnalité principale de Workspace ONE UEM en intégrant les REST API à 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 REST API 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 REST API de Workspace ONE UEM sont entièrement capables et prêtes à être intégrées aux serveurs, aux programmes et aux processus d'entreprise. Les REST API 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. Ce guide permet la compréhension de la conception et de l'architecture de la bibliothèque d'API et facilite un développement et une 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 Workspace ONE UEM.

1. Connectez-vous à Workspace ONE UEM Console en tant qu'administrateur.
2. Dans la barre d'adresse de votre navigateur, remplacez le « cn » dans l'URL par « as », puis ajoutez /api/help après .com.

Par exemple, la documentation de l'API pour l'URL d'un environnement SaaS de…

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. Les URL de jeton sont spécifiques à la région.

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.

   Remarque : 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 RESTde 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 Copier () 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 :

   REQUÊTE HTTP

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

   PARAMÈTRES D'ENTRÉE

   Paramètre	Requis	Description
   tenant_url	Oui (URL)	Nom d'hôte de votre locataire
   grant_type=client_credentials	Oui (corps)	Requis pour recevoir le jeton d'accès
   application/x-www-form-urlencoded	Oui (en-tête)	Format du codage
   Autorisation : basique	Oui (en-tête)	Vous devez transmettre la chaîne codée en Base64 de client_id:Client_secret

10. Utilisez le jeton d'accès qui a été renvoyé pour autoriser de futures demandes d'API vers les serveurs d'API Workspace ONE UEM. Vous devez formater le jeton d'accès dans les en-têtes de demandes de la manière suivante.

    Appel d'API : {UEM API}

    Clé	Valeur
    Autorisation	{Access Token}

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

Chaque appel d'API dispose d'une ressource (ou d'une autorisation) correspondante que vous devez 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. Consultez ensuite la section intitulée Créer un rôle d'administrateur dans Accès basé sur les rôles pour obtenir des instructions sur la création de ce rôle.