Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To open the HTTP/2 Client agent configuration dialog from a workflow configuration, you can do either one of the following:

...

SettingDescription
Use OpenAPI Profile

Select this option if you want the agent to use the OpenAPI profile(s).

OpenAPI Profile

Browse and select the profile to be used. This field is enabled when the Use OpenAPI Profile option is selected.

Click Browse to search for the available OpenAPI profiles.

Warning
titleWarning!

There are no limits to the number of profiles users can select. However, selecting a large number of OpenAPI profiles will have significant impact on the overall performance of the workflow.


Enable Validation

Select this option if you want to validate the OpenAPI profile.

Warning
titleWarning!

Turning this option ON will have a very significant performance impact on the overall performance of the flow. When validation is enabled, each payload will be validated against the Open API schema, an operation that can be very resource-intensive. We recommend to only enable this setting during development and testing and to disable it in a stable production environment.


Note
titleNote!

Strict validation is applied against the OpenAPI specification due to the upgrade of third party libraries. For Example, if the response contains the body but the schema doesn't expect the response to contain body then it will causing validation failure. Refer to this link for further information https://bitbucket.org/atlassian/swagger-request-validator/issues/246/validator-does-not-check-a-response-body


Authentication Tab

The Authentication tab contains settings for the following Authentication types:

...

SettingDescription
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 ID

Enter the unique client identifier issued by the authorization server.

Client Secret

Enter the client secret.

UsernameEnter the resource owner username, this can be the 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.
PasswordEnter 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.

Token expiration override (sec)

Enter a time in seconds when you would like to refresh the access token prior to the expiration. This allows the application to obtain a new access token without the user's interaction. 

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 HTTP2 Client agent. For instance, "https://example.com/" will be sent as "https%3A%2F%2example.com%2F".


Note
titleNote!

If an agent is configured on the Authentication Tab to use OAuth 2.0, an additional step may be required if the token needs to be obtained via HTTPS protocol.

The HTTP/2 Client internally uses the Java built-in HTTP Client to obtain a token. If a certificate is required to contact the authentication server, the proper certificate has to be put into the default certificates file for the respective JDK distribution used.

Info
titleExample - OpenJDK 64-Bit Server VM Zulu17.40+19-CA


Code Block
cd $JAVA_HOME/lib/security
keytool -import -alias mycert -keystore cacerts -file oauth2Host.cert



...