Safeguard Docs
Credentials VaultProviders

BeyondTrust Password Safe

Read scan credentials from BeyondTrust Password Safe through its public API, with a password request per scan that is checked in when the scan ends.

BeyondTrust Password Safe

Reference

pam://beyondtrust/<SystemName>/<AccountName>

Example: pam://beyondtrust/web-prod-01/svc_dast.

How a read works

  1. POST Auth/SignAppin with Authorization: PS-Auth key=<api_key>; runas=<run_as>;.
  2. GET ManagedAccounts?systemName=...&accountName=... finds the system and account ids.
  3. POST Requests opens a release request for duration_minutes, with reason as the request reason. If a request for that account is already open (409), it is reused.
  4. GET Credentials/<requestId> returns the password.
  5. When the scan ends: PUT Requests/<requestId>/Checkin for every request the runner opened, then POST Auth/Signout.

A second read of the same account in one scan (a DAST re-login) reuses the open request.

What the BeyondTrust administrator prepares

  • An API registration for Safeguard, with authentication rules limited to the runner's address, and its API key.
  • A run-as user that may request the scan managed accounts, with no approval step for this user.
  • The scan accounts managed by Password Safe, with a release duration that covers a scan.

Runner configuration

providers:
  - type: beyondtrust
    url: https://pws.example.internal/BeyondTrust/api/public/v3
    api_key: file:///etc/safeguard/bt-api-key
    run_as: svc-safeguard
    reason: Safeguard scan
    duration_minutes: 120
    ca_cert: /etc/safeguard/internal-root-ca.pem

If a scan stops before it ends cleanly (the machine loses power), the request is not checked in and stays open until its duration ends.

On this page