Skip to main content

Your submission was sent successfully! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates from Canonical and upcoming events where you can meet our team.Close

Thank you for contacting us. A member of our team will be in touch shortly. Close

An error occurred while submitting your form. Please try again or file a bug report. Close

user

Enter keyword arguments in the form key=value.

Delete a user

maas $PROFILE user delete [--help] [-d] [-k] username [data ...] 

Positional arguments

  • username

Deletes a given username.

Keyword “transfer_resources_to”

Optional String. An optional username. If supplied, the allocated resources of the user being deleted will be transferred to this user. A user can’t be removed unless its resources (machines, IP addresses, …), are released or transfered to another user.

Command-line options

Option Effect
–help, -h Show this help message and exit.
-d, --debug Display more information about API responses.
-k, --insecure Disable SSL certificate check

Retrieve user details

maas $PROFILE user read [--help] [-d] [-k] username [data ...] 

Positional arguments

  • username

Retrieve a user’s details.

Command-line options

Option Effect
–help, -h Show this help message and exit.
-d, --debug Display more information about API responses.
-k, --insecure Disable SSL certificate check

Create a MAAS user account

maas $PROFILE users create [--help] [-d] [-k] [data ...] 

Creates a MAAS user account. This is not safe: the password is sent in plaintext. Avoid it for production, unless you are confident that you can prevent eavesdroppers from observing the request.

Keyword “username”

Required String. Identifier-style username for the new user.

Keyword “email”

Required String. Email address for the new user.

Keyword “password”

Required String. Password for the new user.

Keyword “is_superuser”

Required Boolean. Whether the new user is to be an administrator. (‘0’ == False, ‘1’ == True)

Command-line options

Option Effect
–help, -h Show this help message and exit.
-d, --debug Display more information about API responses.
-k, --insecure Disable SSL certificate check

List users

maas $PROFILE users read [--help] [-d] [-k] [data ...] 

List users

Command-line options

Option Effect
–help, -h Show this help message and exit.
-d, --debug Display more information about API responses.
-k, --insecure Disable SSL certificate check

Retrieve logged-in user

maas $PROFILE users whoami [--help] [-d] [-k] [data ...] 

Returns the currently logged-in user.

Command-line options

Option Effect
–help, -h Show this help message and exit.
-d, --debug Display more information about API responses.
-k, --insecure Disable SSL certificate check

Last updated 3 months ago. Help improve this document in the forum.