Skip to main content

Data import

Connection details

ParameterValue
Base URLhttps://{yourtenant}/scim/v2/
Authentication typeOAuth2 Client Credentials
Token endpointhttps://https://{yourtenant}/oauth2/token/{yourappid}
Client IDYour client id
Client SecretYour client secret
OAuth token typeBearer
ScopeSCIM
Test connectionSelect the checkbox
Test queryUsers

Queries and mappings

Users - Accounts

Parameters:

TabParameterValue
GeneralURLUsers
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Business keyMapid
Unique IDMapuserName
Account NameMapuserName
Display NameMapdisplayName
StatusExpressionactive ? "Active" : "Inactive"
Distinguished nameMapid

Groups – Resources

Parameters:

TabParameterValue
GeneralURLGroups
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Business keyMapid
Security resource business keyMapid
NameMapdisplayName
CategoryConstantGroup
TypeConstantCyberArk Privileged Cloud - Group
Display nameExpressionurnietfparamsscimschemascyberark10Group_description != null ? urnietfparamsscimschemascyberark10Group_description : displayName
Short nameMapid
Logical KeyMapdisplayName
Description*Mapid
note

*Do not use the Description field on resources, as Omada uses this field to prevent duplication during resource import.

Containers – Resources

Parameters:

TabParameterValue
GeneralURLContainers
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Business keyMapid
Security resource business keyMapid
NameMapdisplayName
CategoryConstantGroup
TypeConstantCyberArk Privileged Cloud - Container
Display nameMapdisplayName
Short nameMapid
Logical KeyMapdisplayName
Description*Mapid
LocationMapurnietfparamsscimschemascyberark10Safe_location
SupportolacMapurnietfparamsscimschemascyberark10Safe_supportOLAC
note

*Do not use the Description field on resources, as Omada uses this field to prevent duplication during resource import.

Rights – Resources

Parameters:

TabParameterValue
GeneralURLContainerPermissions
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Business keyMaprights
Security resource business keyMaprights
NameMaprights
CategoryConstantPermission
TypeConstantCyberArk Privileged Cloud - rights
Short nameMaprights

Privileged Data – Resources

Parameters:

TabParameterValue
GeneralURLPrivilegedData
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Business keyMapid
Security resource business keyMapid
NameMapname
CategoryConstantGroup
TypeConstantCyberArk Privileged Cloud - Privileged Data
Display NameMapname
Short nameMapid
Logical KeyMapname
DescriptionMapdescription
privilegeddatatypeMaptype
safeMapurnietfparamsscimschemascyberark10PrivilegedData_safe
propertieskeyMapurnietfparamsscimschemascyberark10PrivilegedData_properties_key

Users to Containers (Safes) – Resource Assignments

Parameters:

TabParameterValue
GeneralURLContainerPermissions
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Resource business keyExpressionuser_value != null ? container_value : null
Account – business keyExpressionuser_value != null ? user_value : null
DescriptionExpressioncontainer_display + " -> user: " + user_display
rightsMaprights
assignmentIdConstantid

Users to Groups (Roles) – Resource Assignments

Parameters:

TabParameterValue
GeneralURLGroups
GeneralCollectionResources
GeneralFiltertype != "Group"
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
Resource business keyMapid
Account – business keyExpression(members_ref != null && members_ref.ToString().Contains("Group")) ? null : members_value
DescriptionExpressiondisplayName + " -> user: " + members_display

Groups assigned to Groups – Resource parent/child

Parameters:

TabParameterValue
GeneralURLGroups
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
IndirectConstantfalse
Parent resource business keyExpression(members_ref != null && members_ref.ToString().Contains("Group")) ? id : null
Child resource – business keyExpression(members_ref != null && members_ref.ToString().Contains("Group")) ? members_value : null

Privileged data assigned to Containers – Resource parent/child

Parameters:

TabParameterValue
GeneralURLContainers
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
IndirectConstantfalse
Parent resource business keyExpression(privilegedData_ref != null) ? privilegedData_value : null
Child resource – business keyExpression(privilegedData_ref != null) ? id : null

Containers assigned via Groups – Resource parent/child

Parameters:

TabParameterValue
GeneralURLContainerPermissions
GeneralCollectionResources
Advancedhttp verbGET

Mappings:

DestinationOperatorSource
IndirectConstantfalse
Parent resource business keyExpressiongroup_value != null ? container_value : null
Child resource – business keyExpressiongroup_value != null ? group_value : null

Account rules

The CyberArk Privileged Cloud connectivity includes the ownership and classification account rules.

Ownership rule

The account owner is set to the identity where the Identity's unique ID value of the identity matches the Account UID value of the account.

FieldValue
TypeIdentity lookup
Join reasonExact Match
Account attributeAccount UID
Identity attributeIdentity’s unique ID

Classification rule

If an account with the account attribute Identity join reason equals Exact Match, the account type is set to Persona.

FieldValue
Account typePersonal
Scope attributeIdentity join reason
Scope operatorEquals
Scope valueExact Match

Before enabling provisioning and after the initial import, perform the following actions:

RoPE configuration

  1. Open the RoPE configuration file:

    • On-prem: \Omada Identity Suite\Role and Policy Engine\Service\ConfigFiles
    • Cloud: In the Cloud Management Portal, navigate to Environments. In the environment row, from the drop-down menu, select Configure. Choose the RoPE configuration tab.
  2. Add the following lines under the Attribute Value Resolver extension (change the key value in case you already have that specific key defined):

<add key="5" extraInfo="CyberArk Privileged Cloud - Container" name="assignmentId" value="CYBERARK_ASSIGNMENT_ID" />

Events Definition

For efficient resource provisioning (covering groups, containers and privileged data), create event definitions that trigger create and delete operations.

CyberArk Container and Groups - Create

  1. In Omada Identity, go to Setup > Administration > Process configuration > Event definitions. Click New.

  2. Enter the following details:

    • Name: Provision CyberArk Container (Safe) and Groups
    • Description: When a new resource of type CyberArk Privilege Cloud - Container or CyberArk Privilege Cloud - Group is created, trigger provisioning.
    • Event is triggered when: A new object is created
    • Triggers on objects of type: Resources
  3. Click Apply.

  4. Create a new code method. Click New.

  5. Select Execute code method. Enter the following details and click OK:

  6. Create a new code method. Click New.

  7. Select Execute code method. Enter the following details and click OK:

  8. In the upper left corner, click Filter.

  9. Create a new filter and enter the following details:

  10. Click OK. In the Event definition view, click OK.

CyberArk Container and Groups - Delete

  1. In Omada Identity, go to Setup > Administration > Process configuration > Event definitions. Click New.

  2. Enter the following details:

    • Name: Provision CyberArk Container (Safe) and Groups
    • Description: When a new resource of type CyberArk Privilege Cloud - Container or CyberArk Privilege Cloud - Group is deleted, trigger provisioning.
    • Event is triggered when: A new object is deleted
    • Triggers on objects of type: Resources
  3. Click Apply.

  4. Create a new code method. Click New.

  5. Select Execute code method. Enter the following details and click OK:

  6. In the upper left corner, click Filter.

  7. Create a new filter and enter the following details:

  8. Click OK. In the Event definition view, click OK.

CyberArk Privileged Data - Create

  1. In Omada Identity, go to Setup > Administration > Process configuration > Event definitions. Click New.

  2. Enter the following details:

    • Name: Provision CyberArk Privileged Data
    • Description: When a new resource of type CyberArk Privilege Cloud - Privileged Data is created, trigger provisioning.
    • Event is triggered when: A new object is created
    • Triggers on objects of type: Resources
  3. Click Apply.

  4. Create a new code method. Click New.

  5. Select Execute code method. Enter the following details:

  6. In the template field, enter the following value and click OK: [C_CYBERARK_PLATFORMID]-[C_CYBERARK_USERNAME]-[C_CYBERARK_ADDRESS]

  7. Create a new code method. Click New.

  8. Select Execute code method. Enter the following details and click OK:

    note

    To find your targetSystemUid, navigate to your CyberArk system then press Ctrl + right-click. Select Form data uid. Copy the UID and paste it into the targetSystemUid field.

  9. In the upper left corner, click Filter.

  10. Create a new filter and enter the following details:

  1. Click OK. In the Event definition view, click OK.

CyberArk Privileged Data - Delete

  1. In Omada Identity, go to Setup > Administration > Process configuration > Event definitions. Click New.

  2. Enter the following details:

    • Name: Provision CyberArk Privileged Data
    • Description: When a new resource of type CyberArk Privilege Cloud - Privileged Data is deleted, trigger provisioning.
    • Event is triggered when: A new object is deleted
    • Triggers on objects of type: Resources
  3. Click Apply.

  4. Create a new code method. Click New.

  5. Select Execute code method. Enter the following details:

    note

    To find your targetSystemUid, navigate to your CyberArk system then press Ctrl + right-click. Select Form data uid. Copy the UID and paste it into the targetSystemUid field.

  6. In the upper left corner, click Filter.

  7. Create a new filter and enter the following details:

  8. Click OK. In the Event definition view, click OK.

Additional configuration

For provisioning to work correctly, configure the additional elements in Omada Identity.

Creating the Safe property

  1. Go to Setup > Administration > Process configuration > Properties.
  2. Click New and then Reference property. Enter the following details:
    • Name: Safe
    • Description: CyberArk Privileged Cloud attribute
    • System name: C_CYBERARK_SAFE
    • Refers object of type: Resource
    • Control type: Lookup (single value)
  3. In the upper left corner, click Edit lookup view.
  4. Click Expressions field and then New. Enter the following details:
    • Left side: Resource Type
    • Inner operator: in
    • Right side: CyberArk Privileged Cloud – Container

Adding values to the PlatformId property

  1. Go to Setup > Administration > Process configuration > Properties.
  2. Go to the PlatformId property and click it. In the upper left corner, select the Values field.
  3. Add the platform IDs available in your CyberArk system.

Adding values to the Type property

  1. Go to Setup > Administration > Process configuration > Properties.
  2. Go to the Type property and click it. In the upper left corner, select the Values field.
  3. Add the types available in your CyberArk system.

Adding expression to the CyberArk Rights property

  1. Go to Setup > Administration > Process configuration > Properties.
  2. Go to Cyberark Rights and click it. In the upper left corner, select Edit lookup view.
  3. Click Expressions > New. Enter the following details:
    • Left side: Resource Type
    • Inner operator: in
    • Right side: CyberArk Privileged Cloud – Rights

Adding fields to the Resources form

  1. Go to Setup > Master data > Resources. Click New.
  2. Use CRTL + right button and then choose Form designer.
  3. Click New section > Fields > Name: CyberArk Privileged Cloud.

Configuring the Resources data object type

  1. Go to Setup > Administration > Process Configuration > Data object types.
  2. Search the Resource (id 52) object. Click Properties.
  3. Add the following properties:
    • C_CYBERARK_PLATFORMID
    • C_CYBERARK_SECRET
    • C_CYBERARK_ADDRESS
    • C_CYBERARK_USERNAME
    • C_CYBERARK_TYPE
    • C_CYBERARK_SAFE
  4. Select the Type form: Resource > Section: CyberArk Privileged Cloud.