Command Reference - SuperADMIN

This section describes the SuperADMIN commands.

auth, authentication — This command controls user authentication. Use it to configure an external authentication service, such as LDAP, SAML or Active Directory.

account — This command allows you to create and manage users and groups.

cat — Use this command to configure the catalogue; the collection of datasets and folders available to SuperSERVER.

cfg — This command is used to change configuration properties that are stored in the SuperSTAR configuration server.

connection — This command configures the settings used to connect to the administration domain.

console — This command controls the SuperADMIN display output.

createdatabaselist — This command creates a text file containing a list of all the databases in the catalogue.

displayoptions — This command is used to set the display precision for summation options in SuperWEB2.

exit, quit — This command closes the SuperADMIN console.

export — This command exports the current database catalogue to a macro file.

gc, config, globalconfiguration — This command manages some global configuration properties, most of which relate to the creation of personal folders in the discontinued SuperWEB1 product. The personal folder settings do not apply to SuperWEB2.

help — This command displays a list of currently available commands and details of what they do.

login — Logs in to SuperADMIN. You must login to start configuring users and permissions.

loginConfig — This command allows you to customise the SuperWEB2 login page for SAML authentication by creating and configuring “login groups”.

loginToken — Logs in to SuperADMIN using a single-use token.

logout — Logs the current user out of the console.

macro — When performing repetitive tasks, instead of entering each command at the command line, you can enter the commands in a macro and then run the macro.

method — The method command is used to set parameters for data control plugins and apply the plugins to a database.

mode — This command sets one of the SuperADMIN commands as the current "mode" of the console. The specified command is then automatically prefixed to future commands so you do not have to type it each time.

ranges — This command configures the limits for the custom range and quantile user defined fields available in SuperWEB2.

refreshFamilies — This command allows you to revoke JWT key refresh families.

server — This command maintains the settings for the registered and available SuperSERVERs.

table — Use this command to manage shared tables saved to the User Data Repository (UDR).

tokenKeys — This command allows you to view and manage the keys used for signing JSON Web Tokens (JWTs).

user — This command displays the name of the currently logged in user.

userreg — This command allows you to check whether an email address is blocked by the user registration system and manually block or unblock an address.

Command Syntax

The following command syntax is used throughout these instructions:

Element	Description
`{ }`	Indicates a set of possible choices.
`\|`	Separates two mutually exclusive choices in a syntax line. Type one of the choices (do not type the `\|` symbol).
`< >`	Specifies some information you must provide (such as a path or filename). Replace with the relevant value for your system.
`...`	Indicates that an argument can be repeated several times in a command line. Type only the information, not the ellipsis.
`[ ]`	Indicates optional items.
`" "`	Whenever you specify a value or argument that contains a space (for example an ID or a display name) you must enclose it in quotes. You must also use quotes for a value or argument that is alphanumeric but starts with a numeric character.

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.