BeyondTrust

App · 25 actions

Use BeyondTrust Password Safe in workflows: request, retrieve and check in privileged credentials, approve requests, change passwords, read and save Secrets Safe secrets, end sessions and manage users' groups. Start a workflow on a new request, an approval, a new account, system, secret, session or user.

Actions

ActionWhat it does
Add user to groupAdd a user to a user group, giving them the group's roles, such as when someone joins a team.
Approve requestApprove a request waiting for you, such as after someone approved it in Teams or a ticket.
Change account passwordChange a managed account's password now, on the system and in Password Safe: a new random one by its password rule, or the one you give, such as after someone saw it.
Check in requestGive a request's access back before it ends, which may change the account's password, as its policy says.
Create folderCreate a folder in a Secrets Safe safe or folder.
Create secretSave a username and password, or text, as a secret in a Secrets Safe folder, owned by the user Lodol runs as.
Delete folderDelete a Secrets Safe folder.
Delete secretDelete a Secrets Safe secret.
Deny requestDeny a request waiting for you, or cancel one of your own still waiting.
End sessionEnd a live RDP or SSH session at once, such as one flagged as risky.
List foldersList the safes and folders in Secrets Safe you can see, with their paths.
List managed accountsList the managed accounts you can request credentials for, on one system or all of them, or find one by name.
List managed systemsList the systems Password Safe manages accounts on (servers, databases, directories, cloud platforms), or find one by name.
List requestsList credential requests: your own, or the ones waiting on you to approve, by status.
List secretsList the Secrets Safe secrets you can see, in a folder, by title or changed since a time.
List sessionsList the RDP and SSH sessions Password Safe recorded, newest first, by status or user.
List Smart RulesList the Smart Rules you can see, which group accounts, systems and assets in Password Safe, or find one by title.
List user groupsList BeyondInsight user groups, or find one by name.
List usersList BeyondInsight users, or find one by username.
Quarantine userQuarantine a user so they can't use Password Safe, keeping their account, such as when their sign-in looks compromised.
Read secretRead a Secrets Safe secret's username and password, or its text, to use in a later step.
Remove user from groupTake a user out of a user group, removing the group's roles, such as when someone leaves a team.
Request credentialsAsk for a managed account's credentials for a time, with a reason.
Retrieve credentialsRead the password (or SSH key or passphrase) of an approved, active request, to use in a later step.
Search assetsFind assets (servers, workstations, devices) by name, IP address or range, DNS name, domain or type.

Add user to group

Add a user to a user group, giving them the group's roles, such as when someone joins a team.

Inputs

UserusertextRequired
The BeyondInsight user.
User groupgroup_idtextRequired
The BeyondInsight user group.

Outputs

addedtrue/false
True once added
group_idnumber
The group
group_nametext
The group's name
user_idnumber
The user
Example output
{
  "added": true,
  "group_id": 8,
  "group_name": "DBA requestors",
  "user_id": 27
}

Approve request

Approve a request waiting for you, such as after someone approved it in Teams or a ticket.

Inputs

Requestrequest_idtextRequired
The request waiting for your approval.
Reasonreasontext
A reason, kept on the request in Password Safe.

Outputs

approvedtrue/false
True once approved
reasontext
The reason given, if any
request_idnumber
The request
Example output
{
  "approved": true,
  "reason": "Approved for CHG-2210",
  "request_id": 5821
}

Change account password

Change a managed account's password now, on the system and in Password Safe: a new random one by its password rule, or the one you give, such as after someone saw it.

Inputs

Managed accountaccount_idtextRequired
The account whose password to change.
New passwordnew_passwordtext
The password to set. Leave blank for a new random one.
Change it on the systemupdate_systemtrue/false
Set the password on the system itself as well as in Password Safe. Turn off only to record a password already changed there.Default: true.
Queue if unreachablequeue_if_unreachabletrue/false
If the system can't be reached, queue the change for later instead of failing.Default: false.

Outputs

account_idnumber
The managed account
changedtrue/false
True once the password changed
generatedtrue/false
True if Password Safe made a new random password
updated_systemtrue/false
True if the password changed on the system too
Example output
{
  "account_id": 345,
  "changed": true,
  "generated": true,
  "updated_system": true
}

Check in request

Give a request's access back before it ends, which may change the account's password, as its policy says.

Inputs

Requestrequest_idtextRequired
Your active request.
Reasonreasontext
A reason, kept on the request in Password Safe.

Outputs

checked_intrue/false
True once checked in
reasontext
The reason given, if any
request_idnumber
The request
Example output
{
  "checked_in": true,
  "reason": "",
  "request_id": 5821
}

Create folder

Create a folder in a Secrets Safe safe or folder.

Inputs

NamenametextRequired
The new folder's name.
In folderparent_folder_idtextRequired
The safe or folder to create it in.
Descriptiondescriptiontext
What the folder is for.

Outputs

descriptiontext
Its description
folder_idtext
The folder's id
nametext
The folder's name
owner_group_idnumber
The id of the group that owns it
owner_user_idnumber
The id of the user who owns it
parent_idtext
The id of the folder or safe it is in
Example output
{
  "description": "Payroll vendor logins",
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Payroll",
  "owner_group_id": null,
  "owner_user_id": 27,
  "parent_id": "0b6f1c2e-8d47-4a55-9f1e-7c2d4b8a9e10"
}

Create secret

Save a username and password, or text, as a secret in a Secrets Safe folder, owned by the user Lodol runs as.

Inputs

Folderfolder_idtextRequired
The Secrets Safe folder.
TitletitletextRequired
The secret's title.
Kind of secretsecret_kindtext
A username and password, or text such as a key or a recovery code.One of: credential (Username and password), text. Default: credential.
Usernameusernametext
The username to save.Only when Kind of secret is Username and password.
Passwordpasswordtext
The password to save.Only when Kind of secret is Username and password.
Texttexttext
The text to save, up to 4,096 characters.Only when Kind of secret is Text.
Descriptiondescriptiontext
What the secret is for.
Notesnotestext
Notes kept with it.
Web addressurltext
Where the login is used.

Outputs

created_bytext
Who created it
created_ontext
When it was created
descriptiontext
Its description
file_nametext
The file's name, for a file secret
foldertext
Its folder's name
folder_idtext
The id of its folder
folder_pathtext
Its folder's path
modified_bytext
Who changed it last
modified_ontext
When it last changed
notestext
Its notes
secret_idtext
The secret's id
secret_typetext
Credential, Text or File
titletext
The secret's title
urlslist
The web addresses saved with it
usernametext
The username, for a username and password
Example output
{
  "created_by": "Jamie Smith",
  "created_on": "2026-10-02T09:15:04",
  "description": "Payroll vendor admin login",
  "file_name": "",
  "folder": "Payroll",
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "folder_path": "Finance/Payroll",
  "modified_by": "Jamie Smith",
  "modified_on": "2026-11-05T14:20:41",
  "notes": "",
  "secret_id": "9b2e4c1a-6f3d-4e8b-a0c7-5d1f2e3a4b6c",
  "secret_type": "Credential",
  "title": "ADP admin",
  "urls": [
    "https://login.adp.com"
  ],
  "username": "payroll-admin@example.com"
}

Delete folder

Delete a Secrets Safe folder.

Inputs

Folderfolder_idtextRequired
The Secrets Safe folder.

Outputs

deletedtrue/false
True once deleted
folder_idtext
The folder
Example output
{
  "deleted": true,
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Delete secret

Delete a Secrets Safe secret.

Inputs

Secretsecret_idtextRequired
The secret.

Outputs

deletedtrue/false
True once deleted
secret_idtext
The secret
Example output
{
  "deleted": true,
  "secret_id": "9b2e4c1a-6f3d-4e8b-a0c7-5d1f2e3a4b6c"
}

Deny request

Deny a request waiting for you, or cancel one of your own still waiting.

Inputs

Requestrequest_idtextRequired
The request waiting for your approval.
Reasonreasontext
A reason, kept on the request in Password Safe.

Outputs

deniedtrue/false
True once denied
reasontext
The reason given, if any
request_idnumber
The request
Example output
{
  "denied": true,
  "reason": "No change ticket",
  "request_id": 5821
}

End session

End a live RDP or SSH session at once, such as one flagged as risky.

Inputs

Sessionsession_idtextRequired
The live session to end.

Outputs

session_idnumber
The session
terminatedtrue/false
True once ended
Example output
{
  "session_id": 908,
  "terminated": true
}

List folders

List the safes and folders in Secrets Safe you can see, with their paths.

Inputs

Namenametext
Only folders with this name.
Underunder_pathtext
Only this folder and the folders in it, such as Finance/Payroll.
Top level onlytop_level_onlytrue/false
Only the safes and folders at the top.Default: false.

Outputs

countnumber
How many were returned
folderslist
The folders
Example output
{
  "count": 1,
  "folders": [
    {
      "description": "Payroll vendor logins",
      "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Payroll",
      "owner_group_id": null,
      "owner_user_id": 27,
      "parent_id": "0b6f1c2e-8d47-4a55-9f1e-7c2d4b8a9e10",
      "path": "Finance/Payroll"
    }
  ]
}

List managed accounts

List the managed accounts you can request credentials for, on one system or all of them, or find one by name.

Inputs

Managed systemsystem_idtext
Only accounts on this system. Leave blank for every system.
Account nameaccount_nametext
Only the account with this name.
Account typeaccount_typetext
Only accounts of this type. Leave blank for every type.One of: system (Local accounts on systems), domainlinked (Domain accounts linked to systems), database (Database accounts), cloud (Cloud accounts), application (Application accounts), recent (Recently used).
Workgroupworkgroup_nametext
Only accounts in this workgroup.
Limitlimitnumber
The most accounts to return, up to 1000. Leave blank for 100.From 1 to 1000.
Offsetoffsetnumber
How many to skip, for the next page: the next_offset of the last step.At least 0.

Outputs

countnumber
How many were returned
managed_accountslist
The managed accounts
next_offsetnumber
The offset of the next page, or empty when this is the last
Example output
{
  "count": 1,
  "managed_accounts": [
    {
      "account_id": 345,
      "account_name": "svc_backup",
      "application_name": "",
      "default_release_minutes": 120,
      "description": "Nightly backup service account",
      "domain_name": "",
      "instance_name": "",
      "is_changing": false,
      "isa_access": false,
      "last_change_date": "2026-11-01T02:00:13",
      "max_release_minutes": 525600,
      "next_change_date": "2026-12-01T02:00:00",
      "platform_id": 1,
      "system_id": 12,
      "system_name": "SQL-PROD-01",
      "user_principal_name": ""
    }
  ],
  "next_offset": null
}

List managed systems

List the systems Password Safe manages accounts on (servers, databases, directories, cloud platforms), or find one by name.

Inputs

Namenametext
Only the managed system with this name.
Limitlimitnumber
The most systems to return, up to 1000. Leave blank for 100.From 1 to 1000.
Offsetoffsetnumber
How many to skip, for the next page: the next_offset of the last step.At least 0.

Outputs

countnumber
How many were returned
managed_systemslist
The managed systems
next_offsetnumber
The offset of the next page, or empty when this is the last
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "managed_systems": [
    {
      "asset_id": 40,
      "auto_management": true,
      "contact_email": "dba@example.com",
      "description": "Production SQL Server",
      "dns_name": "sql-prod-01.corp.example.com",
      "entity_type": "Asset",
      "host_name": "sql-prod-01",
      "ip_address": "10.0.4.21",
      "managed_system_id": 12,
      "max_release_minutes": 525600,
      "name": "SQL-PROD-01",
      "platform_id": 1,
      "release_minutes": 120,
      "workgroup_id": 1
    }
  ],
  "next_offset": null,
  "total": 1
}

List requests

List credential requests: your own, or the ones waiting on you to approve, by status.

Inputs

Whose requestsqueuetext
Your own requests, or the ones you can approve.One of: app (Requests I can approve), req (My own requests). Default: req.
Statusstatustext
Which requests to list.One of: all, pending (Waiting for approval), active (Approved and active). Default: all.

Outputs

countnumber
How many were returned
requestslist
The requests
Example output
{
  "count": 1,
  "requests": [
    {
      "access_type": "View",
      "account_id": 345,
      "account_name": "svc_backup",
      "approved_date": "",
      "canceled_date": "",
      "domain_name": "",
      "expires_date": "2026-11-12T16:00:00",
      "reason": "Restore last night's backup (CHG-2210)",
      "release_date": "2026-11-12T15:00:00",
      "request_id": 5821,
      "requestor_name": "Jamie Smith",
      "requestor_user_id": 27,
      "status": "Pending",
      "system_id": 12,
      "system_name": "SQL-PROD-01"
    }
  ]
}

List secrets

List the Secrets Safe secrets you can see, in a folder, by title or changed since a time. Values aren't read.

Inputs

Folderfolder_pathtext
Only secrets in this folder and the folders in it.
Titletitletext
Only the secret with this exact title.
Changed sincechanged_sincedate and time
Only secrets created or changed at or after this time.
Limitlimitnumber
The most secrets to return, up to 1000. Leave blank for 100.From 1 to 1000.
Offsetoffsetnumber
How many to skip, for the next page: the next_offset of the last step.At least 0.

Outputs

countnumber
How many were returned
next_offsetnumber
The offset of the next page, or empty when this is the last
secretslist
The secrets, without their values
Example output
{
  "count": 1,
  "next_offset": null,
  "secrets": [
    {
      "created_by": "Jamie Smith",
      "created_on": "2026-10-02T09:15:04",
      "description": "Payroll vendor admin login",
      "file_name": "",
      "folder": "Payroll",
      "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "folder_path": "Finance/Payroll",
      "modified_by": "Jamie Smith",
      "modified_on": "2026-11-05T14:20:41",
      "notes": "",
      "secret_id": "9b2e4c1a-6f3d-4e8b-a0c7-5d1f2e3a4b6c",
      "secret_type": "Credential",
      "title": "ADP admin",
      "urls": [
        "https://login.adp.com"
      ],
      "username": "payroll-admin@example.com"
    }
  ]
}

List sessions

List the RDP and SSH sessions Password Safe recorded, newest first, by status or user.

Inputs

Statusstatuslist
Only sessions in these states. Leave empty for every session.One or more of: 0 (Not started), 1 (In progress), 2 (Completed), 5 (Locked), 7 (Terminated), 8 (Logged off), 9 (Disconnected).
Userusertext
Only sessions this user opened.
Limitlimitnumber
The most sessions to return, up to 1000. Leave blank for 100.From 1 to 1000.

Outputs

countnumber
How many were returned
sessionslist
The sessions, newest first
totalnumber
How many sessions matched, before the limit
Example output
{
  "count": 1,
  "sessions": [
    {
      "account_id": 345,
      "account_name": "svc_backup",
      "duration_seconds": null,
      "end_time": "",
      "protocol": "RDP",
      "request_id": 5821,
      "session_id": 908,
      "session_type": "Request",
      "start_time": "2026-11-12T15:02:41",
      "status": "In progress",
      "status_code": 1,
      "system_id": 12,
      "system_name": "SQL-PROD-01",
      "user_id": 27
    }
  ],
  "total": 1
}

List Smart Rules

List the Smart Rules you can see, which group accounts, systems and assets in Password Safe, or find one by title.

Inputs

Groupsrule_typetext
Only Smart Rules that group these. Leave blank for every kind.One of: ManagedAccount (Managed accounts), ManagedSystem (Managed systems), Asset (Assets).
Titletitletext
Only the Smart Rule with this title.

Outputs

countnumber
How many were returned
smart_ruleslist
The Smart Rules
Example output
{
  "count": 1,
  "smart_rules": [
    {
      "category": "Managed Accounts",
      "description": "",
      "is_active": true,
      "is_read_only": false,
      "last_processed_date": "2026-11-12T06:00:12",
      "rule_type": "ManagedAccount",
      "smart_rule_id": 15,
      "status": "Complete",
      "title": "Production database accounts"
    }
  ]
}

List user groups

List BeyondInsight user groups, or find one by name.

Inputs

Namenametext
Only the group with this name.

Outputs

countnumber
How many were returned
groupslist
The user groups
Example output
{
  "count": 1,
  "groups": [
    {
      "description": "Can request database accounts",
      "group_id": 8,
      "group_type": "BeyondInsight",
      "is_active": true,
      "name": "DBA requestors"
    }
  ]
}

List users

List BeyondInsight users, or find one by username.

Inputs

Usernameusernametext
Only this user, such as jsmith, or CORP\jsmith for a directory user.
Include inactiveinclude_inactivetrue/false
List inactive users too.Default: false.

Outputs

countnumber
How many were returned
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "domain_name": "",
      "email": "jsmith@example.com",
      "first_name": "Jamie",
      "is_active": true,
      "is_quarantined": false,
      "last_login_date": "2026-11-12T08:41:02",
      "last_name": "Smith",
      "name": "Jamie Smith",
      "user_id": 27,
      "username": "jsmith"
    }
  ]
}

Quarantine user

Quarantine a user so they can't use Password Safe, keeping their account, such as when their sign-in looks compromised. An administrator releases them in BeyondInsight.

Inputs

UserusertextRequired
The BeyondInsight user.

Outputs

domain_nametext
The user's domain, for a directory user
emailtext
Email address
first_nametext
First name
is_activetrue/false
True if the user is active
is_quarantinedtrue/false
True if the user is quarantined
last_login_datetext
When the user last signed in
last_nametext
Last name
nametext
First and last name
user_idnumber
The user's id
usernametext
The username, such as jsmith or CORP\jsmith
Example output
{
  "domain_name": "",
  "email": "jsmith@example.com",
  "first_name": "Jamie",
  "is_active": true,
  "is_quarantined": true,
  "last_login_date": "2026-11-12T08:41:02",
  "last_name": "Smith",
  "name": "Jamie Smith",
  "user_id": 27,
  "username": "jsmith"
}

Read secret

Read a Secrets Safe secret's username and password, or its text, to use in a later step. The value is in the step's result for later steps, so anyone who can see this workflow's runs can see it; the run's summary doesn't print it.

Inputs

Secretsecret_idtextRequired
The secret.
Kind of secretsecret_kindtext
A username and password, or text such as a key or a recovery code.One of: credential (Username and password), text. Default: credential.

Outputs

created_bytext
Who created it
created_ontext
When it was created
descriptiontext
Its description
file_nametext
The file's name, for a file secret
foldertext
Its folder's name
folder_idtext
The id of its folder
folder_pathtext
Its folder's path
modified_bytext
Who changed it last
modified_ontext
When it last changed
notestext
Its notes
passwordtext
The password, for a username and password
secret_idtext
The secret's id
secret_typetext
Credential, Text or File
texttext
The text, for a text secret
titletext
The secret's title
urlslist
The web addresses saved with it
usernametext
The username, for a username and password
Example output
{
  "created_by": "Jamie Smith",
  "created_on": "2026-10-02T09:15:04",
  "description": "Payroll vendor admin login",
  "file_name": "",
  "folder": "Payroll",
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "folder_path": "Finance/Payroll",
  "modified_by": "Jamie Smith",
  "modified_on": "2026-11-05T14:20:41",
  "notes": "",
  "password": "Xy7#pQ2m!vR9",
  "secret_id": "9b2e4c1a-6f3d-4e8b-a0c7-5d1f2e3a4b6c",
  "secret_type": "Credential",
  "text": "",
  "title": "ADP admin",
  "urls": [
    "https://login.adp.com"
  ],
  "username": "payroll-admin@example.com"
}

Remove user from group

Take a user out of a user group, removing the group's roles, such as when someone leaves a team.

Inputs

UserusertextRequired
The BeyondInsight user.
User groupgroup_idtextRequired
The BeyondInsight user group.

Outputs

group_idnumber
The group
removedtrue/false
True once removed
user_idnumber
The user
Example output
{
  "group_id": 8,
  "removed": true,
  "user_id": 27
}

Request credentials

Ask for a managed account's credentials for a time, with a reason. Password Safe approves it at once or waits for an approver, as its policy says; once approved, 'Retrieve credentials' reads them.

Inputs

Managed systemsystem_idtextRequired
The system the account is on.
Managed accountaccount_idtextRequired
The account to request.
Minutesduration_minutesnumber
How long you need it, in minutes. Leave blank for 60.From 1 to 525600.
Reasonreasontext
A reason, kept on the request in Password Safe.
Ticket numberticket_numbertext
A change or incident ticket, if your policy asks for one.
If a request is already openif_opentext
What to do when you already have an open request for this account.One of: reuse (Use the request already open), renew (Make a new request). Default: reuse.
Change password afterrotate_on_check_intrue/false
Change the password when the request is checked in or ends, if the account's policy allows it.

Outputs

account_idnumber
The managed account
duration_minutesnumber
How long the request lasts, in minutes
request_idnumber
The new request's id, for 'Retrieve credentials'
system_idnumber
The managed system
Example output
{
  "account_id": 345,
  "duration_minutes": 60,
  "request_id": 5821,
  "system_id": 12
}

Retrieve credentials

Read the password (or SSH key or passphrase) of an approved, active request, to use in a later step. The value is in the step's result for later steps, so anyone who can see this workflow's runs can see it; the run's summary doesn't print it.

Inputs

Requestrequest_idtextRequired
The approved request, such as the one 'Request credentials' made.
Credentialcredential_typetext
What to retrieve.One of: password, dsskey (SSH private key), passphrase (SSH key passphrase). Default: password.

Outputs

credentialtext
The password, SSH private key or passphrase
credential_typetext
password, dsskey or passphrase
request_idnumber
The request
Example output
{
  "credential": "Xy7#pQ2m!vR9",
  "credential_type": "password",
  "request_id": 5821
}

Search assets

Find assets (servers, workstations, devices) by name, IP address or range, DNS name, domain or type. Give at least one.

Inputs

Namenametext
The asset's exact name.
IP addressip_addresstext
An address, several separated by commas, a range (10.0.0.1-10.0.0.25) or a CIDR block (10.0.0.0/24).
DNS namedns_nametext
The asset's exact DNS name.
Domaindomain_nametext
The asset's domain.
Asset typeasset_typetext
The asset's type, such as Server.
Limitlimitnumber
The most assets to return, up to 1000. Leave blank for 100.From 1 to 1000.
Offsetoffsetnumber
How many to skip, for the next page: the next_offset of the last step.At least 0.

Outputs

assetslist
The assets found
countnumber
How many were returned
next_offsetnumber
The offset of the next page, or empty when this is the last
totalnumber
How many there are in all
Example output
{
  "assets": [
    {
      "asset_id": 40,
      "asset_type": "Server",
      "created": "2025-03-14T10:02:55",
      "description": "",
      "dns_name": "sql-prod-01.corp.example.com",
      "domain_name": "corp.example.com",
      "ip_address": "10.0.4.21",
      "last_updated": "2026-11-10T03:12:09",
      "name": "SQL-PROD-01",
      "operating_system": "Windows Server 2022 Standard",
      "workgroup_id": 1
    }
  ],
  "count": 1,
  "next_offset": null,
  "total": 1
}

On this page