Guides
GuidesAPI ReferenceJoin the Mailing ListMake a Suggestion

Users

The orka user group of commands in the Orka CLI. These commands are used for user management.

Create user

Command

Create a new user 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

2022

Options

You can pass the following options with orka user create in direct mode:

OptionDescriptionSample value
-eThe email address for the new user. This also serves as username.[email protected]
--passwordA password for the new user.pa$$w0rd
-lAn 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.orka-license-key
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

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:

OptionDescriptionSample value
-lAn 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.orka-license-key
--jsonReturns the output of the command in JSON.
--rawReturns the output of the command in raw, greppable format.

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

1488

Options

You can pass the following options with orka user reset in direct mode:

OptionDescriptionSample value
-eThe username (email) for the user whose password you want to reset.[email protected]
--passwordThe new password for the specified user.pa$$w0rd
-lAn 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.orka-license-key
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

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

1488

Options

You can pass the following options with orka user update in direct mode:

OptionDescriptionSample value
-eYour username (email).[email protected]
--passwordThe new password that you want to use.pa$$w0rd
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

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

1488

Options

You can pass the following options with orka user group in direct mode:

OptionDescriptionSample value
-eThe username (email) of the user that you want to delete.[email protected]
-lAn 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.orka-license-key
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

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

830

Options

You can pass the following options with orka user group in direct mode:

OptionShorthand optionDescriptionSample value
--email-eThe username (email) of the user whose user group label you want to modify.[email protected]
--group-gThe user group label that you want to apply. The label may or may not already exist.

To remove a group label, leave blank.
mygroup
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.