Skip to main content

Vault Onboarding

Requires Enterprise edition.

The Not in PAM Tool KRI and its findings list privileged accounts that no vault knows about. Vault Onboarding puts them in the vault for you: it adds each account to a safe, on a platform that has password rotation switched on, so the vault's password manager (CPM) takes the password over. It works with CyberArk (self-hosted and Privilege Cloud), Delinea Secret Server and BeyondTrust Password Safe.

Because it writes to your vault, it is deliberately cautious. Nothing is written until an administrator turns it on and sets rules, every batch is checked against the vault first, and a second person must approve each batch before an administrator applies it.

How it works​

  1. Rules decide where each account goes. An account that matches no rule is never touched.
  2. A batch freezes a set of accounts and checks each one against the vault, read-only. Nothing is written.
  3. A different IAM Governance Manager or Administrator approves the batch.
  4. An administrator applies it. Each account is checked again just before it is written.
  5. If needed, an administrator rolls back the accounts the batch created.

You never need the account's password​

OrbisID does not know the passwords of the accounts it onboards and never asks for them. The account is added to the vault without a password and flagged for the vault to reconcile: CPM sets a new password through the platform's reconcile account. This is why the platform you choose must change passwords automatically and allow reconciliation, and why a reconcile account must be linked to it in the vault. An account on a platform that cannot do this is shown as Blocked with the reason, and is never written.

Where accounts go in each vault​

CyberArkDelinea Secret ServerBeyondTrust Password Safe
Rule's Safe fieldA safeA folder path, such as Servers\WindowsA managed system, by name
Rule's Platform fieldA platform ID (case sensitive)A secret template, by name or numeric IDThe platform the managed system must be on, by name or numeric ID
The passwordThe vault takes it over by reconcile; no password is sentA one-off random password is set, then Secret Server changes and checks itNo password is sent; Password Safe changes and tests it through the managed system's functional account
Settings on the systemThe write credentialThe write credential, and a tick to confirm Secret Server can reset passwordsThe write credential, and the application API key

See the CyberArk and Delinea Secret Server and BeyondTrust pages for what each vault needs.

Setting it up​

Open Systems, find the CyberArk, Secret Server or Password Safe system and choose Vault onboarding (an administrator; managers see only batches).

Settings

SettingDescription
Vault onboarding enabledThe switch. Nothing is planned or written until it is on
Write credentialA credential that can add accounts to the target safes and delete the ones OrbisID created. Separate from the scan credential. For Privilege Cloud, set the credential's Domain to your Identity tenant
Most accounts per batchDefault 25, at most 100
Stop after failuresA run stops after this many failures (default 3) and leaves the rest untouched

Rules are checked in order and the first match wins. Each has:

FieldDescription
SystemsMatches the host name of the system the account is on; * and ? work
AccountsMatches the account name; * and ? work
Risk levelThe account's risk level must be at least this
Only accounts that have an ownerThe account's linked identity, else its system's owner
Safe / folder / managed systemThe safe (CyberArk), folder (Secret Server) or managed system (Password Safe) to add to. May use {system} (the host name), {owner} and {risk}
Platform / templateThe platform ID, which is case sensitive (CyberArk), the template name or ID (Secret Server), or the platform the managed system must be on (Password Safe)

The safe, folder or managed system and the platform or template must already exist: OrbisID never creates them. A CyberArk safe name is cut to 28 characters and characters the vault does not allow in a safe name are replaced with _; spaces are kept. A missing safe or platform makes the account Blocked.

Candidates and batches​

Candidates lists every privileged, enabled account that no vault entry is linked to, and what your rules would do with it. Select accounts, or create a batch of the highest-risk ones. An account already waiting in a batch is not offered again.

Creating a batch checks each account in the vault and gives it a status:

StatusMeaning
Will be writtenThe safe exists, the platform is active, allows the safe, rotates passwords and allows reconciliation, and the account is not already in the vault
BlockedThe reason is shown: for example the safe does not exist, the platform does not rotate passwords, or the platform does not allow this safe
Already in vaultThe account is in the vault already, in any safe. It is not added again

If the vault cannot be reached, no batch is created.

Approving and applying​

A batch waits for approval for 24 hours from creation, then expires. Someone other than the person who created it, an active IAM Governance Manager or Administrator, opens it under Batches and approves it. The creator cannot approve their own batch.

An administrator then applies it. It runs in the background. For each account OrbisID checks again that it is still unvaulted and that the vault still accepts it, then adds it to the vault and flags it for reconcile. If flagging reconcile fails, the account just added is removed again, so no half-onboarded account is left. The run stops after the configured number of failures, and a batch applies only once. Every write is recorded against the account, with the vault's own account ID, and in the audit log.

Account statusMeaning
OnboardedAdded to the vault
FailedThe vault refused it; the reason is shown
Not attemptedThe run stopped before reaching it
Skipped (changed)It was no longer an unvaulted privileged account when the batch was applied

Rolling back​

Roll back on a finished batch deletes from the vault the accounts that batch created. Accounts that were already in the vault, and anything OrbisID did not create, are not touched.

After onboarding​

OrbisID does not link the new vault entry itself. Scan the CyberArk system again: the account is picked up with the vault's other accounts and your PAM linking rules link it, which clears it from the Not in PAM Tool KRI.

Who can do what​

ActionRole
Set up, preview, create, apply, cancel and roll backAdministrator
View batches and approve themIAM Governance Manager and above, other than the batch's creator