blob: d0fc3f8734f86b4bf5e864b5fbe358f6f81a614c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
====
user
====
Identity v2, v3
user create
-----------
Create new user
.. program:: user create
.. code:: bash
openstack user create
[--domain <domain>]
[--project <project> [--project-domain <project-domain>]]
[--password <password>]
[--password-prompt]
[--email <email-address>]
[--description <description>]
[--multi-factor-auth-rule <rule>]
[--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]
[--enable | --disable]
[--or-show]
<user-name>
.. option:: --domain <domain>
Default domain (name or ID)
.. versionadded:: 3
.. option:: --project <project>
Default project (name or ID)
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. option:: --password <password>
Set user password
.. option:: --password-prompt
Prompt interactively for password
.. option:: --email <email-address>
Set user email address
.. option:: --description <description>
User description
.. versionadded:: 3
.. option:: --ignore-lockout-failure-attempts
Opt into ignoring the number of times a user has authenticated and
locking out the user as a result
.. option:: --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
.. option:: --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.
.. option:: --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.
.. option:: --ignore-password-expiry
Opt into allowing user to continue using passwords that may be
expired
.. option:: --no-ignore-password-expiry
Opt out of allowing user to continue using passwords that may be
expired
.. option:: --enable-lock-password
Disables the ability for a user to change its password through
self-service APIs
.. option:: --disable-lock-password
Enables the ability for a user to change its password through
self-service APIs
.. option:: --enable-multi-factor-auth
Enables the MFA (Multi Factor Auth)
.. option:: --disable-multi-factor-auth
Disables the MFA (Multi Factor Auth)
.. option:: --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.
.. option:: --enable
Enable user (default)
.. option:: --disable
Disable user
.. option:: --or-show
Return existing user
If the username already exist return the existing user data and do not fail.
.. describe:: <user-name>
New user name
user delete
-----------
Delete user(s)
.. program:: user delete
.. code:: bash
openstack user delete
[--domain <domain>]
<user> [<user> ...]
.. option:: --domain <domain>
Domain owning :ref:`\<user\> <user_delete-user>` (name or ID)
.. versionadded:: 3
.. _user_delete-user:
.. describe:: <user>
User(s) to delete (name or ID)
user list
---------
List users
.. program:: user list
.. code:: bash
openstack user list
[--project <project>]
[--domain <domain>]
[--group <group> | --project <project>]
[--long]
.. option:: --project <project>
Filter users by `<project>` (name or ID)
.. option:: --domain <domain>
Filter users by `<domain>` (name or ID)
*Identity version 3 only*
.. option:: --group <group>
Filter users by `<group>` membership (name or ID)
*Identity version 3 only*
.. option:: --long
List additional fields in output
user set
--------
Set user properties
.. program:: user set
.. code:: bash
openstack user set
[--name <name>]
[--project <project> [--project-domain <project-domain>]]
[--password <password>]
[--password-prompt]
[--email <email-address>]
[--description <description>]
[--multi-factor-auth-rule <rule>]
[--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]
[--enable|--disable]
<user>
.. option:: --name <name>
Set user name
.. option:: --domain <domain>
Domain the user belongs to (name or ID).
This can be used in case collisions between user names exist.
.. versionadded:: 3
.. option:: --project <project>
Set default project (name or ID)
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. option:: --password <password>
Set user password
.. option:: --password-prompt
Prompt interactively for password
.. option:: --email <email-address>
Set user email address
.. option:: --description <description>
Set user description
.. versionadded:: 3
.. option:: --ignore-lockout-failure-attempts
Opt into ignoring the number of times a user has authenticated and
locking out the user as a result
.. option:: --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
.. option:: --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.
.. option:: --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.
.. option:: --ignore-password-expiry
Opt into allowing user to continue using passwords that may be
expired
.. option:: --no-ignore-password-expiry
Opt out of allowing user to continue using passwords that may be
expired
.. option:: --enable-lock-password
Disables the ability for a user to change its password through
self-service APIs
.. option:: --disable-lock-password
Enables the ability for a user to change its password through
self-service APIs
.. option:: --enable-multi-factor-auth
Enables the MFA (Multi Factor Auth)
.. option:: --disable-multi-factor-auth
Disables the MFA (Multi Factor Auth)
.. option:: --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.
.. option:: --enable
Enable user (default)
.. option:: --disable
Disable user
.. describe:: <user>
User to modify (name or ID)
user show
---------
Display user details
.. program:: user show
.. code:: bash
openstack user show
[--domain <domain>]
<user>
.. option:: --domain <domain>
Domain owning :ref:`\<user\> <user_show-user>` (name or ID)
.. versionadded:: 3
.. _user_show-user:
.. describe:: <user>
User to display (name or ID)
|
