1. 外部プロバイダー

外部認証プロバイダー

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

ユーザーは、外部認証プロバイダーを介したシングル サインオン (SSO) を使用して、Sitecore Content Hub™ にログインできます。

次の外部認証プロバイダーを使用できます。

外部認証プロバイダーは、ExternalAuthenticationProviders プロパティで設定できます。

"ExternalAuthenticationProviders": {
"global_email_claim_type": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress",
"global_username_claim_type": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
"google": [],
"microsoft": [],
"saml": [],
"sitecore": [],
"ws_federation": [],
"yandex": []
}
注意

global_email_claim_type と global_username_claim_type プロパティでは、すべてのプロバイダーのメール アドレスとユーザー名を解決するようにクレーム タイプを設定します。特定のプロバイダーに対するこれらのプロパティをオーバーライドすることができます。

基本のプロバイダー設定

次のコードは、すべてのプロバイダーの基本設定は示しています。

{
"authentication_mode": "Passive",
"email_claim_type": "<ClaimTypeOverride>",
"external_user_creation_url": "https://www.registerme.com",
"is_enabled": true,
"messages": {
"signIn": "translationKey",
"signInDescription": "translationKey",
"signInTitle": "translationKey"
},
"provider_name": "<name>",
"username_claim_type": "<ClaimTypeOverride>"
}

プロバイダー認証モード

プロバイダー認証モードは Active または Passive に設定できます。同時にアクティブにできるプロバイダーは 1 つだけです。

認証モードを Active に設定すると、ユーザーが認証されていない場合に、システムは自動的にプロバイダーのログイン ページにリダイレクトします。それ以外の場合、ユーザーはログイン ページのプロバイダー ボタンをクリックする必要があります。

ヒント

プロバイダーが Active に設定されている場合、ログイン ページを参照することができなくなります。この動作をオーバーライドするには、/en-US/Account?forcePassive=true に移動します。既定値は Passive です。

プロバイダーの主なプロパティ

プロパティ説明既定値
AutoCreateUserstrue に設定されている場合、新しいユーザー アカウントが自動的に作成されます。false に設定されている場合、既定でエラー ページにリダイレクトされます。この動作をオーバーライドして外部ユーザー ページにリダイレクトするには、プロバイダー設定の external_user_creation_url パラメーター (既定値は null) を使用します。false
is_enabledプロバイダーを有効または無効にします（それだけ有効なプロバイダーが表示され、認証パイプラインに登録できます。）false
messages外部プロバイダーを設定すると、新しい [プロバイダー名でサインイン] ボタンが既定でログイン ページに表示されます。messages で次をカスタマイズできます。
  • signIn: ボタン メッセージ
  • signInTitle: ボタンにカーソルを合わせたときのメッセージ
  • signInDescription: ボタンの横にある小さな説明。値は、既存の変換エンティティ キーの名前である必要があります (例: MyOwnCustomKey)。
    		• empty
    email_claim_type と username_claim_type (それぞれ使用)特定のプロバイダー向けに global_email_claim_type と global_username_claim_type をオーバーライドします。null
    provider_name外部プロバイダーの名前:
  • 必須で一意
  • 最大 50 文字の英数字である必要がある
  • 大文字と小文字が区別されない
    • 警告

    プロバイダー名は、同じタイプの複数の外部認証プロバイダーをサポートするために、一意の REST API コールバックの設定に使用されます。通常、このコールバックは外部認証プロバイダー自体で設定する必要があります。プロバイダー名を変更する場合は、外部認証プロバイダーにも変更を加える必要があります。 既定で、コールバック URL は /signin-{provider-name} の形式です。

    プロバイダー固有のプロパティ

    次の表で、各外部プロバイダーに固有のプロパティについて説明します。

    注意

    各プロバイダーの設定例については、「設定例」を参照してください。

    プロバイダー特定のプロパティ説明必須/オプション (既定)
    Googleclient_idOAuth クライアント ID。必須
    client_secretOAuth クライアント シークレット。必須
    Microsoftclient_idOAuth クライアント ID。必須
    client_secretOAuth クライアント シークレット。必須
    authorization_endpoint承認エンドポイントをオーバーライドします。オプション
    token_endpointトークン エンドポイントをオーバーライドします。オプション
    user_information_endpointユーザー情報エンドポイントをオーバーライドします。オプション
    SAMLcertificateID プロバイダーがメッセージに署名するために使用する証明書へのパス。証明書は、SAML プロバイダーが署名済みの認証リクエストを予期している場合にのみ必要です。オプション (既定: null)
    idp_entity_idID プロバイダーのエンティティ ID。必須
    metadata_locationSAML サービス プロバイダーの XML メタデータを指す URL。/AuthServices-{providerNameInTheAuthenticationSettings} エンドポイントを使用して、SP_metadata.xml ファイルを自動的に生成できます。必須
    password証明書へのアクセスに使用されるパスワード。オプション
    sp_entity_idサービス プロバイダーのエンティティ ID。必須
    module_pathSAML エンドポイントのアプリケーション ルート相対パス。既定で /AuthServices- の後に小文字のプロバイダー名が続きます。大文字と小文字を区別し、一意である必要があります。オプション (既定: null)
    bindingID プロバイダーに認証要求を送信するときに使用されるバインディング。受け入れられる値は次のとおりです。
  • HttpRedirect
  • HttpPost
  • Artifact
    		• オプション (既定: HttpRedirect)
    authn_request_protocol_binding応答時に使用する ID プロバイダーを要求するバインディング タイプ。認証要求の ProtocolBinding 属性に含まれています。受け入れられる値は次のとおりです。
  • HttpPost
  • Artifact
    		• オプション (既定: null)
    Sitecoreidentity_server_urlSitecoreは、認証用に IdentityServer を使用します。URL は、ユーザーがサインイン プロセス中にリダイレクトされる IdentityServer インスタンスを指す必要があります。必須
    client_idIdentityServer インスタンスによって認識される OAuth クライアント ID。必須
    client_secretIdentityServer インスタンスによって認識される OAuth クライアント シークレット。必須
    WsFederationmetadata_addressWsFederation サービス プロバイダーの XML メタデータを公開する URL。必須
    wtrealm要求している領域の URL。必須
    Yandexclient_idOAuth クライアント ID。必須
    client_secretOAuth クライアント シークレット。必須
    警告

    URL を設定して、ID プロバイダー (IdP) メタデータを IdP メタデータ エンドポイントに提供することをお勧めします。この XML ファイルを Content Hub でホストしないでください。

    SAML について

    SAML プロバイダーが署名済みの認証リクエストを予期しているかどうかを判断するには、メタデータ ファイルを検査します。メタデータ ファイルの AuthnRequestsSigned 属性が「true」に設定されている場合、署名済みのリクエストが予期され、証明書ファイルを提供する必要があります。それ以外の場合、署名済みのリクエストは要求されず、証明書が提供されません。

    注意

    ほとんどの SAML プロバイダーは、コールバック URL (大文字と小文字を区別します) を必要とします。ユーザーが認証するとき、ユーザーはこの URL に SAML トークンを投稿します。コールバック URLは module_path によって異なります。このコールバック URL は、他の外部認証タイプからのコールバック URL と一致しません。

    この記事を改善するための提案がある場合は、 お知らせください!