Apex リファレンスガイド
リリースノート
IntegratingAppType 列挙
InvocationContext 列挙
LightningLoginEligibility 列挙
LoginDiscoveryMethod 列挙
OAuth2TokenExchangeType 列挙
OauthTokenType 列挙
SessionLevel 列挙
VerificationMethod 列挙
VerificationPolicy 列挙
Auth の例外
ExternalService 名前空間
Auth 名前空間
Auth 名前空間のインターフェースを次に示します。
-
AuthConfiguration クラス
ユーザーが Salesforce ログイン情報ではなく認証プロバイダーログイン情報を使用して Salesforce にログインするための設定を定義するメソッドが含まれます。認証プロバイダーは、Google、Facebook、Twitter など、OpenID Connect プロトコルをサポートする任意の認証プロバイダーです。ユーザーは、Experience Cloud サイト (https://MyDomainName.my.site.com) または [私のドメイン] のログイン URL (https://MyDomainName.my.salesforce.com) のいずれかにログインします。 -
AuthProviderCallbackState クラス
要求 HTTP ヘッダー、本文、およびクエリパラメーターをユーザー認証用の AuthProviderPlugin.handleCallback メソッドに提供します。このクラスでは、ヘッダー、本文、クエリパラメーターを個別に渡す代わりに、渡す情報をグループ化できます。 -
AuthProviderPlugin インターフェース
このインターフェースは非推奨です。新しい開発で、Salesforce へのシングルサインオン用に OAuth ベースのカスタム認証プロバイダープラグインを作成するには、抽象クラス Auth.AuthProviderPluginClass を使用します。 -
AuthProviderPluginClass クラス
Salesforce へのシングルサインオン用に OAuth ベースのカスタム認証プロバイダープラグインを作成するためのメソッドが含まれます。Salesforce が提供するどの認証プロバイダーも使用できない場合、このクラスを使用してカスタム認証プロバイダープラグインを作成します。 -
AuthProviderTokenResponse クラス
AuthProviderPlugin.handleCallback メソッドからのレスポンスを保存します。 -
AuthToken クラス
認証されたユーザーの認証プロバイダー (Janrain プロバイダー以外) に関連付けられたアクセストークンを提供するメソッドが含まれます。 -
CommunitiesUtil クラス
Experience Cloud ユーザーに関する情報を取得するためのメソッドが含まれます。 -
ConfigurableSelfRegHandler インターフェース
Auth.ConfigurableSelfRegHandler を実装するクラスを作成することで、Experience Cloud サイトへの顧客またはパートナーのセルフ登録方法をより詳細に制御できます。収集するユーザー情報と、ユーザーが本人確認を行う方法 (メールアドレス、電話番号、または別の ID を使用する) を選択します。検証が完了したら、顧客またはパートナーユーザーを作成して、ユーザーを Experience Cloud サイトにログインします。 -
ConfirmUserRegistrationHandler インターフェース
Salesforce とサードパーティ ID プロバイダー間のシングルサインオン (SSO) ユーザーの対応付けを管理します。このインターフェースを使用して、更新前にユーザーの対応付けを確認します。 -
ConnectedAppPlugin クラス
接続アプリケーションの動作を拡張するためのメソッドが含まれます。たとえば、使用するプロトコルに応じて接続アプリケーションの呼び出し方法をカスタマイズします。このクラスによって、Salesforce と接続アプリケーション間のインタラクションの制御を強化できます。 -
HeadlessSelfRegistrationHandler インターフェース
ヘッドレス登録フロー中にカスタマーユーザーおよびパートナーユーザーを作成します。 -
IntegratingAppType 列挙
カスタマイズした Apex トークン交換ハンドラーで使用するメソッドで、アプリケーションを接続アプリケーションとして統合するか、外部クライアントアプリケーションとして統合するかを指定します。このメソッドは、Auth.Oauth2TokenExchangeHandler クラスを拡張しています。 -
InvocationContext 列挙
接続アプリケーションが呼び出されるコンテキスト。使用されるプロトコルフローや発行されるトークンの種別 (ある場合) など。開発者は、コンテキスト情報を使用して、呼び出しの種別に固有のコードを記述できます。 -
JWS クラス
デジタル署名を JSON Web 署名 (JWS) データ構造を使用して、JSON Web トークン (JWT) に適用するメソッドが含まれます。このクラスでは、署名済み JWT ベアラートークンが作成されます。このトークンは OAuth 2.0 JWT ベアラートークンフローで OAuth アクセストークンの要求に使用できます。 -
JWT クラス
JSON Web トークン (JWT) の JSON 要求セットを生成します。結果の Base64 エンコード済みペイロードを引数として渡して Auth.JWS クラスのインスタンスを作成できます。 -
JWTBearerTokenExchange クラス
署名済み JWT ベアラートークンをトークンエンドポイントに POST して、OAuth 2.0 JWT ベアラートークンフローでアクセストークンを要求するメソッドが含まれます。 -
JWTUtil クラス
OAuth 2.0 トークン交換フローの一部として、外部 ID プロバイダーからの JSON Web トークン (JWT) を検証するためのメソッドが含まれます。これらのメソッドは、Auth.Oauth2TokenExchangeHandler クラスの validateIncomingToken メソッドの一部として使用します。 -
LightningLoginEligibility 列挙
Auth.SessionManagement.getLightningLoginEligibility メソッドで使用される Lightning Login 資格値が含まれます。 -
LoginDiscoveryHandler インターフェース
Salesforce では、ユーザー名とパスワード以外の確認方法に基づくユーザーのログイン機能が提供されます。たとえば、メール、電話番号、または別の ID (統合 ID やデバイス識別子など) を使用してログインするようにユーザーに要求できます。Login Discovery は、Customer Community、Customer Community Plus、External Identity、Partner Community、Partner Community Plus ライセンスで使用可能です。 -
LoginDiscoveryMethod 列挙
[私のドメイン] のログインプロセスでログイン検出が使用される場合に、ユーザーの ID 確認に使用されるメソッドが含まれます。 -
MyDomainLoginDiscoveryHandler インターフェース
インタビューベース (2 ステップ) のログインプロセスである、[私のドメイン] のログイン検出ページを実装するために使用するハンドラー。まず、メールアドレスや電話番号などの一意の識別子をユーザーに要求します。次に、このハンドラーがユーザーの認証方法を決定 (検出) します。ユーザーはパスワードを入力するか、ID プロバイダーのログインページにリダイレクトされます。 -
Oauth2TokenExchangeHandler クラス
このクラスを使用して、外部 ID プロバイダーからのトークンを検証し、OAuth 2.0 トークン交換フロー中にトークンの件名を Salesforce ユーザーにマッピングするトークン交換ハンドラーを作成します。このハンドラーを使用して、新しい User オブジェクトを設定し、それを Salesforce に返して自動的に挿入することにってユーザーを作成することもできます。 -
OAuth2TokenExchangeType 列挙
OAuth 2.0 トークン交換フローで使用し、Salesforce トークンと交換するトークンの種別を指定します。 -
OAuthRefreshResult クラス
AuthProviderPluginClass 更新メソッドの結果を保存します。OAuth 認証フローでは、新しいアクセストークンの取得に使用できる更新トークンが提供されます。アクセストークンの有効期間は、セッションタイムアウト値で指定されたとおりに制限されます。アクセストークンの有効期限が切れた場合、更新トークンを使用して新しいアクセストークンを取得します。 -
OauthToken クラス
不透明な OAuth アクセストークンと更新トークンを取り消すためのメソッドが含まれます。 -
OauthTokenType 列挙
OauthToken.revokeToken メソッドで、無効にする Salesforce が発行した OAuth 2.0 トークンの種別を指定します。 -
RegistrationHandler インターフェース
Salesforce では、Salesforce へのシングルサインオンに Facebook©、Janrain© などの認証プロバイダーを使用する機能を提供します。 -
SamlJitHandler インターフェース
このインターフェースを使用して、SAML シングルサインオン時にジャストインタイムのユーザープロビジョニングロジックの制御とカスタマイズを行います。 -
SessionManagement クラス
現在のセッションでユーザーの ID の検証、カスタムログインフローの作成、セキュリティレベルのカスタマイズ、および信頼済み IP 範囲の定義を行うためのメソッドが含まれます。 -
SessionLevel 列挙
Auth.SessionLevel 列挙値は、SessionManagement.setSessionLevel メソッドで使用されます。 -
TokenValidationResult クラス
OAuth 2.0 トークン交換フロー中に validateIncomingToken メソッドを使用するトークン交換ハンドラーによって実行されたトークン検証の結果を記述するメソッドが含まれます。 -
UserData クラス
Auth.RegistrationHandler のユーザー情報を保存します。 -
VerificationMethod 列挙
ユーザーがログイン時に自分自身を識別できるさまざまな方法が含まれます。これを使用して、モバイル重視のパスワードなしのログインページの実装や、検証方法のセルフ登録 (および登録解除) を行うことができます。 -
VerificationPolicy 列挙
Auth.VerificationPolicy 列挙には ID 検証ポリシー値が含まれ、SessionManagement.generateVerificationUrl メソッドで使用されます。 -
VerificationResult クラス
独自の検証ページを作成したときに呼び出す検証の結果が含まれます。検証は、System.UserManagement.verifyPasswordlessLogin メソッドまたは System.UserManagement.verifySelfRegistration メソッドのいずれかで開始できます。 -
Auth の例外
Auth 名前空間には、いくつかの例外クラスが含まれています。