【G Suite】プロビジョニングの設定
CloudGate UNOはG Suiteのアカウントやグループに対して作成・更新・削除(停止)といった処理を行うことができます。これらの処理を行うためには、お客様のG Suite環境からGoogleが提供するAPIの設定が必要です。
このガイドではG suiteと連携するための前準備である、OAuth設定について説明しています。
目次
1.利用に際しての前提条件、注意事項
1-1.管理者アカウントでの操作
このガイドに記載されている作業を行う際に利用するG Suite特権管理者はCloudGateを利用するにあたりG Suite上に存在している必要がありますので、削除しないようお願いします。
削除、変更をご希望の場合には、新しいG Suite特権管理者で再度本作業を行う必要があります。詳しくは【G Suite】API接続情報を変更する をご覧ください。
*G Suiteの特権管理者(スーパーユーザー)について 既定の管理者の役割<外部サイト> *権限の割り当てについて ユーザーに管理者の役割を割り当てる<外部サイト>
2. APIプロジェクトの作成
2-1. 事前準備
Google管理コンソール(https://admin.google.com/)にG Suite特権管理者でログインします。
トップページの「アプリ」をクリックして、次の画面で「その他のGoogleサービス」をクリックします。
主なGoogleサービスが一覧表示されます。
Google Cloud Platform 項目の「ステータス」が「オン」になっていることを確認します。
オンになっていない場合は、右側の三本線のメニューから「すべてのユーザーに対してオンにする」を選択して設定します。
Google Cloud Platform 項目が見つからない場合は、ページ下の1ページあたりの行数を変更するか、ページを切り替えて確認します。
2-2. プロジェクトの作成
Google Cloud Platform(https://console.developers.google.com)に、G Suite特権管理者でログインします。
利用規約が表示される場合は、以下を選択して「同意して続行」をクリックします。
- 利用規約:チェックを入れる(必須項目)
- 最新情報をメールで通知:(任意項目)
画面右の「作成」をクリックします。 もしくは画面左上のプルダウンをクリックして、「新しいプロジェクト」をクリックします。
新しいプロジェクトを作成する画面が表示されるので、プロジェクト名に「CloudGate」と入力して「作成」ボタンをクリックします。
※プロジェクトの作成が完了するまで少し時間がかかります。
2-3. APIを有効にする
プロジェクトの作成が完了したら、プロジェクト「CloudGate」を選択した状態で、ナビゲーションメニュー(画面左上の「三本線のアイコン」)から「APIとサービス」にマウスカーソルを合わせて「ライブラリ」をクリックします。
※「このページを表示するには、プロジェクトを選択してください。」と表示される場合:
「選択」ボタンをクリックして、作成したプロジェクト「CloudGate」を選択します。
検索窓に以下のAPIを1つずつ入力して検索し、APIを有効化します。
- Admin SDK API
- Contacts API
- Google People API
それぞれの検索結果画面にて対象のAPIをクリックして「有効にする」ボタンをクリックします。
再度、ナビゲーションメニューから「APIとサービス」にマウスカーソルを合わせて「ライブラリ」をクリックし、もう1つのAPIについても有効にする操作を実施します。
ナビゲーションメニューから「APIとサービス」にマウスカーソルを合わせて「ダッシュボード」をクリックし、画面下部の一覧表に、有効にしたAPIがリスト表示されていることを確認してください。
3. OAuthのクライアントIDを作成する
有効にしたAPIがリスト表示されていることを確認したら、左メニューより「認証情報」をクリックします。
認証情報の画面より「認証情報を作成」をクリックし、表示されたリストより「サービスアカウント」をクリックします。
「サービスアカウントキーの作成」画面に遷移します。
- サービス アカウントの詳細
サービス アカウント名に「CloudGate」を入力して「作成」をクリックします。 - このサービス アカウントにプロジェクトへのアクセスを許可する
「ロールを選択」のプルダウンから「Project」を選択して「オーナー」を選択します。
「続行」をクリックして次の画面に進みます。 - ユーザーにこのサービス アカウントへのアクセスを許可
画面下の「完了」をクリックするとサービスアカウントが作成されます。
サービスアカウントの作成が完了すると、認証情報画面が表示されます。
画面右側の「サービスアカウントを管理」をクリックし、作成したサービスアカウント表の右端のメニューから「編集」を選択します。
「サービスアカウントの詳細」画面で以下情報を入力してキーをダウンロードします。
- サービスアカウントのステータス
「ドメイン全体の委任の表示」をクリックして表示される「G Suite ドメイン全体の委任を有効にする」にチェックを入れ、「同意画面のプロダクト名」に「CloudGate」と入力します。 - キー
鍵を追加 >「新しい鍵を作成」を選択すると、「秘密鍵の作成」画面が表示されます。
「P12」を選択し、「作成」をクリックすると「CloudGate-**************.p12」という名称のプライベートキーが自動でダウンロードされます。
「秘密鍵がパソコンに保存されました」と表示されるので画面を閉じます。
・ダウンロードされるまで少し時間がかかります。
・この.p12ファイルは、後ほどの設定で重要なファイルとなりますので、大切に保管してください。
「保存」をクリックし「サービスアカウントの詳細」を保存します。
ナビゲーションメニューから「APIとサービス」にマウスカーソルを合わせて「認証情報」をクリックし、表示された画面で、作成した「サービスアカウントの名前のリンク」をクリックします。
作成されたサービスアカウントの情報が画面上に表示されます。
画面上で確認できる「クライアントID」と「サービスアカウント(メールアドレス)」の値をテキストエディタなどにコピー&ペーストして控えます。
※「クライアントID」と「サービスアカウント(メールアドレス)」の値は「4. APIスコープの承認」「5. CloudGate UNO管理者サイトでの設定」の作業で必要になります。「サービスアカウント」の1行目に表示されている「CloudGate」という文字はコピー不要です。
ナビゲーションメニューから「IAMと管理」にマウスカーソルを合わせて「IAM」をクリックし、表示された画面で、「CloudGate」プロジェクトの役割が、「オーナー」もしくは「編集者」であることを確認します。
役割の設定を確認できたら、Google Cloud Platform での作業は完了です。画面を閉じて「4. APIスコープの承認」の手順に進みます。
※「オーナー」または「編集者」以外の場合は、列右端の鉛筆マークをクリックして、「役割」のプルダウンより「Project」から「オーナー」もしくは「編集者」を選択します。
※作成した「CloudGate」プロジェクトが一覧にない場合は、以下手順で確認します。
(1)画面上部の「追加」をクリックします。
(2)「メンバーの追加」画面で、「メンバー」欄には先ほどサービスアカウント情報の確認画面でコピーした「サービスアカウント(メールアドレス)」の値を入力します。
(3)「役割」のプルダウンより「Project」項目にマウスカーソルを合わせ「オーナー」を選択します。
追加したサービスアカウントがリストに反映されたことを確認し、Google Cloud Platform での作業は完了です。画面を閉じて次の手順に進みます。
4. APIスコープの承認
Google管理コンソール(https://admin.google.com/)にG Suite特権管理者でログインします。
ダッシュボードから、「セキュリティ」をクリックします。
ダッシュボードの一覧にない場合は、画面下の「その他の設定」をクリックすることで、「セキュリティ」が表示されます。
セキュリティ設定の「API の制御」をクリックし、APIの制御画面内の「ドメイン全体の委任」項目内「ドメイン全体の委任を管理」をクリックします。
「ドメイン全体の委任」画面で、APIクライアントを新しく追加します。
- クライアントID:「3. OAuthのクライアントID作成」の作業で確認したクライアントID を入力
- OAuth スコープ:以下の5つのURLをコピー&ペーストして入力
https://www.google.com/m8/feeds,
https://www.googleapis.com/auth/admin.directory.group,
https://www.googleapis.com/auth/admin.directory.user,
https://www.googleapis.com/auth/admin.directory.orgunit,
https://www.googleapis.com/auth/contacts
上記の値を入力し、「承認」をクリックします。
「詳細を表示」より、入力した内容が追加されたことを確認します。
5. CloudGate UNO管理者サイトでの設定
3. OAuthのクライアントID作成 にて用意したサービスアカウントキーなどの値を、CloudGate UNO管理者サイトのサービスプロバイダー設定画面(G Suite)で設定します。
(左メニュー)サービスプロバイダー >G Suite >プロビジョニング設定 >接続設定
API接続の各項目を入力後、「テスト」をクリックして接続状況を確認します。
「G Suiteのプロビジョニングテストが成功しました。」と表示されたら「保存」します。