Apex リファレンスガイド
jTokenValidationResult クラス
OAuth 2.0 トークン交換フロー中に validateIncomingToken メソッドを使用するトークン交換ハンドラーによって実行されたトークン検証の結果を記述するメソッドが含まれます。
名前空間
使用方法
詳細は、「トークン交換ハンドラーの検証と件名のマッピング」を参照してください。
例
以下に、クラスの例を示します。
TokenValidationResult のコンストラクター
TokenValidationResult のコンストラクターは次のとおりです。
TokenValidationResult(isValid, data, userData, token, tokenType, customErrorMsg)
Auth.TokenValidationResult クラスのインスタンスを作成して、OAuth 2.0 トークン交換フロー中に実行されたトークン検証の結果を記述します。
署名
public TokenValidationResult(Boolean isValid, Object data, Auth.UserData userData, String token, Auth.OAuth2TokenExchangeType tokenType, String customErrorMsg)
パラメーター
- isValid
- 型: Boolean
- true の場合、トークンは有効です。
- data
- 型: Object
- userData に保存されていないカスタムデータを保存します。
- userData
- 型: Auth.UserData
- Salesforce ユーザーに関する情報を保存します。
- token
- 型: String
- 外部 ID プロバイダーからのトークン。
- tokenType
- 型: Auth.OAuth2TokenExchangeType
- 外部 ID プロバイダーからのトークンの型。
- customErrorMsg
- 型: String
- トークンの検証が失敗した場合に返されるカスタムエラーメッセージ。
TokenValidationResult(valid)
Auth.TokenValidationResult クラスのインスタンスを作成して、OAuth 2.0 トークン交換フロー中に、有効なトークン検証結果を記述します。
署名
public TokenValidationResult(Boolean valid)
パラメーター
- valid
- 型: Boolean
- 有効なトークン検証結果を示します。
TokenValidationResult のプロパティ
TokenValidationResult のプロパティは次のとおりです。
data
外部 ID プロバイダーへのコールアウトを介して入手された情報など、Auth.UserData クラスに保存されていないユーザーに関する情報が含まれます。
署名
public Object data {get; set;}
プロパティ値
型: Object
isValid
トークン交換ハンドラーのカスタム検証ロジックに基づいて、トークンが有効かどうかを示します。
署名
public Boolean isValid {get; set;}
プロパティ値
型: Boolean
tokenType
外部 ID プロバイダーからのトークンの型。アクセストークン、更新トークン、ID トークン、SAML 2.0 アサーション、または JSON Web トークン (JWT) にできます。
署名
public Auth.OAuth2TokenExchangeType tokenType {get; set;}
プロパティ値
TokenValidationResult のメソッド
TokenValidationResult のメソッドは次のとおりです。
getData()
ID プロバイダートークンからデータを取得します。このデータは、userData プロパティに保存されていないカスタムデータを含んでいることがあります。
署名
public Object getData()
戻り値
型: Object
getTokenType()
外部 ID プロバイダーから渡されたトークンの型を取得します。
署名
public Auth.OAuth2TokenExchangeType getTokenType()
戻り値
getUserData()
ユーザーに関する情報を取得します。ユーザー情報は ID プロバイダーのトークンから、または、該当する場合は ID プロバイダーへのコールアウトから取得できます。
署名
public Auth.UserData getUserData()
戻り値
isValid
トークン交換ハンドラーのカスタム検証ロジックに基づいて、トークンが有効かどうかを示します。
署名
public Boolean isValid {get; set;}
プロパティ値
型: Boolean