@@ -88,21 +88,21 @@ For more NUT options and examples, see <https://github.com/salesforcecli/cli-plu
88
88
89
89
<!-- commands -->
90
90
91
- - [ ` sfdx force: user: password: generate` ] ( #sfdx-forceuserpasswordgenerate )
92
- - [ ` sfdx org: assign: permset` ] ( #sfdx-orgassignpermset )
93
- - [ ` sfdx org: assign: permsetlicense` ] ( #sfdx-orgassignpermsetlicense )
94
- - [ ` sfdx org: create: user` ] ( #sfdx-orgcreateuser )
95
- - [ ` sfdx org: display: user` ] ( #sfdx-orgdisplayuser )
96
- - [ ` sfdx org: generate: password` ] ( #sfdx-orggeneratepassword )
97
- - [ ` sfdx org: list: users` ] ( #sfdx-orglistusers )
91
+ - [ ` sf force user password generate` ] ( #sf-force-user-password-generate )
92
+ - [ ` sf org assign permset` ] ( #sf-org-assign-permset )
93
+ - [ ` sf org assign permsetlicense` ] ( #sf-org-assign-permsetlicense )
94
+ - [ ` sf org create user` ] ( #sf-org-create-user )
95
+ - [ ` sf org display user` ] ( #sf-org-display-user )
96
+ - [ ` sf org generate password` ] ( #sf-org-generate-password )
97
+ - [ ` sf org list users` ] ( #sf-org-list-users )
98
98
99
- ## ` sfdx force: user: password: generate`
99
+ ## ` sf force user password generate`
100
100
101
101
Generate a random password for scratch org users.
102
102
103
103
```
104
104
USAGE
105
- $ sfdx force: user: password: generate -u <value> [--json] [-o <value>] [-l <value>] [-c <value>] [--api-version <value>]
105
+ $ sf force user password generate -u <value> [--json] [-o <value>] [-l <value>] [-c <value>] [--api-version <value>]
106
106
107
107
FLAGS
108
108
-c, --complexity=<value> [default: 5] Level of password complexity or strength; the higher the value, the
@@ -141,33 +141,33 @@ DESCRIPTION
141
141
EXAMPLES
142
142
Generate a password for the original admin user of your default scratch org:
143
143
144
- $ sfdx force: user: password: generate
144
+ $ sf force user password generate
145
145
146
146
Generate a password that contains 12 characters for the original admin user of the scratch org with alias
147
147
"my-scratch":
148
148
149
- $ sfdx force: user: password: generate --length 12 --target-org my-scratch
149
+ $ sf force user password generate --length 12 --target-org my-scratch
150
150
151
151
Generate a password for your default scratch org admin user that uses lower and upper case letters and numbers only:
152
152
153
- $ sfdx force: user: password: generate --complexity 3
153
+ $ sf force user password generate --complexity 3
154
154
155
155
Generate a password for the specified users in the default scratch org; these users must have been created locally
156
156
with the "org create user" command:
157
157
158
- $ sfdx force: user: password: generate --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of \
158
+ $ sf force user password generate --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of \
159
159
user3@my.org
160
160
```
161
161
162
- _ See code: [ src/commands/force/user/password/generate.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/force/user/password/generate.ts ) _
162
+ _ See code: [ src/commands/force/user/password/generate.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/force/user/password/generate.ts ) _
163
163
164
- ## ` sfdx org: assign: permset`
164
+ ## ` sf org assign permset`
165
165
166
166
Assign a permission set to one or more users of a scratch org.
167
167
168
168
```
169
169
USAGE
170
- $ sfdx org: assign: permset -n <value> -o <value> [--json] [-b <value>] [--api-version <value>]
170
+ $ sf org assign permset -n <value> -o <value> [--json] [-b <value>] [--api-version <value>]
171
171
172
172
FLAGS
173
173
-b, --on-behalf-of=<value>... Username or alias to assign the permission set to.
@@ -191,26 +191,26 @@ DESCRIPTION
191
191
EXAMPLES
192
192
Assign two permission sets called DreamHouse and CloudHouse to original admin user of your default scratch org:
193
193
194
- $ sfdx org: assign: permset --name DreamHouse --name CloudHouse
194
+ $ sf org assign permset --name DreamHouse --name CloudHouse
195
195
196
196
Assign the Dreamhouse permission set to the original admin user of the scratch org with alias "my-scratch":
197
197
198
- $ sfdx org: assign: permset --name DreamHouse --target-org my-scratch
198
+ $ sf org assign permset --name DreamHouse --target-org my-scratch
199
199
200
200
Assign the Dreamhouse permission set to the specified list of users of your default scratch org:
201
201
202
- $ sfdx org: assign: permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
202
+ $ sf org assign permset --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of user
203
203
```
204
204
205
- _ See code: [ src/commands/org/assign/permset.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/org/assign/permset.ts ) _
205
+ _ See code: [ src/commands/org/assign/permset.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/org/assign/permset.ts ) _
206
206
207
- ## ` sfdx org: assign: permsetlicense`
207
+ ## ` sf org assign permsetlicense`
208
208
209
209
Assign a permission set license to one or more users of a scratch org.
210
210
211
211
```
212
212
USAGE
213
- $ sfdx org: assign: permsetlicense -n <value> -o <value> [--json] [-b <value>] [--api-version <value>]
213
+ $ sf org assign permsetlicense -n <value> -o <value> [--json] [-b <value>] [--api-version <value>]
214
214
215
215
FLAGS
216
216
-b, --on-behalf-of=<value>... Usernames or alias to assign the permission set license to.
@@ -234,27 +234,27 @@ DESCRIPTION
234
234
EXAMPLES
235
235
Assign the DreamHouse permission set license to original admin user of your default scratch org:
236
236
237
- $ sfdx org: assign: permsetlicense --name DreamHouse
237
+ $ sf org assign permsetlicense --name DreamHouse
238
238
239
239
Assign two permission set licenses to the original admin user of the scratch org with alias "my-scratch":
240
240
241
- $ sfdx org: assign: permsetlicense --name DreamHouse --name CloudHouse --target-org my-scratch
241
+ $ sf org assign permsetlicense --name DreamHouse --name CloudHouse --target-org my-scratch
242
242
243
243
Assign the Dreamhouse permission set license to the specified list of users of your default scratch org:
244
244
245
- $ sfdx org: assign: permsetlicense --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 \
246
- --on-behalf-of user3
245
+ $ sf org assign permsetlicense --name DreamHouse --on-behalf-of user1@my.org --on-behalf-of user2 --on-behalf-of \
246
+ user3
247
247
```
248
248
249
- _ See code: [ src/commands/org/assign/permsetlicense.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/org/assign/permsetlicense.ts ) _
249
+ _ See code: [ src/commands/org/assign/permsetlicense.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/org/assign/permsetlicense.ts ) _
250
250
251
- ## ` sfdx org: create: user`
251
+ ## ` sf org create user`
252
252
253
253
Create a user for a scratch org.
254
254
255
255
```
256
256
USAGE
257
- $ sfdx org: create: user -o <value> [--json] [-a <value>] [-f <value>] [-s] [--api-version <value>]
257
+ $ sf org create user -o <value> [--json] [-a <value>] [-f <value>] [-s] [--api-version <value>]
258
258
259
259
FLAGS
260
260
-a, --set-alias=<value> Set an alias for the created username to reference in other CLI commands.
@@ -298,31 +298,31 @@ DESCRIPTION
298
298
https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_users.htm.
299
299
300
300
ALIASES
301
- $ sfdx force: user: create
301
+ $ sf force user create
302
302
303
303
EXAMPLES
304
304
Create a user for your default scratch org and let this command generate a username, user ID, and other
305
305
characteristics:
306
306
307
- $ sfdx org: create: user
307
+ $ sf org create user
308
308
309
309
Create a user with alias "testuser1" using a user definition file. Set the "profileName" option to "Chatter Free
310
310
User", which overrides the value in the defintion file if it also exists there. Create the user for the scratch org
311
311
with alias "my-scratch":
312
312
313
- $ sfdx org: create: user --set-alias testuser1 --definition-file config/project-user-def.json profileName='Chatter \
313
+ $ sf org create user --set-alias testuser1 --definition-file config/project-user-def.json profileName='Chatter \
314
314
Free User' --target-org my-scratch
315
315
316
316
Create a user by specifying the username, email, and perm set assignment at the command line; command fails if the
317
317
username already exists in Salesforce:
318
318
319
- $ sfdx org: create: user username=testuser1@my.org email=me@my.org permsets=DreamHouse
319
+ $ sf org create user username=testuser1@my.org email=me@my.org permsets=DreamHouse
320
320
321
321
Create a user with a definition file, set the email value as specified (overriding any value in the definition
322
322
file), and generate a password for the user. If the username in the definition file isn't unique, the command
323
323
appends the org ID to make it unique:
324
324
325
- $ sfdx org: create: user --definition-file config/project-user-def.json email=me@my.org generatepassword=true \
325
+ $ sf org create user --definition-file config/project-user-def.json email=me@my.org generatepassword=true \
326
326
--set-unique-username
327
327
328
328
FLAG DESCRIPTIONS
@@ -344,15 +344,15 @@ FLAG DESCRIPTIONS
344
344
might be different than what you specify in the definition file.
345
345
```
346
346
347
- _ See code: [ src/commands/org/create/user.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/org/create/user.ts ) _
347
+ _ See code: [ src/commands/org/create/user.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/org/create/user.ts ) _
348
348
349
- ## ` sfdx org: display: user`
349
+ ## ` sf org display user`
350
350
351
351
Display information about a Salesforce user.
352
352
353
353
```
354
354
USAGE
355
- $ sfdx org: display: user -o <value> [--json] [--api-version <value>]
355
+ $ sf org display user -o <value> [--json] [--api-version <value>]
356
356
357
357
FLAGS
358
358
-o, --target-org=<value> (required) Username or alias of the target org.
@@ -369,27 +369,27 @@ DESCRIPTION
369
369
in the Setup UI.
370
370
371
371
ALIASES
372
- $ sfdx force: user: display
372
+ $ sf force user display
373
373
374
374
EXAMPLES
375
375
Display information about the admin user of your default scratch org:
376
376
377
- $ sfdx org: display: user
377
+ $ sf org display user
378
378
379
379
Display information about the specified user and output in JSON format:
380
380
381
- $ sfdx org: display: user --target-org me@my.org --json
381
+ $ sf org display user --target-org me@my.org --json
382
382
```
383
383
384
- _ See code: [ src/commands/org/display/user.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/org/display/user.ts ) _
384
+ _ See code: [ src/commands/org/display/user.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/org/display/user.ts ) _
385
385
386
- ## ` sfdx org: generate: password`
386
+ ## ` sf org generate password`
387
387
388
388
Generate a random password for scratch org users.
389
389
390
390
```
391
391
USAGE
392
- $ sfdx org: generate: password -o <value> [--json] [-b <value>] [-l <value>] [-c <value>] [--api-version <value>]
392
+ $ sf org generate password -o <value> [--json] [-b <value>] [-l <value>] [-c <value>] [--api-version <value>]
393
393
394
394
FLAGS
395
395
-b, --on-behalf-of=<value>... Comma-separated list of usernames or aliases to assign the password to; must have been
@@ -428,32 +428,32 @@ DESCRIPTION
428
428
EXAMPLES
429
429
Generate a password for the original admin user of your default scratch org:
430
430
431
- $ sfdx org: generate: password
431
+ $ sf org generate password
432
432
433
433
Generate a password that contains 12 characters for the original admin user of the scratch org with alias
434
434
"my-scratch":
435
435
436
- $ sfdx org: generate: password --length 12 --target-org my-scratch
436
+ $ sf org generate password --length 12 --target-org my-scratch
437
437
438
438
Generate a password for your default scratch org admin user that uses lower and upper case letters and numbers only:
439
439
440
- $ sfdx org: generate: password --complexity 3
440
+ $ sf org generate password --complexity 3
441
441
442
442
Generate a password for the specified users in the default scratch org; these users must have been created locally
443
443
with the "org create user" command:
444
444
445
- $ sfdx org: generate: password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
445
+ $ sf org generate password --on-behalf-of user1@my.org --on-behalf-of user2@my.org --on-behalf-of user3@my.org
446
446
```
447
447
448
- _ See code: [ src/commands/org/generate/password.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/org/generate/password.ts ) _
448
+ _ See code: [ src/commands/org/generate/password.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/org/generate/password.ts ) _
449
449
450
- ## ` sfdx org: list: users`
450
+ ## ` sf org list users`
451
451
452
452
List all locally-authenticated users of an org.
453
453
454
454
```
455
455
USAGE
456
- $ sfdx org: list: users -o <value> [--json] [--api-version <value>]
456
+ $ sf org list users -o <value> [--json] [--api-version <value>]
457
457
458
458
FLAGS
459
459
-o, --target-org=<value> (required) Username or alias of the target org.
@@ -469,18 +469,18 @@ DESCRIPTION
469
469
org admin user is marked with "(A)". For other orgs, the list includes the users you used to authenticate to the org.
470
470
471
471
ALIASES
472
- $ sfdx force: user: list
472
+ $ sf force user list
473
473
474
474
EXAMPLES
475
475
List the locally-authenticated users of your default org:
476
476
477
- $ sfdx org: list: users
477
+ $ sf org list users
478
478
479
479
List the locally-authenticated users of the specified org:
480
480
481
- $ sfdx org: list: users --target-org me@my.org
481
+ $ sf org list users --target-org me@my.org
482
482
```
483
483
484
- _ See code: [ src/commands/org/list/users.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.42 /src/commands/org/list/users.ts ) _
484
+ _ See code: [ src/commands/org/list/users.ts] ( https://github.com/salesforcecli/plugin-user/blob/2.3.43 /src/commands/org/list/users.ts ) _
485
485
486
486
<!-- commandsstop -->
0 commit comments