Jump to Content
Documentation
API Reference
Release Notes
v1
v24.2
v24.3
v25.1
v25.2
v25.3
API Reference
v25.3
Documentation
API Reference
Release Notes
Get all Nodes
JUMP TO
BeyondTrust Password Safe API
Introduction
Access Levels
Get all access levels
get
Create access level assignment
post
Access Policies
Get all access policies
get
Test access to managed account
post
Get assignees for access policy
get
Address Groups
Get address groups for organization ID
get
Get address groups
get
Create address group
post
Get address group by ID
get
Update address group
put
Delete address group
del
Get address by ID
get
Update address
put
Delete address by ID
del
Get all addresses in address group
get
Create address within address group
post
Delete address by group ID
del
Aliases
Get requestable managed account aliases
get
Get a requestable managed account alias
get
API Registration
Get API registration by ID
get
Update API registration
put
Delete API registration
del
Get all API registrations
get
Create API registration
post
Rotate API key by ID
post
Get API key by ID
get
Applications
Get all applications
get
Get application by ID
get
Get applications by managed account ID
get
Remove all applications from managed account
del
Assign application to managed account
post
Remove application from managed account
del
Assets
Search assets
post
Get all assets by workgroup ID
get
Create asset workgroup by ID
post
Get all assets by workgroup name
get
Create asset workgroup by name
post
Delete by workgroup and asset name
del
Get all assets by Smart Rule ID
get
Get by ID
get
Update asset
put
Delete by ID
del
Attribute Types
Get all attribute types
get
Create attribute type
post
Get attribute type by ID
get
Delete attribute type
del
Attributes
Get attributes by type
get
Create attribute
post
Get attribute by ID
get
Delete attribute
del
Get all attributes for asset
get
Delete all attributes for asset
del
Assign attribute to asset
post
Delete attribute from asset
del
Get attributes for managed account
get
Delete all attributes from managed account
del
Assign attribute to managed account
post
Delete attribute from managed account
del
Get attributes for managed system
get
Delete all attributes from managed system
del
Assign attribute to managed system
post
Delete attribute from managed system
del
Auth
Sign in
post
Sign out
post
Configuration
Get current system version
get
Credentials
Get credentials by Request ID
get
Get Credentials by Alias and Request ID
get
Update managed account credentials by ID
put
Get credentials by Managed Account ID
get
Update managed account credentials by Workgroup Name, Asset Name, and Account Name
put
Test managed account credentials
post
Change managed account credentials
post
Update all managed account credentials by Managed System ID
post
Custom Platforms
Get all custom platform configurations
get
Get custom platform configuration by ID
get
Import custom platform configuration
post
Export custom platform configuration
get
Databases
Get all databases
get
Get database by ID
get
Delete database by ID
del
Update database by ID
put
Get all databases by asset ID
get
Create database for asset
post
Directories
Get all directories
get
Get directory by ID
get
Update directory by ID
put
Delete directory by ID
del
Create directory in workgroup
post
DSS Key Rules
Get all DSS key rules
get
Get DSS key rule by ID
get
Entitlements
Get user entitlements
get
Entity Types
Get all entity types
get
Functional Accounts
Get all functional accounts
get
Create functional account
post
Get functional account by ID
get
Delete functional account
del
ISA Requests
Create ISA request
post
ISA Sessions
Create ISA session
post
Keystrokes
Get all keystrokes for session
get
Get keystroke by ID
get
Searches keystroke records by condition and type (deprecated endpoint).
get
Search keystrokes
post
Linked Accounts
Get Linked Accounts by Managed System
get
Remove all Linked Accounts by Managed System
del
Create Linked Account
post
Remove Linked Account
del
Managed Accounts
Get Requestable Managed Account(s)
get
Get Managed Account
get
Update Managed Account
put
Delete Managed Account
del
Get Managed Account(s) by Managed System
get
Create Managed Account in Managed System
post
Delete all Managed Accounts by Managed System
del
Delete Managed Account by Managed System ID and Managed Account name
del
Get Managed Accounts by Smart Rule
get
Get Managed Accounts by Quick Rule
get
Update Quick Rule Managed Accounts
put
Add Managed Account to Quick Rule
post
Remove Managed Account from Quick Rule
del
Managed Systems
Get requestable Managed Systems
get
Get all Managed Systems
get
Get Managed System by ID
get
Update Managed System by ID
put
Delete Managed System by ID
del
Get Managed System by Asset ID
get
Create a Managed System
post
Get Managed System by Database ID
get
Get Managed System by Directory ID
get
Get Managed Systems by functional account ID
get
Get Managed Systems by Workgroup ID
get
Create Managed System
post
Get Managed System for Directory by ID
post
Create Managed System by Workgroup ID
post
Get Managed Systems by Smart Rule ID
get
Get Managed Systems by Quick Rule ID
get
Update Managed System Quick Rule filters by Quick Rule ID
put
Add Managed System to Quick Rule
post
Remove Managed System from Quick Rule
del
Nodes
Get all Nodes
get
Operating Systems
Get all operating systems
get
Oracle Internet Directories
Get all Oracle Internet Directories
get
Get Oracle Internet Directories by organization
get
Get an Oracle Internet Directory by ID
get
Test Oracle Internet Directory LDAP connection
post
Query Oracle Internet Directory DB services
post
Organizations
Get organizations
get
Get organization by ID
get
Password Rules
Get all password rules by product
get
Get password rule by ID
get
Password Safe OAuth Proxy
Authenticate
post
Permissions
Get all permissions
get
Assign permissions to user group
post
Get all permissions for user group
get
Delete all permissions for user group
del
Platforms
Get all platforms
get
Get platform by ID
get
Get platforms by entity type ID
get
Propagation Action Types
Get all propagation action types
get
Propagation Actions
Get all propagation actions
get
Get propagation action by ID
get
Get managed account propagation actions
get
Unassign propagation actions from managed account
del
Assign propagation actions to managed account
post
Unassign propagation action from managed account
del
Quick Rules
Get all Quick Rules
get
Create Quick Rule
post
Delete Quick Rule by title
del
Get Quick Rule by ID
get
Delete Quick Rule by ID
del
Get Quick Rule by organization and title
get
Delete Quick Rule by organization and title
del
Replay
Creates a new replay session for a specified session token. The session token can be discovered using the `sessions` endpoints.
post
Displays the replay session details.
get
Controls the replay session status.
put
Terminates the replay session.
del
Request Sets
Create release request set
post
Get request sets
get
Requests
Create release request
post
Get release requests
get
Create release request using an alias
post
Check-in/release request
put
Update request to rotate credentials on check-in/expiry
put
Approve pending request
put
Deny/cancel pending request
put
Terminate requests by managed account ID
post
Terminate requests by managed system ID
post
Terminate requests by requestor user ID
post
Roles
Get all roles
get
Get roles assigned to user group and smart rule
get
Assign role to user group and smart rule
post
Remove role from user group and smart rule
del
Secrets Safe Folders
Get all folders
get
Create folder
post
Get folder by ID
get
Update folder
put
Delete folder by ID
del
Move folder
put
Secrets Safe Safes
Create safe
post
Get all safes accessible to current user
get
Get safe by ID
get
Update safe by ID
put
Delete safe by ID
del
Get all possible safe permissions
get
Get permissions assigned to safe
get
Update safe permissions by ID
put
Revoke safe permissions by ID
del
Secrets Safe Secrets
Create credential secret
post
Get all secrets by folder ID
get
Create file secret
post
Create text secret
post
Get credential secret by ID
get
Update credential secret
put
Delete secret
del
Get text secret by ID
get
Update text secret
put
Get file secret by ID
get
Update file secret
put
Get secret file content by ID
get
Get all secrets
get
Upload secrets to folder by ID
post
Share secret to folder by ID
post
Delete share
del
Get all shares of secret
get
Delete all shares of secret
del
Move secrets and shares to folder
put
Sessions
Get all sessions
get
Get session by ID
get
Create session by request ID
post
Create admin session
post
Lock active session by session ID
post
Lock active sessions by managed account ID
post
Lock active sessions by managed system ID
post
Terminate active session by session ID
post
Terminate active sessions by managed account ID
post
Terminate active sessions by managed system ID
post
Smart Rules
Get Smart Rules
get
Delete Smart Rule by title
del
Get Smart Rule by ID
get
Delete Smart Rule by ID
del
Get Smart Rule by organization ID and title
get
Delete Smart Rule by organization ID and title
del
Get all Smart Rules for user group and access level
get
Process Smart Rule
post
Create asset filtering Smart Rule
post
Subscription Delivery
Get subscription delivery identifiers
get
Download subscription delivery
post
Synced Accounts
Get Synced Accounts by Managed Account
get
Remove all Synced Accounts by Managed Account
del
Create Synced Account
post
Remove Synced Account
del
Ticket Systems
Get all configured ticket systems
get
User Audits
Get user audits
get
Get user audit by ID
get
User Groups
Get user groups
get
Create new user group
post
Delete user group by name
del
Get user group
get
Delete user group by ID
del
Get user groups for user
get
Add user to user group
post
Remove user from user group
del
Users
Get User
get
Update user
put
Delete user
del
Get users
get
Create user account
post
Get all users in group.
get
Create user in group
post
Quarantine user
post
Generate OAuth client secret for user
post
Workgroups
Get workgroups by name
get
Create workgroup
post
Get workgroup by ID
get
Powered by
Get all Nodes
get
https://example.com/beyondtrust/api/public/v3/nodes
Required Permission(s)
None
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Response
Click
Try It!
to start a request and see the response here!
