---
title: user
description: Canonical makes open source secure, reliable and easy to use, providing
  support for Ubuntu and a portfolio of enterprise-grade technologies. Founded in
  2004, Canonical operates globally with team members in over 80 countries.
url: https://canonical-com-2950.demos.haus/maas/docs/user?format=md
---

*Submit*

# user

Enter keyword arguments in the form `key=value`.

## [Delete a user](https://canonical-com-2950.demos.haus/maas/docs/user?format=md#p-23254-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](https://canonical-com-2950.demos.haus/maas/docs/user?format=md#p-23254-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](https://canonical-com-2950.demos.haus/maas/docs/user?format=md#p-23254-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](https://canonical-com-2950.demos.haus/maas/docs/user?format=md#p-23254-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](https://canonical-com-2950.demos.haus/maas/docs/user?format=md#p-23254-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 |

---

[Previous

tag](https://canonical-com-2950.demos.haus/maas/docs/tag)
[Next

version](https://canonical-com-2950.demos.haus/maas/docs/version)

Last updated 1 year, 5 months ago. [Help improve this document in the forum](https://discourse.maas.io/t/user/11374).