API v2: Managing Password Changers and Remote Apps in Accounts ๐Ÿ†•ยถ

Account Scriptโ€“related endpoints allow you to manage Password Changers and Remote Apps within the Accounts configuration.

Note

If you want to learn how to obtain the IDs of Password Changers and Remote Apps, see the following sections: API v2: Remote Applications, API v2: Password Changers.


Data Structuresยถ

AccountScriptModelยถ

Attribute

Type

Required

Description

id

string

Account Password Changer ID. Read-only, protected, unique object identifier.

account_id

string

yes

Account ID. Immutable. Requires rights to perform operations on the account object: read for GET, modify for POST, PATCH, and DELETE.

password_changer_id

string

Password changer ID. Immutable.

remote_app_id

string

Remote application ID. Read-only. Expensive to use.

password_changer _name

string

yes

Case insensitive password changer name. Read-only. Expensive to use.

password_changer _type

string {change, verify, remoteapp}

Type of password changer / verifier. Can be assigned only to accounts of type regular, using the password method, and with a defined login. An account can have multiple password changers, but only one password verifier. Read-only.

password_changer _transport

string

if password_changer _type == change || verify

Transport layer for password changer. Read-only. Expensive to use.

remote_app_path

string {LDAP, SSH, Telnet, WinRM}

if password_changer _type == remoteapp

Path to the executable file of the remote app. Read-only. Expensive to use.

remote_app _arguments

string

if password_changer _type == remoteapp

Arguments passed to the remote application as binary data. Read-only. Expensive to use.

position

number

if password_changer _type == change

Order of execution for password changers. Value range from 1 to 2147483647. Uniqueness is required in the combination of attribute position with attribute account_id.

timeout

number

Value range from 1 to 2147483647. Script execution timeout, specified in seconds.

created_at

datetime

Read-only. Timestamp of creation.

modified_at

datetime

Read-only. Timestamp of modification.

removed

boolean

Read-only.

Retrieve Available Attributes of the AccountScriptModelยถ

Request

Method

GET

Path

/api/v2/objspec/account_script

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.


Get Password Changers and Remote Apps Assigned to Accountsยถ

Request

Method

GET

Path

/api/v2/account_script

GET /api/v2/account_script

Example Request

curl -s -k -X GET  \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk'  \
'https://10.0.214.98/api/v2/account_script'

Response

{
    "account_script": [
        {
            "account_id": "5683542729741565961",
            "created_at": "2025-06-06 01:00:34.800512-07",
            "id": "5683542729741565967",
            "modified_at": "2025-06-06 01:00:34.800512-07",
            "password_changer_id": "5683542729741565961",
            "password_changer_name": "powershell",
            "password_changer_type": "remoteapp",
            "remote_app_id": "5683542729741565961",
            "remote_app_path": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
        },
        {
            "account_id": "5683542729741565959",
            "created_at": "2025-06-06 00:57:09.61763-07",
            "id": "5683542729741565965",
            "modified_at": "2025-06-06 00:57:09.61763-07",
            "password_changer_id": "5683542729741565963",
            "password_changer_name": "putty-defined-variables",
            "password_changer_type": "remoteapp",
            "remote_app_arguments": "-l %%login%% -pw %%password%% -P %%port%% %%host%%",
            "remote_app_id": "5683542729741565963",
            "remote_app_path": "C:\\Windows\\System32\\putty.exe"
        },
        {
            "account_id": "5683542729741565959",
            "created_at": "2025-06-06 00:57:09.628782-07",
            "id": "5683542729741565966",
            "modified_at": "2025-06-06 00:57:09.628782-07",
            "password_changer_id": "5683542729741565964",
            "password_changer_name": "tightvnc",
            "password_changer_type": "remoteapp",
            "remote_app_id": "5683542729741565964",
            "remote_app_path": "C:\\Program Files\\TightVNC\\tvnviewer.exe"
        }
    ],
    "result": "success"
}

Get Password Changer or Remote App Assigned to an Account by Assignment IDยถ

Request

Method

GET

Path

/api/v2/account_script/<id>

GET /api/v2/account_script/<id>

Example Request

curl -s -k -X GET  \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk'  \
'https://10.0.214.98/api/v2/account_script/5683542729741565967'

Response

{
    "account_script": {
        "id": "5683542729741565967",
        "account_id": "5683542729741565961",
        "password_changer_id": "5683542729741565961",
        "remote_app_id": "5683542729741565961",
        "password_changer_type": "remoteapp",
        "password_changer_name": "powershell",
        "remote_app_path": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
        "variables": [ ],
        "created_at": "2025-06-06 01:00:34.800512-07",
        "modified_at": "2025-06-06 01:00:34.800512-07"
    },
    "result": "success"
}

Assign Password Changer or Remote App to an Accountยถ

Request

Method

POST

Path

/api/v2/account_script

Headers

Content-Type: Application/json

Body

AccountScriptModel

POST /api/v2/account_script

Example Request

curl -s -k -X POST  \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk'  \
-H 'Content-Type: application/json'  \
https://10.31.96.188/api/v2/account_script \
-d'{"account_id": "5683542729741565961","remote_app_id": "5683542729741565957"}'

Response

{
    "account_script": {
        "id": "5683542729741565970"
    },
    "result": "success"
}

Modify Password Changer or Remote App Assignment for an Accountยถ

Request

Method

PATCH

Path

/api/v2/account_script/<id>

Headers

Content-Type: Application/json

Body

AccountScriptModel

PATCH /api/v2/account_script/<id>

Example Request

curl -s -k -X PATCH  \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk'  \
-H 'Content-Type: application/json'  \
https://10.31.96.188/api/v2/account_script/5683542729741565969 \
-d'{"account_id": "5683542729741565961","remote_app_id": "5683542729741565957"}'

Response

{
    "result": "success"
}

Delete Password Changer or Remote App Assignment from an Accountยถ

Request

Method

DELETE

Path

/api/v2/account_script/<id>

DELETE /api/v2/account_script/<id>

Example Request

curl -s -k -X DELETE \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk' \
https://10.31.96.188/api/v2/account_script/5683542729741565970

Response

{
    "result": "success"
}