GET /identityManagementSystems/cyberark/paths
Use this method to return a list of all CyberArk paths that are defined in Lenovo XClarity Administrator. A CyberArk path is made up of an application ID, safe, and optional folder that identify the location of onboarded user accounts in CyberArk.
Note
This API requires Lenovo XClarity Administrator v3.2.0 or later.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/identityManagementSystems/cyberark/paths
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
The response body is an array of objects. Each object that contains information about each path to the identity-management system.
| Parameters | Type | Description | ||
|---|---|---|---|---|
| id | String | Path ID | ||
| appId | String | Application ID | ||
| folder | String | Folder | ||
| safe | String | Safe | ||
The following example is returned if the request is successful.
[{
"id": "2",
"appId": "LXCC",
"safe": "safe_1",
"folder": "folder_1",
}, {
"id": "4",
"appId": "LXCC",
"safe": "safe_2",
"folder": ""
}]
Give documentation feedback