ユーザーガイド > Webベースのデータソースの構成 > TDVの[OAuth]タブの[XML Processors(XMLプロセッサー)]フィールドリファレンス > RefreshToken要素
 
RefreshToken要素
RefreshToken要素を使用すると、OAuthフローでアクセストークンを更新する方法をカスタマイズできます。
要素のXMLスキーマ
<xs:element name="RefreshToken" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="RequestMsgStyle" minOccurs="0"/>
<xs:element ref="ResponseMsgStyle" minOccurs="0"/>
<xs:element ref="ExpireTime" minOccurs="0"/>
<xs:element ref="TokenProcessor" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
シーケンス要素
値の説明
RequestMsgStyle
RFC 6749によると、認可コード付与、リソース所有者パスワード資格情報付与、およびカスタマイズフローのデフォルト値はFORMです。
<xs:element name="RequestMsgStyle" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="FORM"/>
<xs:enumeration value="QUERY"/>
<xs:enumeration value="QUERYPOST"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
QUERY - HTTP GETメソッドを使用して、OAuthのすべてのリクエストパラメーターをクエリー文字列としてURLに追加します。
QUERYPOST - HTTP POSTメソッドを使用して、OAuthのすべてのリクエストパラメーターをクエリー文字列としてURLに追加します。
FORM - application/x-www-form-urlencodedコンテンツタイプを使用して、OAuthのすべてのリクエストパラメーターをリクエスト本文に追加します。
ResponseMsgStyle
RFC 6749に従い、デフォルト値は、承認コード付与、リソース所有者パスワード資格情報付与、およびカスタマイズされたフローの場合JSONです。
<xs:element name="ResponseMsgStyle" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="FORM"/>
<xs:enumeration value="QUERY"/>
<xs:enumeration value="JSON"/>
<xs:enumeration value="RAWBODY"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
 
QUERY - OAuthのすべてのレスポンスパラメーターが、リダイレクトURLに追加されたクエリー文字列として返されます。
FORM - OAuthのすべてのレスポンスパラメーターがエンティティーとともに返されます。コンテンツタイプはapplication/x-www-form-urlencodedです。
JSON - OAuthのすべてのレスポンスパラメーターがエンティティーとともに返されます。コンテンツタイプはapplication/jsonです。
RAWBODY - OAuthのすべてのレスポンスパラメーターがエンティティーとともに返されますが、形式は明確に定義されていません。この場合は、tokenProcessor(JavaScript)を使用してすべてのパラメーターを取得します。
ExpireTime
アクセストークンの有効期限を設定し、デフォルトの5秒を上書きします。
要素のXMLスキーマ
<xs:element name="ExpireTime" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:integer"/>
</xs:simpleType>
</xs:element>
TokenProcessor
認可レスポンスが指定された形式でない場合、トークンまたはその他のパラメーターを取得します。
要素のXMLスキーマ
<xs:element name="TokenProcessor" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>