Manage Users on Your API Gateway

Use the following commands if you need to list, add, update or remove authenticated users on your API gateway.

Note: For a list of all the API gateway commands, see API Gateway (APIGW) Command Index.

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw user list

  3. Below is an example of the output:

    4. EMAIL        ENABLED    ROLES
========     =======    =====
jane_doe     true       superadmin (apigw-admin, appliance-controller-admin, client-management-admin)
john_doe     true       admin (appliance-controller-admin, flexsync-admin, stornext-admin)
sarah_doe    true       user (appliance-controller-user, flexsync-user, stornext-user)

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw user add <email> OPTIONS

    Below are the available options for the user add command.

    Option Description.

    -r, or --role

    This option allows you to specify the role of a user. Enter one of the following roles:

    • user
    • admin
    • superadmin

    The default is user. See About User Roles for more information about each user role.

    -e, or --enabled

    This option allows you to specify if a user is enabled or disabled. Enter one of the following:

    • true
    • false

    The default is true.

    -p, or --password

    		 This option allows you to specify a password for a user account.

    Example

    /opt/quantum/api-gateway/bin/apigw user add jdoe@mycompany.com -r admin -e true -p mypassword12345

About User Roles

The table below provides information about what each role is allowed to perform.

User Role Description
user
  • Execute read-only commands in StorNext.
  • Execute read-only commands in FlexSync.
  • Execute read-only commands in NAS.
admin
  • Execute read-write commands in StorNext and all file system pooling commands.
  • Execute read-write commands in FlexSync.
  • Execute read-write commands in NAS.
superadmin
  • Configure mystornext credentials and SSL certificates.
  • Add, update, delete users and assign roles.
  • Add, update, delete clients and assign roles.
  • View the license report.
  • Execute read-only commands in StorNext.
  • Execute read-write commands in StorNext and all file system pooling commands.
  • Execute commands for a user in file system pooling.
  • Execute commands for all users in file system pooling.
  • Execute read-only commands in FlexSync.
  • Execute read-write commands in FlexSync.
  • Execute read-only commands in NAS.
  • Execute read-write commands in NAS.
  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw user update <email> OPTIONS

    Note: The username is the name of a user you want to update on your API gateway. See Show All Users on Your API Gateway.

    Below are the available options for the user update command.

    Option Description.

    -r, or --role

    This option allows you to specify the role of a user. Enter one of the following roles:

    • user
    • admin
    • superadmin

    -e, or --enabled

    This option allows you to specify if a user is enabled or disabled. Enter one of the following:

    • true
    • false

    -p, or --password

    		 This option allows you to specify the password for a user account.

    Example

    /opt/quantum/api-gateway/bin/apigw user update john_doe -r user -e false -p newpassword12345

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. /opt/quantum/api-gateway/bin/apigw user delete <email>

    Note: The email is the user you want to remove from your API gateway. See Show All Users on Your API Gateway.