Apple BusinessでAPIアカウントを作成する
概要
Apple Business APIを使用すると、デバイスの管理割り当てを編集したり、デバイス情報を表示したりできます。デバイスのエンドポイントを使用して、アプリにカスタムレポートの作成機能やデバイスデータのエクスポート機能を提供することもできます。APIではOAuth 2がサポートされます。OAuth 2では、アプリはアクセストークンの受け渡しによって認証情報を使用した認証を行い、APIに対して認証されたリクエストを実行します。
これらのAPIを使用する前に、Apple BusinessでAPIアカウントを作成する必要があります。なお、APIアカウントを作成できるのは、組織管理者の役割を持つユーザーのみです。
注記: 最大50個のAPIアカウントを持つことができます。
データアクセス
APIアカウントが適切に設定されている場合、そのアカウントにより、アプリは以下の情報にアクセスできるようになります。
カテゴリ | 説明 |
|---|---|
デバイス | 自動デバイス登録を使用して登録した、組織内のデバイスのリストを取得します。 |
デバイス | 組織内のデバイスに関する情報(デバイスモデル、注文番号、部品番号など)を取得します。 |
デバイス管理サービス | 組織内のデバイス管理サービスのリストを取得します。 |
デバイス管理サービス | デバイス管理サービスに割り当てられたデバイスのシリアル番号のリストを取得します。 |
デバイス管理サービス | デバイスに割り当てられたデバイス管理サービスID情報を取得します。 |
デバイス管理サービス | デバイスに割り当てられたデバイス管理サービス情報を取得します。 |
デバイス管理サービス | 割り当てや割り当て解除など、デバイス管理アクションによって作成される組織デバイスのアクティビティ情報を取得します。 |
デバイス管理サービス | デバイス管理サービスにデバイスを割り当てたり、割り当てを解除したりします。 |
ユーザー管理サービス | 組織内のユーザーのリストを取得します。 |
ユーザー管理サービス | 組織内の特定のユーザーに関する情報を取得します。 |
ユーザーグループ管理サービス | 組織内のユーザーグループのリストを取得します。 |
ユーザーグループ管理サービス | 組織内の特定のユーザーグループに関する情報を取得します。 |
ユーザーグループ管理サービス | 組織内のユーザーグループに割り当てられたユーザーのリストを取得します。 |
ブループリント | 組織内のブループリントのリストを取得します。 |
ブループリント | 組織内のブループリントを作成します。 |
ブループリント | 組織内のブループリントに関する情報を取得します。 |
ブループリント | 組織内のブループリントを更新します。 |
ブループリント | 組織内のブループリントを削除します。 |
ブループリント | 組織内のブループリントにおける特定のタイプのメンバーを取得または変更します。 |
構成 | 組織内の構成のリストを取得します。 |
構成 | 組織内の構成の詳細を取得します。 |
構成 | 組織内の構成を作成します(タイプ：CUSTOM_SETTING)。 |
構成 | 組織内の構成を更新します(タイプ：CUSTOM_SETTING)。 |
構成 | 組織内の構成を削除します。 |
パッケージ | 組織内のパッケージを取得します。 |
アプリ | 組織内のライセンスされたアプリを取得します。 |
監査イベント | さまざまな条件でフィルタリングされた組織の監査イベントのリストを取得します。監査イベントは、デバイスの追加や削除など、組織内のアクティビティを表します。 |
APIエンドポイントにアクセスするには、どのような権限が必要ですか？
APIアカウントを持つユーザーがAPIエンドポイントにアクセスするには、以下の権限が必要です。
リソース | リソースのURLと権限 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
auditEvents | /v1/auditEvents CAN_ACCESS_AUDIT_EVENTS | ||||||||||
users | /v1/users 黙示的な権限(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
users | /v1/users/<IDENTIFIER> 黙示的な権限(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
userGroups | /v1/usergroups 黙示的な権限(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
userGroups | /v1/usergroups/<IDENTIFIER> 黙示的な権限(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
userGroups | /v1/usergroups/<IDENTIFIER>/relationships/users 黙示的な権限(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
blueprints | /v1/blueprints CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
blueprints | /v1/blueprints/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
blueprints | /v1/blueprints/<IDENTIFIER>/relationships/<resource> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
apps | /v1/apps /v1/apps/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
packages | /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 | ||||||||||
秘密鍵を生成する
Apple Businessへの安全な接続を維持するには、秘密鍵を生成する必要があります。鍵のファイル名は.pemで終わり、鍵は一度だけ生成されます。
APIアカウントを作成して、秘密鍵をダウンロードする
Apple Businessで、組織管理者の役割を持つユーザーとしてサインインします。
「APIアカウントを追加する」を選択し、ユーザーの名前と役割を選択し、「次へ」を選択します。
以下のいずれかを実行します。
「生成してダウンロード」を選択し、鍵を生成およびダウンロードします。
ファイルはブラウザの設定で指定されたファイルのダウンロード場所に自動的にダウンロードされます。場所が指定されていない場合は、ファイルの保存場所を指定するよう求められます。
後で秘密鍵を生成するには、「今はしない」を選択します。
接続を作成するために必要な情報を表示するには、「編集」を選択します。
接続を作成する方法については、Apple Developerのドキュメントを参照してください。
Apple BusinessまたはApple Business Essentialsから移行した既存のAPIアカウントを編集する
組織がApple Business ManagerまたはApple Business EssentialsからApple Businessに移行し、既存のAPIアカウントがある場合、これらのアカウントにはカスタムの役割が割り当てられます。APIアカウント情報は確認および編集できます。
Apple Businessで、組織管理者の役割を持つユーザーとしてサインインします。
既存のAPIアカウントの横にある「編集」を選択します。
必要に応じて、以下のいずれかを実行します。
アカウント名を変更する
役割を変更する
デフォルトの役割はデバイスAPIマネージャーです。役割の権限を編集するには、「役割と権限について」を参照してください。
クライアントIDをクリップボードにコピーします。
キーIDをクリップボードにコピーします。
秘密鍵を無効化します。
「保存」を選択します。
接続を管理する方法については、Apple Developerのドキュメントを参照してください。