Share this page

# lr_cyberark_get_vault

Queries a protected password in a CyberArk Vault and Safe, and saves it to a parameter.

## C Language

    int lr_cyberark_get_vault("param1=value1", "param2=value2", LAST);

## Java Language

    int lr.cyberark_get_vault(String[] args);

## Arguments

Name | Comments
--- | ---
ServerUrl | URL for the web request.
CertPath | The path for the certificate.
KeyPath | (Optional) The path for a private key.
Password | (Optional) The password for the private key.
AppID | The application ID to use for the web request.
Safe | The safe on CyberArk in which the application belongs.
AccountName | The Object Name of the account (referred to as Name in the account properties).
ExtraQueryData | (Optional) Extra data for the query (if any) should be in key=value format.
ResultParamName | Parameter name where the token (the secret password) will be saved.

## Return Values

Returns 0 on success, or 1 for an error.

## Parameterization

All string input arguments can be passed using standard parameterization.

## General Information

The certificate and private key must be in PEM format.

## Examples

For C language:

Copy code

    lr_cyberark_get_vault(
           "ServerUrl=https://test.skytap.com/AIMWebService/api/Accounts",
           "CertPath=D:\\feature\\cyberark\\Certs needed to make CCP call\\client_1-28.crt",
            "KeyPath=D:\\feature\\cyberark\\Certs needed to make CCP call\\client.pem", // optional
            "Password=Cyberark1", // optional
            "AppID=testappid",
            "Safe=Test",
            "AccountName=testobject1",
            "ResultParamName=TEST",
            LAST);

For Java:

Copy code

    lr.cyberark_get_vault(new String[]{
            "ServerUrl=https://test.skytap.com/AIMWebService/api/Accounts",
            "CertPath=D:\\feature\\cyberark\\Certs needed to make CCP call\\client_1-28.crt",
            "KeyPath=D:\\feature\\cyberark\\Certs needed to make CCP call\\client.pem", // optional
            "Password=Cyberark1", // optional
            "AppID=testappid",
            "Safe=Test",
            "AccountName=testobject",
            "ResultParamName=TEST"});

Tips to improve your search results... VuGen Function Reference Version 25.1-25.3 Function Reference 25.1-25.3 All View Local Help Center View Online Help Center Version: