Administrative commands

Birst provides a set of administrative commands for common activities related to provisioning users and groups, managing spaces, and more. All commands are available to Account Administrators. A subset of commands are available to Space Administrators.

  • Email Domain Whitelisting Commands
  • Group and ACL Commands
  • IP Address Restriction Commands
  • OpenID Connect Commands
  • Password Policy Commands
  • Product Operations Commands
  • Proxy User Commands
  • Report Catalog Commands
  • Salesforce.com Account Mappings Commands
  • Space Operations Commands
  • Usage Tracking Commands
  • User Operations Commands
  • Miscellaneous Commands

Execute commands from:

  • Space Management - Command Window
Note: 
  • If you do not have permission to execute a command, you see the message "Invalid command".
  • When you use the Command Window Help, you see only those commands for which you have permission to execute.
Web Services
  • Unless otherwise stated, the administrative commands are also exposed through web services.
Syntax
  • Pipes (|) signify that you pick one from multiple alternatives.
  • Italics signify arguments to be replaced by the actual values.
  • Items enclosed in brackets {} are optional. Do not include the brackets when specifying the optional arguments.
  • Arguments with spaces should be enclosed with double quotes. For example, "test space",
    Note: The user interface does not allow for double quotes. Double quotes can be used in the command line prompt but results in an error in the user interface.
  • Do not put spaces around equal signs (=).
  • Put a space between parameters.
Related topics