For the complete documentation index, see llms.txt. This page is also available as Markdown.

CyberArk Import

Migrating CyberArk Accounts to Keeper

Keeper Commander will log on to CyberArk Privilege Cloud Web Portal or the self-hosted Password Vault Web Access (PVWA), retrieve accounts and their passwords, and automatically create corresponding Server records in Keeper.

keeper import --format=cyberark server.domain

If the server is a CyberArk Privilege Cloud Web Portal, i.e., it ends in ".cyberark.cloud," then it will prompt for the CyberArk Identity Tenant ID and CyberArk Service User credentials

When importing from CyberArk Privilege Cloud, Commander detects the Identity tenant and asks which authentication method to use.:

If the server is any other hostname or IP address, then it will prompt for the authentication method, username, and password for PVWA:

For self-hosted CyberArk PVWA, Commander first asks whether a client certificate is required.

ℹ️ Use LDAP (not Windows) to log in with an Active Directory account

CyberArk Accounts based on Platforms in the Windows and *NIX groups will be imported as Server records. Accounts based on the Business Website platform, i.e., CyberArk Workforce Password Management Accounts, will import as Login records.

Selecting Safes

After successful authentication, Commander asks which Safes to import.

Enter one or more Safe names separated by commas:

Leave the prompt blank to let Commander get the Safe list from CyberArk.

Nested Share Folder Support

CyberArk import now supports Nested Share Folders.

With --nsf, CyberArk Safes are imported as Keeper Nested Share Folder paths, and records are placed into the matching Safe folder.

Optional Client Certificate

For self-hosted CyberArk PVWA environments that require a client certificate, set the P12/PFX path and password before running the import.

If _CYBERARK_CLIENT_CERT_P12 is not set, Commander prompts for a P12 path. Leave the prompt blank if a client certificate is not required.

Keeper Enterprise Provisioning

When the import is run by a Keeper Enterprise admin, Commander can also create Keeper access objects from CyberArk users and groups.

CyberArk object
Keeper object

CyberArk user group

Keeper Team

CyberArk user group

Keeper Role

CyberArk user with a valid email

Keeper user invitation

CyberArk group membership

Keeper Role assignment

Existing Keeper Teams, Roles, and users are skipped instead of duplicated.

Use --target-node or --node to place new Teams, Roles, and users in a specific Keeper Enterprise node.

To import records only and skip Keeper Team, Role, and user provisioning:

Non-Interactive Import

For automation, set the required values before running the command.

--dry-run previews the Keeper record import. If you also want to prevent Keeper Team, Role, and user provisioning during testing, set _CYBERARK_SKIP_TEAMS=true.

Additional Environment Variables

Variable
Purpose

_CYBERARK_LOGON_TYPE

CyberArk logon type for self-hosted PVWA.

_CYBERARK_USERNAME

CyberArk username for self-hosted PVWA.

_CYBERARK_PASSWORD

CyberArk password for self-hosted PVWA.

_CYBERARK_SAFES

Comma-separated Safes to import.

_CYBERARK_ASSUME_YES

Skip confirmation when set to true, yes, or 1.

_CYBERARK_SKIP_TEAMS

Skip Keeper Team, Role, and user provisioning.

_CYBERARK_SKIP_ROLES

Skip Keeper Role creation.

_CYBERARK_SKIP_CREATE_USERS

Skip Keeper user invitations and Role assignments.

_CYBERARK_CLIENT_CERT_P12

Optional P12/PFX client certificate path.

_CYBERARK_CLIENT_CERT_PASSWORD

Optional P12/PFX passphrase.

_CYBERARK_CA_BUNDLE

Optional CA bundle for self-hosted PVWA TLS verification.

KEEPER_CYBERARK_USERNAME

CyberArk Privilege Cloud username or client ID.

KEEPER_CYBERARK_PASSWORD

CyberArk Privilege Cloud password or client secret.

KEEPER_CYBERARK_AUTH_METHOD

CyberArk Privilege Cloud authentication method.

Membership Download

CyberArk Safe membership can be downloaded to a Keeper membership file.

Then apply the membership file:

Use --folders-only to download only Safe-to-folder membership:

Importing Accounts

The process will list the Accounts to be imported, including the ID, Name, and Safe. It will also show a progress meter with a timer and ETA. If password retrieval fails for an Account, a Retry, Skip, or Skip All dialog is presented. The process can retry the request, skip the Account, or skip all Accounts that trigger the same HTTP status.

A dialog resulting from a 400 (Bad Request) HTTP response from the password API endpoint.

Skipped Accounts

The skipped Accounts will be listed after processing is complete. The list includes the ID, Name, Safe, and the Error code and message.

Using a search string to limit the imported Accounts

The process will import all Accounts by default; however, appending a question mark (?) followed by the search string will limit processing to Accounts that match the search.

Using a custom query string

Alternatively, if the search string contains '=', the process will pass it to the CyberArk Get Accounts endpoint as a query string. E.g.,

passes the limit and offset parameters to the Accounts endpoint, causing it to page the accounts 10 at a time, starting at the 20th account.

PowerShell Method

The end-user guide includes a process to import data into Keeper from Cyberark using a PowerShell script. Note, however, that it accesses the Vault server directly, so it only works on self-hosted servers.

Last updated