Create Authenticators - EcoSys - 3.1 - Help - Hexagon

In this screen, you can provide authentication for each type of API by providing credentials, username token, and message level security details. Authenticators defines a set of credentials that are associated with a type of service. EcoSys Connect supports EcoSys and SOAP service and SQL.

To create a new Authenticator:

1. Click the Authenticators icon.

   

2. Click the symbol at the top right corner to add new authenticator.

3. In the General section, enter the authenticator Name and Description.

4. Select the authenticator Type. The available authenticator types are SOAP, ECOSYS, SQL, OAuth2, and Basic HTTP.

5. If you select the type as EcoSys, enter the username and password under Credentials section and click SAVE.

   

6. If you select the authenticator type as OAuth2, enter the following details:

   1. In the General section, enter the authenticator Name and Description.

   2. Enter the Type as OAuth2.

   3. In the Configuration section, enter the following details:

      • Server Token URL

      • Grant Type - Select Client Credentials or Password from the list.

      • Client ID

      • Client Secret

      • Scope

      • Username/Password - Only available if Grant Type is Password. 

      • Options

        If you have multiple options, use new line as separator.

7. Click the TEST button. If an HTTP code 200 is returned by the token service, a message appears as "Success", otherwise it displays an error.

   An empty tokenServerUrl is allowed and can be used for services that do not require authentication. No token will be obtained while accessing the API.

   

8. If you select the authenticator type as SOAP, enter the following details:

   1. Username Token – Select Randomize or TimeStamp checkbox. Selecting Randomize makes your request unique and ensure that old communications cannot be reused.

   2. Message Level Security – Select the Timestamp checkbox. Message–level security specifies whether the SOAP API between a client application and the web service invoked by the client should be digitally signed or encrypted.

9. Click SAVE. The authenticator appears in the Authenticators list.

10. To delete the authenticator, select the authenticator and click symbol.

    Authenticators are unique by Type and Name.