Créer un compte API dans Apple Business
Présentation
L’API Apple Business permet de modifier les assignations de la gestion et de consulter les informations des appareils. Vous pouvez aussi utiliser le point d’accès de l’appareil pour permettre aux apps de créer des rapports personnalisés ou d’exporter les données des appareils. L’API est compatible avec OAuth 2, qui permet aux apps de fournir un jeu d’identifiants pour s’authentifier, et de recevoir un jeton d’accès afin de transmettre des requêtes authentifiées à l’API.
Avant d’utiliser ces API, vous devez créer un compte API dans Apple Business. Seuls les profils utilisateurs ayant le rôle d’administrateur de l’organisation peuvent créer un compte API.
Remarque : Vous pouvez avoir jusqu’à 50 comptes API.
Accès aux données
Lorsque le compte API est correctement configuré, il peut autoriser une app à accéder aux informations suivantes :
Catégorie | Description |
|---|---|
Appareils | Permet d’obtenir une liste des appareils d’une organisation donnée, enregistrés via Inscription automatisée des appareils. |
Appareils | Permet d’obtenir des informations sur un appareil appartenant à une organisation, comme le modèle, le numéro de commande ou de pièce, etc. |
Services de gestion des appareils | Permet d’obtenir une liste des services de gestion des appareils d’une organisation donnée. |
Services de gestion des appareils | Permet d’obtenir une liste des numéros de série des appareils affectés à un service de gestion des appareils. |
Services de gestion des appareils | Permet d’obtenir les informations d’identification attribuées à un appareil affecté à un service de gestion des appareils. |
Services de gestion des appareils | Permet d’obtenir les informations de service associées à un appareil affecté à un service de gestion des appareils. |
Services de gestion des appareils | Permet d’obtenir des informations sur l’activité d’un appareil appartenant à l’organisation générée par une action de gestion de l’appareil, comme une attribution ou un retrait. |
Services de gestion des appareils | Permet d’attribuer ou de retirer des appareils à un service de gestion des appareils. |
Services de gestion des utilisateurs | Permet d’obtenir la liste des utilisateurs au sein d’une organisation. |
Services de gestion des utilisateurs | Permet d’obtenir des informations sur un utilisateur ou une utilisatrice en particulier au sein d’une organisation. |
Services de gestion des groupes d’utilisateurs | Permet d’obtenir la liste des groupes d’utilisateurs au sein d’une organisation. |
Services de gestion des groupes d’utilisateurs | Permet d’obtenir des informations sur un groupe d’utilisateurs en particulier au sein d’une organisation. |
Services de gestion des groupes d’utilisateurs | Permet d’obtenir la liste des utilisateurs attribués à un groupe d’utilisateurs au sein d’une organisation. |
Schémas | Permet d’obtenir une liste des schémas au sein d’une organisation. |
Schémas | Permet de créer un schéma au sein d’une organisation. |
Schémas | Permet d’obtenir des informations sur un schéma au sein d’une organisation. |
Schémas | Permet de mettre à jour un schéma au sein d’une organisation. |
Schémas | Permet de supprimer un schéma au sein d’une organisation. |
Schémas | Permet d’obtenir ou modifier les membres d’un type donné dans un schéma au sein d’une organisation. |
Configurations | Permet d’obtenir la liste des configurations au sein d’une organisation. |
Configurations | Permet d’obtenir les détails d’une configuration au sein d’une organisation. |
Configurations | Permet de créer une configuration au sein d’une organisation (de type CUSTOM_SETTING). |
Configurations | Permet de mettre à jour une configuration au sein d’une organisation (de type CUSTOM_SETTING). |
Configurations | Permet de supprimer une configuration au sein d’une organisation. |
Paquets | Permet d’obtenir des paquets au sein d’une organisation. |
Apps | Permet d’obtenir les apps sous licence au sein d’une organisation. |
Évènements d’audit | Récupérez une liste d’évènements d’audit pour une organisation, filtrés selon différents critères. Un évènement d’audit représente une activité au sein de l’organisation, par exemple l’ajout ou la suppression d’un appareil. |
De quelles autorisations ai-je besoin pour accéder aux points d’accès API ?
Les utilisateurs disposant d’un compte API ont besoin des autorisations suivantes pour accéder aux points d’accès API :
Ressources | URL de la ressource et autorisation | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Évènements d’audit | /v1/auditEvents CAN_ACCESS_AUDIT_Events | ||||||||||
Utilisateurs | /v1/users Autorisation implicite(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Utilisateurs | /v1/users/<IDENTIFIER> Autorisation implicite(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Groupes d’utilisateurs | /v1/usergroups Autorisation implicite(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Groupes d’utilisateurs | /v1/usergroups/<IDENTIFIER> Autorisation implicite(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Groupes d’utilisateurs | /v1/usergroups/<IDENTIFIER>/relationships/users Autorisation implicite(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Schémas | /v1/blueprints CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Schémas | /v1/blueprints/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Schémas | /v1/blueprints/<IDENTIFIER>/relationships/<resource> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Apps | /v1/apps /v1/apps/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Paquets | /v1/packages /v1/packages/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Configurations | /v1/configurations /v1/configurations/<IDENTIFIER> CAN_VIEW_CONFIGURATIONS/CAN_MANAGE_CONFIGURATIONS | ||||||||||
mdmDevices | /v1/mdmDevices /v1/mdmDevices/<IDENTIFIER>/ Details CAN_MANAGE_DEVICES | ||||||||||
Générer une clé privée
Afin de sécuriser la connexion à Apple Business, vous devez générer une clé privée. Le nom de fichier de la clé se termine par .pem, et vous ne le générez qu’une seule fois.
Créer un compte API et télécharger la clé privée
Dans Apple Business, connectez-vous avec un profil utilisateur ayant le rôle d’administrateur de l’organisation.
Dans votre Navigateur, sélectionnez Réglages > API.
Sélectionnez Ajouter un compte API, saisissez le nom du profil utilisateur et sélectionnez son rôle, puis Suivant.
Choisissez l’une des options suivantes :
Sélectionnez Générer et télécharger pour générer et télécharger la clé.
Le fichier est téléchargé automatiquement à l’emplacement défini dans les réglages de votre navigateur, ou à l’emplacement que vous indiquez en l’absence de réglage prédéfini.
Sélectionnez Plus tard pour générer la clé privée ultérieurement.
Pour consulter les informations nécessaires afin de créer la connexion, sélectionnez Modifier.
Consultez la documentation Apple Developer pour savoir comment créer la connexion.
Modifier un compte API existant migré depuis Apple Business Manager ou Apple Business Essentials
Si votre organisation a migré d’Apple Business Manager ou Apple Business Essentials vers Apple Business et si vous disposiez de comptes API, ces comptes ont désormais un rôle par défaut. Vous pouvez consulter et modifier toutes les informations du compte API.
Dans Apple Business, connectez-vous avec un profil utilisateur ayant le rôle d’administrateur de l’organisation.
Dans votre Navigateur, sélectionnez Réglages > API.
Sélectionnez Modifier à côté d’un compte API existant.
Si nécessaire, vous pouvez effectuer l’une des actions suivantes :
Modifier le nom du compte
Changer le rôle
Le rôle personnalisé est Gestionnaire d’API d’appareil. Pour modifier les autorisations d’un rôle, consultez la section Introduction aux rôles et autorisations.
Copiez l’identifiant client dans votre presse-papiers.
Copiez l’identifiant de clé dans votre presse-papiers.
Révoquer la clé privée.
Sélectionnez Enregistrer.
Consultez la documentation Apple Developer pour savoir comment gérer la connexion.