generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
SF-CLI-BOT
committed
Jul 13, 2021
1 parent
a983eb4
commit 8366e79
Showing
3 changed files
with
67 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -90,14 +90,17 @@ For more NUT options and examples, see <https://github.com/salesforcecli/cli-plu | |
* [`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) | ||
* [`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) | ||
* [`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) | ||
* [`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) | ||
* [`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) | ||
* [`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) | ||
|
||
## `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]` | ||
|
||
create a user for a scratch org | ||
|
||
``` | ||
create a user for a scratch org | ||
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. | ||
USAGE | ||
$ 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] | ||
|
@@ -138,13 +141,16 @@ EXAMPLES | |
sfdx force:user:create -f config/project-user-def.json [email protected] generatepassword=true | ||
``` | ||
|
||
_See code: [src/commands/force/user/create.ts](https://github.com/salesforcecli/plugin-user/blob/v1.3.0/src/commands/force/user/create.ts)_ | ||
_See code: [src/commands/force/user/create.ts](https://github.com/salesforcecli/plugin-user/blob/v1.3.1/src/commands/force/user/create.ts)_ | ||
|
||
## `sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
displays information about a user of a scratch org | ||
|
||
``` | ||
displays information about a user of a scratch org | ||
Output includes the profile name, org ID, access token, instance URL, login URL, and alias if applicable. | ||
USAGE | ||
$ sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
@@ -172,13 +178,16 @@ EXAMPLES | |
sfdx force:user:display -u [email protected] --json | ||
``` | ||
|
||
_See code: [src/commands/force/user/display.ts](https://github.com/salesforcecli/plugin-user/blob/v1.3.0/src/commands/force/user/display.ts)_ | ||
_See code: [src/commands/force/user/display.ts](https://github.com/salesforcecli/plugin-user/blob/v1.3.1/src/commands/force/user/display.ts)_ | ||
|
||
## `sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
||
list all authenticated users of an org | ||
|
||
``` | ||
list all authenticated users of an org | ||
The original scratch org admin is marked with "(A)" | ||
USAGE | ||
$ sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
@@ -207,18 +216,43 @@ EXAMPLES | |
sfdx force:user:list --json > tmp/MyUserList.json | ||
``` | ||
|
||
_See code: [src/commands/force/user/list.ts](https://github.com/salesforcecli/plugin-user/blob/v1.3.0/src/commands/force/user/list.ts)_ | ||
_See code: [src/commands/force/user/list.ts](https://github.com/salesforcecli/plugin-user/blob/v1.3.1/src/commands/force/user/list.ts)_ | ||
|
||
## `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 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]` | ||
|
||
generate a password for scratch org users | ||
|
||
``` | ||
generate a password for scratch org users | ||
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. | ||
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. | ||
To change the password strength, set the --complexity parameter to a value between 0 and 5. | ||
Each value specifies the types of characters used in the generated password: | ||
0 - lower case letters only. | ||
1 - lower case letters and numbers only. | ||
2 - lower case letters and symbols only. | ||
3 - lower and upper case letters and numbers only | ||
4 - lower and upper case letters and symbols only | ||
5 - lower and upper case letters and numbers and symbols only | ||
To see a password that was previously generated, run "sfdx force:user:display". | ||
USAGE | ||
$ 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 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] | ||
OPTIONS | ||
-c, --complexity=complexity [default: 5] level of password | ||
complexity or strength; the higher | ||
the value, the stronger the password | ||
-l, --length=length [default: 13] number of characters | ||
in the generated password; valid | ||
values are between 8 and 1000 | ||
-o, --onbehalfof=onbehalfof comma-separated list of usernames or | ||
aliases to assign the password to | ||
|
@@ -243,21 +277,36 @@ DESCRIPTION | |
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. | ||
To change the password strength, set the --complexity parameter to a value between 0 and 5. | ||
Each value specifies the types of characters used in the generated password: | ||
0 - lower case letters only. | ||
1 - lower case letters and numbers only. | ||
2 - lower case letters and symbols only. | ||
3 - lower and upper case letters and numbers only | ||
4 - lower and upper case letters and symbols only | ||
5 - lower and upper case letters and numbers and symbols only | ||
To see a password that was previously generated, run "sfdx force:user:display". | ||
EXAMPLES | ||
sfdx force:user:password:generate | ||
sfdx force:user:password:generate -l 12 | ||
sfdx force:user:password:generate -c 3 | ||
sfdx force:user:password:generate -u [email protected] --json | ||
sfdx force:user:password:generate -o "[email protected],[email protected],[email protected]" | ||
``` | ||
|
||
_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)_ | ||
_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)_ | ||
|
||
## `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]` | ||
|
||
assign a permission set to one or more users of an org | ||
|
||
``` | ||
assign a permission set to one or more users of an org | ||
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. | ||
USAGE | ||
$ 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] | ||
|
@@ -291,5 +340,5 @@ EXAMPLES | |
sfdx force:user:permset:assign -n DreamHouse -o "[email protected],user2,user3" | ||
``` | ||
|
||
_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)_ | ||
_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)_ | ||
<!-- commandsstop --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters