SHOHS Cloud ConsoleでOAuth2.0認証用のIDを取得する方法

最終更新:

SHOHS Cloud Consoleでプロジェクトを作成し、使うAPIを有効化してOAuth同意画面とスコープを設定したうえで、「認証情報」から認証情報を作成すると、Client IDとClient Secretが発行されます。Client Secretは作成時に一度しか表示されません。

このページの内容SHOHS Cloud ConsoleでOAuth2.0認証用のIDを取得する方法取得の手順注意点取得したあとの流れよくある質問関連記事

SHOHS Cloud ConsoleでOAuth2.0認証用のIDを取得する方法

この記事では、SHOHS Cloud ConsoleでOAuth 2.0の認証情報(Client IDとClient Secret)を取得する手順を説明します。自分のWebアプリやサービスに「SHOHSでログイン」の機能を組み込むには、この認証情報が必要です。取得は、プロジェクトの作成から順に進めます。

取得の手順

  1. SHOHS Cloud Consoleを開き、SHOHSアカウントでログインします。
  2. プロジェクトを作成します。Cloud Consoleでは、APIやOAuthクライアントをプロジェクト単位で管理します。
  3. 使うAPI(例:Runtera API)を「ライブラリ」から有効化します。
  4. 「OAuth 同意画面」でアプリ名とサポートメールを設定し、「データアクセス」で使うスコープを追加します。
  5. 「認証情報」から「認証情報を作成」を選び、名前とRedirect URIを登録します。Redirect URIには、HTTPSのURLを登録してください。
  6. 公開範囲(ユーザーの種類)を「内部」または「外部」で設定します。どちらを選ぶかは、関連記事「SHOHS Cloud ConsoleのOAuth同意画面のユーザーの種類とは」をご覧ください。
  7. 発行されたClient IDとClient Secretを、安全な場所に保存します。

注意点

  • Client Secretは、作成時に一度しか表示されません。表示されたその場で、必ず安全な場所に保存してください。
  • Client Secretは、パスワードと同じように他人に知られないよう管理してください。公開しているソースコードやWebページに含めないでください。
  • 認可リクエストでは、登録したRedirect URIと同じURLを使ってください。

取得したあとの流れ

認証情報を取得したら、Authorization Code Flowでユーザーをログインへ導き、受け取った認可コードをトークンエンドポイントに渡してアクセストークンを取得します。アクセストークンを使うと、UserInfoエンドポイントでユーザーのプロフィール情報を取得できます。エンドポイントの仕様やコード例は、SHOHS OAuth 2.0 開発者ドキュメントをご覧ください。

よくある質問

スコープとは何ですか?

スコープは、認可リクエストで要求する権限の範囲です。ユーザーの識別情報へのアクセス(openid)、プロフィール情報(profile)、メールアドレス(email)、表示名(name)などがあり、「データアクセス」で使うスコープをあらかじめ追加しておきます。

Client Secretはどこで確認できますか?

Client Secretが表示されるのは、認証情報を作成したときに限られます。作成時に必ず控えを保存してください。控えを失くした場合は、Cloud Consoleから該当クライアントを削除し、新しいクライアントとして再発行してください。

「内部」と「外部」はどちらを選べばいいですか?

自分の組織のメンバーだけが使うアプリでは「内部」、SHOHSアカウントを持つ人なら誰でも使えるアプリでは「外部」を選びます。詳しくは関連記事をご覧ください。

関連記事

この情報は役に立ちましたか?