Who is this article for?

Administrators wanting to generate trusted clients access keys for an embedded integration.

Sysadmin permissions are required.

In this tutorial, you will learn how to create a trusted clients access key in the new (Helix) Ideagen Please Review interface.

This article provides instructions using the new interface. If you want to generate trusted clients access keys in the legacy UI, see Generating trusted clients access keys in the legacy UI.

Creating a trusted clients access key

1. Log into the system.

   

2. Switch to the new UI by clicking the toggle, if the toggle is off.

   

3. Click the System button.

   

4. Select the Trusted Clients option.

   

5. Click the New button to start adding a new trusted clients in Please Review.

   

6. Enter the Client Name. This is the unique name of the external system. Eg: REST API - IQMP.

   

7. Enter hub/api for Web Service URL. 

   You must enter this exact value: hub/api. The Hub REST API checks this on every request. A key with a different service name is rejected with INVALID_ACCESS_KEY.

   

8. Click the Generate Key button to create a new access key for the trusted clients.

   

9. Save this access key securely, as it cannot be re-generated.

   

10. Click the Create button to save the new trusted clients configuration.

    

11. The new trusted clients has been created successfully.