Product Operations Commands

Note: These commands are for account administrators only.

addproduct

Add a Birst product for a user. Allows the user to have access to the product.

addproduct username product_ID {quantity}

Example:

addproduct pinky@acmelabs.com 2

Use listproducts to get the list of products and their product ID.

The comparable web service is called addProductToUser.

Creates an audit log table. The audit log database must already exist.

Not available as a web service.

Deletes a user account. A user cannot be deleted if the user is the owner of a space.

deleteuser username

Enables or disables a user account.

enableuser username true|false

Example:

enableuser user1@company.com false

Returns the language assigned to a user.

getlanguageforuser username

Gets the release for a user.

getuserrelease username

Lists all supported languages for the account or for a specified user.

listlanguages {username}

Lists all products for the account and their product IDs, or optionally those assigned to a particular user.

listproducts {username}

Example results:

Executing command: listproducts
9, Birst Connect
10, Birst Live Access
11, Birst Web Services

Use addproduct to assign a user access to a product.

Not available as a web service.

Lists the available releases.

listreleases

Remove a product from a user.

removeproduct username product_ID

Use listproducts to see the products assigned to a user and the product ID.

The web service is called RemoveProductFromUser.

Prevents a user from creating a new space.

setdenycreatespace username true|false

There is no web service for this command.

Sets a supported language for a user. Use the listlanguages command to see the list of supported languages with their language codes.

setlanguageforuser username language_code

Example:

setlanguageforuser user1@birst.com en-us

Sets the default space for a user and sets if they default to dashboards (true/false).

setuserdefaultspace username spaceID true|false

Example:

setuserdefaultspace user1@company.com 5bf1dff7-1f47-4dc6-a16b-d8529b76e37b true

Note: Users can set their own default space from their User Settings.

Sets the password for a user.

setuserpassword username password

Example:

setuserpassword user1@company.com h4h4h4N4rf!

Example:

unlockuser user1@company.com