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

Apex 開発者ガイド

Apex 開発者ガイド
Apex の使用開始
Apex の作成
Apex の実行
Apex のデバッグ、テスト、リリース
Apex 言語のリファレンス
Apex DML 操作
ApexPages 名前空間
AppLauncher 名前空間
Approval 名前空間
Auth 名前空間
AuthConfiguration クラス
AuthConfiguration のコンストラクタ
AuthConfiguration のメソッド
AuthProviderCallbackState クラス
AuthProviderPlugin インターフェース
AuthProviderPluginClass クラス
AuthProviderTokenResponse クラス
AuthToken クラス
CommunitiesUtil クラス
ConnectedAppPlugin クラス
InvocationContext 列挙
JWS クラス
JWT クラス
JWTBearerTokenExchange クラス
OAuthRefreshResult クラス
RegistrationHandler インターフェース
SamlJitHandler インターフェース
SessionManagement クラス
SessionLevel 列挙
UserData クラス
VerificationPolicy 列挙
Auth の例外
Cache 名前空間
Canvas 名前空間
ChatterAnswers 名前空間
ConnectApi 名前空間
Database 名前空間
Datacloud 名前空間
DataSource 名前空間
Dom 名前空間
EventBus 名前空間
Flow 名前空間
KbManagement 名前空間
Messaging 名前空間
Metadata 名前空間
Process 名前空間
QuickAction 名前空間
Reports 名前空間
Schema 名前空間
Search 名前空間
Sfc 名前空間
Site 名前空間
Support 名前空間
System 名前空間
TerritoryMgmt 名前空間
TxnSecurity 名前空間
UserProvisioning 名前空間
VisualEditor 名前空間
wave 名前空間
付録
用語集
PDF

AuthConfiguration クラス

ユーザが Salesforce ログイン情報ではなく認証プロバイダ (Google または Facebook) を使用して Salesforce にログインするためのユーザ設定を定義するメソッドが含まれます。ユーザは Salesforce コミュニティにログインするか、[私のドメイン] で作成したサブドメインにログインします。

名前空間

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

署名

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(communityUrl, startUrl, developerName)

コミュニティ、または [私のドメイン] で作成されたカスタムドメインのシングルサインオン URL を返します。

署名

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

パラメータ

communityUrl
型: String
コミュニティまたはカスタムドメインの URL。null でなく、空の文字列として指定されていない場合、コミュニティの 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 (既存のアカウントでログイン)」など)。

getForgotPasswordUrl()

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

署名

public String getForgotPasswordUrl()

戻り値

型: String

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

getLogoUrl()

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

署名

public String getLogoUrl()

戻り値

型: String

アイコン画像へのパス。

getRightFrameUrl()

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

署名

public String getLoginRightFrameUrl()

戻り値

型: String

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

getSamlProviders()

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

署名

public List<SamlSsoConfig> getSamlProviders()

戻り値

型: List<SamlSsoConfig>

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

getSamlSsoUrl(communityUrl, startURL, samlId)

コミュニティ、または [私のドメイン] で作成されたカスタムドメインのシングルサインオン URL を返します。

署名

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

パラメータ

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

戻り値

型: String

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

getSelfRegistrationEnabled()

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

署名

public Boolean getSelfRegistrationEnabled()

戻り値

型: Boolean

getSelfRegistrationUrl()

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

署名

public String getSelfRegistrationUrl()

戻り値

型: String

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

getStartUrl()

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

署名

public String getStartUrl()

戻り値

型: String

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

getUsernamePasswordEnabled()

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

署名

public Boolean getUsernamePasswordEnabled()

戻り値

型: Boolean

isCommunityUsingSiteAsContainer()

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

署名

public Boolean isCommunityUsingSiteAsContainer()

戻り値

型: Boolean