Chapter 74. user


This chapter describes the commands under the user command.

74.1. user create

Usage:

openstack user create [-h] [-f {json,shell,table,value,yaml}]

                           [-c COLUMN] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--noindent] [--prefix PREFIX]
                           [--project <project>] [--password <password>]
                           [--password-prompt] [--email <email-address>]
                           [--enable | --disable] [--or-show]
                           <name>
Copy to Clipboard Toggle word wrap

Create new user

Expand
Table 74.1. Positional Arguments
ValueSummary

<name>

New user name

Expand
Table 74.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--project <project>

Default project (name or id)

--password <password>

Set user password

--password-prompt

Prompt interactively for password

--email <email-address>

Set user email address

--enable

Enable user (default)

--disable

Disable user

--or-show

Return existing user

Expand
Table 74.3. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 74.4. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 74.5. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 74.6. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

74.2. user delete

Usage:

openstack user delete [-h] <user> [<user> ...]
Copy to Clipboard Toggle word wrap

Delete user(s)

Expand
Table 74.7. Positional Arguments
ValueSummary

<user>

User(s) to delete (name or id)

Expand
Table 74.8. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

74.3. user list

Usage:

openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]

                         [--max-width <integer>] [--fit-width]
                         [--print-empty] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [--sort-column SORT_COLUMN] [--project <project>]
                         [--long]
Copy to Clipboard Toggle word wrap

List users

Expand
Table 74.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--project <project>

Filter users by project (name or id)

--long

List additional fields in output

Expand
Table 74.10. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 74.11. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 74.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 74.13. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

74.4. user role list

Usage:

openstack user role list [-h] [-f {csv,json,table,value,yaml}]

                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN]
                              [--project <project>]
                              [<user>]
Copy to Clipboard Toggle word wrap

List user-role assignments

Expand
Table 74.14. Positional Arguments
ValueSummary

<user>

User to list (name or id)

Expand
Table 74.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--project <project>

Filter users by <project> (name or id)

Expand
Table 74.16. Output Formatters
ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Expand
Table 74.17. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 74.18. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 74.19. CSV Formatter
ValueSummary

--quote {all,minimal,none,nonnumeric}

when to include quotes, defaults to nonnumeric

74.5. user set

Usage:

openstack user set [-h] [--name <name>] [--project <project>]

                        [--password <user-password>] [--password-prompt]
                        [--email <email-address>] [--enable | --disable]
                        <user>
Copy to Clipboard Toggle word wrap

Set user properties

Expand
Table 74.20. Positional Arguments
ValueSummary

<user>

User to modify (name or id)

Expand
Table 74.21. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set user name

--project <project>

Set default project (name or id)

--password <user-password>

Set user password

--password-prompt

Prompt interactively for password

--email <email-address>

Set user email address

--enable

Enable user (default)

--disable

Disable user

74.6. user show

Usage:

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]

                         [--max-width <integer>] [--fit-width]
                         [--print-empty] [--noindent] [--prefix PREFIX]
                         <user>
Copy to Clipboard Toggle word wrap

Display user details

Expand
Table 74.22. Positional Arguments
ValueSummary

<user>

User to display (name or id)

Expand
Table 74.23. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 74.24. Output Formatters
ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

the output format, defaults to table

-c COLUMN, --column COLUMN

specify the column(s) to include, can be repeated

Expand
Table 74.25. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 74.26. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 74.27. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat