Bearer Token Request

This REST tool is used to obtain an OAuth 2.0 access bearer token for a client credentials grant or a password grant.  This tool returns a parsed token from JSON that you can use in the Bearer Token parameter for the REST HTTP Request tool. The server response must be JSON. Use the client credentials grant for PureCloud APIs and the password grant for Salesforce.com APIs.

This tool:

• Expects the certificate file to exist in a specific directory: I3\IC\Certificates\REST. Create the I3\IC\Certificates\REST directory if it does not exist. The I3\IC\Certificates\REST directory is not created by default.
  
  Use the CertTrustU.exe to install a client certificate. The certificate must be in PEM format. For more information, see PureConnect Security Features Technical Reference in the PureConnect Documentation Library.

• Supports many concurrent requests.

• Does not use Windows Certificate store to check for validity of the certificate and uses openssl to do the verification.

To obtain more information on any failure, check logs of Interaction Processor or the response body and headers for failure information.

For more information, refer to the Interaction Designer REST APIs Developer's Guide in the PureConnect Documentation Library.

Inputs

URL

The URL of the request.

Proxy Uri

(Optional) String URI of the HTTP proxy to use for REST calls. This parameter supports the use of a forward proxy to retrieve content from the origin (API) server. This parameter must include the protocol used. For example: http://env4-revproxy1.ininlab or http://192.168.1.10.

ID/Key

The ID or key required for client credentials grant and password grant. Do not encode.

Secret

Secret required for client credentials grant and password grant. Do not encode.

User Name

(Optional) Username required for password grant.

Password

(Optional) Password required for password grant.

Grant Type

(Optional) Specify whether to use a grant type of "client_credentials" or "password". If this parameter contains an empty string, the default "client_credentials" is used.

Credentials In POST Body ?

(Optional) Set to true to output the credentials in the body of the REST call. Set to false to encode the credentials in the header. You must set this parameter to true for Salesforce.com API compatibility.

Content Type

The content type to add to the header of the REST call. If this parameter contains an empty string, the default (application/x-www-form-urlencoded) is used.

Request Timeout [s]

Maximum time in seconds to wait for request to be sent and response received before terminating the REST call request. Default: 10 seconds.

Client SSL Certificate

(Optional) Specify whether the server certificate validates against a client certificate to establish the HTTPS connection (installed by using CertTrustU.exe in I3\IC\Certificates\REST). Create the I3\IC\Certificates\REST directory if it does not exist. The I3\IC\Certificates\REST directory is not created by default.  

Ignore Unknown SSL Certificate Authority

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept certificate even if certificate authority is unknown.

Ignore Wrong SSL Certificate Usage

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept malformed certificates.

Ignore SSL Certificate Name Mismatch

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept a certificate even if the name does not match the visited host.

Ignore Invalid SSL Certificate Date (expired certificate)

This parameter applies only if the URL protocol is HTTPS. Check this parameter to accept a certificate even if it has expired.

Outputs

Bearer Access Token

Parsed bearer token that the responding server provides. Only supports JSON server response.

Exit Paths

Success

This path is taken if the operation is successful and a bearer token is parsed from JSON.

Unknown Host

This path is taken if an invalid or unknown hostname is used (for example, DNS lookup failed).

Timeout

This path is taken if the request timed out.

Connection Failure

This path is taken if a valid HTTP or HTTPS session was not established. For example, a failure to establish a HTTPS connection due to the absence of a client certificate when the Client SSL Certificate parameter is true.

Failure

This path is taken for any failure other than timeout or connection failure.