この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

AuthConfiguration クラス

ユーザーが Salesforce ログイン情報ではなく認証プロバイダーログイン情報を使用して Salesforce にログインするための設定を定義するメソッドが含まれます。認証プロバイダーは、Google、Facebook、Twitter など、OpenID Connect プロトコルをサポートする任意の認証プロバイダーです。ユーザーは、Experience Cloud サイト (https://MyDomainName.my.site.com) または [私のドメイン] のログイン URL (https://MyDomainName.my.salesforce.com) のいずれかにログインします。

名前空間

Auth

例

��の例では、Auth.AuthConfiguration クラスのメソッドをコールする方法を示します。この例を実行するには、有効な URL の値と開発者名を指定する必要があります。

1String communityUrl = 'MyDomainName.my.site.com';
2String startUrl = '<Add URL>';
3Auth.AuthConfiguration authConfig = new Auth.AuthConfiguration(communityUrl,startUrl);
4List<AuthProvider> authPrvs = authConfig.getAuthProviders();
5String bColor = authConfig.getBackgroundColor();
6String fText = authConfig.getFooterText();
7
8String sso = Auth.AuthConfiguration.getAuthProviderSsoUrl(communityUrl, startUrl, 'developerName');

AuthConfiguration のコンストラクター

AuthConfiguration のコンストラクターは次のとおりです。

AuthConfiguration (networkId, startUrl) コンストラクターは API バージョン 56.0 以降では廃止されました。

メモ

AuthConfiguration(communityOrCustomUrl, startUrl)

Experience Cloud サイトまたは [私のドメイン] サブドメインの指定された URL と認証されたユーザーの開始 URL を使用して、AuthConfiguration クラスのインスタンスを作成します。

署名

public AuthConfiguration(String communityOrCustomUrl, String startUrl)

パラメーター

communityOrCustomUrl: 型: String; ドメインの URL。[私のドメイン] で作成された Salesforce サブドメイン (my.salesforce.com) または Experience Cloud サイトのサブドメイン (force.com) を使用できます。
startUrl: 型: String; ユーザーが Experience Cloud サイトまたは [私のドメイン] サブドメインに正常にログインすると表示されるページ。

AuthConfiguration(networkId, startUrl)

指定された Experience Cloud サイト ID と認証済みユーザ開始 URL を使用して、AuthConfiguration クラスのインスタンスを作成します。

署名

public AuthConfiguration(Id networkId, String startUrl)

パラメータ

networkId: 型: Id; Experience Cloud サイトの ID。
startUrl: 型: String; ユーザが Experience Cloud サイトに正常にログインすると表示されるページ。

AuthConfiguration のメソッド

AuthConfiguration のメソッドは次のとおりです。これらのメソッドを使用して、Salesforce コミュニティの認証を管理およびカスタマイズします。

getAllowInternalUserLoginEnabled()

Experience Cloud サイトで内部ユーザーが Experience Cloud サイトログインページを使用してログインできるかどうかを示します。有効にするには、システム管理者がエクスペリエンスワークスペースの [ログイン & 登録] ページで [内部ユーザーにエクスペリエンスへの直接ログインを許可] を設定します。デフォルトでは無効になっています。

署名

public Boolean getAllowInternalUserLoginEnabled()

戻り値

型: Boolean

使用方法

true の場合、内部ユーザーはサイトのログインページから内部ログイン情報を使用して Experience Cloud サイトにログインできます。Experience Cloud サイトから内部組織に移動する場合、再度ログインする必要はありません。

getAuthConfig()

AuthConfig sObject を返します。これは、Experience Cloud サイトまたは Salesforce �� [私のドメイン] サブドメインの認証オプションを表します。

署名

public AuthConfig getAuthConfig()

戻り値

型: AuthConfig

Experience Cloud サイトまたは Salesfofce の [私のドメイン] サブドメインの AuthConfig sObject。

getAuthConfigProviders()

Experience Cloud サイトまたは Salesfofce の [私のドメイン] サブドメイン用に設定された認証プロバイダーのリストを返します。

署名

public List<AuthConfigProviders> getAuthConfigProviders()

戻り値

型: List<AuthConfigProviders>

AuthProvider sObject の子である認証プロバイダー (AuthConfigProviders sObject) のリスト。

getAuthProviders()

Experience Cloud サイトまたは Salesfofce の [私のドメイン] サブドメイン用に設定された認証プロバイダーのリストを返します。

署名

public List<AuthProvider> getAuthProviders()

戻り値

型: List<AuthProvider>

Experience Cloud サイトまたは [私のドメイン] サブドメイン用の認証プロバイダー (AuthProvider sObject) のリスト。

getAuthProviderSsoDomainUrl(communityUrl, startUrl, developerName)

Experience Cloud サイトサブドメインのシングルサインオン URL を返します。

パフォーマンス向上のため、getAuthProviderSsoUrl ではなく、このメソッドを使用することをお勧めします。認証プロバイダーで [User Subdomain for Callback (コールバックのユーザーサブドメイン)] が有効になっている場合、シングルサインオン URL を変更すると、コールバック URL も Experience Cloud サイトサブドメインを使用するように変更されます。このメソッドに変える前に、サードパーティアプリケーションのコールバック URL を更新して、シングルサインオン中に無効なコールバック URL のエラーが発生しないようにしてください。

メモ

署名

public static String getAuthProviderSsoDomainUrl(String communityUrl, String startUrl, String developerName)

パラメーター

communityUrl: 型: String; Experience Cloud サイトサブドメインの URL。null の場合、または空の文字列として指定された場合は、組織の [私のドメイン] のシングルサインオン URL が取得されます。
startUrl: 型: String; ユーザーが Experience Cloud サイトサブドメインにログインすると表示されるページ。
developerName: 型: String; 認証プロバイダーの一意の名前。

戻り値

型: String

Experience Cloud サイトサブドメインのシングルサインオン初期化 URL。

getAuthProviderSsoUrl(communityUrl, startUrl, developerName)

Experience Cloud サイトまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン URL を返します。

署名

public static String getAuthProviderSsoUrl(String communityUrl, String startUrl, String developerName)

パラメーター

communityUrl: 型: String; Experience Cloud サイトまたは [私のドメイン] サブドメインの URL。null でなく、空の文字列として指定されていない場合、Experience Cloud サイトの URL が取得されます。null の場合、または空の文字列として指定された場合は、カスタムドメインの URL が取得されます。
startUrl: 型: String; ユーザーが Experience Cloud サイトまたは [私のドメイン] サブドメインにログインすると表示されるページ。
developerName: 型: String; 認証プロバイダーの一意の名前。

戻り値

型: String

Experience Cloud サイトまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン初期化 URL。

getBackgroundColor()

コミュニティのログインページの背景色を返します。

署名

public String getBackgroundColor()

戻り値

型: String

getCertificateLoginEnabled(domainUrl)

証明書ベースの認証が [私のドメイン] の URL で有効になっている場合、true を返します。

署名

public Boolean getCertificateLoginEnabled(String domainUrl)

パラメーター

domainUrl: 型: String; 証明書ベースの認証がチェックされる [私のドメイン] の URL。

戻り値

型: Boolean

getCertificateLoginUrl(domainUrl, startUrl)

組織で証明書ベースの認証が有効になっている場合、[私のドメイン] の URL の証明書ベースの認証エンドポイントを返します。

署名

public static String getCertificateLoginUrl(String domainUrl, String startUrl)

パラメーター

domainUrl: 型: String; 証明書ベースの認証エンドポイントがチェックされる [私のドメイン] の URL。
startUrl: 型: String; ユーザーが証明書ベースの認証を使用して [私のドメイン] にログインすると表示されるページ。

戻り値

型: String

[私のドメイン] の URL: mydomainURL:8443/services/certauth?startURL=startURLParam の証明書ベースの認証エンドポイント

getDefaultProfileForRegistration()

新しいコミュニティユーザーに割り当てられたプロファイル ID を返します。

署名

public String getDefaultProfileForRegistration()

戻り値

型: String

プロファイル ID。

getFooterText()

コミュニティのログインページの下部に表示されるテキストを返します。

署名

public String getFooterText()

戻り値

型: String

ログインページの下部に表示されるテキスト文字列 (「Log in with an existing account (既存のアカウントでログイン)」など)。

getForgotPasswordUrl()

システム管理者によって Experience Cloud サイトまたはポータルに指定された、標準またはカスタムの [パスワードを忘れた場合] ページの URL を返します。

署名

public String getForgotPasswordUrl()

戻り値

型: String

標準またはカスタムの [パスワードを忘れた場合] ページの URL。

getLogoUrl()

コミュニティのログインページの下部に表示されるアイコン画像の場所を返します。

署名

public String getLogoUrl()

戻り値

型: String

アイコン画像へのパス。

getRightFrameUrl()

Experience Cloud サイトログインページの右側に表示される右フレームのコンテンツの URL を返します。システム管理者が URL を指定します。

署名

public String getLoginRightFrameUrl()

戻り値

型: String

Experience Cloud サイトログインページの右フレームのコンテンツの URL。Salesforce により、ログインページの右側に、URL で指定されたコンテンツを表示するインラインフレーム (iframe) が作成されます。

getSamlProviders()

Experience Cloud サイトまたは Salesfofce の [私のドメイン] サブドメインで使用できる SAML ベースの認証プロバイダーのリストを返します。

署名

public List<SamlSsoConfig> getSamlProviders()

戻り値

型: List<SamlSsoConfig>

SAML ベースの認証プロバイダー (SamlSsoConfig sObject) のリスト。

getSamlSsoUrl(communityUrl, startURL, samlId)

Experience Cloud サイトまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン URL を返します。

署名

public static String getSamlSsoUrl(String communityUrl, String startURL, String samlId)

パラメーター

communityUrl: 型: String; Experience Cloud サイトまたは [私のドメイン] サブドメインの URL。null でなく、空の文字列として指定されていない場合、Experience Cloud サイトの URL が取得されます。null の場合、または空の文字列として指定された場合は、[私のドメイン] サブドメインの URL が取得されます。
startUrl: 型: String; ユーザーが Experience Cloud サイトまたは [私のドメイン] サブドメインに正常にログインすると表示されるページ。
samlId: 型: String; Experience Cloud サイトまたは [私のドメイン] サブドメインの SamlSsoConfig 標準オブジェクトの一意の識別子。

戻り値

型: String

Experience Cloud サイトまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン初期化 URL。

getSelfRegistrationEnabled()

現在のコミュニティで、新規ユーザーが登録フォームに入力することで自分のアカウントを作成できるかどうかを示します。

署名

public Boolean getSelfRegistrationEnabled()

戻り値

型: Boolean

getSelfRegistrationUrl()

コミュニティで新規ユーザーがアカウントにサインアップするためのセルフ登録ページの場所を返します。

署名

public String getSelfRegistrationUrl()

戻り値

型: String

セルフ登録ページの場所。

getStartUrl()

Experience Cloud サイトまたは Salesforce の [私のドメイン] サブドメインの開始ページを返します。この URL はユーザーがログインしたときに最初に表示されるページです。

署名

public String getStartUrl()

戻り値

型: String

Experience Cloud サイトまたは [私のドメイン] サブドメインの開始ページの場所。

getUsernamePasswordEnabled()

現在のコミュニティがユーザー名とパスワードの入力を要求するログインフォームを表示するように設定されているかどうかを示します。コミュニティが、認証されていないユーザーまたはサードパーティ認証プロバイダーを使用してログインするユーザーを対象としたものである場合、ユーザー名とパスワードを要求しないように設定することができます。

署名

public Boolean getUsernamePasswordEnabled()

戻り値

型: Boolean

isCommunityUsingSiteAsContainer()

Experience Cloud サイトが Site.com ページを使用する場合は true、使用しない場合は false を返します。

署名

public Boolean isCommunityUsingSiteAsContainer()

戻り値

型: Boolean

Apex 開発者ガイド

AuthConfiguration クラス

名前空間

例

AuthConfiguration のコンストラクター

AuthConfiguration(communityOrCustomUrl, startUrl)

署名

パラメーター

AuthConfiguration(networkId, startUrl)

署名

パラメータ

AuthConfiguration のメソッド

getAllowInternalUserLoginEnabled()

署名

戻り値

使用方法

getAuthConfig()

署名

戻り値

getAuthConfigProviders()

署名

戻り値

getAuthProviders()

署名

戻り値

getAuthProviderSsoDomainUrl(communityUrl, startUrl, developerName)

署名

パラメーター

戻り値

getAuthProviderSsoUrl(communityUrl, startUrl, developerName)

署名

パラメーター

戻り値

getBackgroundColor()

署名

戻り値

getCertificateLoginEnabled(domainUrl)

署名

パラメーター

戻り値

getCertificateLoginUrl(domainUrl, startUrl)

署名

パラメーター

戻り値

getDefaultProfileForRegistration()

署名

戻り値

getFooterText()

署名

戻り値

getForgotPasswordUrl()

署名

戻り値

getLogoUrl()

署名

戻り値

getRightFrameUrl()

署名

戻り値

getSamlProviders()

署名

戻り値

getSamlSsoUrl(communityUrl, startURL, samlId)

署名

パラメーター

戻り値

getSelfRegistrationEnabled()

署名

戻り値

getSelfRegistrationUrl()

署名

戻り値

getStartUrl()

署名

戻り値

getUsernamePasswordEnabled()

署名

戻り値

isCommunityUsingSiteAsContainer()

署名