【G Suite】OAuth設定（CloudGate UNO）
このガイドではCloudGate UNOとサービス連携するための前準備である、G Suite側でのOAuth（オー・オース）設定について説明しています。
（CloudGate SSO/LightのOAuth設定につきましてはこちら）
ご不明点ございましたらCloudGateサポートまでお問合せください。
トライアル申込み・トライアル中のお客様は、弊社営業部までご連絡をお願い致します。
|
|
1. はじめに
1-1. 目的と内容
CloudGateはG Suiteのアカウントやグループに対して作成・更新・削除（停止）といった処理を行うことができます。
これらの処理を行うためには、お客様のG Suite環境からGoogleが提供するAPIの設定が必要であり、その際に必要な作業をこのガイドで解説します。
なお、本作業はすべてG Suiteの特権管理者権限を持つアカウント（以下、G Suite特権管理者）で行う必要があります。
1-2. 注意点
このガイドに記載されている作業を行う際に利用する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特権管理者でログインします。
「利用規約の更新」が表示される場合は、以下を選択して「同意する」をクリックします。
- 新機能のお知らせ、パフォーマンスに関するアドバイス、フィードバック調査、特典に関する最新情報をメールで受け取ります。：「はい」または「いいえ」を選択（必須項目）
- すべてのサービスと関連APIについて、適用される利用規約を遵守して利用することに同意します。：「はい」を選択（必須項目）
画面右上の「プロジェクト作成」をクリックします。
「作成」ボタンが表示されるのでクリックします。
新しいプロジェクトを作成する画面が表示されるので、プロジェクト名に「CloudGate」と入力して「作成」ボタンをクリックします。
※プロジェクトの作成が完了するまで少し時間がかかります。
2-3. APIを有効にする
プロジェクトの作成が完了したら、プロジェクト「CloudGate」を選択した状態で、画面上部の「三本線のアイコン」をクリックします。
※プロジェクト「CloudGate」が選択されていない場合：
プロジェクト作成完了後に表示される画面で、左上のプルダウンから所属する組織を選択します。プロジェクト一覧から「CloudGate」をクリックします。
表示されるスライドメニューの「APIとサービス」にマウスカーソルを合わせ、「ライブラリ」をクリックします。
※プロジェクトを選択していない場合、「このページを表示するには、プロジェクトを選択してください。」と表示されるので「選択」ボタンをクリックして、作成したプロジェクト「CloudGate」を選択します。
検索窓に以下の2つのAPIを1つずつ入力して検索し、APIを有効化します。
- Admin SDK
- Contacts API
それぞれの検索結果画面にて対象のAPIをクリックして「有効にする」ボタンをクリックします。
左メニューの「ライブラリ」をクリックすると、API一覧画面に戻ることができます。
左メニュー「ダッシュボード」より、画面下部の一覧表に、有効にしたAPIがリスト表示されていることを確認してください。
3. OAuthのクライアントIDを作成する
3-1. OAuthのクライアントID作成
2つのAPIの有効化が完了後、左のメニューより「認証情報」を選択します。
「認証情報を作成」ボタンが表示されるのでクリックします。
表示されるメニューより「サービスアカウントキー」を選択します。
「サービスアカウントキーの作成」画面に遷移後、以下を実施し「作成」ボタンをクリックします。
- サービスアカウントのプルダウン：「新しいサービスアカウント」を選択
- サービスアカウント名：「CloudGate」と入力
- キーのタイプ：「P12」を選択
「サービスアカウント名」の横に「役割」の項目が表示されている場合は、「役割を選択」プルダウンの「Project」から「オーナー」を選択して設定します。
サービスアカウントキーの作成が完了することで「CloudGate-**************.p12」という名称のプライベートキーがダウンロードされます。
※ダウンロード開始まで少し時間がかかります。
※この.p12ファイルは、後ほどCloudGate UNO開通のためにご提出いただく必要があり、重要なファイルとなりますので、大切に保管してください。
※.p12ファイルではなく、.txtファイルがダウンロードされた場合はこちらの対処策をお試しください。
下記の画面の「閉じる」をクリックし、次に進みます。
画面右側の「サービスアカウントの管理」をクリックし、作成したサービスアカウント表の右端のメニューから「編集」を選択します。
メニューが表示されていない場合は、画面右上の「情報パネルを非表示」をクリックすることでメニューを選択できるようになります。
「サービスアカウントの詳細」画面で「SHOW DOMAIN-WIDE DELEGATION」をクリックすると「G Suiteのドメイン全体の委任を有効にする」の項目が表示されます。
「G Suiteのドメイン全体の委任を有効にする」チェックし、「同意画面のサービス名」入力項目に「CloudGate」と入力し、そのまま「保存」をクリックします。
画面上部の「三本線のアイコン」をクリックして、スライドメニューより「API とサービス」にマウスカーソルを合わせ「認証情報」をクリックします。
表示された画面で作成した「サービスアカウントの名前のリンク」をクリックします。
作成されたサービスアカウントの情報が画面上に表示されます。
画面上で確認できる「クライアントID」と「サービスアカウント（メールアドレス）」の値をテキストエディタなどにコピー＆ペーストし控えます。
※「クライアントID」と「サービスアカウント（メールアドレス）」の値は「4-2. API アクセスの有効化」の作業で必要になります。尚、「サービスアカウント」の1行目に表示されている「CloudGate」という文字はコピー不要です。
画面上部の「三本線のアイコン」をクリックして表示されるスライドメニューより「IAMと管理」にマウスカーソルを合わせて「IAM」をクリックします。
表示された画面で「プロジェクト『CloudGate』の権限」で作成した「CloudGate」プロジェクトの「役割」が、「オーナー」もしくは「編集者」であることを確認します。
「役割」の設定を確認できたら、Google Cloud Platform での作業は完了です。画面を閉じて「4. API アクセスの有効化」の手順に進みます。
※「オーナー」または「編集者」以外の場合は、「役割」のプルダウンを選択して「Project」項目にマウスカーソルを合わせ「オーナー」か「編集者」に変更します。
※作成した「CloudGate」プロジェクトが一覧にない場合は、以下手順で確認します。
（1）画面上部の「追加」をクリックします。
（2）「メンバーの追加」画面で、「メンバー」欄には先ほどサービスアカウント情報の確認画面でコピーした「サービスアカウント（メールアドレス）」の値を入力します。
（3）「役割」のプルダウンより「Project」項目にマウスカーソルを合わせ「オーナー」を選択します。
追加したサービスアカウントがリストに反映されたことを確認し、Google Cloud Platform での作業は完了です。画面を閉じて次の手順に進みます。
4. APIアクセスの有効化
4-1. APIアクセスの有効化
Google管理コンソール（https://admin.google.com/）にG Suite特権管理者でログインします。
ダッシュボードから、「セキュリティ」をクリックします。
ダッシュボードの一覧にない場合は、画面下の「その他の設定」をクリックすることで、「セキュリティ」のリンクを見つけることができます。
セキュリティ設定の画面で、「APIリファレンス」をクリックすることで、サブメニューが表示されますので「API アクセスを有効にする」のチェックボックスにチェックを入れます。
4-2. APIスコープの承認
セキュリティ設定の画面内の「詳細設定」をクリックします。
詳細設定のサブメニューから、「認証」項目内の「API クライアント アクセスを管理する」のリンクをクリックします。
「APIクライアントアクセスを管理する」画面で、以下の値を入力します。
- クライアント名：「3-1. OAuthのクライアントID作成」の作業で確認したクライアントID を入力
- 1つ以上のAPI の範囲：以下の3つのURLをコピー＆ペーストして入力
https://www.google.com/m8/feeds,
https://www.googleapis.com/auth/admin.directory.group,
https://www.googleapis.com/auth/admin.directory.user
上記の値を入力し、「承認」をクリックします。
下記の画面のように入力した内容が追加されたことを確認します。
5. CloudGate UNO 必要情報の送信
CloudGate UNOの開通には下記のG Suite特権管理者と「3-1. OAuthのクライアントID作成」の作業後に取得できるファイル及び情報が必要になります。
・本OAuth設定を行ったG Suite特権管理者（メールアドレス）
・OAuthクライアントのプライベートキー（.p12 ファイル） ・OAuthクライアントのクライアントID ・OAuthクライアントのサービスアカウント（メールアドレス）
5-1. WebフォームからCloudGateトライアルお申し込みの場合
トライアルをお申し込みの場合はお申込みフォームより、このガイドにて作成した「OAuthクライアントのプライベートキー」のアップロード、「OAuthクライアントのサービスアカウント」を入力して送信します。
5-2. その他のお申込みの場合
お申込みに必要な情報と「OAuthクライアントのプライベートキー」を一緒に弊社まで提出します。
5-3. アカウントを変更する場合
CloudGate UNO管理者サイト上で変更できます。詳しくはこちらをご確認ください。
