OAuth Config Objects

The following objects are used in the OAuth Config Definition.

OAuth Request Definition Object

The OAuth request definition object describes a request made to an identity provider as part of the OAuth process.

Name	Type	Required?	Description
`method`	string	✔	The `HTTP` method to use for this request. Valid values include the following: `GET` `POST` `PUT`
`url`	string	✔	The URL for this request.
`contentType`	string		The content-type for the body parameters. Valid values include: `application/json` (default) `application/x-www-form-urlencoded`
`bodyParameters`	object[]		An array of body parameters that should be included as part of the request.
`bodyParameters[].name`	string	✔	The name of the parameter.
`bodyParameters[].value`	string	✔	The value of the parameter.
`bodyParameters[].encoding`	string	✔	The type of encoding used for this parameter. The values currently supported are `base64` and `basic-auth`.
`headerParameters`	object[]		An array of header parameters that should be included as part of the request.
`headerParameters[].name`	string	✔	THe name of the parameter.
`headerParameters[].value`	string	✔	The value of the parameter.
`headerParameters[] .encoding`	string	✔	The type of encoding used for this parameter. The values currently supported are `base64` and `basic-auth`.
`queryParameters`	object[]		An array of query parameters that should be included as part of the request.
`queryParameters[].name`	string	✔	The name of the parameter.
`queryParameters[].value`	string	✔	The value of the parameter.
`queryParameters[] .encoding`	string	✔	The type of encoding used for this parameter. The values currently supported are `base64` and `basic-auth`.

The OAuth response definition object describes a response received from an identity provider as part of the OAuth process.

Name	Type	Required?	Description
`bodyParameters`	object[]		An array of body parameters that should be included as part of the request.
`bodyParameters[].name`	string	✔	The name of the parameter.
`bodyParameters[].value`	string	✔	The value of the parameter.
`bodyParameters[].encoding`	string	✔	The type of encoding used for this parameter. The only value currently supported is `base64`.
`headerParameters`	object[]		An array of header parameters that should be included as part of the request.
`headerParameters[].name`	string	✔	THe name of the parameter.
`headerParameters[].value`	string	✔	The value of the parameter.
`headerParameters[] .encoding`	string	✔	The type of encoding used for this parameter. The only value currently supported is `base64`.
`queryParameters`	object[]		An array of query parameters that should be included as part of the request.
`queryParameters[].name`	string	✔	The name of the parameter.
`queryParameters[].value`	string	✔	The value of the parameter.
`queryParameters[] .encoding`	string	✔	The type of encoding used for this parameter. The only value currently supported is `base64`.