メインコンテンツまでスキップ

OAuth SP

OAuth SPではサイトに登録されたOAuth SP設定の一覧の確認・追加・更新ができます。

OAuth SP一覧

確認方法

[外部システム連携] -> [OAuth SP]をクリックします。
Image from Gyazo

項目説明

Image from Gyazo

項目説明
有効OAuth SPの有効状態を確認できます。
Image (fetched from Gyazo):有効
Image (fetched from Gyazo):無効
OAuth SPの名称OAuth SPの名前を表示します。
タイプOAuth SPのタイプを表示します。
更新日時最終更新日時を表示します。

OAuth SPの編集

編集方法

[外部システム連携] -> [OAuth SP]をクリックします。
Image from Gyazo

OAuth SP一覧ページから編集をしたいOAuth SP設定の[OAuth SPの名称]をクリックします。

Image from Gyazo

項目説明

OAuth SP編集

Image from Gyazo

項目説明
OAuth SPの名称OAuth SPの名前を入力します。
有効にチェックを入れると、現在の設定が有効になり、チェックを外すと、無効になります。 テスト機能は、OAuth SPの設定が有効になっていない場合でも機能します。
ターゲットドメインターゲットとなるドメインを選択します。
管理画面:管理画面のURLがターゲットになります。
API:APIドメインがターゲットになります。
タイプOAuth SPでのログインを利用するサービスを選択します。
Customを選択した場合は追加の設定項目が表示され、サービスプロバイダーが機能するための設定を直接入力することができます。
ログインURLユーザーがログインするために使用するURLを表示します。
クライアントID (Client ID)アイデンティティプロバイダーで新しいOAuthアプリケーションを作成するときに取得する識別子、クライアントIDを入力します。 クライアントIDは大切に保管し、複数のサービスプロバイダーで同じクライアントIDを使用しないでください。
クライアントの秘密鍵 (Client Secret)アイデンティティプロバイダーで新しいOAuthアプリケーションを作成するときに取得する秘密鍵を入力します。秘密鍵は大切に保管してください。
(API用) Grantトークン生成セキュリティが動的アクセストークンに設定されたAPIの一覧が表示されます。SSOでGrantトークンを生成する場合、利用するAPIにチェックをいれてください。表示されたURLでSSOを実施するとリターンURLへの遷移時にgrant_tokenのパラメータがURLに追加されますので、これを利用してアクセストークンを発行してください。
プライベート URL を使用[戻りURLのドメインにプライベートIPを許可する]にチェックを入れると、リターンURLにhttp://IPアドレスや、http://localhost:3000/ などのURLが設定できるようになります。
セキュリティ的に推奨されない設定なので、開発時のみご利用ください。
リターンURL(成功)ユーザーがログインに成功した際にリダイレクトするURLを設定します。
入力がない場合は、TOPページに戻ります。
リターンURL(エラー)ユーザーがログインに失敗した際にリダイレクトするURLを設定します。
入力がない場合は、TOPページに戻ります。
自動ユーザー登録ユーザーの自動登録を許可するかどうかを設定します。チェックが入っていない場合、未登録ユーザーがSSOを利用してログインしようとすると、リターンURL(エラー)にリダイレクトされます。
Emailを利用せずメンバー拡張項目にIDを格納してリンクする有効にするにチェックを入れると、アイデンティティプロバイダーから取得されるOpenIDを利用してユーザーを認識するようになります。
OpenIDはメンバーの拡張項目(テキスト)に保存されます。
ユーザーがログインできなくなる可能性があるため、後でこれを変更しないでください。
ユーザーアクセストークンを保存チェックを入れると、ユーザーのアクセストークンがデータベースに保存され、後で使用できるようになります。 アイデンティティプロバイダーが提供する場合、リフレッシュトークンも保存されます。 トークンは、ユーザーがログインするたびに更新されます。

各ボタン

Image from Gyazo

項目説明
更新する入力した内容を反映します。
テストSSO OAuth SPのテストを実行し、どのフィールドに必要なデータが含まれているかを確認できます。
保存されていないデータはテストできないため、テストを実行する前に、まず設定データを更新する必要があります。
削除するOAuth SPの設定を削除します。

Customを利用した場合の追加設定項目

タイプの設定でCustomを選択すると、下記の項目が追加で表示され、サービスプロバイダーが機能するための設定を直接入力できます。設定の多くは、アイデンティティプロバイダーのドキュメントを確認し、取得する必要があります。

SSO OAuth SP編集

項目説明
ログインURL(Use Path Parameter for spid.)IdPによってはクエリパラメータでURLを返すことを許可していない場合があります。その場合は、このチェックボックスをオンにして、代わりにパスパラメータを使用できます。
承認URLユーザーがサインインするためにリダイレクトされるURLです。 アイデンティティプロバイダーから取得します。
トークンURLコードに対してアクセストークンを取得するために使用されるURLです。 アイデンティティプロバイダーから取得します。
リソースURLアクセストークンを使用してログイン資格情報を取得するために使用されるURLです。 アイデンティティプロバイダーから取得します。
必要なデータのスコープアイデンティティプロバイダーにリクエストするデータのスコープです。複数のスコープを設定することができます。
スコープセパレータ複数のスコープをリクエストする場合は、スコープを結合するために使用されるセパレータを指定する必要があります。 この情報は、アイデンティティプロバイダーのドキュメントに記載されています。デフォルトではカンマ,が使用されますが、使用しているアイデンティティプロバイダーに応じて、リストから選択できます。
基本認証ヘッダーにクライアントの秘密鍵を送信チェックを入れると、クライアント秘密鍵は基本認証ヘッダーで送られます。チェックを外している場合は、URLパラメータで送信されます。 この仕様は、アイデンティティプロバイダーのドキュメントに記載されています。 不明の場合はチェックを外してください。
承認プロンプトのパラメータを送信しないチェック入れると、承認プロンプトクエリがリクエストで送信されなくなります。 この仕様は、アイデンティティプロバイダーのドキュメントに記載されています。不明の場合はチェックを外してください。

トークンとリソースリクエストの設定

[設定する]をクリックします。

Image from Gyazo

Image from Gyazo

項目説明
リクエストタイプアイデンティティプロバイダーに対して行われるリクエストのタイプを設定します。 デフォルト値はGETになります。 アイデンティティプロバイダーがPOSTリクエストを要求している場合は、こちらで変更ください。
ヘッダにアクセストークンを送信しないチェックした場合は、アクセストークンを送信するためのパラメータを1つ以上指定する必要があります。
追加パラメータを送信リクエストで送信されるパラメータのキーを設定します。 一部のアイデンティティプロバイダーでは、リクエストで追加のパラメーターを送信する必要がある場合があります
IDPからのリソースキーアイデンティティプロバイダーからのレスポンスをマップするためのキーと、t_member_headerテーブルのうち、データをマッピングする列を設定します。

関連ドキュメント


サポート

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。