Users
The orka user
group of commands in the Orka CLI. These commands are used for user management.
Create user
Command
Create a new useruser - To work with Orka, you need to have a user with an assigned license. You will use this user and the respective credentials to authenticate against the Orka service. After being authenticated against the service, you can run Orka CLI commands and Orka API calls. for your Orka environment. This command requires additional administrative authentication with an Orka license key.
orka user create
OR
orka user create -e <EMAIL> --password <PASSWORD> -y
Output


Options
You can pass the following options with orka user create
in direct mode:
Option | Description | Sample value |
---|---|---|
| The email address for the new user. This also serves as username. | |
| A password for the new user. |
|
| An Orka license key used for authentication against your Orka environment. Set this option, if you want to use a license key different from the one cached locally. |
|
| Bypasses the interactive prompt and executes the command with the specified parameters. | |
| Returns the output of the command in |
List users
Command
List all users in your Orka environment. This command requires additional administrative authentication with an Orka license key.
orka user list
Options
You can pass the following options with orka user list
in direct mode:
Option | Description | Sample value |
---|---|---|
| An Orka license key used for authentication against your Orka environment. Set this option, if you want to use a license key different from the one cached locally. |
|
| Returns the output of the command in |
Reset password (Admin-only)
Command
Reset the password for the specified user. This operation is intended for administrators who need to change the password of an existing user.
You must specify the email of the user whose password you want to reset.
This command requires additional administrative authentication with an Orka license key.
orka user reset
OR
orka user reset -e <EMAIL> --password <PASSWORD> -y
Output


Options
You can pass the following options with orka user reset
in direct mode:
Option | Description | Sample value |
---|---|---|
| The username (email) for the user whose password you want to reset. | |
| The new password for the specified user. |
|
| An Orka license key used for authentication against your Orka environment. Set this option, if you want to use a license key different from the one cached locally. |
|
| Bypasses the interactive prompt and executes the command with the specified parameters. | |
| Returns the output of the command in |
Update user
Command
Update your password or change the email address for your Orka user. This operation is intended for regular Orka users who need to update their information or credentials.
orka user update
OR (change current email)
orka user update -e <EMAIL> -y
OR (change current password)
orka user update --password <PASSWORD> -y
OR (change both)
orka user update -e <EMAIL> --password <PASSWORD> -y
Output


Options
You can pass the following options with orka user update
in direct mode:
Option | Description | Sample value |
---|---|---|
| Your username (email). | |
| The new password that you want to use. |
|
| Bypasses the interactive prompt and executes the command with the specified parameters. | |
| Returns the output of the command in |
Delete user
Command
Deletes the specified user. The user must have no Orka resources associated with them. This command requires additional administrative authentication with an Orka license key.
orka user delete
OR
orka user delete -e <EMAIL> -y
Output


Options
You can pass the following options with orka user group
in direct mode:
Option | Description | Sample value |
---|---|---|
| The username (email) of the user that you want to delete. | |
| An Orka license key used for authentication against your Orka environment. Set this option, if you want to use a license key different from the one cached locally. |
|
| Bypasses the interactive prompt and executes the command with the specified parameters. | |
| Returns the output of the command in |
Manage user grouping
Command
Applies or removes a user group label from the specified user. The user must exist.
orka user group
OR
orka user group -g <GROUP> -e <EMAIL> -y
OR (to remove a user group)
orka user group -g -e <EMAIL> -y
Output


Options
You can pass the following options with orka user group
in direct mode:
Option | Shorthand option | Description | Sample value |
---|---|---|---|
|
| The username (email) of the user whose user group label you want to modify. | |
|
| The user group label that you want to apply. The label may or may not already exist. To remove a group label, leave blank. |
|
| Bypasses the interactive prompt and executes the command with the specified parameters. | ||
| Returns the output of the command in |
Updated 10 months ago