When you select None in Authentication Type, there are no additional settings. Basic authentication requires a username and a password, which are base64 encoded and sent in the header of the request. When you select Basic in Authentication Type, the following settings are available: Setting | Description |
---|
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. |
RFC 6749 specifies four grant types for authentication. At the time of writing, the only available grant types are "Client Credentials" and "Resource Owner Password Credentials". These types require additional parameters that are sent to an authorization server. Token ExpiryA request that is using invalid token, e g due to expiry, will fail and an error code will be set in the corresponding RESTCycleUDR that the agent routes back to the workflow. The agent will automatically attempt to obtain a new token, but you must configure your APL to resend the failed request. SettingsWhen you select OAuth 2.0 in Authentication Type, the following settings are available: Setting | Description |
---|
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 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 Code Block |
---|
{"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%2examplehttps%3A%2F%2example.com%2Fcom%2F". |
If you need to have dynamically configurable client credentials for OAuth 2.0, you may also use the OAuth2UDR for this, see REST Client UDR Types for further information. |