Skip to main content

CyberArk setup

CyberArk connects through the unified HRIS connector. This page covers the CyberArk-side configuration you complete first. Once it's done, add the connector in Mesh by following Connect your HR system.

You finish with four values:

ValueWhere it comes from
Tenant URLYour organization's CyberArk sign-in host
OAuth client application IDThe application ID you choose in Step 3
Client IDThe service user you create in Step 4
Client secretSet when you create the service user

Before you start

You need administrator access to your company's CyberArk instance, or a colleague who has it.

Third-party product

These steps reflect Axiad's current understanding of CyberArk's configuration. Because CyberArk is a third-party product, there may be variations between your experience and what this guide describes, depending on the version in use and recent updates.

If you find a significant difference, or anything that doesn't make sense, let us know through Axiad support.

Step 1 — Open the admin portal

  1. Sign in to CyberArk at your organization's tenant URL.

    The CyberArk portal home page

  2. Select the grid symbol next to Identity User Portal and choose Admin Portal.

    Switching to the CyberArk admin portal

    The admin portal view

Step 2 — Create a SCIM client role

  1. Go to Core Services → Roles.

    The Core Services menu open at Roles

  2. Select Add Role, name it SCIM Client, and select Save.

  3. Under Administrative Rights, select Add, then find and select User Management.

    Choose User Management, not Read Only User Management

    The read-only variant does not grant enough for the connection to work.

    Adding the User Management administrative right to the role

  4. Select Save.

Step 3 — Create a custom OAuth2 client

  1. Go to Apps & Widgets → Web Apps.

    The Apps and Widgets menu open at Web Apps

  2. Select Add Web Apps, open the Custom tab, and select Add next to OAuth2 Client.

    Adding a custom OAuth2 client from the Custom tab

  3. Confirm with Yes, then close the dialog. CyberArk opens the client's configuration.

  4. On Settings, set an Application ID — any value you like, for example scim_oauth_client. This becomes part of the OAuth endpoint URL, and it is the value you enter in Mesh, so note it down.

  5. On General Usage, set Client ID Type to Confidential and check Must be OAuth Client.

    The General Usage page with the client ID type set

  6. On Tokens, set:

    FieldValue
    Token TypeJwtRS256
    Auth methodsClient Creds
    Access token lifetime5 hours

    The Tokens page with the token type and auth method set

  7. On Scope, select Add and create a scope named SCIMAPIScope, then add an allowed REST API entry with the text scim.

    Enter these values exactly

    Both the scope name and the REST API entry are matched literally. A typo here surfaces later as an authorization failure that looks unrelated.

    The Scope page with the SCIM API scope defined

  8. On Permissions, add the SCIM Client role from Step 2 and check the Run permission.

  9. Select Save.

Step 4 — Create a service user

Go to Core Services → Users and create a service user for the connection. Note its client ID and secret — these are the credentials Mesh authenticates with, and they belong to the SCIM Client role you created.

Step 5 — Connect in Mesh

Follow Connect your HR system, choose CyberArk in the connection window, and supply the tenant URL, application ID, client ID, and client secret.

After connecting

The connector appears in your connectors list with Health: Initializing while the first collection runs, then moves to Good. Access is read-only: Mesh does not write back to CyberArk.

If it doesn't come online, see Troubleshoot HR connectors.

Troubleshooting

What you seeLikely causeFix
Authorization is rejectedThe scope name or the scim REST API entry has a typoRe-check both on the client's Scope page, exactly as shown
The connector authorizes but reads nothingThe role has Read Only User Management rather than User ManagementChange the administrative right on the SCIM Client role
The client cannot be usedThe SCIM Client role was not added on the Permissions page, or Run is uncheckedAdd the role and check Run, then save