Directory API:認可リクエスト

このページは Directory API: Authorize Requestsを翻訳したものです。

自作のアプリケーション(以下アプリ)から Google Apps のユーザやグループを管理するには、 ADMIN SDK に含まれる Directory API を使用します。アプリが Directory API に対してリクエストを送る際は、必ずそのリクエストに認可トークンが含まれていなければなりません。 認可トークンはまた、Google があなたのアプリを特定する際の識別子にもなります。

認可プロトコルについて

あなたのアプリは OAuth 2.0 ([[和訳あり>http://net-newbie.com/apps/Oauth2WebServer.html]]) を使ってリクエストを認可してもらう必要があります。 これ以外の認可プロトコルはサポートされていません。 ただし、あなたのアプリがGoogle+ サインイン を使っている場合は、認可のために別の手段が用意されています。

OAuth 2.0 による認可リクエスト

Directory API に対するすべてのリクエストは、 認証されたユーザーにより認可されていなければなりません。

OAuth 2.0 による認可のための処理の詳細(フロー)は、 作成するアプリの種類によって多少異なります。 どのタイプのアプリケーションについても適用される、一般的な手順を以下に示します。

  1. アプリを作る際は、まず Google Developer Consoleを使ってそのアプリを登録します。それにより、CLIENT IDCLIENT SECRETといった、後で必要になる情報が Google より提示されます。
  2. Google Developer Console で Directory API を有効にします。 (API が Developer Console の一覧にない場合は、この手順はスキップします。)
  3. あなたのアプリでユーザーのデータにアクセスしたくなったら、 まず Google に対して特定のアクセス権限のスコープ(適用範囲)を問い合わせます。
  4. Google はユーザーに対して承諾確認画面を表示し、 あなたのアプリが自分のデータにアクセスしてよいかどうかを尋ねます。
  5. ユーザーがそれに同意したら、Google はあなたのアプリに対して短期間だけ有効な アクセストークンを付与します。
  6. あなたのアプリはユーザーデータをリクエストする際、 リクエストへのアクセストークンを添付します。
  7. Google があなたのリクエストとトークンが正当なものであると判断したら、 リクエストされたデータが返されます。

フローの中には、新しいアクセストークンを取得するための リフレッシュトークンといった、追加的な手順が含まれます。 さまざまなタイプのアプリに関するフローの詳細は、Google の OAuth 2.0 Documentation和訳)を参照してください。

Directory API に関する OAuth 2.0 のスコープ情報を以下に示します。:

デバイス用のスコープ 意味
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.userschema すべてのカスタムユーザースキーマ操作へのアクセスに関するスコープ
https://www.googleapis.com/auth/admin.directory.userschema.readonly カスタムユーザースキーマ情報の取得に限ったスコープ
通知に関するスコープ 意味
https://www.googleapis.com/auth/admin.directory.notifications すべての管理者通知操作へのアクセスに関するスキーマ

OAuth 2.0 を使ってアクセスをリクエストする際は、 あなたがアプリを登録した時に Google から与えられた情報( CLIENT IDCLIENT SECRETといったもの) に加えてスコープの情報が必要になります。

TIP:Google API のクライアントライブラリを使うと、 認可処理の一部を代行してくれます。 クライアントライブラリは複数のプログラミング言語のものが用意されています。 詳細は ライブラリとサンプルのページを参照してください。

特に記載のない限り、このページのコンテンツは クリエイティブ・コモンズの表示 3.0 ライセンス により使用許諾されます。サンプル コードは Apache 2.0 ライセンス (リンク先は英語)により使用許諾されます。詳しくは、Google のサイトに関するポリシーをご覧ください。

最終更新日: 7月 22, 2015

Go Top