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.
Showing
52 changed files
with
2,610 additions
and
1,649 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 |
---|---|---|
@@ -1,56 +1,74 @@ | ||
[ | ||
{ | ||
"command": "force:user:create", | ||
"command": "force:user:password:generate", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": [ | ||
"apiversion", | ||
"definitionfile", | ||
"api-version", | ||
"complexity", | ||
"json", | ||
"length", | ||
"loglevel", | ||
"setalias", | ||
"setuniqueusername", | ||
"targetdevhubusername", | ||
"targetusername" | ||
"on-behalf-of", | ||
"target-dev-hub", | ||
"target-org" | ||
], | ||
"alias": [] | ||
}, | ||
{ | ||
"command": "force:user:display", | ||
"command": "force:user:permset:assign", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["apiversion", "json", "loglevel", "targetdevhubusername", "targetusername"], | ||
"flags": ["api-version", "json", "loglevel", "on-behalf-of", "perm-set-name", "target-org"], | ||
"alias": [] | ||
}, | ||
{ | ||
"command": "force:user:list", | ||
"command": "force:user:permsetlicense:assign", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["apiversion", "json", "loglevel", "targetdevhubusername", "targetusername"], | ||
"flags": ["api-version", "json", "loglevel", "name", "on-behalf-of", "target-org"], | ||
"alias": [] | ||
}, | ||
{ | ||
"command": "force:user:password:generate", | ||
"command": "user:create", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": [ | ||
"apiversion", | ||
"complexity", | ||
"api-version", | ||
"definition-file", | ||
"json", | ||
"length", | ||
"loglevel", | ||
"onbehalfof", | ||
"targetdevhubusername", | ||
"targetusername" | ||
"set-alias", | ||
"set-unique-username", | ||
"target-dev-hub", | ||
"target-org" | ||
], | ||
"alias": [] | ||
"alias": ["force:user:create", "org:create:user"] | ||
}, | ||
{ | ||
"command": "force:user:permset:assign", | ||
"command": "user:display", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["apiversion", "json", "loglevel", "onbehalfof", "permsetname", "targetusername"], | ||
"alias": [] | ||
"flags": ["api-version", "json", "loglevel", "target-dev-hub", "target-org", "verbose"], | ||
"alias": ["force:user:display", "org:display:user"] | ||
}, | ||
{ | ||
"command": "force:user:permsetlicense:assign", | ||
"command": "user:list", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["apiversion", "json", "loglevel", "name", "onbehalfof", "targetusername"], | ||
"alias": [] | ||
"flags": ["api-version", "json", "loglevel", "target-dev-hub", "target-org"], | ||
"alias": ["force:user:list", "org:list:users"] | ||
}, | ||
{ | ||
"command": "user:password:generate", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["api-version", "complexity", "json", "length", "on-behalf-of", "target-org"], | ||
"alias": ["org:generate:password"] | ||
}, | ||
{ | ||
"command": "user:permset:assign", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["api-version", "json", "on-behalf-of", "perm-set-name", "target-org"], | ||
"alias": ["org:assign:permset"] | ||
}, | ||
{ | ||
"command": "user:permsetlicense:assign", | ||
"plugin": "@salesforce/plugin-user", | ||
"flags": ["api-version", "json", "name", "on-behalf-of", "target-org"], | ||
"alias": ["org:assign:permsetlicense"] | ||
} | ||
] |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# summary | ||
|
||
create a user for a scratch org | ||
|
||
# description | ||
|
||
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 | ||
|
||
- <%= config.bin %> <%= command.id %> | ||
- <%= config.bin %> <%= command.id %> -a testuser1 -f config/project-user-def.json profileName='Chatter Free User' | ||
- <%= config.bin %> <%= command.id %> username=[email protected] email=[email protected] permsets=DreamHouse | ||
- <%= config.bin %> <%= command.id %> -f config/project-user-def.json email=[email protected] generatepassword=true | ||
|
||
# flags.alias.summary | ||
|
||
set an alias for the created username to reference within the CLI, | ||
|
||
# flags.definitionfile.summary | ||
|
||
file path to a user definition, | ||
|
||
# flags.setuniqueusername.summary | ||
|
||
force the username, if specified in the definition file or at the command line, to be unique by appending the org ID | ||
|
||
# licenseLimitExceeded | ||
|
||
There are no available user licenses for the user profile "%s". | ||
|
||
# duplicateUsername | ||
|
||
The username "%s" already exists in this or another Salesforce org. Usernames must be unique across all Salesforce orgs. | ||
|
||
# success | ||
|
||
Successfully created user "%s" with ID %s for org %s.%s | ||
You can see more details about this user by running "<%= config.bin %> user:display -u %s". |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# summary | ||
|
||
displays information about a user of a scratch org | ||
|
||
# description | ||
|
||
Output includes the profile name, org ID, access token, instance URL, login URL, and alias if applicable. | ||
|
||
# examples | ||
|
||
- <%= config.bin %> <%= command.id %> | ||
- <%= config.bin %> <%= command.id %> -u [email protected] --json | ||
|
||
# securityWarning | ||
|
||
This command will expose sensitive information that allows for subsequent activity using your current authenticated session. | ||
Sharing this information is equivalent to logging someone in under the current credential, resulting in unintended access and escalation of privilege. | ||
For additional information, please review the authorization section of the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_web_flow.htm |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# summary | ||
|
||
list all authenticated users of an org | ||
|
||
# description | ||
|
||
The original scratch org admin is marked with "(A)" | ||
|
||
# examples | ||
|
||
- <%= config.bin %> <%= command.id %> | ||
- <%= config.bin %> <%= command.id %> -u [email protected] --json | ||
- <%= config.bin %> <%= command.id %> --json > tmp/MyUserList.json | ||
|
||
# flags.target-hub.summary | ||
|
||
Username or alias of the Dev Hub org. |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# summary | ||
|
||
generate a password for scratch org users | ||
|
||
# description | ||
|
||
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 "<%= config.bin %> user:display". | ||
|
||
# examples | ||
|
||
- <%= config.bin %> <%= command.id %> | ||
- <%= config.bin %> <%= command.id %> -l 12 | ||
- <%= config.bin %> <%= command.id %> -c 3 | ||
- <%= config.bin %> <%= command.id %> -u [email protected] --json | ||
- <%= config.bin %> <%= command.id %> -o "[email protected],[email protected],[email protected]" | ||
|
||
# flags.onBehalfOf | ||
|
||
comma-separated list of usernames or aliases to assign the password to | ||
|
||
# flags.length | ||
|
||
number of characters in the generated password; valid values are between 8 and 1000 | ||
|
||
# flags.complexity | ||
|
||
level of password complexity or strength; the higher the value, the stronger the password | ||
|
||
# noSelfSetErrorV50 | ||
|
||
Create a scratch org with the enableSetPasswordInApi org security setting set to TRUE and try again. | ||
|
||
# noSelfSetError | ||
|
||
Starting in Spring '21, EnableSetPasswordInApi is a feature in your scratch org definition file and not a setting. This change is a result of the field Settings.securitySettings.passwordPolicies.enableSetPasswordInApi being deprecated in version 51.0 of the Metadata API. | ||
|
||
# noSelfSetError.actions | ||
|
||
- Update your scratch org definition file and remove enableSetPasswordInApi from the "securitySettings" setting. Then add EnableSetPasswordInApi as a feature. For example: | ||
- "features": ["EnableSetPasswordInApi"] | ||
- Then try creating the scratch org again. | ||
|
||
# scratchFeaturesUrl | ||
|
||
see https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file_config_values.htm | ||
|
||
# success | ||
|
||
Successfully set the password "%s" for user %s. | ||
|
||
# successMultiple | ||
|
||
Successfully set passwords:%s | ||
|
||
# viewWithCommand | ||
|
||
You can see the password again by running "sfdx user:display -u %s". | ||
|
||
# flags.target-org.summary | ||
|
||
Scratch org alias or login user. | ||
|
||
# onBehalfOfMultipleError | ||
|
||
Found a comma-separated list of usernames or aliases for the --onbehalfof parameter. Either specify one per flag or separate by a space. |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# summary | ||
|
||
assign a permission set to one or more users of an org | ||
|
||
# description | ||
|
||
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. | ||
|
||
# examples | ||
|
||
- <%= config.bin %> <%= command.id %> -n "DreamHouse, LargeDreamHouse", | ||
- <%= config.bin %> <%= command.id %> -n DreamHouse -u [email protected], | ||
- <%= config.bin %> <%= command.id %> -n DreamHouse -o "[email protected],user2,user3" | ||
|
||
# flags.onBehalfOf | ||
|
||
comma-separated list of usernames or aliases to assign the permission set to | ||
|
||
# flags.permsetName | ||
|
||
comma-separated list of permission sets to assign | ||
|
||
# flags.target-org.summary | ||
|
||
Scratch org alias or login user. |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.