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

Force.com Apex コード開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

AuthConfiguration クラス

ユーザがコミュニティ、または [私のドメイン] を使用して作成されたカスタムドメインに認証プロバイダ (Facebook© など) を使用してログインするための設定を定義するためのメソッドが含まれます。

名前空間

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(String, String)

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

署名

public AuthConfiguration(String cURL, String startURL)

パラメータ

cURL
型: String
コミュニティまたはカスタムドメインの URL。
startURL
型: String
ユーザがコミュニティまたはカスタムドメインに正常にログインすると表示されるページ。

AuthConfiguration メソッド

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

getAuthConfig()

AuthConfig sObject を返します。これは、コミュニティ、または [私のドメイン] を使用して作成されたカスタムドメインでの認証オプションを表します。

署名

public AuthConfig getAuthConfig()

戻り値

型: AuthConfig

コミュニティまたはカスタムドメインの AuthConfig sObject。

getAuthConfigProviders()

コミュニティまたはカスタムドメイン用に設定された認証プロバイダのリストを返します。

署名

public List<AuthConfigProviders> getAuthConfigProviders()

戻り値

型: List<AuthConfigProviders>

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

getAuthProviders()

コミュニティまたはカスタムドメインで使用可能な認証プロバイダのリストを返します。

署名

public List<AuthProvider> getAuthProviders()

戻り値

型: List<AuthProvider>

コミュニティまたはカスタムドメイン用の認証プロバイダ (AuthProvider sObject) のリスト。

getAuthProviderSsoUrl(String, String, String)

コミュニティまたはカスタムドメインのシングルサインオン URL を返します。

署名

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

パラメータ

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

戻り値

型: String

コミュニティまたはカスタムドメインの [シングルサインオン初期化 URL]。

getBackgroundColor()

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

署名

public String getBackgroundColor()

戻り値

型: String

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) のリスト。

getSamlSsoUrl(String, String, String)

コミュニティまたはカスタムドメインのシングルサインオン URL を返します。

署名

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

パラメータ

cUrl
型: String
コミュニティまたはカスタムドメインの URL。null の場合、または空の文字列として指定した場合、カスタムドメイン用の URL が取得されます。
startUrl
型: String
ユーザがコミュニティまたはカスタムドメインに正常にログインすると表示されるページ。
samlId
型: String
コミュニティまたはカスタムドメインの SAML 設定の一意の名前。

戻り値

型: String

コミュニティまたはカスタムドメインのシングルサインオン初期化 URL。

getSelfRegistrationEnabled()

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

署名

public Boolean getSelfRegistrationEnabled()

戻り値

型: Boolean

getSelfRegistrationUrl()

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

署名

public String getSelfRegistrationUrl()

戻り値

型: String

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

getStartUrl()

ユーザがログインした後に表示されるコミュニティまたはカスタムドメインのページを返します。

署名

public String getStartUrl()

戻り値

型: String

コミュニティまたはカスタムドメイン開始ページの場所。

getUsernamePasswordEnabled()

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

署名

public Boolean getUsernamePasswordEnabled()

戻り値

型: Boolean