python-openstackclient/doc/source/command-objects/user.rst
TerryHowe d70df6a4a2 Fix yet more documentation warnings
Change-Id: I87683039601ae90531f27ebebbc4d0b1d252e846
2015-07-21 14:07:18 -06:00

3.5 KiB

user

Identity v2, v3

user create

Create new user

user create

os 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

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

--domain <domain>

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

3

User to delete (name or ID)

user list

List users

user list

os 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

os user set
    [--name <name>]
    [--project <project> [--project-domain <project-domain>]]
    [--password <password>]
    [--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

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

--domain <domain>

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

3

User to display (name or ID)