How to create an API user and token

Products

• Carbon Black App Control (formerly Cb Protection)

Issue/Introduction

Steps to create an API user and token for API access

Environment

• App Control Console: All supported versions

Resolution

Before starting, please review the App Control API documentation on the server or GitHub (https://github.com/carbonblack) to determine the permissions needed for the API client.

1. Navigate to the App Control console
2. In the console, click the gear icon in the top right corner, go to Login Accounts
3. Click the User Roles tab and then Add User Role button.
   1. On the Add User Role page, provide a Name (for example, “API Connector Extensions”), add a Description, and check the box for each permission needed for the client.
   2. After configuring the group, click the Enabled button in the Status line and click the Create & Exit button at the bottom of the page.
4. Click the Users tab, then on the Login Accounts: Users page click Add User.
   1. On the Add User page, provide a user name (example, “API HashScript”) and password. Afterward, choose the User Role created above
   2. On the bottom of the page, check the Show API token box and then click the Generate button. A string of characters appears in the API Token box.
   3. Copy the API Token to a location where it can be copied to the API code. 
   4. Click the Save button at the bottom of the page.