provider | String Name of the service provider to which the client will connect. Integration Server uses this parameter to determine which OAuth client implementation in the Scribe library to use when issuing requests. Possible values are IntegrationServer and Other (case insensitive). Note: If set to Other, you must specify a value for providerClass. |
providerClass | String Name of a class that implements the org.scribe.builder.api.Api interface. This parameter is required only when the provider parameter is set to Other. Note: The org.scribe.builder.api.Api interface is part of the Scribe API. It facilitates the use of the pub.client.oauth:executeRequest service to connect to providers other than IntegrationServer. For more information about org.scribe.builder.api.Api see the Usage Notes. |
clientID | String The client identifier assigned to the client by the provider. The clientID is used to authenticate the client to the provider. The value is assigned by the provider at registration time. |
clientSecret | String The secret assigned to the client when it registered with the provider. Use this parameter to specify either the client secret or the key to the client secret in the outbound password store. For information about using the outbound password store, see the Usage Notes. |
accessToken | String The access token assigned to the client application when it registered with the provider. Note: The process for obtaining the accessToken varies depending on the provider. For information about obtaining the accessToken, refer to your provider's documentation. Use this parameter to specify either the access token or the key to the access token in the outbound password store. For information about using the outbound password store, see the Usage Notes. |
acccessTokenSecret | String Optional. The access token secret assigned to the client application when it registered with the provider. Note: The process for obtaining the accessTokenSecret varies depending on the provider. For information about obtaining the accessTokenSecret, refer to your provider's documentation. Use this parameter to specify either the access token secret or the key to the access token secret in the outbound password store. For information about using the outbound password store, see the Usage Notes. Note: Not all providers use an access token secret. If the provider issued a secret with the token, you must specify it with the accessTokenSecret parameter. |
resourceUri | String The URI given to the client application when it registered with the provider. The client application uses this URI when issuing requests to the provider. It points to the resource that the client application wants to access on the provider. |
method | String The HTTP method Integration Server will use to issue the request to the provider. Possible values are get, post, put, and delete. |
headers | Document List Optional. One or more name/value pairs to add to the header of the request sent to the provider. If the provider requires a request header, you must provide a value. |
queryString Parameters | Document List Optional. One or more name/value pairs to add to the URL of the get request sent to the provider. |
bodyParameters | Document List Optional. One or more name/value pairs to add to the body of the request sent to the provider. |
requestDataType | String Optional. If supplying data with the request to the provider, indicates the data type of the requestData parameter. If set to: bytes, requestData must be a byte[]. This is the default. string, requestData must be a java.lang.String. |
requestData | Object Optional. Data to include in the body of the request sent to the provider. The value can be a string or a byte[]. Note: The data type of requestData must match what is specified by the requestDataType parameter. requestData is ignored if bodyParameters is specified. |
responseDataType | String Optional. Indicates the data type of the responseData output parameter. Set to: stream to return the responseData as a java.io.InputStream. This is the default. bytes to return the responseData as a byte[]. string to return the responseData as a java.lang.String, constructed using the default platform encoding (indicated by the file.encoding Java system property, or UTF-8 if file.encoding is not set). |
responseData | Object The response from the provider. If the responseDataType is set to: stream, responseData is a java.io.InputStream. bytes, responseData is a byte[]. string, responseData is a java.lang.String, constructed using the default platform encoding (indicated by the file.encoding Java system property, or UTF-8 if file.encoding is not set). |