Chapter 87. user

87.1. user create

Create new user

Usage:

openstack user create [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--noindent] [--prefix PREFIX]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--domain <domain>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--password <password>] [--password-prompt]
                             [--email <email-address>]
                             [--description <description>]
                             [--ignore-lockout-failure-attempts]
                             [--no-ignore-lockout-failure-attempts]
                             [--ignore-password-expiry]
                             [--no-ignore-password-expiry]
                             [--ignore-change-password-upon-first-use]
                             [--no-ignore-change-password-upon-first-use]
                             [--enable-lock-password]
                             [--disable-lock-password]
                             [--enable-multi-factor-auth]
                             [--disable-multi-factor-auth]
                             [--multi-factor-auth-rule <rule>]
                             [--enable | --disable] [--or-show]
                             <name>

Table 87.1. Positional arguments
Value	Summary
<name>	New user name

Table 87.2. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Default domain (name or id)
--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
--ignore-lockout-failure-attempts	Opt into ignoring the number of times a user has authenticated and locking out the user as a result
--no-ignore-lockout-failure-attempts	Opt out of ignoring the number of times a user has authenticated and locking out the user as a result
--ignore-password-expiry	Opt into allowing user to continue using passwords that may be expired
--no-ignore-password-expiry	Opt out of allowing user to continue using passwords that may be expired
--ignore-change-password-upon-first-use	Control if a user should be forced to change their password immediately after they log into keystone for the first time. Opt into ignoring the user to change their password during first time login in keystone
--no-ignore-change-password-upon-first-use	Control if a user should be forced to change their password immediately after they log into keystone for the first time. Opt out of ignoring the user to change their password during first time login in keystone
--enable-lock-password	Disables the ability for a user to change its password through self-service APIs
--disable-lock-password	Enables the ability for a user to change its password through self-service APIs
--enable-multi-factor-auth	Enables the mfa (multi factor auth)
--disable-multi-factor-auth	Disables the mfa (multi factor auth)
--multi-factor-auth-rule <rule>	Set multi-factor auth rules. for example, to set a rule requiring the "password" and "totp" auth methods to be provided, use: "--multi-factor-auth-rule password,totp". May be provided multiple times to set different rule combinations.
--enable	Enable user (default)
--disable	Disable user
--or-show	Return existing user

Table 87.3. Output formatter options
Value	Summary
-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 to show multiple columns

Table 87.4. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 87.5. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 87.6. Table formatter options
Value	Summary
--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.

87.2. user delete

Delete user(s)

Usage:

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

Table 87.7. Positional arguments
Value	Summary
<user>	User(s) to delete (name or id)

Table 87.8. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Domain owning <user> (name or id)

87.3. user list

List users

Usage:

openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--noindent] [--max-width <integer>] [--fit-width]
                           [--print-empty] [--sort-column SORT_COLUMN]
                           [--sort-ascending | --sort-descending]
                           [--domain <domain>]
                           [--group <group> | --project <project>] [--long]

Table 87.9. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Filter users by <domain> (name or id)
--group <group>	Filter users by <group> membership (name or id)
--project <project>	Filter users by <project> (name or id)
--long	List additional fields in output

Table 87.10. Output formatter options
Value	Summary
-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 to show multiple columns
--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
--sort-ascending	Sort the column(s) in ascending order
--sort-descending	Sort the column(s) in descending order

Table 87.11. CSV formatter options
Value	Summary
--quote {all,minimal,none,nonnumeric}	When to include quotes, defaults to nonnumeric

Table 87.12. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 87.13. Table formatter options
Value	Summary
--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.

87.4. user password set

Change current user password

Usage:

openstack user password set [-h] [--password <new-password>]
                                   [--original-password <original-password>]

Table 87.14. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--password <new-password>	New user password
--original-password <original-password>	Original user password

87.5. user set

Set user properties

Usage:

openstack user set [-h] [--name <name>] [--domain <domain>]
                          [--project <project>]
                          [--project-domain <project-domain>]
                          [--password <password>] [--password-prompt]
                          [--email <email-address>]
                          [--description <description>]
                          [--ignore-lockout-failure-attempts]
                          [--no-ignore-lockout-failure-attempts]
                          [--ignore-password-expiry]
                          [--no-ignore-password-expiry]
                          [--ignore-change-password-upon-first-use]
                          [--no-ignore-change-password-upon-first-use]
                          [--enable-lock-password] [--disable-lock-password]
                          [--enable-multi-factor-auth]
                          [--disable-multi-factor-auth]
                          [--multi-factor-auth-rule <rule>]
                          [--enable | --disable]
                          <user>

Table 87.15. Positional arguments
Value	Summary
<user>	User to modify (name or id)

Table 87.16. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--name <name>	Set user name
--domain <domain>	Domain the user belongs to (name or id). this can be used in case collisions between user names exist.
--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
--ignore-lockout-failure-attempts	Opt into ignoring the number of times a user has authenticated and locking out the user as a result
--no-ignore-lockout-failure-attempts	Opt out of ignoring the number of times a user has authenticated and locking out the user as a result
--ignore-password-expiry	Opt into allowing user to continue using passwords that may be expired
--no-ignore-password-expiry	Opt out of allowing user to continue using passwords that may be expired
--ignore-change-password-upon-first-use	Control if a user should be forced to change their password immediately after they log into keystone for the first time. Opt into ignoring the user to change their password during first time login in keystone
--no-ignore-change-password-upon-first-use	Control if a user should be forced to change their password immediately after they log into keystone for the first time. Opt out of ignoring the user to change their password during first time login in keystone
--enable-lock-password	Disables the ability for a user to change its password through self-service APIs
--disable-lock-password	Enables the ability for a user to change its password through self-service APIs
--enable-multi-factor-auth	Enables the mfa (multi factor auth)
--disable-multi-factor-auth	Disables the mfa (multi factor auth)
--multi-factor-auth-rule <rule>	Set multi-factor auth rules. for example, to set a rule requiring the "password" and "totp" auth methods to be provided, use: "--multi-factor-auth-rule password,totp". May be provided multiple times to set different rule combinations.
--enable	Enable user (default)
--disable	Disable user

87.6. user show

Display user details

Usage:

openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
                           [--noindent] [--prefix PREFIX]
                           [--max-width <integer>] [--fit-width]
                           [--print-empty] [--domain <domain>]
                           <user>

Table 87.17. Positional arguments
Value	Summary
<user>	User to display (name or id)

Table 87.18. Command arguments
Value	Summary
-h, --help	Show this help message and exit
--domain <domain>	Domain owning <user> (name or id)

Table 87.19. Output formatter options
Value	Summary
-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 to show multiple columns

Table 87.20. JSON formatter options
Value	Summary
--noindent	Whether to disable indenting the json

Table 87.21. Shell formatter options
Value	Summary
--prefix PREFIX	Add a prefix to all variable names

Table 87.22. Table formatter options
Value	Summary
--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.

Ce contenu n'est pas disponible dans la langue sélectionnée.

87.1. user create

87.2. user delete

87.3. user list

87.4. user password set

87.5. user set

87.6. user show

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Rendre l’open source plus inclusif

À propos de Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links