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
May 19, 2021
1 parent
17d7abc
commit acf5306
Showing
3 changed files
with
27 additions
and
22 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 |
---|---|---|
|
@@ -87,20 +87,19 @@ For more NUT options and examples, see <https://github.com/salesforcecli/cli-plu | |
## Commands | ||
|
||
<!-- commands --> | ||
|
||
- [`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: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-string--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]`](#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: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 | ||
|
||
``` | ||
USAGE | ||
$ sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-s] [-v <string>] [-u <string>] [--apiversion | ||
$ 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] | ||
OPTIONS | ||
|
@@ -129,7 +128,7 @@ OPTIONS | |
this command invocation | ||
DESCRIPTION | ||
Create a user for a scratch org, optionally setting an alias for use by the CLI, assigning permission sets (e.g., | ||
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. | ||
EXAMPLES | ||
|
@@ -139,15 +138,15 @@ 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.2.10/src/commands/force/user/create.ts)_ | ||
_See code: [src/commands/force/user/create.ts](https://github.com/salesforcecli/plugin-user/blob/v1.2.11/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 | ||
|
||
``` | ||
USAGE | ||
$ sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
$ sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
OPTIONS | ||
|
@@ -173,15 +172,15 @@ 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.2.10/src/commands/force/user/display.ts)_ | ||
_See code: [src/commands/force/user/display.ts](https://github.com/salesforcecli/plugin-user/blob/v1.2.11/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 | ||
|
||
``` | ||
USAGE | ||
$ sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
$ sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
OPTIONS | ||
|
@@ -208,15 +207,15 @@ 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.2.10/src/commands/force/user/list.ts)_ | ||
_See code: [src/commands/force/user/list.ts](https://github.com/salesforcecli/plugin-user/blob/v1.2.11/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]` | ||
|
||
generate a password for scratch org users | ||
|
||
``` | ||
USAGE | ||
$ sfdx force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] | ||
$ 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] | ||
OPTIONS | ||
|
@@ -238,10 +237,10 @@ OPTIONS | |
this command invocation | ||
DESCRIPTION | ||
Generates and sets a random password for one or more scratch org users. Targets the usernames listed with the | ||
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, | ||
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 see a password that was previously generated, run "sfdx force:user:display". | ||
|
@@ -252,15 +251,15 @@ EXAMPLES | |
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.2.10/src/commands/force/user/password/generate.ts)_ | ||
_See code: [src/commands/force/user/password/generate.ts](https://github.com/salesforcecli/plugin-user/blob/v1.2.11/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 | ||
|
||
``` | ||
USAGE | ||
$ sfdx force:user:permset:assign -n <array> [-o <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
$ 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] | ||
OPTIONS | ||
|
@@ -287,11 +286,10 @@ DESCRIPTION | |
the User.Alias value of the org user. | ||
EXAMPLES | ||
sfdx force:user:permset:assign -n DreamHouse | ||
sfdx force:user:permset:assign -n "DreamHouse, LargeDreamHouse" | ||
sfdx force:user:permset:assign -n DreamHouse -u [email protected] | ||
sfdx force:user:permset:assign -n "DreamHouse,LargeDreamHouse" -u [email protected] | ||
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.2.10/src/commands/force/user/permset/assign.ts)_ | ||
_See code: [src/commands/force/user/permset/assign.ts](https://github.com/salesforcecli/plugin-user/blob/v1.2.11/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