Skip to main content

Account overview


The account endpoints provide the primary identity and organizational structure for controlling access to the resources. An account can consist of one of the following:

  • Single person

  • Group of people

  • Internal software service

A single person or group of people is identified through a user token. A software service is represented with a service token.

At a high level, an account is a collection of the following:

  • Associated person or group of people or software service

  • One or more workspaces

  • One or more BlueXP Connectors

Each account has a name selected by the administrator. In addition, a unique identifier is assigned by the system when the account is created. You must include the account ID on subsequent API calls to refer to the account.

The following actions can be performed with the account endpoints:

  • Create an account

  • Delete an account

  • Associate a user (person) to an account

  • Disassociate a user from an account

  • List the users of an account

  • List the services (service accounts) of an account

  • List the members (users and services) of an account

  • List the roles and permissions of an account

  • Leave an account

  • Allow a user to enable or disable receiving BlueXP notifications

  • List the accounts a user is associated with

  • Migrate the configuration data from one account to another account

  • Rename an account

  • Set miscellaneous account enablement options