Introduction Ask Anything

BeyondInsight and Password Safe API

SignIn (OAuth)SignOut Token (OAuth)

BeyondInsight-Access Levels

Set Access Level for a User Group Smart Rule Access Levels

BeyondInsight-Address Groups

Addresses by ID Addresses by ID Addresses by ID Address Group by ID Address Group by ID Address Groups by ID Addresses by Address Group ID Addresses by Address Group ID Address Groups by Organization ID Address Groups Address Groups Addresses by Address Group ID Address Group by Name

BeyondInsight-API Registrations

API Registration for ApiAccessPolicy API Registration by ID for ApiAccessPolicy API Registration by ID Retrieve API Key API Registrations Rotate API Key API Registration by ID

BeyondInsight-Assets

Asset by Workgroup Name and Asset Name Asset by ID Asset by ID Asset by Workgroup Name Asset by Smart Rule ID Asset by Workgroup ID Asset by Workgroup Name and Asset Name Asset by ID Assets by Workgroup ID Assets Search

BeyondInsight-Asset Attributes

Delete Asset Attribute by Asset ID and Attribute ID Asset Attributes by Asset ID Assigns Attribute to an Asset Delete All Asset Attributes by Asset ID

BeyondInsight-Attribute Types

Get Attribute Type by ID Delete Attribute Type by ID List of Attribute Types Create Attribute Type

BeyondInsight-Attributes

Create Attribute by Attribute Type ID Get Attribute by ID Delete Attribute by ID List Attributes by Attribute Type ID

BeyondInsight-Configuration

BeyondInsight-Databases

List Databases List Databases by Asset ID Database by ID Delete Database by ID Update Database by ID Create Database in the Asset by Asset ID

BeyondInsight-Entitlements

Get Entitlements by Group IDs

BeyondInsight-Imports

BeyondInsight-Operating Systems

List Operating Systems

BeyondInsight-Organizations

Organization by Name Organization by ID

BeyondInsight-Permissions

List of Permissions List of Permissions of a User Group by ID Assign Permissions for a User Group by ID Delete Permissions of a User Group by ID

BeyondInsight-Smart Rules

Get Smart Rule by Title Delete a Smart Rule by Org ID and Title Delete a Smart Rule by ID List of Smart Rules by User Group ID Create an Asset Smart Rule for Filtering Assets by Attributes Get Smart Rule by Org ID and Title Delete a Smart Rule by Title Process a Smart Rule by ID Get Smart Rule by ID

BeyondInsight-User Groups

Get a User Group by Name Create a User Group LDAPDirectory-Type Delete a User Group by ID Get a User Group by ID Delete a User Group by Name

BeyondInsight-User Group Memberships

Get User Group Memberships of a User Remove User from a User Group Assign User to a User Group

BeyondInsight-User Audits

List of User Audit Details by Audit ID List of User Audits

BeyondInsight-Users

Create a User Application-Type Update an Application User by ID Create User in BeyondInsight-Type User Group Quarantine User by ID Rotate Client Secret for Application User Delete a User by ID List of All Users List of Users by User Group ID Get a User by ID

BeyondInsight-Workgroups

Get a Workgroup by Name Create a Workgroup Get a Workgroup by ID

Password Safe-Access Policies

Tests Access to a Managed Account List of Access Policies

Password Safe-Aliases

Get Managed Account Aliases by Name Get Managed Account Aliases by ID

Password Safe-Applications

Get an Application by ID List of Applications

Password Safe-Attributes

Delete a Managed System Attribute by Managed System ID and Attribute ID Delete all Managed System Attributes by Managed System ID Assign an Attribute to a Managed System Delete a Managed Account Attribute by Managed Account ID and Attribute ID Assign an Attribute to a Managed Account List of Attributes by Managed Account ID Delete all Managed Account Attributes by Managed Account ID List of Attributes by Managed System ID

Password Safe-Credentials

Retrieve Credentials for an Approved and Active Request Retrieve Alias Credentials for an Approved and Active Request

Password Safe-Custom Platforms

List of Custom Platforms Export a Custom Platform by ID Import a Custom Platform Get a Custom Platforms by ID

Password Safe-Directories

Create a Directory in a Workgroup by Workgroup ID List of Directories Get a Directory by ID Update a Directory by ID Delete a Directory by ID

Password Safe-Oracle Internet Directories

List of Oracle Internet Directories Test Connection to an Oracle Internet Directory by ID Get an Oracle Internet Directory by ID Query DB Services for an Oracle Internet Directory by ID List of Oracle Internet Directories by organization ID

Password Safe-DSS Key Policies

Get a DSS Key Rule by ID List of DSS Key Rules

Password Safe-Entity Types

List of Entity Types

Password Safe-Functional Accounts

Create a Functional Account Get a Functional Account by ID Delete a Functional Account by ID List of Functional Accounts

Password Safe-Information Systems Administrator (ISA)

ISA Return RDP Session ISA Release Request and Return Session

Password Safe-Keystrokes

List of Keystrokes by Session ID Search for Keystrokes Get a Keystroke by ID

Password Safe-Linked Accounts

Link a Directory Managed Account to Managed System by ID Unlink All Directory Managed Accounts from Managed System by ID List of Linked Directory Managed Accounts by Managed System ID Unlink a Directory Managed Account from Managed System by ID

Password Safe-Managed Accounts

Get a Managed Account by Managed System ID and Managed Account Name List of Managed Accounts Update a Managed Account by ID Delete a Managed Account by ID Delete All Managed Accounts on the Managed System by ID Delete a Managed Account by Managed System ID and Managed Account Name Create a Managed Account in the Managed System by ID Get a Managed Account by ID

Password Safe-Managed Account Credentials

Update Credentials of a Managed Account by ID Update Credentials of a Managed Account Change Credentials of a Managed Account Test Credentials of a Managed Account Queue Credential Change for all Managed Accounts of a Managed System

Password Safe-Quick Rule Managed Accounts

List of Managed Accounts by Quick Rule ID Delete a Managed Account from Quick Rule Update Managed Accounts in Quick Rule Add a Managed Account to Quick Rule

Password Safe-Smart Rule Managed Accounts

List of Managed Accounts by Smart Rule ID

Password Safe-Managed Account Applications

Unassign an Application from a Managed Account List of applications assigned to a Managed Account Unassign all Application from a Managed Account Assign an Application to a Managed Account

Password Safe-Managed Systems

List of Managed Systems Managed System by Database ID Create Managed System by Database ID Create Managed System by Asset ID Update Managed System by ID Delete a Managed System List of Managed Systems by Workgroup ID Managed System by Asset ID Managed System by ID List of Managed Systems auto-managed by Functional Account Create Managed Systems by Workgroup ID

Password Safe-Quick Rule Managed Systems

List of Managed Systems by Quick Rule ID Remove a Managed System from Quick Rule by ID Add a Managed System to Quick Rule by ID Update List of Managed Systems by Quick Rule ID

Password Safe-Smart Rule Managed Systems

List of Managed Systems by Smart Rule ID

Password Safe-Nodes

Password Safe-Password Policies

List of Password Rules for Password Safe or Secrets Safe Password Rule by ID

Password Safe-Platforms

Platform by ID for Managed Systems List of Platforms for Managed Systems List of Platforms by Entity ID

Password Safe-Propagation Actions

List of Propagation Action Types Propagation Action by ID List of Propagation Actions

Password Safe-Managed Account Propagation Actions

Assign a Propagation Action to Managed Account by ID Unassign a Propagation Action from Managed Account by ID List of assigned Propagation Actions by Managed Account ID Unassign all Propagation Actions from Managed Account

Password Safe-Quick Rules

Quick Rule by Title Create a Quick Rule with the Managed Accounts or Systems by ID and Rule Type Delete a Quick Rule by ID Quick Rule by Organization ID and Rule Title Delete a Quick Rule by Title Quick Rule by ID Delete a Quick Rule by Organization ID and Rule Title

Password Safe-Replay

Control Replay Session Status Create a Replay Session for a specified Session Token Terminate Replay Session Display Replay Session Details

Password Safe-Requests

Create a Release Request List of Requests Create a Release Request using Alias Update Request to Rotate Credentials on Check-In/Expiry Deny/Cancel Active or Pending Request Approve Pending Request Check-In/Release a Request

Password Safe-Request Termination

Terminate all Active Requests by Managed System ID Terminate all Active Requests by Requestor User ID Terminate all Active Requests by Managed Account ID

Password Safe-Request Sets

Lists Request Sets Create Release Request Set

Password Safe-Roles

List of Password Safe Roles

Password Safe-User Group Roles

Remove all Password Safe Roles for the User Group and Smart Rule by ID List of Roles for the User Group and Smart Rule by ID Sets Password Safe Roles for the User Group and Smart Rule by ID

Password Safe-Sessions

List of Sessions Session by ID Create Admin Session Create a Session for the given Release

Password Safe-Session Locking

Locks an Active Session Locks all Active Sessions by Managed System ID Locks all Active Sessions by Managed Account ID

Password Safe-Session Termination

Terminate all Active Sessions by Managed Account ID Terminate an Active Session Terminate all Active Sessions by Managed System ID

Password Safe-Synced Accounts

Unsubscribe/Unsync a Managed Account from the Managed Account by ID List of Subscribed/Synced Managed Accounts by Managed Account ID Subscribe/Sync a Managed Account to the Managed Account by ID

Password Safe Cloud Only-Subscription Delivery

Subscription Delivery by Requested ID List of IDs for all Subscription Deliveries

Secrets Safe-Folders

Delete a Secret Safe Folder by ID Create a Secret Safe Folder List of Secret Safe Folders Get a Secret Safe Folder by ID Update a Secret Safe Folder by ID

Introduction Ask Anything

BeyondInsight and Password Safe API

SignIn (OAuth)SignOut Token (OAuth)

BeyondInsight-Access Levels

Set Access Level for a User Group Smart Rule Access Levels

BeyondInsight-Address Groups

Addresses by ID Addresses by ID Addresses by ID Address Group by ID Address Group by ID Address Groups by ID Addresses by Address Group ID Addresses by Address Group ID Address Groups by Organization ID Address Groups Address Groups Addresses by Address Group ID Address Group by Name

BeyondInsight-API Registrations

API Registration for ApiAccessPolicy API Registration by ID for ApiAccessPolicy API Registration by ID Retrieve API Key API Registrations Rotate API Key API Registration by ID

BeyondInsight-Assets

Asset by Workgroup Name and Asset Name Asset by ID Asset by ID Asset by Workgroup Name Asset by Smart Rule ID Asset by Workgroup ID Asset by Workgroup Name and Asset Name Asset by ID Assets by Workgroup ID Assets Search

BeyondInsight-Asset Attributes

Delete Asset Attribute by Asset ID and Attribute ID Asset Attributes by Asset ID Assigns Attribute to an Asset Delete All Asset Attributes by Asset ID

BeyondInsight-Attribute Types

Get Attribute Type by ID Delete Attribute Type by ID List of Attribute Types Create Attribute Type

BeyondInsight-Attributes

Create Attribute by Attribute Type ID Get Attribute by ID Delete Attribute by ID List Attributes by Attribute Type ID

BeyondInsight-Configuration

BeyondInsight-Databases

List Databases List Databases by Asset ID Database by ID Delete Database by ID Update Database by ID Create Database in the Asset by Asset ID

BeyondInsight-Entitlements

Get Entitlements by Group IDs

BeyondInsight-Imports

BeyondInsight-Operating Systems

List Operating Systems

BeyondInsight-Organizations

Organization by Name Organization by ID

BeyondInsight-Permissions

List of Permissions List of Permissions of a User Group by ID Assign Permissions for a User Group by ID Delete Permissions of a User Group by ID

BeyondInsight-Smart Rules

Get Smart Rule by Title Delete a Smart Rule by Org ID and Title Delete a Smart Rule by ID List of Smart Rules by User Group ID Create an Asset Smart Rule for Filtering Assets by Attributes Get Smart Rule by Org ID and Title Delete a Smart Rule by Title Process a Smart Rule by ID Get Smart Rule by ID

BeyondInsight-User Groups

Get a User Group by Name Create a User Group LDAPDirectory-Type Delete a User Group by ID Get a User Group by ID Delete a User Group by Name

BeyondInsight-User Group Memberships

Get User Group Memberships of a User Remove User from a User Group Assign User to a User Group

BeyondInsight-User Audits

List of User Audit Details by Audit ID List of User Audits

BeyondInsight-Users

Create a User Application-Type Update an Application User by ID Create User in BeyondInsight-Type User Group Quarantine User by ID Rotate Client Secret for Application User Delete a User by ID List of All Users List of Users by User Group ID Get a User by ID

BeyondInsight-Workgroups

Get a Workgroup by Name Create a Workgroup Get a Workgroup by ID

Password Safe-Access Policies

Tests Access to a Managed Account List of Access Policies

Password Safe-Aliases

Get Managed Account Aliases by Name Get Managed Account Aliases by ID

Password Safe-Applications

Get an Application by ID List of Applications

Password Safe-Attributes

Delete a Managed System Attribute by Managed System ID and Attribute ID Delete all Managed System Attributes by Managed System ID Assign an Attribute to a Managed System Delete a Managed Account Attribute by Managed Account ID and Attribute ID Assign an Attribute to a Managed Account List of Attributes by Managed Account ID Delete all Managed Account Attributes by Managed Account ID List of Attributes by Managed System ID

Password Safe-Credentials

Retrieve Credentials for an Approved and Active Request Retrieve Alias Credentials for an Approved and Active Request

Password Safe-Custom Platforms

List of Custom Platforms Export a Custom Platform by ID Import a Custom Platform Get a Custom Platforms by ID

Password Safe-Directories

Create a Directory in a Workgroup by Workgroup ID List of Directories Get a Directory by ID Update a Directory by ID Delete a Directory by ID

Password Safe-Oracle Internet Directories

List of Oracle Internet Directories Test Connection to an Oracle Internet Directory by ID Get an Oracle Internet Directory by ID Query DB Services for an Oracle Internet Directory by ID List of Oracle Internet Directories by organization ID

Password Safe-DSS Key Policies

Get a DSS Key Rule by ID List of DSS Key Rules

Password Safe-Entity Types

List of Entity Types

Password Safe-Functional Accounts

Create a Functional Account Get a Functional Account by ID Delete a Functional Account by ID List of Functional Accounts

Password Safe-Information Systems Administrator (ISA)

ISA Return RDP Session ISA Release Request and Return Session

Password Safe-Keystrokes

List of Keystrokes by Session ID Search for Keystrokes Get a Keystroke by ID

Password Safe-Linked Accounts

Link a Directory Managed Account to Managed System by ID Unlink All Directory Managed Accounts from Managed System by ID List of Linked Directory Managed Accounts by Managed System ID Unlink a Directory Managed Account from Managed System by ID

Password Safe-Managed Accounts

Get a Managed Account by Managed System ID and Managed Account Name List of Managed Accounts Update a Managed Account by ID Delete a Managed Account by ID Delete All Managed Accounts on the Managed System by ID Delete a Managed Account by Managed System ID and Managed Account Name Create a Managed Account in the Managed System by ID Get a Managed Account by ID

Password Safe-Managed Account Credentials

Update Credentials of a Managed Account by ID Update Credentials of a Managed Account Change Credentials of a Managed Account Test Credentials of a Managed Account Queue Credential Change for all Managed Accounts of a Managed System

Password Safe-Quick Rule Managed Accounts

List of Managed Accounts by Quick Rule ID Delete a Managed Account from Quick Rule Update Managed Accounts in Quick Rule Add a Managed Account to Quick Rule

Password Safe-Smart Rule Managed Accounts

List of Managed Accounts by Smart Rule ID

Password Safe-Managed Account Applications

Unassign an Application from a Managed Account List of applications assigned to a Managed Account Unassign all Application from a Managed Account Assign an Application to a Managed Account

Password Safe-Managed Systems

List of Managed Systems Managed System by Database ID Create Managed System by Database ID Create Managed System by Asset ID Update Managed System by ID Delete a Managed System List of Managed Systems by Workgroup ID Managed System by Asset ID Managed System by ID List of Managed Systems auto-managed by Functional Account Create Managed Systems by Workgroup ID

Password Safe-Quick Rule Managed Systems

List of Managed Systems by Quick Rule ID Remove a Managed System from Quick Rule by ID Add a Managed System to Quick Rule by ID Update List of Managed Systems by Quick Rule ID

Password Safe-Smart Rule Managed Systems

List of Managed Systems by Smart Rule ID

Password Safe-Nodes

Password Safe-Password Policies

List of Password Rules for Password Safe or Secrets Safe Password Rule by ID

Password Safe-Platforms

Platform by ID for Managed Systems List of Platforms for Managed Systems List of Platforms by Entity ID

Password Safe-Propagation Actions

List of Propagation Action Types Propagation Action by ID List of Propagation Actions

Password Safe-Managed Account Propagation Actions

Assign a Propagation Action to Managed Account by ID Unassign a Propagation Action from Managed Account by ID List of assigned Propagation Actions by Managed Account ID Unassign all Propagation Actions from Managed Account

Password Safe-Quick Rules

Quick Rule by Title Create a Quick Rule with the Managed Accounts or Systems by ID and Rule Type Delete a Quick Rule by ID Quick Rule by Organization ID and Rule Title Delete a Quick Rule by Title Quick Rule by ID Delete a Quick Rule by Organization ID and Rule Title

Password Safe-Replay

Control Replay Session Status Create a Replay Session for a specified Session Token Terminate Replay Session Display Replay Session Details

Password Safe-Requests

Create a Release Request List of Requests Create a Release Request using Alias Update Request to Rotate Credentials on Check-In/Expiry Deny/Cancel Active or Pending Request Approve Pending Request Check-In/Release a Request

Password Safe-Request Termination

Terminate all Active Requests by Managed System ID Terminate all Active Requests by Requestor User ID Terminate all Active Requests by Managed Account ID

Password Safe-Request Sets

Lists Request Sets Create Release Request Set

Password Safe-Roles

List of Password Safe Roles

Password Safe-User Group Roles

Remove all Password Safe Roles for the User Group and Smart Rule by ID List of Roles for the User Group and Smart Rule by ID Sets Password Safe Roles for the User Group and Smart Rule by ID

Password Safe-Sessions

List of Sessions Session by ID Create Admin Session Create a Session for the given Release

Password Safe-Session Locking

Locks an Active Session Locks all Active Sessions by Managed System ID Locks all Active Sessions by Managed Account ID

Password Safe-Session Termination

Terminate all Active Sessions by Managed Account ID Terminate an Active Session Terminate all Active Sessions by Managed System ID

Password Safe-Synced Accounts

Unsubscribe/Unsync a Managed Account from the Managed Account by ID List of Subscribed/Synced Managed Accounts by Managed Account ID Subscribe/Sync a Managed Account to the Managed Account by ID

Password Safe Cloud Only-Subscription Delivery

Subscription Delivery by Requested ID List of IDs for all Subscription Deliveries

Secrets Safe-Folders

Delete a Secret Safe Folder by ID Create a Secret Safe Folder List of Secret Safe Folders Get a Secret Safe Folder by ID Update a Secret Safe Folder by ID

Home BeyondInsight and Password Safe API Password Safe-CredentialsRetrieve Credentials for an Approved and Active Request

Retrieve Credentials for an Approved and Active Request

GET {{biBaseURL}}/Credentials/:requestId

Request Params

Key	Datatype	Required	Description
`type`	null		optional

Password Safe-Credentials

Retrieve Alias Credentials for an Approved and Active Request