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

OauthTokenExchangeHandler

トークン交換ハンドラーを表します。トークン交換ハンドラーも Apex クラスで構成されています。OAuth 2.0 のトークン交換フローでは、トークン交換ハンドラーを使用して、外部の ID プロバイダからのトークンを検証してユーザーを Salesforce にマッピングします。このオブジェクトは、API バージョン 60.0 以降で使用できます。

サポートされているコール

create()delete()describeSObjects()query()retrieve()update()upsert()

特別なアクセスルール

項目

項目 詳細
説明
string
プロパティ
Create、Filter、Group、Sort、Update
説明
トークン交換ハンドラーの説明。
DeveloperName
string
プロパティ
Create、Filter、Group、Sort、Update
説明
ハンドラーの API 名。
IsEnabled
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
トークン交換フローでハンドラーが有効になっているかどうかを示します。
デフォルト値は false です。
IsUserCreationAllowed
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
ハンドラーが新規ユーザーを設定できるかどうかを示します。トークン交換フローでは、Apex ハンドラーが ID プロバイダから Salesforce にユーザーをマッピングします。IsUserCreationAllowed 項目が truegetUserForTokenSubject メソッドの canCreateUser ブール値が true で、Salesforce にユーザーが存在しない場合、ハンドラーは新しいユーザーオブジェクトをセットアップします。Salesforce がユーザーオブジェクトを自動的に挿入してユーザーの作成を完了します。
デフォルト値は false です。
言語
picklist
プロパティ
Create、Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort、Update
説明
トークン交換ハンドラーが作成された組織で使用される言語を示します。
可能な値は次のとおりです。
  • da - デンマーク語
  • de - ドイツ語
  • en_US - 英語
  • es - スペイン語
  • es_MX - スペイン語 (メキシコ)
  • fi - フィンランド語
  • fr - フランス語
  • it - イタリア語
  • ja - 日本語
  • ko - 韓国語
  • nl_NL - オランダ語
  • no - ノルウェー語
  • pt_BR - ポルトガル語 (ブラジル)
  • ru - ロシア語
  • sv - スウェーデン語
  • th - タイ語
  • zh_CN - 中国語 (簡体字)
  • zh_TW - 中国語 (繁体字)
MasterLabel
string
プロパティ
Create、Filter、Group、Sort、Update
説明
トークン交換ハンドラーレコードのラベル。
NamespacePrefix
string
プロパティ
Filter、Group、Nillable、Sort
説明
このオブジェクトと関連付けられた名前空間プレフィックス。管理パッケージを作成する Developer Edition 組織ごとに一意の名前空間プレフィックスがあります。最大 15 文字です。namespacePrefix__componentName 表記を使用して、管理パッケージのコンポーネントを参照できます。名前空間プレフィックスには、次のいずれかの値があります。
  • Developer Edition 組織では、インストールされた管理パッケージにオブジェクトが含まれていない限り、名前空間プレフィックスをサポートするすべてのオブジェクトで NamespacePrefix が組織の名前空間プレフィックスに設定されます。その場合、オブジェクトにはインストールされた管理パッケージの名前空間プレフィックスが付きます。この項目の値は、パッケージ開発者の Developer Edition 組織の名前空間プレフィックスです。
  • Developer Edition 組織でない場合、NamespacePrefix は、インストールされた管理パッケージの一部であるオブジェクトでのみ設定されます。その他のオブジェクトには名前空間プレフィックスがありません。
SupportedTokenTypesAccessToken
boolean
プロパティ
Create、Filter、Update
説明
SupportedTokenTypesIdToken
boolean
プロパティ
Create、Filter、Update
説明
ハンドラーが ID プロバイダからの OpenID Connect ID トークンをサポートしているかどうかを示します。
SupportedTokenTypesJwt
boolean
プロパティ
Create、Filter、Update
説明
JWT ベースのアクセストークンなど、JWT 形式の ID プロバイダからのトークンをハンドラーがサポートするかどうかを示します。
SupportedTokenTypesRefreshToken
boolean
プロパティ
Create、Filter、Update
説明
ハンドラーが ID プロバイダからの OAuth 2.0 更新トークンをサポートしているかどうかを示します。
SupportedTokenTypesSaml2
boolean
プロパティ
Create、Filter、Update
説明
ハンドラーが ID プロバイダからの SAML 2.0 アサーションをサポートしているかどうかを示します。
TokenHandlerApexId
reference
プロパティ
Create、Filter、Group、Sort、Update
説明
トークン交換ハンドラーに関連付けられている Apex クラス。このクラスには、トークンを検証し、ユーザーを Salesforce にマッピングするメソッドが含まれています。Oauth2TokenExchangeHandler Apex クラスを拡張する必要があります。
この項目はリレーション項目です。
リレーション名
TokenHandlerApex
リレーション種別
Lookup
参照先
ApexClass