User and Workspace management commands
This page describes all commands that allow users and workspaces to be managed with their options (see also common options available for all commands).
create a workspace
update a workspace
delete a workspace
list users
create a user
describe a user
update user profile
update user password
delete a user
Notice: an Akamas workspace (user) is an Akamas resource (see list of Akamas resources) so you can also refer to resource management commands.
Create workspace
The create workspace command allows defining a new workspace:
The following snippet shows an example:
After the workspace has been created you can add users to the workspace with the following command:
See Update user section for further details
Update workspace
The update workspace command allows updating the workspace name:
with the following options:
--name TEXT
yes
New workspace name
The following snippet shows an example:
Delete workspace
The delete workspace command allows deleting a workspace:
with the following options:
-y
no
Show this message and exit
The following snippet shows an example:
List users
The list users command returns the list of the available users.
The following snippet shows an example:
Create user
The create user command allows defining a new user and assigning it to one or more workspaces.
with the following options
-u, --username TEXT
yes
Username
-p, --password TEXT
yes
Password
--first-name TEXT
no
User first name
--last-name TEXT
no
User last name
--email TEXT
no
Valid email
-w, --add-to-workspace TEXT
no
Add the user to the specified workspace with the specified role (R|W) (e.g., --add-to-workspace WORKSPACE_A R). The option can be specified multiple times to add more workspaces.
--admin
no
Specify if you want to give Administration privileges to the user
The default policy requires the password to satisfy the following rules:
Include one or more uppercase characters (A-Z)
Include one or more special characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/)
The username and password can be either provided interactively or as command arguments.
The following snippet shows the process of creating a new user interactively:
The same action can be performed using the command options:
Describe user
The describe user command returns the details of a valid user matching the provided username or ID:
Notice: users without administrative privileges can only describe their profiles, while administrators can inspect any profile.
The following snippet shows an example:
Update user
The update user command allows updating the user profile attributes for the user matching the username or ID:
with the following options:
--first-name TEXT
no
User first name
--last-name TEXT
no
User last name
--email TEXT
no
Valid email
-w, --add-to-workspace TEXT
no
Add the user to the specified workspace with the specified role (R|W) (e.g., --add-to-workspace WORKSPACE_A R). The option can be specified multiple times to add more workspaces.
-r, --remove-from-workspace TEXT
no
Remove the user from the specified workspace
--admin
no
Specify if you want to give Administration privileges to the user
--no-admin
no
Specify if you want to remove Administration privileges to the user
For single sign-on users is possible to update only the workspaces and the administration privilege. It is not possible to modify the profile info.
The following snippet shows an example of updating the email of a user:
This command is also used to grant or revoke access to workspaces and administrative privileges to users.
The following snippet shows an example of updating the user’s workspace access privileges, adding write privileges on Workspace 1, and revoking access on Default:
Update password
The update password command updates the password for the user matching the username or ID:
with the following options:
-p, --password TEXT
yes
New password
Users without administrative privileges can update only their own passwords, while administrators can perform this action on any profile.
Single sign-on users can't change their password using the Akamas CLI. They must manage their passwords through the configured external identity provider.
The default policy requires the password to satisfy the following rules:
Include one or more uppercase characters (A-Z)
Include one or more special characters (~!@#$%^&*_-+=`|\(){}[]:;"'<>,.?/)
The password can be either provided interactively or as command arguments.
The following snippet shows the prompts to update the user password:
The same action can be performed using the command options:
Delete user
The delete user command removes the user with the provided username or id:
with the following options:
-y
no
Automatic yes to prompts
The following snippet shows an example of deleting interactively a user:
Last updated