Page Comparison

Base URL

This is the target URL for requests from the REST Client agent.

Enter the URL in the following format:

<protocol>://hostname:<optional-port>/<optional-path>

The supported protocols are HTTP and HTTPS. If no port is specified, the agent will default to 80 for HTTP and 443 for HTTPS.

Use TLS

Enable Transport Layer Security for the REST Client agent. This option is configurable when https is set as the protocol in the base URL.

Security Profile

Timeout (ms)

Enter the maximum response time from the remote server in milliseconds.

If the response time from the server exceeds this value, the REST Client agent updates the Error field of the outgoing RESTCycleUDR. 

For further information about UDR types, see REST Client UDR Types.

The default value is 5000 ms.

Max Outstanding Requests

Enter the maximum number of outstanding requests that the agent can handle simultaneously. A request that is received by the agent is considered outstanding until a corresponding response is received from the remote server.

If the number of requests exceeds this value, the REST Client agent updates the Error field of the outgoing RESTCycleUDR. New requests are not sent by the agent until the number of outstanding requests decreases.

For further information about UDR types, see REST Client UDR Types.

The default value is 100 requests.

Username

Enter a username for an account on the remote server. The username must not include colon (:) characters.

Password

Enter the password associated with the username.

Grant Type

Select the grant type:

• Client Credentials

  The agent fetches the access token from the Access Token URI during initialization, using client id and client secret for basic authentication. The credentials are base64 encoded and sent in the header of the request.

  The response contains an access token, which is then used in subsequent requests. 

• Resource Owner Password Credentials

  The agent fetches the access token from the Access Token URI during initialization, using the following credentials for authentication:

  • Client ID

  • Client Secret

  • Username

  • Password

  The credentials are sent in the body of the request. The response contains an access token, which is then used in subsequent requests. 

Client Auth Type

Select the client authentication method:

• client_secret_basic - The credentials are base64 encoded and sent in the header of the request.

• client_secret_post - The credentials are sent in the body of the request.

Client ID

Enter the unique client identifier issued by the authorization server.

Client Secret

Enter the client secret.

Username

Enter the resource owner username, i e end-user granting access to a protected resource. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Password

Enter the password associated with the username. This field is required when you have selected Resource Owner Password Credentials from the drop-down list Grant Type.

Access Token URI

Enter the URI where the access token can be obtained.

Base URL Field

Some authentication servers may provide a base URL in the response body that the REST client agent must use in subsequent requests. When this is applicable, enter the name of the key in the JSON formatted string that holds the base URL. The value extracted from the response overrides, the Base URL, that you have configured in the Basic tab.

In the following example, the base URL is available in instance_url.

Example - Base URL in response from authentication server

{"access_token":"00D5E0000008lbR...",
"instance_url":"https://cs84.example.com",
"id":"https://example.com/id/00D5E0000008lbRUAQ/0055E000000HRCHQA4",
"token_type":"Bearer","issued_at":"1490699031149",
"signature":"tWccV/a3r0y/JoMRTUbpiviwmslJD2J29yTtSz7yDHE="}

Additional Parameters

Some authentication servers may require additional parameters in the body of the token requests. To add a parameter, click the Add button and then enter the name of the parameter in the Key field and the value of the parameter in the Value field.

Do not use escape characters in the value field, these will be added automatically by the REST Client agent. For instance, "https://example.com/ " will be sent as "https%3A%2F%2example.com%2F".