この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

TokenValidationResult クラス

OAuth 2.0 トークン交換フロー中に validateIncomingToken メソッドを使用するトークン交換ハンドラーによって実行されたトークン検証の結果を記述するメソッドが含まれます。

名前空間

Auth

使用方法

詳細は、「トークン交換ハンドラーの検証と件名のマッピング」を参照してください。

以下に、クラスの例を示します。

1global class TokenValidationResult {        
2    global TokenValidationResult(Boolean valid) { this.isValid = valid; }
3    
4    global TokenValidationResult(Boolean isValid, Object data, Auth.UserData userData, 
5        String token, Auth.OAuth2TokenExchangeType tokenType, String customErrorMsg) {
6        
7        this.isValid = isValid;
8        this.data = data;
9        this.userData = userData;
10        this.token = token;
11        this.tokenType = tokenType;
12        this.customErrorMsg = customErrorMsg;
13    
14    }
15    
16    global Boolean isValid;
17    global Object data; 
18    global Auth.UserData userData;
19    global String token;
20    global Auth.OAuth2TokenExchangeType tokenType; //Enum
21    global String customErrorMsg; //Custom error message that’s returned to the client if token validation fails 
22    
23    global Boolean isValid(){
24        return isValid;
25    }
26    global Object getData(){
27        return data;
28    }
29    global Auth.UserData getUserData(){
30        return userData;
31    }
32    global String getToken(){
33        return token;
34    }
35    global OAuth2TokenExchangeType getTokenType(){
36        return tokenType;
37    }
38    global String getCustomErrorMessage(){
39        return customErrorMsg;
40    }
41}

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 のプロパティは次のとおりです。

customErrorMsg

トークンの検証が失敗した場合に返されるカスタムエラーメッセージ。

署名

public String customErrorMsg {get; set;}

プロパティ値

型: String

data

外部 ID プロバイダーへのコールアウトを介して入手された情報など、Auth.UserData クラスに保存されていないユーザーに関する情報が含まれます。

署名

public Object data {get; set;}

プロパティ値

型: Object

isValid

トークン交換ハンドラーのカスタム検証ロジックに基づいて、トークンが有効かどうかを示します。

署名

public Boolean isValid {get; set;}

プロパティ値

型: Boolean

token

外部 ID プロバイダーからのトークン。

署名

public String token {get; set;}

プロパティ値

型: String

tokenType

外部 ID プロバイダーからのトークンの型。アクセストークン、更新トークン、ID トークン、SAML 2.0 アサーション、または JSON Web トークン (JWT) にできます。

署名

public Auth.OAuth2TokenExchangeType tokenType {get; set;}

プロパティ値

型: Auth.OAuth2TokenExchangeType

userData

ID プロバイダーのトークンから取得される、ユーザーに関する情報。

署名

public Auth.UserData userData {get; set;}

プロパティ値

型: Auth.UserData

TokenValidationResult のメソッド

TokenValidationResult のメソッドは次のとおりです。

getCustomErrorMessage()

トークンの検証が失敗したときに返される CustomErrorMsg を取得します。

署名

public String getCustomErrorMessage()

戻り値

型: String

getData()

ID プロバイダートークンからデータを取得します。このデータは、userData プロパティに保存されていないカスタムデータを含んでいることがあります。

署名

public Object getData()

戻り値

型: Object

getToken()

外部 ID プロバイダーから渡されたトークンを取得します。

署名

public String getToken()

戻り値

型: String

getTokenType()

外部 ID プロバイダーから渡されたトークンの型を取得します。

署名

public Auth.OAuth2TokenExchangeType getTokenType()

getUserData()

ユーザーに関する情報を取得します。ユーザー情報は ID プロバイダーのトークンから、または、該当する場合は ID プロバイダーへのコールアウトから取得できます。

署名

public Auth.UserData getUserData()

戻り値

型: Auth.UserData

isValid

トークン交換ハンドラーのカスタム検証ロジックに基づいて、トークンが有効かどうかを示します。

署名

public Boolean isValid {get; set;}

プロパティ値

型: Boolean