Apex リファレンスガイド
jNewer Version Available
OauthToken クラス
不透明な OAuth アクセストークンと更新トークンを取り消すためのメソッドが含まれます。
名前空間
使用方法
クライアントが認証フローを完了して Salesforce データへのアクセスを許可されると、アクセストークンが発行されます。これにより、クライアントはこのトークンを使用して、保護された Salesforce リソースに対して認証されたリクエストを行うことができます。クライアントは更新トークンを使用して、より多くのアクセストークンを取得することもできます。クライアントが Salesforce データにアクセスできないようにするには、その Salesforce トークンを取り消します。
このクラスは Auth.AuthToken クラスとは異なり、Salesforce トークンの代わりにサードパーティプロバイダによって発行されたトークンを取り消すメソッドを含みます。
OauthToken のメソッド
OauthToken のメソッドは次のとおりです。
revokeToken(type, authToken)
Salesforce が発行した OAuth トークンを取り消します。
署名
public static Boolean revokeToken(Auth.OauthTokenType type, String authToken)
パラメーター
- type
- 型: Auth.OauthTokenType
- 取り消すトークンの型を指定します。アクセストークンを取り消すには、ACCESS_TOKEN 値を使用します。更新トークンおよび関連するアクセストークンを取り消すには、REFRESH_TOKEN 値を使用します。更新トークンおよび関連するアクセストークンを取り消すには、DELETE_TOKEN 値を使用します。
- authToken
- 型: String
- Salesforce によって発行されたアクセストークン、更新トークン、または削除トークン。
戻り値
型: Boolean
このメソッドは、成功した場合は true を返し、失敗した場合は false を返します。無効なトークンまたは期限切れのトークンの場合、メソッドは NoDataFoundException 例外を返します。