Authorization Element Reference

The authorization element lets you customize the authorization segment of the OAuth flow.

XML Schema of the Element

 <xs:element name="Authorization" minOccurs="0">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="RequestMsgStyle" minOccurs="0"/>
        <xs:element ref="ResponseMsgStyle minOccurs="0""/>
        <xs:element ref="AuthorizationProcessors minOccurs="0""/>
        <xs:element ref="TokenProcessor" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

Sequence Element

Description of value

RequestMsgStyle

According to RFC 6749, the default value is GET for Authorization Code Grant, Implicit Grant, and Customized Flow.

<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—Append all request parameters of OAuth to the URL as a query string, using the HTTP GET method.
• QUERYPOST—Add all request parameters of OAuth to URL as query string, using the HTTP POST method.
• FORM—Add all request parameters of OAuth to the request body, using a Content-Type of application/x-www-form-urlencoded.

ResponseMsgStyle

According to RFC 6749, the default value is GET for Authorization Code Grant, Implicit Grant, and Customized Flow.

<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—All response parameters of OAuth are returned as a query string appended to a redirect URL.
• FORM—All response parameters of OAuth are returned with the entity, and Content-Type is application/x-www-form-urlencoded.
• JSON—All response parameters of OAuth are returned with the entity, and Content-Type is application/json.
• RAWBODY—All response parameters of OAuth are returned with the entity, but the format is not clearly defined. In this case, use tokenProcessor(JavaScript) to retrieve all parameters.

AuthorizationProcessors

Simulates a browser (user agent), automatically performing whatever authorization process is required to log in. Each AuthorizationProcessor within AuthorizationProcessors should be mapped to one pop-up page of the browser.

<xs:element name="AuthorizationProcessors" minOccurs="0">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="AuthorizationProcessor"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="AuthorizationProcessor">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>

TokenProcessor

Get tokens or other parameters if the response is not in the specified format.

XML Schema of the Element

  <xs:element name="TokenProcessor" minOccurs="0">
    <xs:simpleType>
      <xs:restriction base="xs:string"/>
    </xs:simpleType>
  </xs:element>