diff --git a/CHANGELOG.md b/CHANGELOG.md index 0932918c..bec07546 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [1.1.3](https://github.com/salesforcecli/plugin-user/compare/v1.1.2...v1.1.3) (2021-03-08) + ### [1.1.2](https://github.com/salesforcecli/plugin-user/compare/v1.1.1...v1.1.2) (2021-02-18) diff --git a/README.md b/README.md index 47616649..ba86370a 100644 --- a/README.md +++ b/README.md @@ -69,46 +69,53 @@ sfdx plugins ## Commands +* [`sfdx force:user:create [name=value...] [-a ] [-f ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceusercreate-namevalue--a-string--f-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:user:display [-v ] [-u ] [--apiversion ] [--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 ] [-u ] [--apiversion ] [--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 ] [-v ] [-u ] [--apiversion ] [--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 [-o ] [-u ] [--apiversion ] [--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) -A list of the available commands - -- sfdx force:user:list [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] - -## `sfdx force:user:list [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx force:user:create [name=value...] [-a ] [-f ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -lists all users of a scratch org +create a user for a scratch org ``` USAGE - $ sfdx force:user:list [-v ] [-u ] [--apiversion ] [--json] [--loglevel - trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sfdx force:user:create [name=value...] [-a ] [-f ] [-v ] [-u ] [--apiversion + ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org + -a, --setalias=setalias set an alias for the created + username to reference within the CLI + + -f, --definitionfile=definitionfile file path to a user definition - -v, --targetdevhubusername=targetdevhubusername username or alias for the - dev hub org; overrides - default dev hub org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - --apiversion=apiversion override the api version - used for api requests made - by this command + -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub + org; overrides default dev hub org + + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + 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., + permsets=ps1,ps2), generating a password (e.g., generatepassword=true), and setting User sObject fields. EXAMPLES - sfdx force:user:list - sfdx force:user:list -u me@my.org --json - sfdx force:user:list --json > tmp/MyUserList.json + sfdx force:user:create + sfdx force:user:create -a testuser1 -f config/project-user-def.json profileName='Chatter Free User' + sfdx force:user:create username=testuser1@my.org email=me@my.org permsets=DreamHouse + sfdx force:user:create -f config/project-user-def.json email=me@my.org generatepassword=true ``` -- sfdx force:user:display [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] +_See code: [src/commands/force/user/create.ts](https://github.com/salesforcecli/plugin-user/blob/v1.1.2/src/commands/force/user/create.ts)_ ## `sfdx force:user:display [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -116,109 +123,104 @@ displays information about a user of a scratch org ``` USAGE - $ sfdx force:user:display [-v ] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:user:display [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - -v, --targetdevhubusername=targetdevhubusername username or alias for the - dev hub org; overrides - default dev hub org + -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub + org; overrides default dev hub org - --apiversion=apiversion override the api version - used for api requests made - by this command + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation + +DESCRIPTION + Output includes the profile name, org ID, access token, instance URL, login URL, and alias if applicable. EXAMPLES sfdx force:user:display sfdx force:user:display -u me@my.org --json ``` -- sfdx force:user:create [name=value...] [-a ] [-f ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] +_See code: [src/commands/force/user/display.ts](https://github.com/salesforcecli/plugin-user/blob/v1.1.2/src/commands/force/user/display.ts)_ -## `sfdx force:user:create [name=value...] [-a ] [-f ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx force:user:list [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -create a user for a scratch org +list all authenticated users of an org -```USAGE - $ sfdx force:user:create [name=value...] [-a ] [-f ] [-v ] [-u ] [--apiversion - ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] +``` +USAGE + $ sfdx force:user:list [-v ] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -a, --alias=alias set an alias for the created - username to reference within - the CLI + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - -f, --definitionfile=definitionfile file path to a user - definition + -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub + org; overrides default dev hub org - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org - - -v, --targetdevhubusername=targetdevhubusername username or alias for the - dev hub org; overrides - default dev hub org - - --apiversion=apiversion override the api version - used for api requests made - by this command + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation + +DESCRIPTION + The original scratch org admin is marked with "(A)" EXAMPLES - sfdx force:user:create - sfdx force:user:create -a testuser1 -f config/project-user-def.json - sfdx force:user:create username=testuser1@my.org email=me@my.org permsets=DreamHouse - sfdx force:user:create -f config/project-user-def.json email=me@my.org generatepassword=true + sfdx force:user:list + sfdx force:user:list -u me@my.org --json + sfdx force:user:list --json > tmp/MyUserList.json ``` -- force:user:password:generate [-o ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] +_See code: [src/commands/force/user/list.ts](https://github.com/salesforcecli/plugin-user/blob/v1.1.2/src/commands/force/user/list.ts)_ -## `force:user:password:generate [-o ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx force:user:password:generate [-o ] [-v ] [-u ] [--apiversion ] [--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 ] [-v ] [-u ] [--apiversion ] [--json] + $ sfdx force:user:password:generate [-o ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -o, --onbehalfof=onbehalfof comma-separated list of - usernames or aliases to - assign the password to + -o, --onbehalfof=onbehalfof comma-separated list of usernames or + aliases to assign the password to - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - -v, --targetdevhubusername=targetdevhubusername username or alias for the - dev hub org; overrides - default dev hub org + -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub + org; overrides default dev hub org - --apiversion=apiversion override the api version - used for api requests made - by this command + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation + +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 see a password that was previously generated, run "sfdx force:user:display". EXAMPLES sfdx force:user:password:generate @@ -226,7 +228,7 @@ EXAMPLES sfdx force:user:password:generate -o "user1@my.org,user2@my.org,user3@my.org" ``` -- sfdx force:user:permset:assign -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] +_See code: [src/commands/force/user/password/generate.ts](https://github.com/salesforcecli/plugin-user/blob/v1.1.2/src/commands/force/user/password/generate.ts)_ ## `sfdx force:user:permset:assign -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` @@ -234,30 +236,27 @@ assign a permission set to one or more users of an org ``` USAGE - $ sfdx force:user:permset:assign -n [-o ] [-u ] [--apiversion ] [--json] - [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sfdx force:user:permset:assign -n [-o ] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS -n, --permsetname=permsetname (required) the name of the permission set to assign - -o, --onbehalfof=onbehalfof comma-separated list of - usernames or aliases to - assign the permission set to + -o, --onbehalfof=onbehalfof comma-separated list of usernames or + aliases to assign the permission set + to - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - --apiversion=apiversion override the api version - used for api requests made - by this command + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation EXAMPLES sfdx force:user:permset:assign -n DreamHouse @@ -265,4 +264,5 @@ EXAMPLES sfdx force:user:permset:assign -n DreamHouse -o "user1@my.org,user2,user3" ``` +_See code: [src/commands/force/user/permset/assign.ts](https://github.com/salesforcecli/plugin-user/blob/v1.1.2/src/commands/force/user/permset/assign.ts)_ diff --git a/package.json b/package.json index 9675b199..86f1f26e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-user", "description": "Commands to interact with Users and Permission Sets", - "version": "1.1.2", + "version": "1.1.3", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {