python-openstackclient/doc/source/command-objects/user.rst
Kevin_Zheng 446e6f2fa8 change os in command example to openstack(3)
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00

3.6 KiB

user

Identity v2, v3

user create

Create new user

user create

openstack user create
    [--domain <domain>]
    [--project <project> [--project-domain <project-domain>]]
    [--password <password>]
    [--password-prompt]
    [--email <email-address>]
    [--description <description>]
    [--enable | --disable]
    [--or-show]
    <user-name>

--domain <domain>

Default domain (name or ID)

3

--project <project>

Default project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--password <password>

Set user password

--password-prompt

Prompt interactively for password

--email <email-address>

Set user email address

--description <description>

User description

3

--enable

Enable user (default)

--disable

Disable user

--or-show

Return existing user

If the username already exist return the existing user data and do not fail.

<user-name>

New user name

user delete

Delete user(s)

user delete

openstack user delete
    [--domain <domain>]
    <user> [<user> ...]

--domain <domain>

Domain owning \<user\> <user_delete-user> (name or ID)

3

User(s) to delete (name or ID)

user list

List users

user list

openstack user list
    [--project <project>]
    [--domain <domain>]
    [--group <group> | --project <project>]
    [--long]

--project <project>

Filter users by <project> (name or ID)

--domain <domain>

Filter users by <domain> (name or ID)

Identity version 3 only

--group <group>

Filter users by <group> membership (name or ID)

Identity version 3 only

--long

List additional fields in output

user set

Set user properties

user set

openstack user set
    [--name <name>]
    [--project <project> [--project-domain <project-domain>]]
    [--password <password>]
    [--password-prompt]
    [--email <email-address>]
    [--description <description>]
    [--enable|--disable]
    <user>

--name <name>

Set user name

--project <project>

Set default project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

--password <password>

Set user password

--password-prompt

Prompt interactively for password

--email <email-address>

Set user email address

--description <description>

Set user description

3

--enable

Enable user (default)

--disable

Disable user

<user>

User to modify (name or ID)

user show

Display user details

user show

openstack user show
    [--domain <domain>]
    <user>

--domain <domain>

Domain owning \<user\> <user_show-user> (name or ID)

3

User to display (name or ID)