Manage API Users and Tokens

Products

• Carbon Black App Control (formerly Cb Protection)

Issue/Introduction

Steps to create or manage API Users and Tokens for API access.

Environment

• App Control Console: All Supported Versions

Resolution

1. Verify required permissions needed by reviewing the App Control API Reference.
2. Create or modify a Role for use with the API
   1. Log in to the Console as an administrator and navigate to Settings > Login Accounts > User Roles
   2. Add a User Role (example: API - View Computers)
   3. Create & Exit
3. Add or verify the required Permissions for the relevant User Role
   Important: Use API is required at a minimum.
   1. Navigate to Settings > Login Accounts > User Roles > relevant User Role (example: API - View Computers)
   2. Added required Permissions, example:
      • View Computers
      • Use API
      • Local User Override
   3. Save & Exit
4. Create or modify a User for use with the API Role
   1. Log in to the Console and navigate to Settings > Login Accounts > Users
   2. Add User (example: Agent Checker)
   3. Specify the relevant User Role from Step 2 (Ex: API - View Computers)
   4. Create & Exit
5. Obtain the API Token for the relevant API User
   1. Log in to the Console as the API User.
   2. Navigate to user profile (upper right corner) > User Settings
   3. Check the box: Show API Token
   4. If no API Token is shown, click Generate
   5. Copy the API Token somewhere safe
   6. Click Save

Additional Information

• Getting Started with App Control APIs & Integrations
• Use Postman to Retrieve Data Via API
• If SAML is enabled, the Permission Local User Override may also be required.
• Writing API Scripts and/or supporting the API functionality for customer written scripts falls outside the scope of Carbon Black Support.