Skip to main content

Manage users

In this tutorial, you will learn how to list and disable users using the EDK CLI, this lesson is applicable if you have been given a user_admin role.

To get help with commands for managing users, you can use the edk user --help command.

Usage: edk user [options] [command] <command>

manage users

Options:
  -h, --help                display help for command

Commands:
  list [options]            list all users
  access [options] <email>  manages a users ability to access a server
  help [command]            display help for command

List all users

If you have been provided the user_admin role, you can list all users by running edk user list in the command-line. You can get help with the command by running edk user list --help.

Users available in ELARA.AI cloud host.


USERUUID                             EMAIL              LOGINTYPE FIRSTNAME LASTNAME       ISDISABLED LASTLOGIN
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX name1@email.com    any       First     Last           false      YYYY-MM-DDTHH:MM:SS.MSZ
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX name2@email.com    any       First     Last           false      YYYY-MM-DDTHH:MM:SS.MSZ
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX name3@email.com    any       First     Last           false

Disable a user

If you have been provided the user_admin role, you may also disable a users access by running edk user access in the command-line along with the user email address. You can get help with the command by running edk user access --help.

Run the following in the command-line:

edk user access name1@email.com

Which will result in:

✔ User with id XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX disabled successfully

To enable access, you can run the same command with the --enable option as edk user access name1@email.com --enable:, which would result in:

✔ User with id XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX enabled successfully

Add a local user

If you have been provided the user_admin role, you also create local users by running edk user add in the command-line along with the user email, password, confirmation, and name. You can get help with the command by running edk user add --help.

Run the following in the command-line:

edk user add name1@email.com --password "___USERS_SUPER_SECRET_PASSWORD___" --password-confirm "___USERS_SUPER_SECRET_PASSWORD___" --first-name "name1"

Which will result in:

✔ User name1@email.com created successfully

When created a user will have their access enabled by default.

Next steps

In this tutorial you learnt how to manage users, continue to the next tutorial to learn how to manage user roles.

On this page