Adyen

This guide will show you how to set up the integration between Adyen and Clarity Security.

Estimated time to complete: 10-15 minutes.

Configuring in your Downstream Application

You will need to reach out to the Adyen support team to properly configure this integration due to API settings that are not surfaced in the Adyen UI. It is advised to complete steps 1-5 ahead of any working sessions if possible.

More details about these requirements can be found in Step #5

Step 1: Login to Adyen

Login to Adyen with an account that has access to developer features or admin rights.

Step 2: Create API credentials

In the left navbar choose "Developers" -> "API credentials". Click the "Create new credential" button. This will open a form to create an API credential. Choose "Web service user" and provide a short description, such as "Clarity Security API Credential".

Step 3: Generate API Key

Once the API credential has been made, you will be navigated to it's management page. Scroll down to the "Authentication" section, choose "API key", and click the "Generate API key" button. This will populate the "API key" field. Click the copy button that is between the field's text and the "Generate API key" button. This is the API key that you will supply during the Clarity onboarding process.

Step 4: Choose required roles

While still on the API credential management page, scroll down to the "Permissions" and "Roles" section. In there make sure that the following roles are enabled:

• Management API - Accounts read

• Management API - Accounts read and write

• Management API - Stores read

• Management API - Stores read and write

  

  Step 5: Contact Adyen support

  Another role is required but is not available to choose in the API credentials management page. This requires contacting Adyen support, which can be done by clicking the question mark icon in the top navbar on the top right of the screen. Either call support or submit a ticket requesting the "Management API - Users read and write" role be added to the API credential that was created. Be sure to provide the specific API credential username in your request.

  

Configuring the Integration within Clarity

Step 6: Login to your Clarity Security tenant

https://your-tenant.claritysecurity.io/

Step 7: Click on Applications, then Marketplace

Step 8: Find Adyen

Scroll to or search for Adyen in the list of applications from the marketplace, then click Connect.

Step 9: Connect App

Complete the Connect App form.  Details for fields common to all applications can be found at the following article: Common App Configuration Steps

• Server URL should be one of two depending on your environment. Extra URL prefixes may or may not be needed per client.

  • https://management-test.adyen.com

  • https://management-live.adyen.com

• API Key is the value we copied in step 3

Step 10: App Settings

Complete the App Settings form.  Details for each field can be found at the following article: Common App Configuration Steps

Step 11: User Settings

Complete the User Settings form.  Details for each field can be found at the following article: Common App Configuration Steps

Step 12: Validate Your Selections and Save

Validate the selections from Configure App Step 3, and hit the Save button.

Need Help?