@@ -90,14 +90,17 @@ For more NUT options and examples, see <https://github.com/salesforcecli/cli-plu
90
90
* [ ` sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-s] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forceusercreate-namevalue--a-string--f-string--s--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
91
91
* [ ` sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forceuserdisplay--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
92
92
* [ ` sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forceuserlist--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
93
- * [ ` sfdx force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forceuserpasswordgenerate--o-array--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
93
+ * [ ` sfdx force:user:password:generate [-o <array>] [-l <integer>] [-c <integer>] [- v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forceuserpasswordgenerate--o-array--l-integer--c-integer --v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
94
94
* [ ` sfdx force:user:permset:assign -n <array> [-o <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-forceuserpermsetassign--n-array--o-array--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
95
95
96
96
## ` sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-s] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
97
97
98
98
create a user for a scratch org
99
99
100
100
```
101
+ create a user for a scratch org
102
+ Create a user for a scratch org, optionally setting an alias for use by the CLI, assigning permission sets (e.g., permsets=ps1,ps2), generating a password (e.g., generatepassword=true), and setting User sObject fields.
103
+
101
104
USAGE
102
105
$ sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-s] [-v <string>] [-u <string>] [--apiversion
103
106
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -138,13 +141,16 @@ EXAMPLES
138
141
sfdx force:user:create -f config/project-user-def.json email=me@my.org generatepassword=true
139
142
```
140
143
141
- _ See code: [ src/commands/force/user/create.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.0 /src/commands/force/user/create.ts ) _
144
+ _ See code: [ src/commands/force/user/create.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.1 /src/commands/force/user/create.ts ) _
142
145
143
146
## ` sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
144
147
145
148
displays information about a user of a scratch org
146
149
147
150
```
151
+ displays information about a user of a scratch org
152
+ Output includes the profile name, org ID, access token, instance URL, login URL, and alias if applicable.
153
+
148
154
USAGE
149
155
$ sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
150
156
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -172,13 +178,16 @@ EXAMPLES
172
178
sfdx force:user:display -u me@my.org --json
173
179
```
174
180
175
- _ See code: [ src/commands/force/user/display.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.0 /src/commands/force/user/display.ts ) _
181
+ _ See code: [ src/commands/force/user/display.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.1 /src/commands/force/user/display.ts ) _
176
182
177
183
## ` sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
178
184
179
185
list all authenticated users of an org
180
186
181
187
```
188
+ list all authenticated users of an org
189
+ The original scratch org admin is marked with "(A)"
190
+
182
191
USAGE
183
192
$ sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
184
193
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -207,18 +216,43 @@ EXAMPLES
207
216
sfdx force:user:list --json > tmp/MyUserList.json
208
217
```
209
218
210
- _ See code: [ src/commands/force/user/list.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.0 /src/commands/force/user/list.ts ) _
219
+ _ See code: [ src/commands/force/user/list.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.1 /src/commands/force/user/list.ts ) _
211
220
212
- ## ` sfdx force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
221
+ ## ` sfdx force:user:password:generate [-o <array>] [-l <integer>] [-c <integer>] [- v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
213
222
214
223
generate a password for scratch org users
215
224
216
225
```
226
+ generate a password for scratch org users
227
+ Generates and sets a random password for one or more scratch org users. Targets the usernames listed with the --onbehalfof parameter or the --targetusername parameter. Defaults to the defaultusername.
228
+
229
+ If you haven’t set a default Dev Hub, or if your scratch org isn’t associated with your default Dev Hub, --targetdevhubusername is required.
230
+
231
+ To change the password strength, set the --complexity parameter to a value between 0 and 5.
232
+ Each value specifies the types of characters used in the generated password:
233
+
234
+ 0 - lower case letters only.
235
+ 1 - lower case letters and numbers only.
236
+ 2 - lower case letters and symbols only.
237
+ 3 - lower and upper case letters and numbers only
238
+ 4 - lower and upper case letters and symbols only
239
+ 5 - lower and upper case letters and numbers and symbols only
240
+
241
+ To see a password that was previously generated, run "sfdx force:user:display".
242
+
217
243
USAGE
218
- $ sfdx force:user:password:generate [-o <array>] [-v <string >] [-u <string >] [--apiversion <string>] [--json ]
219
- [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
244
+ $ sfdx force:user:password:generate [-o <array>] [-l <integer >] [-c <integer >] [-v <string>] [-u <string> ]
245
+ [--apiversion <string>] [--json] [-- loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
220
246
221
247
OPTIONS
248
+ -c, --complexity=complexity [default: 5] level of password
249
+ complexity or strength; the higher
250
+ the value, the stronger the password
251
+
252
+ -l, --length=length [default: 13] number of characters
253
+ in the generated password; valid
254
+ values are between 8 and 1000
255
+
222
256
-o, --onbehalfof=onbehalfof comma-separated list of usernames or
223
257
aliases to assign the password to
224
258
@@ -243,21 +277,36 @@ DESCRIPTION
243
277
If you haven’t set a default Dev Hub, or if your scratch org isn’t associated with your default Dev Hub,
244
278
--targetdevhubusername is required.
245
279
280
+ To change the password strength, set the --complexity parameter to a value between 0 and 5.
281
+ Each value specifies the types of characters used in the generated password:
282
+
283
+ 0 - lower case letters only.
284
+ 1 - lower case letters and numbers only.
285
+ 2 - lower case letters and symbols only.
286
+ 3 - lower and upper case letters and numbers only
287
+ 4 - lower and upper case letters and symbols only
288
+ 5 - lower and upper case letters and numbers and symbols only
289
+
246
290
To see a password that was previously generated, run "sfdx force:user:display".
247
291
248
292
EXAMPLES
249
293
sfdx force:user:password:generate
294
+ sfdx force:user:password:generate -l 12
295
+ sfdx force:user:password:generate -c 3
250
296
sfdx force:user:password:generate -u me@my.org --json
251
297
sfdx force:user:password:generate -o "user1@my.org,user2@my.org,user3@my.org"
252
298
```
253
299
254
- _ See code: [ src/commands/force/user/password/generate.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.0 /src/commands/force/user/password/generate.ts ) _
300
+ _ See code: [ src/commands/force/user/password/generate.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.1 /src/commands/force/user/password/generate.ts ) _
255
301
256
302
## ` sfdx force:user:permset:assign -n <array> [-o <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
257
303
258
304
assign a permission set to one or more users of an org
259
305
260
306
```
307
+ assign a permission set to one or more users of an org
308
+ To specify an alias for the -u or -o parameter, use the username alias you set with the "alias:set" CLI command, not the User.Alias value of the org user.
309
+
261
310
USAGE
262
311
$ sfdx force:user:permset:assign -n <array> [-o <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
263
312
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -291,5 +340,5 @@ EXAMPLES
291
340
sfdx force:user:permset:assign -n DreamHouse -o "user1@my.org,user2,user3"
292
341
```
293
342
294
- _ See code: [ src/commands/force/user/permset/assign.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.0 /src/commands/force/user/permset/assign.ts ) _
343
+ _ See code: [ src/commands/force/user/permset/assign.ts] ( https://github.com/salesforcecli/plugin-user/blob/v1.3.1 /src/commands/force/user/permset/assign.ts ) _
295
344
<!-- commandsstop -->
0 commit comments