Apex 開発者ガイド
jAuthToken クラス
名前空間
AuthToken のメソッド
AuthToken のメソッドは次のとおりです。すべてのメソッドが静的です。
getAccessToken(authProviderId, providerName)
署名
public static String getAccessToken(String authProviderId, String providerName)
パラメータ
戻り値
型: String
getAccessTokenMap(authProviderId, providerName)
署名
public static Map<String, String> getAccessTokenMap(String authProviderId, String providerName)
パラメータ
refreshAccessToken(authProviderId, providerName, oldAccessToken)
署名
public static Map<String, String> refreshAccessToken(String authProviderId, String providerName, String oldAccessToken)
パラメータ
使用方法
���のメソッドは、Salesforce または OpenID Connect プロバイダを使用する場合は機能しますが、Facebook または Janrain を使用する場合は機能しません。返された対応付けには、AccessToken キーと RefreshError キーが含まれます。要求が成功したかどうかを確認するには、応答内のキーを評価します。要求が成功した場合、RefreshError 値は null、AccessToken はトークン値になります。要求が失敗した場合は、RefreshError 値はエラーメッセージ、AccessToken 値は null になります。
成功した場合は、このメソッドはデータベースに保存されているトークンを更新します。このトークンは、Auth.AuthToken.getAccessToken() を使用して取得できます。
OpenID Connect 認証プロバイダを使用する場合、プロバイダからの応答内に id_token は必要ありません。[認証プロバイダ] 設定に [トークン発行者] が指定されていて id_token が提供される場合は、Salesforce によって検証されます。
例
要求が成功した場合、応答にアクセストークンが含まれます。
revokeAccess(authProviderId, providerName, userId, remoteIdentifier)
署名
public static Boolean revokeAccess(String authProviderId, String providerName, String userId, String remoteIdentifier)
パラメータ
- authProviderId
- 型: String
- Salesforce 組織の認証プロバイダの ID。
- providerName
- 型: String
- サードパーティの正式名称。Janrain を除くすべてのプロバイダの期待値は次のとおりです。
- Salesforce
- Open ID Connect
- Microsoft アクセスコントロールサービス
- userId
- 型: String
- アクセスが取り消されるユーザの 15 文字の ID。
- remoteIdentifier
- 型: String
- サードパーティシステムのユーザの一意の ID (この値は関連付けけられた ThirdPartyAccountLink 標準オブジェクト内にあります)。
例
次の例では、Facebook ユーザのアクセストークンを取り消します。