Versions Compared

Key

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

You open the REST Server agent configuration dialog from a workflow configuration: you can right-click the agent icon and select Configuration..., or double-click the agent icon.

General Tab

The General tab contains settings related to the location and authentication of the REST server.

...

Note

You can find the TLS hanshake failed error from the EC log. You can also find the error if you have debug turned on your workflow monitor.

Authentication Tab

The Authentication tab contains settings related to the OAuth 2.0 Authentication for the REST Server agent.

...

SettingDescription
OAuth 2.0 Authentication

If enabled, the REST Server agent will check all incoming HTTP requests for access tokens and validate the access tokens. Only access tokens generated by the Authorization Server will be accepted.


If not enabled, the REST Server agent will not check the incoming HTTP requests for access tokens.

The Authorization Server is a Service Provider in which is used to generate OAuth 2.0 access tokens. For more information on how to setup the Authorization Server, please refer to 2.1 Enabling Authorization Server

Note

You must select this option for the OAuth Truststore, OAuth Truststore Password and JWT Public Alias to be made available. Enable Use TLS, under the General tab, is also required if OAuth 2.0 Authentication is enabled.


OAuth Truststore

Path to the truststore where the public key for access token validation from the OAuth2 Service is stored. Only Java KeyStore (JKS) format is supported.

Enter the full path to a truststore file on the local or mounted disk on the execution host.

OAuth Truststore Password

The password for the truststore

Note
titleSame Password

All keys must have the same password as the truststore.


JWT Public Key Alias

The alias of the key inside the truststore to be used to access token validation.

The key referred here is the public key of the RSA key pair defined in the "jwt" configuration of the Authorization Server.

Note

The alias password, when configured during the construction of the truststore certificate should be the same as OAuth Truststore password.



Advanced Tab

The Advance tab contains additional properties that can be configured for the REST Server agent.

...

You open the REST Server agent configuration dialog from a workflow configuration: you can right-click the agent icon and select Configuration..., or double-click the agent icon.

General Tab

The General tab contains settings related to the location and authentication of the REST server.

...

Note

To generate the keystore file using , please refer to the 2.2.11 keytool command.


Authentication Tab

The Authentication tab contains settings related to the OAuth 2.0 Authentication for the REST Server agent.

...

SettingDescription
OAuth 2.0 Authentication

If enabled, the REST Server agent will check all incoming HTTP requests for access tokens and validate the access tokens. Only access tokens generated by the Authorization Server will be accepted.


If not enabled, the REST Server agent will not check the incoming HTTP requests for access tokens.

The Authorization Server is a Service Provider in which is used to generate OAuth 2.0 access tokens. For more information on how to setup the Authorization Server, please refer to 2.1 Enabling Authorization Server

Note

You must select this option for the OAuth Truststore, OAuth Truststore Password and JWT Public Alias to be made available. Enable Use TLS, under the General tab, is also required if OAuth 2.0 Authentication is enabled.


OAuth Truststore

Path to the truststore where the public key for access token validation from the OAuth2 Service is stored. Only Java KeyStore (JKS) format is supported.

Enter the full path to a truststore file on the local or mounted disk on the execution host.

OAuth Truststore Password

The password for the truststore

Note
titleSame Password

All keys must have the same password as the truststore.


JWT Public Key Alias

The alias of the key inside the truststore to be used to access token validation.

The key referred here is the public key of the RSA key pair defined in the "jwt" configuration of the Authorization Server.

Note

The alias password, when configured during the construction of the truststore certificate should be the same as OAuth Truststore password.



Advanced Tab

The Advance tab contains additional properties that can be configured for the REST Server agent.

...