# BeyondTrust

> 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.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/beyondtrust

## Actions

### 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**

- User (`user`, text, required): The BeyondInsight user.
- User group (`group_id`, text, required): The BeyondInsight user group.

**Outputs**

- `added` (true/false): True once added
- `group_id` (number): The group
- `group_name` (text): The group's name
- `user_id` (number): The user

**Example output**

```json
{
  "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**

- Request (`request_id`, text, required): The request waiting for your approval.
- Reason (`reason`, text): A reason, kept on the request in Password Safe.

**Outputs**

- `approved` (true/false): True once approved
- `reason` (text): The reason given, if any
- `request_id` (number): The request

**Example output**

```json
{
  "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 account (`account_id`, text, required): The account whose password to change.
- New password (`new_password`, text): The password to set. Leave blank for a new random one.
- Change it on the system (`update_system`, true/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 unreachable (`queue_if_unreachable`, true/false): If the system can't be reached, queue the change for later instead of failing. Default: `false`.

**Outputs**

- `account_id` (number): The managed account
- `changed` (true/false): True once the password changed
- `generated` (true/false): True if Password Safe made a new random password
- `updated_system` (true/false): True if the password changed on the system too

**Example output**

```json
{
  "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**

- Request (`request_id`, text, required): Your active request.
- Reason (`reason`, text): A reason, kept on the request in Password Safe.

**Outputs**

- `checked_in` (true/false): True once checked in
- `reason` (text): The reason given, if any
- `request_id` (number): The request

**Example output**

```json
{
  "checked_in": true,
  "reason": "",
  "request_id": 5821
}
```

### Create folder

Create a folder in a Secrets Safe safe or folder.

**Inputs**

- Name (`name`, text, required): The new folder's name.
- In folder (`parent_folder_id`, text, required): The safe or folder to create it in.
- Description (`description`, text): What the folder is for.

**Outputs**

- `description` (text): Its description
- `folder_id` (text): The folder's id
- `name` (text): The folder's name
- `owner_group_id` (number): The id of the group that owns it
- `owner_user_id` (number): The id of the user who owns it
- `parent_id` (text): The id of the folder or safe it is in

**Example output**

```json
{
  "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**

- Folder (`folder_id`, text, required): The Secrets Safe folder.
- Title (`title`, text, required): The secret's title.
- Kind of secret (`secret_kind`, text): A username and password, or text such as a key or a recovery code. One of: `credential` (Username and password), `text`. Default: `credential`.
- Username (`username`, text): The username to save. Only when Kind of secret is Username and password.
- Password (`password`, text): The password to save. Only when Kind of secret is Username and password.
- Text (`text`, text): The text to save, up to 4,096 characters. Only when Kind of secret is Text.
- Description (`description`, text): What the secret is for.
- Notes (`notes`, text): Notes kept with it.
- Web address (`url`, text): Where the login is used.

**Outputs**

- `created_by` (text): Who created it
- `created_on` (text): When it was created
- `description` (text): Its description
- `file_name` (text): The file's name, for a file secret
- `folder` (text): Its folder's name
- `folder_id` (text): The id of its folder
- `folder_path` (text): Its folder's path
- `modified_by` (text): Who changed it last
- `modified_on` (text): When it last changed
- `notes` (text): Its notes
- `secret_id` (text): The secret's id
- `secret_type` (text): Credential, Text or File
- `title` (text): The secret's title
- `urls` (list): The web addresses saved with it
- `username` (text): The username, for a username and password

**Example output**

```json
{
  "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**

- Folder (`folder_id`, text, required): The Secrets Safe folder.

**Outputs**

- `deleted` (true/false): True once deleted
- `folder_id` (text): The folder

**Example output**

```json
{
  "deleted": true,
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

### Delete secret

Delete a Secrets Safe secret.

**Inputs**

- Secret (`secret_id`, text, required): The secret.

**Outputs**

- `deleted` (true/false): True once deleted
- `secret_id` (text): The secret

**Example output**

```json
{
  "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**

- Request (`request_id`, text, required): The request waiting for your approval.
- Reason (`reason`, text): A reason, kept on the request in Password Safe.

**Outputs**

- `denied` (true/false): True once denied
- `reason` (text): The reason given, if any
- `request_id` (number): The request

**Example output**

```json
{
  "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**

- Session (`session_id`, text, required): The live session to end.

**Outputs**

- `session_id` (number): The session
- `terminated` (true/false): True once ended

**Example output**

```json
{
  "session_id": 908,
  "terminated": true
}
```

### List folders

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

**Inputs**

- Name (`name`, text): Only folders with this name.
- Under (`under_path`, text): Only this folder and the folders in it, such as Finance/Payroll.
- Top level only (`top_level_only`, true/false): Only the safes and folders at the top. Default: `false`.

**Outputs**

- `count` (number): How many were returned
- `folders` (list): The folders

**Example output**

```json
{
  "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 system (`system_id`, text): Only accounts on this system. Leave blank for every system.
- Account name (`account_name`, text): Only the account with this name.
- Account type (`account_type`, text): 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).
- Workgroup (`workgroup_name`, text): Only accounts in this workgroup.
- Limit (`limit`, number): The most accounts to return, up to 1000. Leave blank for 100. From 1 to 1000.
- Offset (`offset`, number): How many to skip, for the next page: the next_offset of the last step. At least 0.

**Outputs**

- `count` (number): How many were returned
- `managed_accounts` (list): The managed accounts
- `next_offset` (number): The offset of the next page, or empty when this is the last

**Example output**

```json
{
  "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**

- Name (`name`, text): Only the managed system with this name.
- Limit (`limit`, number): The most systems to return, up to 1000. Leave blank for 100. From 1 to 1000.
- Offset (`offset`, number): How many to skip, for the next page: the next_offset of the last step. At least 0.

**Outputs**

- `count` (number): How many were returned
- `managed_systems` (list): The managed systems
- `next_offset` (number): The offset of the next page, or empty when this is the last
- `total` (number): How many there are in all

**Example output**

```json
{
  "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 requests (`queue`, text): Your own requests, or the ones you can approve. One of: `app` (Requests I can approve), `req` (My own requests). Default: `req`.
- Status (`status`, text): Which requests to list. One of: `all`, `pending` (Waiting for approval), `active` (Approved and active). Default: `all`.

**Outputs**

- `count` (number): How many were returned
- `requests` (list): The requests

**Example output**

```json
{
  "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**

- Folder (`folder_path`, text): Only secrets in this folder and the folders in it.
- Title (`title`, text): Only the secret with this exact title.
- Changed since (`changed_since`, date and time): Only secrets created or changed at or after this time.
- Limit (`limit`, number): The most secrets to return, up to 1000. Leave blank for 100. From 1 to 1000.
- Offset (`offset`, number): How many to skip, for the next page: the next_offset of the last step. At least 0.

**Outputs**

- `count` (number): How many were returned
- `next_offset` (number): The offset of the next page, or empty when this is the last
- `secrets` (list): The secrets, without their values

**Example output**

```json
{
  "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**

- Status (`status`, list): 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).
- User (`user`, text): Only sessions this user opened.
- Limit (`limit`, number): The most sessions to return, up to 1000. Leave blank for 100. From 1 to 1000.

**Outputs**

- `count` (number): How many were returned
- `sessions` (list): The sessions, newest first
- `total` (number): How many sessions matched, before the limit

**Example output**

```json
{
  "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**

- Groups (`rule_type`, text): Only Smart Rules that group these. Leave blank for every kind. One of: `ManagedAccount` (Managed accounts), `ManagedSystem` (Managed systems), `Asset` (Assets).
- Title (`title`, text): Only the Smart Rule with this title.

**Outputs**

- `count` (number): How many were returned
- `smart_rules` (list): The Smart Rules

**Example output**

```json
{
  "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**

- Name (`name`, text): Only the group with this name.

**Outputs**

- `count` (number): How many were returned
- `groups` (list): The user groups

**Example output**

```json
{
  "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**

- Username (`username`, text): Only this user, such as jsmith, or CORP\jsmith for a directory user.
- Include inactive (`include_inactive`, true/false): List inactive users too. Default: `false`.

**Outputs**

- `count` (number): How many were returned
- `users` (list): The users

**Example output**

```json
{
  "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**

- User (`user`, text, required): The BeyondInsight user.

**Outputs**

- `domain_name` (text): The user's domain, for a directory user
- `email` (text): Email address
- `first_name` (text): First name
- `is_active` (true/false): True if the user is active
- `is_quarantined` (true/false): True if the user is quarantined
- `last_login_date` (text): When the user last signed in
- `last_name` (text): Last name
- `name` (text): First and last name
- `user_id` (number): The user's id
- `username` (text): The username, such as jsmith or CORP\jsmith

**Example output**

```json
{
  "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**

- Secret (`secret_id`, text, required): The secret.
- Kind of secret (`secret_kind`, text): 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_by` (text): Who created it
- `created_on` (text): When it was created
- `description` (text): Its description
- `file_name` (text): The file's name, for a file secret
- `folder` (text): Its folder's name
- `folder_id` (text): The id of its folder
- `folder_path` (text): Its folder's path
- `modified_by` (text): Who changed it last
- `modified_on` (text): When it last changed
- `notes` (text): Its notes
- `password` (text): The password, for a username and password
- `secret_id` (text): The secret's id
- `secret_type` (text): Credential, Text or File
- `text` (text): The text, for a text secret
- `title` (text): The secret's title
- `urls` (list): The web addresses saved with it
- `username` (text): The username, for a username and password

**Example output**

```json
{
  "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**

- User (`user`, text, required): The BeyondInsight user.
- User group (`group_id`, text, required): The BeyondInsight user group.

**Outputs**

- `group_id` (number): The group
- `removed` (true/false): True once removed
- `user_id` (number): The user

**Example output**

```json
{
  "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 system (`system_id`, text, required): The system the account is on.
- Managed account (`account_id`, text, required): The account to request.
- Minutes (`duration_minutes`, number): How long you need it, in minutes. Leave blank for 60. From 1 to 525600.
- Reason (`reason`, text): A reason, kept on the request in Password Safe.
- Ticket number (`ticket_number`, text): A change or incident ticket, if your policy asks for one.
- If a request is already open (`if_open`, text): 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 after (`rotate_on_check_in`, true/false): Change the password when the request is checked in or ends, if the account's policy allows it.

**Outputs**

- `account_id` (number): The managed account
- `duration_minutes` (number): How long the request lasts, in minutes
- `request_id` (number): The new request's id, for 'Retrieve credentials'
- `system_id` (number): The managed system

**Example output**

```json
{
  "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**

- Request (`request_id`, text, required): The approved request, such as the one 'Request credentials' made.
- Credential (`credential_type`, text): What to retrieve. One of: `password`, `dsskey` (SSH private key), `passphrase` (SSH key passphrase). Default: `password`.

**Outputs**

- `credential` (text): The password, SSH private key or passphrase
- `credential_type` (text): password, dsskey or passphrase
- `request_id` (number): The request

**Example output**

```json
{
  "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**

- Name (`name`, text): The asset's exact name.
- IP address (`ip_address`, text): 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 name (`dns_name`, text): The asset's exact DNS name.
- Domain (`domain_name`, text): The asset's domain.
- Asset type (`asset_type`, text): The asset's type, such as Server.
- Limit (`limit`, number): The most assets to return, up to 1000. Leave blank for 100. From 1 to 1000.
- Offset (`offset`, number): How many to skip, for the next page: the next_offset of the last step. At least 0.

**Outputs**

- `assets` (list): The assets found
- `count` (number): How many were returned
- `next_offset` (number): The offset of the next page, or empty when this is the last
- `total` (number): How many there are in all

**Example output**

```json
{
  "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
}
```
