Study guide

6.4 Bulk Onboarding: Password Upload Utility, Bulk Upload REST API & AccountUploader

CyberArk Defender - PAM PAM-DEF

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: Vault Architecture, Network & Security

1.1 CyberArk PAS Core Architecture & Component Topology 1.2 Vault OS Hardening, Network Isolation & Port Requirements 1.3 Vault Cryptography, Encryption Keys & Master User Recovery

2 Chapter 2: Vault Configuration, Administration & CLI Utilities

2.1 Vault Server Configuration Files & DBParm.ini Tuning 2.2 Vault Administrative Utilities & PARClient Commands 2.3 Event Notification Engine (ENE) & Notification Administration

3 Chapter 3: Password Vault Web Access (PVWA) Administration

3.1 PVWA Web Portal Architecture & Interface Configuration 3.2 PVWA REST API Administration & Lifecycle Automation 3.3 PVWA Security Settings, User Access & Session Timeouts

4 Chapter 4: Central Policy Manager (CPM) Architecture & Operations

4.1 CPM Service Architecture, Logs & Multi-CPM Load Distribution 4.2 The Credential Management State Machine: Change, Verify & Reconcile 4.3 CPM Plug-in Architecture, Process/Prompts Files & Custom Plug-in Troubleshooting 4.4 Loosely Connected Devices: Rotating Laptop & Workstation Credentials

5 Chapter 5: Safe Design, RBAC & Account Governance

5.1 Enterprise Safe Architecture & Naming Conventions 5.2 Safe Permissions, Authorizations & Safe Handler Delegation 5.3 Object Versioning, Retention Policies & Storage Quotas 5.4 Mandatory Account Properties, Account Types & Linked Accounts 5.5 Vault Users, Predefined Groups & Vault-Level Authorizations

6 Chapter 6: Account Discovery & Lifecycle Workflows

6.1 Automated Account Discovery, Detection Rules & Pending Accounts 6.2 Dual Control Workflows, Multi-Level Approvals & Master Approver 6.3 Exclusive Access, One-Time Passwords (OTP) & Check-out Automation 6.4 Bulk Onboarding: Password Upload Utility, Bulk Upload REST API & AccountUploader

7 Chapter 7: Master Policy & Platform Management

7.1 Master Policy Framework & Enterprise Compliance Rules 7.2 Platform Architecture, Settings Tree & Platform Duplication 7.3 Platform Policy Overrides, Advanced Settings & Target Tuning

8 Chapter 8: Privileged Session Manager (PSM) Core Architecture

8.1 PSM Architecture, Jump Host Isolation & Service Accounts 8.2 PSM Connection Components (PSM-RDP, PSM-SSH, PSM-Web) 8.3 PSM Universal Connector Framework & Custom Integrations 8.4 Split Workflow: Separating Session Use from Credential Retrieval

9 Chapter 9: PSMP, HTML5 Gateway & Session Security

9.1 PSM for SSH (PSMP) Architecture & Unix Proxy Brokering 9.2 PSM HTML5 Gateway Architecture & Clientless Web Access 9.3 Session Recording, Storage in Recordings Safes & Vault Retention 9.4 CyberArk Remote Access (Vendor PAM): Administering Third-Party Privileged Access

10 Chapter 10: Live Session Auditing, Reporting & Privileged Threat Analytics

10.1 Live Session Monitoring, Shadowing & Active Termination 10.2 Privileged Threat Analytics (PTA) Behavioral Anomaly Detection 10.3 PTA Automated Incident Response & SIEM Integration (CEF/Syslog) 10.4 Vault Reports, Report Authorizations & the Export Vault Data (EVD) Utility

11 Chapter 11: Application Access Manager (AAM) & Secrets Management

11.1 AAM Credential Provider (CP) Architecture & Local Memory Cache 11.2 Central Credential Provider (CCP) & Web Service Integration 11.3 Application Server Credential Provider (ASCP) & Application Authentication (AppID) 11.4 Conjur Secrets Manager & Cloud-Native DevOps Workflows

12 Chapter 12: Directory Integration, Disaster Recovery & Troubleshooting

12.1 Directory Integration: LDAP Mapping, RADIUS MFA & SAML 2.0 SSO 12.2 Disaster Recovery (DR) Vault & PADR Replication Architecture 12.3 Vault Backup Operations with PAReplicate & Safe Recovery 12.4 Diagnostic Procedures, Vault/CPM/PSM Error Codes & System Recovery

6.4 Bulk Onboarding: Password Upload Utility, Bulk Upload REST API & AccountUploader

Key Takeaways Explain This Topic AI

The Password Upload utility creates accounts from a prepared CSV and can build the Vault environment as it runs, creating Safes, adding the CPM user as a Safe owner, and sharing the Safe with the PVWA.

The bulk upload of accounts REST API returns an upload ID that is polled for per-account results, and requires Add accounts, Update account content, and Update account properties authorization in at least one Safe.

Only platformId and safeName are mandatory for each account object submitted to the bulk upload REST API.

AccountUploader onboards accounts whose secret is an SSH private key file, is supported on Linux, and ships as part of the PSM for SSH installation package rather than with the CPM or Vault.

SSH keys already stored in the Vault are not rediscovered, so keys added through the PVWA, the Accounts Feed, or AddAccount will not reappear in the Pending Accounts list.

Last updated: September 2026

6.4 Bulk Onboarding: Password Upload Utility, Bulk Upload REST API & AccountUploader

Quick Answer: Discovery finds accounts, but large migrations still need a way to create thousands of account objects from a list an organization already holds. CyberArk offers three bulk paths, and the exam expects you to pick the right one. The legacy Password Upload Utility is a command-line tool that reads a prepared CSV and can build the Safe environment as it goes. The modern bulk upload of accounts REST API posts an accountsList to the PVWA and returns an upload ID you poll for per-account results. AccountUploader is a separate Linux utility shipped with the PSM for SSH installation package, and it is the one designed to onboard accounts whose secret is an SSH private key file .

Why Bulk Onboarding Exists Alongside Discovery

Sections 6.1 through 6.3 covered the discovery-driven path: the CPM Scanner sweeps the network, populates Pending Accounts , and onboarding rules or an administrator promote those accounts into production Safes. That path is ideal for accounts nobody has inventoried.

Bulk onboarding solves the opposite problem — the organization already knows the accounts, typically because they are being migrated out of a spreadsheet, a retiring password manager, a CMDB export, or a competitor PAM product. Re-discovering them would be slower and would lose the curated metadata (owner, environment, ticket reference) the existing inventory already carries. Bulk upload also covers targets discovery cannot reach at all, such as network appliances on an isolated management VLAN.

Method 1: The Password Upload Utility

The Password Upload utility works with the Password Vault to create accounts from a passwords list and store them in the Vault, making an initial implementation dramatically faster. It is run from a command line whenever an upload is required, reading a pre-prepared file of passwords and their properties.

Its distinguishing capability is that it creates the required Vault environment when necessary . Rather than failing because a destination Safe does not exist, it will:

  • Create new Safes named in the file,
  • Add the CPM user as a Safe owner so the new accounts become manageable immediately, and

Share the Safe with the Password Vault Web Access so the accounts are visible in the PVWA.

The input file is a CSV whose first line is the header describing the columns. A representative header and record look like this: Password_Name,TemplateSafe,CPMUser,Safe,Folder,Password,DeviceType,PolicyID,UserName,Address,CPMDisabled,ResetImmediately

Operating System-UnixSSH-1.1.1.250-Root,ExclusivePasswordsTemplate,PasswordManager,UnixPasswords,Root,asdf,Operating System,UnixSSH,Root,1.1.1.250,,NO_VALUE

Key columns to recognize on sight:

Column Meaning

Password_Name The object name the account will carry in the Safe.

TemplateSafe An existing Safe whose properties and ownership are copied when a new Safe must be created.

CPMUser The CPM user (for example PasswordManager ) added as Safe owner so rotation can begin.

Safe / Folder Destination Safe and folder for the object.

DeviceType / PolicyID The device type and platform (for example Operating System / UnixSSH ) that bind the account to its rotation policy.

UserName / Address The mandatory account properties identifying the target identity and host.

CPMDisabled Set to suspend automatic management for the uploaded object.

ResetImmediately Forces an immediate change after upload instead of waiting for the expiration period.

The literal token NO_VALUE is used to explicitly blank a column rather than inherit a default — a detail that trips up candidates who assume an empty cell and NO_VALUE are equivalent.

Method 2: The Bulk Upload of Accounts REST API

Modern deployments prefer the REST path because it is scriptable, idempotent to re-run, and returns structured per-account results. Three endpoints form the workflow:

Create bulk upload of accounts — posts a payload containing an accountsList array. The response contains the ID of the bulk account upload .

Get all bulk account uploads for user — checks the status of every bulk upload a user has performed.

Get bulk account upload result — returns the summary for a specific upload: which accounts succeeded and which failed, with reasons.

Each object inside accountsList carries the account parameters. Only two are mandatory:

platformId — a valid platform ID such as WinServerLocal .

safeName — the destination Safe.

Optional members include username , address , secret (a password or a private SSH key ), platformAccountProperties as key-value pairs defined by the platform, secretManagement.automaticManagementEnabled (default true ), and remoteMachinesAccess .

Authorization is the exam-relevant constraint: the caller must hold Add accounts , Update account content , and Update account properties authorization in at least one Safe. A service identity that can only add accounts will be rejected before a single object is created.

Because the API is asynchronous, the correct operational pattern is: submit, capture the ID, then poll the result endpoint — not assume success from the HTTP 200 on submission.

Method 3: AccountUploader for SSH Keys

SSH keys can be provisioned in the Vault manually through the PVWA, automatically through the Accounts Feed onboarding wizard, through the AddAccount web service, or with the AccountUploader utility. The utility exists because an SSH key account's secret is a file , not a typed string, and bulk CSV columns do not carry private key material well.

Facts worth memorizing about AccountUploader :

It is included as part of the PSM for SSH installation package — not the CPM, Vault, or PVWA installer.

It is supported on Linux , and is run from a local Unix machine.

Two files are copied to the run directory: AccountUploader and icudt42l.dat .

  • Its usage is: accountuploader -VaultFile VaultFile -CredFile CredFile -SafeName SafeName \
  • KeyFile KeyFile -DeviceType DeviceType -PolicyId PolicyId \
  • Address Address -UserName UserName [-SubnetMask SubnetMask] [-ObjectName ObjectName]

-KeyFile points at the private key being onboarded; -VaultFile and -CredFile supply the Vault connection and the credential file identifying the uploading user, exactly as they do for the Vault's other command-line utilities.

One discovery interaction is commonly tested: SSH keys that already exist in the Vault are not rediscovered. Keys added through the PVWA, onboarded via the Accounts Feed, or provisioned with AddAccount will not reappear in Pending Accounts. Re-running the CPM Scanner against keys that are still pending refreshes their details so the Pending Accounts list reflects current state.

Choosing the Right Tool

Situation Correct mechanism

Migrating thousands of password accounts and the destination Safes do not exist yet Password Upload Utility (creates Safes, adds the CPM user, shares with PVWA)

Automating onboarding from a pipeline or CMDB with structured success/failure reporting Bulk upload of accounts REST API

  • Onboarding Unix accounts whose secret is a private SSH key file, from a Linux host AccountUploader
  • Accounts nobody has inventoried yet CPM Scanner discovery plus onboarding rules (section 6.1)

Loading diagram... Bulk Onboarding Paths Compared to Discovery-Driven Onboarding