クライアントを管理する

クライアントを管理するこのページでは、OIDC/OAuth2/SAML全プロトコル共通の操作について記載しています。【基本的な操作】クライアントを新規登録するクライアントを編集する変数を設定するクライアントを削除するクライアントの詳細を表示する【応用的な操作】クライアントの証明書を更新するSSO/IdP機能の利用状況を確認するクライアントごとのログイン履歴を管理するSSO/IdP機能のログイン画面にテンプレートを適用する【基本的な操作】クライアントを新規登録する設定＞SSO/IdPに遷移します「新規登録」ボタンをクリックします「プロトコル」のSAML/OIDC/OAuth2を選択します登録後の編集画面では、「プロトコル」のSAML/OIDC/OAuth2を変更することはできませんので、ご注意ください。選択したプロトコルに応じた各設定値を入力し、登録ボタンをクリックします各プロトコルでの具体的な登録内容、利用方法についてはOIDC：「SMPをOpenIDProviderとして利用する」OAuth2.0：「SMPをOAuth2.0AuthorizationServerとして利用する」SAML：「SMPをSAMLIdentityProvider(IdP)として利用する」をご確認ください。クライアントを編集するクライアントを登録します設定＞SSO/IdPに遷移します変更内容を入力し、登録ボタンをクリックします登録画面と同様、各プロトコルでの具体的な編集内容、利用方法についてはOIDC：「SMPをOpenIDProviderとして利用する」OAuth2.0：「SMPをOAuth2.0AuthorizationServerとして利用する」SAML：「SMPをSAMLIdentityProvider(IdP)として利用する」をご確認ください。変数を設定するSSO/IdP機能の変数とはSSO/IdP機能では変数形式で、リード/管理者の情報を連携先に渡すことができます。例として1.プロトコル:OIDCを選択2.「好みのユーザー名(profile:preferred_username)」に、「[%company_name%][%division%][%name1%]様」を設定3.リードID:3のリードでSSO/IdP機能を利用したログインを実施した場合ログインしたリードID:3の会社名、部署名、氏名が参照され、「株式会社マニュアル向けデータ営業部仮申込者様」という名前が連携先に渡されます。設定方法クライアント登録/編集画面に遷移します「利用したいリード項目を選ぶと変数が表示されます」のプルダウンからリード項目を選択します右のテキストボックスに表示された値をコピー＆ペーストします変数にはお客様が追加された項目や、「管理者側のみ表示」となっている項目も、連携先に渡すデータとして利用可能です。項目を削除した場合には、変数として利用できなくなりますので、ご注意ください。リード項目の設定方法については、リード項目を設定するのマニュアルをご確認ください。変数の注意点OAuth2では利用できません変数はOIDC標準クレーム群、NameIDの値、Attributeの値でのみ利用できますOIDCかつ管理者の場合も編集できません。画面上で編集した内容は反映されず、決まった値が入りますので、詳細はOIDC：「SMPをOpenIDProviderとして利用する」をご確認くださいSAMLかつ管理者の場合、以下のもののみが利用できます項目名変数E-mail1[%email%]姓[%name1%]名[%name2%]ミドルネーム[%name3%]メモ[%memo%]会社名[%company_name%]ユーザーID[%user_master_id%]外部IDプロバイダ用ユーザ識別子[%saml_login_name_id%](管理者シングルサインオン機能が有効な時のみ)国名（[%country_master_id%]）、都道府県（[%prefecture_master_id%]）、資料送付・各種情報案内を希望しますか（[%permission_type_master_id%]）の項目は文字列ではなくidを返却します。idと文言の関連付けについては、SMPの国名一覧、都道府県IDと都道府県名の対応表にあるidをご確認ください。リードのラジオボタン型追加項目([%VisitorData.attributeXX%])、チェックボックス型追加項目([%VisitorData.attributeXX%])、プルダウン型追加項目([%VisitorData.attributeXX%])については、文字列ではなくidを返却します。文字列とidの関連付けについては、連携先でidと値を再度関連付けるなどの運用をお願いします。クライアントを削除するクライアントを登録します設定＞SSO/IdPに遷移します「削除」ボタンをクリックし、削除画面に遷移します削除画面の下部にある「削除」ボタンをクリックしますクライアントを削除した場合、対象のクライアントへのSSO/IdP機能を利用したログインは、無効になりますのでご注意ください。クライアントの詳細を表示するクライアントを登録します設定＞SSO/IdPに遷移します「詳細」ボタンをクリックし、詳細画面に遷移します詳細画面では、連携先アプリでの設定時に必要なものを、プロトコル毎に表示しています。OIDC/OAuth2のクライアントではクライアントID・クライアントシークレットが表示され、SAMLのクライアントではIdPメタデータのダウンロードボタンが表示されます。【応用的な操作】クライアントの証明書を更新するクライアントの登録時、認証/認可に用いる鍵/証明書を、シャノンが自動的に作成しています。この証明書の有効期限は、登録から2年後になります。有効期限が30日以内に切れる、もしくは既に有効期限が切れてしまったクライアントがある場合、SSO/IdP機能のクライアント一覧画面に、証明書の更新が必要なクライアントが通知されます。注意この操作は基本的に、「証明書の有効期限」が近づいている、または「証明書の有効期限」が切れてしまった場合に、実行してください。設定＞SSO/IdPに遷移します「詳細」ボタンをクリックし、詳細画面に遷移します「証明書を更新」ボタンをクリックします確認画面が表示されるので、「更新」をクリックします注意クライアントの証明書を更新すると、更新した証明書を連携先に登録するまで、SSOでログインできない可能性があります。そのため証明書更新後には連携先サービスへの再設定、動作の確認を行うことを推奨します。SSO/IdP機能の利用状況を確認するSSO/IdP機能を有効にすると、利用状況でSSO/IdP機能を確認できるようになります。機能の詳細については、利用状況のマニュアルをご確認ください。クライアントごとのログイン履歴を管理するSSO/IdP機能を有効にすると、ログイン履歴で利用したクライアントを確認できるようになります。設定＞ログイン履歴に遷移します下記の画像にある、歯車マークをクリックし、表示項目設定に遷移します選択可能列から「IdPクライアント名を選択」し、選択済み列へ移行し登録しますこの手順でSSO/IdP機能を利用したログインの履歴を確認できるようになります。利用したリードを確認する際などにご利用ください。またログイン履歴機能自体の詳細については、ログイン履歴のマニュアルをご確認ください。SSO/IdP機能のログイン画面にテンプレートを適用するWEB＞システムで利用するテンプレートを変更することで、SSO/IdP機能を利用したログイン画面の表示を変更できます。対象となるパス、ファイルは以下のものとなります。/public/sso/login＞/system/sso/login.html/public/sso/login/admin＞/system/sso/login_admin.html/public/sso/login/visitor＞/system/sso/login_visitor.htmlお客様の企業のロゴを、リード向けのログイン画面に表示したい場合などにご活用ください。詳細は「テンプレート変更を利用する」ページをご確認ください。