Environment
- Carbon Black Cloud Console: All Versions
- Audit and Remediation (CB LiveOps)
- Enterprise EDR (CB ThreatHunter)
- Managed Detection (CB ThreatSight)
- Endpoint Standard (CB Defense)
- Endpoint Advanced (CB Defense + CB LiveOps)
- Endpoint Enterprise (CB Defense + CB LiveOps + CB ThreatHunter)
- Machine able to run cURL commands
Objective
To export the list of Administrators from Settings > Users via cURL as a workaround to not having an Export button/link built into the Console on the Users page
Resolution
1. Create API Key
- Log into Console
- Go to Settings > API Keys
- Copy Org ID (top-left, <OrgID> below)
- Click 'Add API Key' button
- 'Add API Key' modal/pop-up appears
- Enter name for easy identification
Example: General_Export_From_Console
- Set Access Level
Access level: Custom
Custom access level: View All
*Warning message can be ignored:
This permission set may contain unversioned APIs. Visit developer.carbonblack.com for all currently supported/versioned APIs.
- Enter Description as desired
- Click 'Save'
- Copy API credentials displayed (<API_ID>, <API_Secret_Key> below)
2. Export Admin Users
- Log into machine able to run cURL
- Run API call to export the data
curl -H X-Auth-Token:<API_Secret_Key>/<API_ID> https://<Dashboard_URL>/appservices/v5/orgs/<ORG_ID>/users
- Save data to file as desired
Additional Notes
- The API above (.../appservices/v5/orgs/<ORG_ID>/users) is an unofficial and unsupported API which is used to populate information for the Console UI and is not supported for use as a standalone API
- Being an unsupported API means the specified route/endpoint could be changed at any point and without notice
- The Role (adminRole) will be displayed as DEPRECATED, as the API has not been updated to work with newer Admin Roles (Level 1/2/3 Analyst, Super Admin, and others)
- For ease of use, there are a number of options available online to convert JSON files to CSV using Python, Java, etc.
Related Content