Integrated Digital Engineering on AWS
  • 🚀First Time Users
    • What is IDEA?
    • Install IDEA
      • Pre-Requisites
      • Standard Installation
    • Access your IDEA cluster
      • Web Interface
      • Virtual Desktops (Linux/Windows)
      • SSH
      • APIs
    • File Browser
    • Let's get started
    • Cluster operations
      • Update IDEA cluster
        • Patch IDEA module (idea-admin.sh patch)
        • Update IDEA configuration (idea-admin.sh config)
        • Update IDEA backend resource (idea-admin.sh deploy)
      • Uninstall IDEA
  • 🤖Modules
    • What is a module?
    • Virtual Desktop Interfaces
      • User Documentation
        • Create a virtual desktop (Linux/Windows)
        • Stop/Delete/Hibernate a virtual desktop
        • Modify a virtual desktop
        • Share a virtual desktop
        • Virtual desktop scheduling
      • Admin Documentation
        • Dashboard
        • Sessions
        • Virtual Desktop Images (Software Stacks)
        • Permissions management
      • Technical
        • APIs
    • HPC Workloads
      • User Documentation
        • Submit a job
        • Control my jobs
        • Supported EC2 parameters
        • Job Storage
        • Troubleshooting
          • My job is not starting
      • Admin Documentation
        • Queue Profiles
        • Create Web Based Job Submission Worfklows
        • Configure Floating License resources
    • Cluster Manager
      • Projects Management
      • Users Management
      • Groups Management
      • Cluster Status
      • Email Templates
      • APIs
    • Shared Storage
      • Storage Management
  • 👑Best Practices
    • Analytics
      • OpenSearch
        • Configure your OpenSearch
        • Create your own analytics visualizations
    • Budget
      • Review your AWS spend
      • Control your AWS spend
      • Set up budget per project
    • Security
      • Backup IDEA environment
  • 🧱Architecture
    • High Level Overview
  • 🛠️Developer Portal
    • IDEA CLI utility
    • Developer Onboarding
  • 🚨Help and Support
    • FAQ
    • Raise a bug
Powered by GitBook
On this page
  • Create a new user
  • Understanding Confirmation Status
  • Enable a user
  • Disable a user
  • Give user Cluster Admin privileges
  • Remove Cluster Admin privileges for a user
  • Add user to group
  • Remove user from group
  • Reset password for a user
  • Add a batch of users
  • ideactl accounts
  1. Modules
  2. Cluster Manager

Users Management

PreviousProjects ManagementNextGroups Management

Last updated 1 year ago

To manage IDEA users, navigate to the "Cluster Management" section on the left sidebar of IDEA menu and click "Users"

Create a new user

  1. Click "Create User"

  2. Specify the username

  3. Specify the email address

  4. Select whether or not the email is verified.

    1. NO (default & recommended): A temporary password will be send to the email and user will need to change it at first login

    2. YES: You will be asked to manually set up a password for the user

  5. Choose the permissions applicable for the user. To learn more about the different permissions, refer to Groups Management

  6. Choose the login shell

If "Email is Verified" is not checked during account creation, the user will receive a welcome email message with a temporary password. User will be required to change this password after first successful login.

Understanding Confirmation Status

Confirmed: User can log in to IDEA

Force Change Password: User will be required to change his/her password after the next successful login

Enable a user

  • Select a user with Status set to "Disabled"

  • Click "Actions" then "Enable User"

Disable a user

  • Select a user with Status set to "Enabled"

  • Click "Actions" then "Disable User"

Give user Cluster Admin privileges

  • Select a standard user

  • Click "Actions" then "Set as Admin user"

Remove Cluster Admin privileges for a user

  • Select a user with admin privileges

  • Click "Actions" then "Remove as Admin user"

Add user to group

  • Select the user

  • Click "Actions" then "Add User to Group"

  • Choose the group from the list

Remove user from group

  • Select the user

  • Click "Actions" then "Remove User From Group"

  • Select the group(s) you want your user to be removed from

Reset password for a user

  • Select the user

  • Click "Actions" then "Reset Password"

You cannot reset the password of a user if his/her confirmation status is not "Confirmed"

Add a batch of users

Login to the cluster manager and run ideactl accounts batch-create-users to create multiple users in a single command. Users informations (username/email ...) must be specified via a .csv file

ideactl accounts

IDEA provides ideactl utility in case you cannot access the web interface but needs to interact with users. To get started, log in to the Cluster Manager EC2 machine and run ideactl accounts

ideactl accounts
Usage: ideactl accounts [OPTIONS] COMMAND [ARGS]...

  account management options

Options:
  --help  Show this message and exit.

Commands:
  batch-create-users  creates users from csv file
  create-user         create new user account
  delete-user         delete user
  disable-user        disable user
  enable-user         enable user
  get-user            get user
  list-users          list existing users
  modify-user         update an existing user account

For example, here is how to create a new user, setting a temp password and giving this user admin permission

# ideactl accounts create-user --email "mcrozes@myemail.com" --password "Password123@" --username "mcrozes2" --sudo --email-verified
{
  "username": "mcrozes2",
  "email": "mcrozes@myemail.com",
  "uid": 5068,
  "gid": 5077,
  "group_name": "mcrozes2-user-group",
  "login_shell": "/bin/bash",
  "home_dir": "/data/home/mcrozes2",
  "sudo": true,
  "status": "CONFIRMED",
  "enabled": true,
  "created_on": "2022-12-21T16:37:32.033000+00:00",
  "updated_on": "2022-12-21T16:37:32.033000+00:00"
}
🤖
Users portal
Example of invitation email
Example of group selection