Safeguard Docs
Credentials Vault

Supported PAM providers

The PAM and secret-store products Safeguard reads scan credentials from, the reference format for each, and how each one signs in.

Supported PAM providers

A "From your PAM vault" entry names a provider and a reference inside it. The runner or CLI that runs the scan asks that provider for the value, using the connection settings in its local provider file.

ProvidertypeReferenceRunner signs in withSetup
ARCON PAMarconpam://arcon/<TargetType>/<ServerIp>/<UserName>API user and key (token request), optional client certificateARCON PAM
CyberArk Central Credential Provider (CCP)cyberark-ccppam://cyberark-ccp/<AppID>/<Safe>/<Object>Client certificate for the Application IDCyberArk
CyberArk Conjurcyberark-conjurpam://cyberark-conjur/<variable-id>Host API key, or a JWT authenticatorCyberArk
HashiCorp Vaulthashicorp-vaultvault://<mount>/<path>#<key>Token, AppRole or KubernetesHashiCorp Vault
Delinea Secret Serverdelineapam://delinea/<secretId>/<fieldSlug>OAuth2: application account and password, or client credentialsDelinea Secret Server
BeyondTrust Password Safebeyondtrustpam://beyondtrust/<SystemName>/<AccountName>API registration key and run-as userBeyondTrust
Azure Key Vaultazure-key-vaultpam://azure-key-vault/<vault>/<secret>[/<version>]App registration or managed identityAzure and AWS
AWS Secrets Manageraws-secrets-managerpam://aws-secrets-manager/<secret-id>[#json-key]The machine's default AWS credential chainAzure and AWS
Any PAM with an HTTP API (REST connector)restpam://<name>/<key>=<value>/...Whatever the API needs: token step, API key header, BasicREST connector
Environment variable or filenoneenv://NAME, file:///absolute/pathNothing: read on the machineEnvironment and file

The REST connector page has a worked configuration for ManageEngine PAM360, written from its public API documentation. Test it with safeguard secrets test against your instance before relying on it. For Delinea Secret Server, use the delinea type: it needs fewer settings than a REST connector recipe.

Reference rules

  • sgvault://<handle> (also written pam://safeguard/<handle>) points at an entry in the credentials vault, whichever kind it is. This is what the app's From the vault button inserts, and it is the recommended form: the platform audit trail then names the entry.
  • A reference can name a configured provider instead of its type, for example pam://ccp-prod/<AppID>/<Safe>/<Object> when ccp-prod is a provider of type cyberark-ccp in the provider file. Use this when you have two instances of one product.
  • #password (the default) or #username picks which field to read, for ARCON PAM, CyberArk CCP, Delinea, the REST connector and sgvault://. HashiCorp Vault and AWS use #<key> to pick a key of the secret.
  • Characters that are not letters, digits, -, . or _ in a path part are percent-encoded, for example a CCP folder Root\Apps is ?folder=Root%5CApps.
  • A value is treated as a reference only when the whole value is one. Any other value is used exactly as typed.
  • If a reference cannot be read, the scan does not start. Safeguard never falls back to sending the reference text as the credential.

What every provider does the same way

  • TLS certificate verification is on, with your own CA through ca_cert. A plain http:// address is refused unless it points at the runner machine itself (a local Vault agent, for example) or the provider sets allow_http: true.
  • Secrets the runner needs to sign in (API keys, AppRole secret ids, client secrets, tokens) are written in the provider file as env://NAME or file:///path, never inline.
  • A dropped connection, a timeout, a 429 or a 5xx answer is retried (retries, default 2). Authentication, permission and not-found answers are not.
  • allowed_refs limits which references the runner reads from that provider.
  • Every read is recorded on the platform and in the runner's local audit file. See Audit.

On this page