Directory API スコープを選択する

このドキュメントには、Directory API 固有の認可と認証に関する情報が記載されています。このドキュメントを読む前に、認証と認可についてで Google Workspace の一般的な認証と認可に関する情報をご確認ください。

認可用に OAuth 2.0 を構成する

OAuth 同意画面を設定し、スコープを選択することで、ユーザーとアプリの審査担当者に表示する情報を定義し、後でアプリを公開できるようにアプリを登録します。

Directory API スコープ

アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルを含む OAuth 2.0 URI 文字列です。スコープとは、ユーザーの Google アカウント データなど、Google Workspace データの操作に対するアプリのリクエストです。

アプリがインストールされると、アプリで使用されるスコープをユーザーが検証するよう求められます。通常は、できるだけ範囲を狭めたスコープを選択し、アプリで必要のないスコープはリクエストしないようにします。ユーザーは、明確に説明された限定的なスコープに対してアクセス権限を付与する傾向があります。

Directory API は、次のスコープをサポートしています。

デバイス用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.device.chromeos Chrome デバイスのすべてのオペレーションにアクセスするためのグローバル スコープ。
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly Chrome デバイスの取得に限ったスコープ。
https://www.googleapis.com/auth/admin.directory.device.mobile モバイル デバイスのすべてのオペレーションにアクセスするためのグローバル スコープ。
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly モバイル デバイスの取得に限ったスコープ。
https://www.googleapis.com/auth/admin.directory.device.mobile.action モバイル デバイスでアクションを起こすタスクのためのスコープ。
グループ、グループ エイリアス、グループ メンバー用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.group.member グループ メンバーのすべてのロールと情報オペレーションにアクセスするためのスコープ。
https://www.googleapis.com/auth/admin.directory.group.member.readonly グループ メンバーのロールと情報の取得に限ったスコープ。
https://www.googleapis.com/auth/admin.directory.group グループのエイリアスやメンバーを含め、すべてのグループ オペレーションにアクセスするためのグローバル スコープ。
https://www.googleapis.com/auth/admin.directory.group.readonly グループ、グループ エイリアス、メンバー情報の取得に限ったスコープ。
組織部門用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.orgunit 組織部門のすべてのオペレーションにアクセスするためのグローバル スコープ。
https://www.googleapis.com/auth/admin.directory.orgunit.readonly 組織部門の取得に限ったスコープ。
ユーザーとユーザー エイリアス用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.user ユーザーとユーザー エイリアスのすべてのオペレーションにアクセスするためのグローバル スコープ。
https://www.googleapis.com/auth/admin.directory.user.readonly ユーザーまたはユーザー エイリアスの取得に限ったスコープ。
https://www.googleapis.com/auth/admin.directory.user.alias ユーザー エイリアスのすべてのオペレーションにアクセスするためのスコープ。
https://www.googleapis.com/auth/admin.directory.user.alias.readonly ユーザー エイリアスの取得に限ったスコープ。
ユーザー セキュリティ機能用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.user.security すべてのアプリケーション固有のパスワード、OAuth トークン、確認コードのオペレーションにアクセスするためのスコープ。
ロール管理用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.rolemanagement ロールとロール割り当てを含め、すべてのロール管理オペレーションのためのスコープ。
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly ロール、権限、ロール割り当てを取得、列挙するためのスコープ。
カスタム ユーザー スキーマ用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.userschema カスタム ユーザーのすべてのスキーマ オペレーションにアクセスするためのスコープ。
https://www.googleapis.com/auth/admin.directory.userschema.readonly カスタム ユーザーのスキーマの取得に限ったスコープ。
顧客用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.customer 顧客のすべてのオペレーションにアクセスするためのスコープ。
https://www.googleapis.com/auth/admin.directory.customer.readonly 顧客の取得に限ったスコープ。
ドメイン用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.domain ドメインのすべてのオペレーションにアクセスするためのスコープ。
https://www.googleapis.com/auth/admin.directory.domain.readonly ドメインの取得に限ったスコープ。
カレンダー リソース用のスコープ 意味
https://www.googleapis.com/auth/admin.directory.resource.calendar カレンダー リソースのすべてのオペレーションにアクセスするためのスコープ。
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly カレンダー リソースの取得に限ったスコープ。