Using login_id as cb_user_id for Delete User API
search cancel

Using login_id as cb_user_id for Delete User API

book

Article ID: 421667

calendar_today

Updated On:

Products

Carbon Black Cloud Enterprise EDR

Issue/Introduction

The customer wants to know which value must be used for the cb_user_id parameter in the Delete User API, or is unable to locate the correct value in the console and API responses.

Environment

  • Carbon Black Cloud Console: All Versions
  • Carbon Black Cloud Sensor: All Versions

Resolution

For the Delete User API, the value that must be used for cb_user_id is the user’s login_id. This login_id value is returned by the List All Users API.

To find the correct value:

  1. Run the List All Users API request.
  2. In the JSON response, locate the user you want to delete (for example by matching email, name, or role).
  3. Note the login_id field in that user object.
  4. Use that login_id value as the cb_user_id parameter in the Delete User API request.

Using any other identifier (such as display name, email, or a different internal ID) instead of login_id for cb_user_id will result in the Delete User operation failing or not targeting the expected account.