{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"676230f3-7895-4a35-a20f-57bd846e1a92","name":"CyberArk REST API [PUBLIC]","description":"All available requests in CyberArk Identity Security Platform.\n\n## **DUE TO INTERNAL CYBERARK POLICY, AS OF 2/18/2024 POSTMAN WILL NO LONGER BE USED DUE TO SYNCHRONIZATION OF DATA TO THE CLOUD. NO FURTHER UPDATES TO THIS COLLECTION WILL OCCUR.**\n\n# THIS IS UNOFFICIAL DOCUMENTATION\n\nThis collection is backed up at [https://github.com/infamousjoeg/CyberArk-RESTAPI](https://github.com/infamousjoeg/CyberArk-RESTAPI).\n\n## New Features & Additions\n\n- Added Endpoint Privilege Manager API\n- Added Discovery & Visibility API for Secrets Hub\n- Fixed bugs in Conjur Enterprise API\n    \n\nHappy automating!\n\n## Quick Start YouTube Video Series\n\n[<img src=\"https://img.youtube.com/vi/Sq-cwn_1lvk/0.jpg\" alt=\"How to Use Postman for No Code Development with CyberArk\">](https://www.youtube.com/watch?v=Sq-cwn_1lvk&list=PL-p_9AwMQDmmqsBus-Bukn3mQaJE0kHzC&index=1)\n\n## Want to use a CLI? Get cybr-cli for your OS!\n\n[https://github.com/infamousjoeg/cybr-cli](https://github.com/infamousjoeg/cybr-cli)\n\n## Community Tools\n\n- [psPAS](https://github.com/pspete/psPAS) - PowerShell Module for CyberArk's REST API\n- [IdentityCommand](https://github.com/pspete/IdentityCommand) - PowerShell Module for CyberArk Identity (Supports psPAS)\n- [CredentialRetriever](https://github.com/pspete/CredentialRetriever) - PowerShell Module for CyberArk's Application Access Manager (AAM)\n- [pyAIM](https://github.com/infamousjoeg/pyAIM) - Python Client Library for CyberArk's Application Access Manager (AAM)\n    \n\n## Code Examples\n\n- [cyberark/epv-api-scripts](https://github.com/cyberark/epv-api-scripts)\n- [infamousjoeg on GitHub](https://github.com/infamousjoeg?tab=repositories)\n- [CyberArk's Automation Greatest Hits (Awesome List of Automation)](https://cybr.rocks/greatesthits)\n    \n\n## YouTube Videos Playlist\n\n- [CyberArk Videos Playlist Curated by InfamousJoeG](https://www.youtube.com/playlist?list=PL-p_9AwMQDmkS6rCXQrINn0Xc7dv73dWU)\n    \n\n## Maintainer\n\n[Joe Garcia](https://github.com/infamousjoeg)\n\n[Buy me a coffee](https://www.buymeacoffee.com/infamousjoeg)\n\n## Status Codes\n\n| Status Name | Status Code | Status Description |\n| --- | --- | --- |\n| Success | 200 | The request succeeded. The actual response will depend on the request method used. |\n| Created | 201 | The request was fulfilled and resulted in a new resource being created. |\n| Bad Request | 400 | The request could not be understood by the server due to incorrect syntax. |\n| Unauthorized | 401 | The request requires user authentication. |\n| Forbidden | 403 | The server received and understood the request, but will not fulfill it. Authorization will not help and the request MUST NOT be repeated. |\n| Not Found | 404 | The server did not find anything that matches the Request-URI. No indication is given of whether the condition is temporary or permanent. |\n| Conflict | 409 | The request could not be completed due to a conflict with the current state of the resource. |\n| Internal Server Error | 500 | The server encountered an unexpected condition which prevented it from fulfilling the request. |\n\n_NOTE: If you are having issues with DEL or PUT methods, make sure that your Password Vault Web Access (PVWA) Server's IIS instance does not include WebDav Publishing. This will cause known issues._","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"998920","team":30093,"collectionId":"676230f3-7895-4a35-a20f-57bd846e1a92","publishedId":"RzZ9Gz1U","public":true,"publicUrl":"https://documenter-api.postman.tech/view/998920/RzZ9Gz1U","privateUrl":"https://go.postman.co/documentation/998920-676230f3-7895-4a35-a20f-57bd846e1a92","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-02-18T01:59:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"CyberArk Environment","id":"dc8d1752-318e-402a-a5e8-d2036ed16079","owner":"998920","values":[{"key":"saasSubdomain","value":"companyname","enabled":true,"type":"default"},{"key":"identityTenantId","value":"xxx1234","enabled":true,"type":"default"},{"key":"identityUsername","value":"identity_user@cyberark.cloud.12345","enabled":true,"type":"default"},{"key":"identityPassword","value":"","enabled":true,"type":"secret"},{"key":"pasBaseURL","value":"https://pvwa.example.com","enabled":true},{"key":"pasAuthType","value":"cyberark","enabled":true,"type":"default"},{"key":"pasAPIUsername","value":"Administrator","enabled":true},{"key":"pasAPIPassword","value":"","enabled":true,"type":"secret"},{"key":"pasNewPassword","value":"","enabled":true,"type":"secret"},{"key":"pasSAMLToken","value":"","enabled":true,"type":"secret"},{"key":"pasSessionToken","value":"","enabled":true,"type":"secret"},{"key":"pasSafe","value":"D-APP-Ansible","enabled":true},{"key":"pasUserName","value":"Svc_CybrAutomation","enabled":true},{"key":"pasAddress","value":"example.com","enabled":true},{"key":"pasObjectName","value":"Operating System-WinDomain-10.0.4.48-Svc_CybrAutomation","enabled":true},{"key":"pasAccountID","value":"2_25","enabled":true},{"key":"pasKeywords","value":"searchterms","enabled":true},{"key":"pasFolder","value":"Root","enabled":true},{"key":"pasExtraPassIndex","value":"1","enabled":true,"type":"default"},{"key":"pasGroupName","value":"DualAccountGroup","enabled":true},{"key":"pasSafeMember","value":"Vault Admins","enabled":true},{"key":"pasPlatformName","value":"WinDomain","enabled":true},{"key":"pasRequestID","value":"1","enabled":true},{"key":"pasComponentsID","value":"pvwa","enabled":true},{"key":"pasBulkID","value":"1","enabled":true},{"key":"pasKeyID","value":"SSHKeyID","enabled":true},{"key":"pasUserID","value":"1","enabled":true},{"key":"pasGroupID","value":"1","enabled":true},{"key":"pasAuthID","value":"saml","enabled":true},{"key":"psmLiveSessionID","value":"1","enabled":true},{"key":"psmRecordingsID","value":"1","enabled":true},{"key":"aamAppID","value":"Ansible","enabled":true},{"key":"aamAuthMethodID","value":"1","enabled":true,"type":"default"},{"key":"ldapID","value":"cyberarkdemo.com","enabled":true},{"key":"ldapMappingID","value":"1","enabled":true},{"key":"conjurHostname","value":"https://conjur.example.com","enabled":true},{"key":"conjurUsername","value":"admin","enabled":true},{"key":"conjurPassword","value":"","enabled":true,"type":"secret"},{"key":"conjurNewPassword","value":"","enabled":true,"type":"secret"},{"key":"conjurAPIKey","value":"","enabled":true,"type":"secret"},{"key":"conjurSessionToken","value":"","enabled":true,"type":"secret"},{"key":"conjurAccount","value":"orgaccount","enabled":true},{"key":"conjurHostID","value":"host/ansible","enabled":true},{"key":"conjurSecretID","value":"aws/access_key_id","enabled":true},{"key":"conjurSecretValue","value":"","enabled":true,"type":"secret"},{"key":"conjurSecretK8sCaCert","value":"conjur/authn-k8s/serviceid/ca-cert","enabled":true},{"key":"conjurSecretK8sServiceAccountToken","value":"conjur/authn-k8s/serviceid/service-account-token","enabled":true},{"key":"conjurPolicyID","value":"policyID","enabled":true},{"key":"conjurGroupID","value":"vault/LOB_CI/CICD-Secrets/delegation/consumers","enabled":true,"type":"default"},{"key":"ptaBaseURL","value":"https://pta.example.com","enabled":true},{"key":"ptaAPIUsername","value":"Administrator","enabled":true,"type":"default"},{"key":"ptaAPIPassword","value":"","enabled":true,"type":"secret"},{"key":"ptaSessionToken","value":"","enabled":true},{"key":"ptaSecurityEventID","value":"1","enabled":true},{"key":"identitySessionID","value":"Automatically Populated","enabled":true,"type":"default"},{"key":"identityMechanismID","value":"Automatically Populated","enabled":true,"type":"default"},{"key":"identityMechanismID2","value":"Automatically Populated","enabled":true,"type":"default"},{"key":"identityToken","value":"","enabled":true,"type":"secret"},{"key":"identitySCIMAppID","value":"ApplicationID","enabled":true,"type":"default"},{"key":"identitySCIMUsername","value":"identity_service_user@cyberark.cloud.12345","enabled":true,"type":"default"},{"key":"identitySCIMSecret","value":"","enabled":true,"type":"secret"},{"key":"identitySCIMResourceAttribute","value":"","enabled":true,"type":"default"},{"key":"identitySCIMAttributeString","value":"","enabled":true,"type":"default"},{"key":"identitySCIMUserID","value":"","enabled":true,"type":"default"},{"key":"identitySCIMGroupID","value":"","enabled":true,"type":"default"},{"key":"identitySCIMContainerName","value":"","enabled":true,"type":"default"},{"key":"identitySCIMObjectName","value":"","enabled":true,"type":"default"},{"key":"identitySCIMPrivilegedDataID","value":"","enabled":true,"type":"default"},{"key":"identitySCIMResourceType","value":"","enabled":true,"type":"default"},{"key":"identitySCIMObjectType","value":"","enabled":true,"type":"default"},{"key":"epmDispatcherAddress","value":"login.epm.cyberark.com","enabled":true,"type":"default"},{"key":"epmServerAddress","value":"us1234.epm.cyberark.com","enabled":true,"type":"default"},{"key":"epmUsername","value":"your@email.com","enabled":true,"type":"default"},{"key":"epmPassword","value":"","enabled":true,"type":"secret"},{"key":"epmToken","value":"","enabled":true,"type":"secret"},{"key":"epmVersion","value":"24.1.1.3883","enabled":true,"type":"default"},{"key":"epmSAMLToken","value":"","enabled":true,"type":"default"},{"key":"epmApplicationID","value":"irrelevant","enabled":true,"type":"default"},{"key":"epmSetID","value":"b4d81800-645d-4a9d-82eb-b9a3beaa7110","enabled":true,"type":"default"},{"key":"epmAgentID","value":"20b07993-ca29-4aa3-b2f1-4a611ff3e89c","enabled":true,"type":"default"},{"key":"epmDestinationSetID","value":"","enabled":true,"type":"default"},{"key":"epmPolicyID","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f8b53a05d7a6268f9d30ef41788cd27b8229ebe6e508f7d276da32b26cd5d2ba","favicon":"https://res.cloudinary.com/postman/image/upload/v1567524565/team/nozlytn75m6xnyohwwqo.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"CyberArk Environment","value":"998920-dc8d1752-318e-402a-a5e8-d2036ed16079"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RzZ9Gz1U"}