AuthProviderPlugin インターフェース

署名

public String getCustomMetadataType()

戻り値

型: String

認証プロバイダーのカスタムメタデータ型 API 名。

使用方法

Salesforce へのシングルサインオン用に OAuth ベースのカスタム認証プロバイダーのカスタムメタデータ型 API 名を返します。getCustomMetatadaType() メソッドは、カスタムメタデータ型の名前のみを返します。カスタムメタデータレコード名は返しません。

署名

public Auth.UserData getUserInfo(Map<String,String> authProviderConfiguration, Auth.AuthProviderTokenResponse response)

パラメーター

authProviderConfiguration

型: Map<String, String>

カスタム認証プロバイダーの設定。Salesforce にカスタムメタデータ型を作成すると、設定にカスタムメタデータ型のデフォルト値が入力されます。または、[設定] の [承認プロバイダー] でカスタムプロバイダーを作成したときに入力した値を設定で指定することもできます。

response

型: Auth.AuthProviderTokenResponse

OAuth アクセストークン、OAuth の秘密または更新トークン、および現在のユーザーを認証するために認証プロバイダーによって指定された状態。

戻り値

型: Auth.UserData

Auth.UserData クラスの新しいインスタンスを作成します。

使用方法

カスタム認証プロバイダーから現在のユーザーに関する情報を返します。登録ハンドラーと他の認証プロバイダーのフローでこの情報を使用します。

署名

public Auth.AuthProviderTokenResponse handleCallback(Map<String,String> authProviderConfiguration, Auth.AuthProviderCallbackState callbackState)

パラメーター

authProviderConfiguration

型: Map<StringString>

カスタム認証プロバイダーの設定。Salesforce にカスタムメタデータ型を作成すると、設定にカスタムメタデータ型のデフォルト値が入力されます。または、[設定] の [承認プロバイダー] でカスタムプロバイダーを作成したときに入力した値を設定で指定することもできます。

callbackState

型: Auth.AuthProviderCallbackState

認証要求の HTTP ヘッダー、本文、および queryParams が含まれるクラス。

戻り値

型: Auth.AuthProviderTokenResponse

AuthProviderTokenResponse クラスのインスタンスを作成します。

使用方法

認証プロバイダーのサポート対象認証プロトコルを使用して、OAuth アクセストークン、OAuth の秘密または更新トークン、現在のユーザーへの要求が開始されたときに渡された状態を返します。

署名

public System.PageReference initiate(Map<String,String> authProviderConfiguration, String stateToPropagate)

パラメーター

authProviderConfiguration

型: Map<StringString>

カスタム認証プロバイダーの設定。Salesforce にカスタムメタデータ型を作成すると、設定にカスタムメタデータ型のデフォルト値が入力されます。または、[設定] の [承認プロバイダー] でカスタムプロバイダーを作成したときに入力した値を設定で指定することもできます。

stateToPropagate

型: String

ユーザーに対する認証要求を開始するために渡される状態。

戻り値

型: System.PageReference

ユーザーが認証のためにリダイレクトされるページの URL。

使用方法

ユーザーが認証のためにリダイレクトされる URL を返します。