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

AuthConfiguration クラス

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

名前空間

Auth

例

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

1String communityUrl = '<Add URL>';
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(communityOrCustomUrl, startUrl)

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

署名

public AuthConfiguration(String communityOrCustomUrl, String startUrl)

パラメータ

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

AuthConfiguration(networkId, startUrl)

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

署名

public AuthConfiguration(Id networkId, String startUrl)

パラメータ

networkId: 型: Id; コミュニティの ID。
startUrl: 型: String; ユーザがコミュニティに正常にログインすると表示されるページ。

AuthConfiguration のメソッド

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

getAllowInternalUserLoginEnabled()

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

署名

public Boolean getAllowInternalUserLoginEnabled()

戻り値

型: Boolean

使用方法

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

getAuthConfig()

AuthConfig sObject を返します。これは、コミュニティまたは Salesforce の [私のドメイン] サブドメインの認証オプションを表します。

署名

public AuthConfig getAuthConfig()

戻り値

型: AuthConfig

コミュニティまたは Salesfofce の [私のドメイン] サブドメインの AuthConfig sObject。

getAuthConfigProviders()

コミュニティまたは Salesfofce の [私のドメイン] サブドメイン用に設定された認証プロバイダのリストを返します。

署名

public List<AuthConfigProviders> getAuthConfigProviders()

戻り値

型: List<AuthConfigProviders>

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

getAuthProviders()

コミュニティまたは Salesfofce の [私のドメイン] サブドメインで使用できる認証プロバイダのリストを返します。

署名

public List<AuthProvider> getAuthProviders()

戻り値

型: List<AuthProvider>

コミュニティまたは [私のドメイン] サブドメイン用の認証プロバイダ (AuthProvider sObject) のリスト。

getAuthProviderSsoUrl(communityUrl, startUrl, developerName)

コミュニティまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン URL を返します。

署名

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

パラメータ

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

戻り値

型: String

コミュニティまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン初期化 URL。

getBackgroundColor()

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

署名

public String getBackgroundColor()

戻り値

型: String

getDefaultProfileForRegistration()

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

署名

public String getDefaultProfileForRegistration()

戻り値

型: String

プロファイル ID。

getFooterText()

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

署名

public String getFooterText()

戻り値

型: String

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

getForgotPasswordUrl()

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

署名

public String getForgotPasswordUrl()

戻り値

型: String

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

getLogoUrl()

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

署名

public String getLogoUrl()

戻り値

型: String

アイコン画像へのパス。

getRightFrameUrl()

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

署名

public String getLoginRightFrameUrl()

戻り値

型: String

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

getSamlProviders()

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

署名

public List<SamlSsoConfig> getSamlProviders()

戻り値

型: List<SamlSsoConfig>

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

getSamlSsoUrl(communityUrl, startURL, samlId)

コミュニティまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン URL を返します。

署名

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

パラメータ

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

戻り値

型: String

コミュニティまたは Salesforce の [私のドメイン] サブドメインのシングルサインオン初期化 URL。

getSelfRegistrationEnabled()

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

署名

public Boolean getSelfRegistrationEnabled()

戻り値

型: Boolean

getSelfRegistrationUrl()

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

署名

public String getSelfRegistrationUrl()

戻り値

型: String

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

getStartUrl()

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

署名

public String getStartUrl()

戻り値

型: String

コミュニティまたは [私のドメイン] サブドメインの開始ページの場所。

getUsernamePasswordEnabled()

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

署名

public Boolean getUsernamePasswordEnabled()

戻り値

型: Boolean

isCommunityUsingSiteAsContainer()

コミュニティが Site.com ページを使用する場合は true、使用しない場合は false を返します。

署名

public Boolean isCommunityUsingSiteAsContainer()

戻り値

型: Boolean

Apex 開発者ガイド

AuthConfiguration クラス

名前空間

例

AuthConfiguration のコンストラクタ

AuthConfiguration(communityOrCustomUrl, startUrl)

署名

パラメータ

AuthConfiguration(networkId, startUrl)

署名

パラメータ

AuthConfiguration のメソッド

getAllowInternalUserLoginEnabled()

署名

戻り値

使用方法

getAuthConfig()

署名

戻り値

getAuthConfigProviders()

署名

戻り値

getAuthProviders()

署名

戻り値

getAuthProviderSsoUrl(communityUrl, startUrl, developerName)

署名

パラメータ

戻り値

getBackgroundColor()

署名

戻り値

getDefaultProfileForRegistration()

署名

戻り値

getFooterText()

署名

戻り値

getForgotPasswordUrl()

署名

戻り値

getLogoUrl()

署名

戻り値

getRightFrameUrl()

署名

戻り値

getSamlProviders()

署名

戻り値

getSamlSsoUrl(communityUrl, startURL, samlId)

署名

パラメータ

戻り値

getSelfRegistrationEnabled()

署名

戻り値

getSelfRegistrationUrl()

署名

戻り値

getStartUrl()

署名

戻り値

getUsernamePasswordEnabled()

署名

戻り値

isCommunityUsingSiteAsContainer()

署名

戻り値