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

Newer Version Available

This content describes an older version of this product. View Latest

AuthConfiguration クラス

ユーザが Facebook© などの認証プロバイダを使用してコミュニティにログインするための設定を行うメソッドが含まれます。

名前空間

Auth

AuthConfiguration コンストラクタ

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

AuthConfiguration(String, String)

指定されたコミュニティ URL と認証されたユーザの開始 URL を使用して、AuthConfiguration クラスの新しいインスタンスを作成します。

署名

public AuthConfiguration(String cURL, String startURL)

パラメータ

cURL
型: String
コミュニティの URL。
startURL
型: String
ユーザがコミュニティに正常にログインすると表示されるページ。

AuthConfiguration メソッド

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

getAuthProviders()

コミュニティで使用可能な認証プロバイダのリストを返します。

署名

public List<AuthProvider> getAuthProviders()

戻り値

型: List<AuthProvider>

認証プロバイダ (AuthProvider sObject) のリスト。

1Auth.AuthConfiguration authConfig = new Auth.AuthConfiguration(communityUrl,startUrl);
2authConfig.getAuthProviders();
3authConfig.getAuthProviderSsoUrl(communityUrl, startUrl, developerName);
4authConfig.getBackgroundColor();
5authConfig.getFooterText();

getBackgroundColor()

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

署名

public String getBackgroundColor()

戻り値

型: String

getAuthProviderSsoUrl(String, String, String)

コミュニティのシングルサインオン URL を返します。

署名

public String getAuthProviderSsoUrl(String cUrl, String startUrl, String developerName)

パラメータ

cUrl
型: String
コミュニティの URL。
startUrl
型: String
ユーザがコミュニティに正常にログインすると表示されるページ。
developerName
型: String
コミュニティの一意の名前。

戻り値

型: String

コミュニティのシングルサインオン初期化 URL。

getDefaultProfileForRegistration()

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

署名

public String getDefaultProfileForRegistration()

戻り値

型: String

プロファイル ID。

getFooterText()

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

署名

public String getFooterText()

戻り値

型: String

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

getLogoUrl()

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

署名

public String getLogoUrl()

戻り値

型: String

アイコン画像へのパス。

getSamlProviders()

コミュニティで使用可能な SAML ベースの認証プロバイダのリストを返します。

署名

public List<SamlSsoConfig> getSamlProviders()

戻り値

型: List<SamlSsoConfig>

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

getSelfRegistrationUrl()

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

署名

public String getSelfRegistrationUrl()

戻り値

型: String

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

getSamlSsoUrl(String)

コミュニティのシングルサインオン URL を返します。

署名

public String getSamlSsoUrl(String samlId)

パラメータ

samlId
型: String
コミュニティの SAML 設定の一意の名前。

戻り値

型: String

コミュニティのシングルサインオン初期化 URL。

getStartUrl()

コミュニティのホームページを返します。

署名

public String getStartUrl()

戻り値

型: String

コミュニティホームページの場所。

isSelfRegistrationEnabled()

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

署名

public Boolean isSelfRegistrationEnabled()

戻り値

型: Boolean