@salesforce/plugin-auth 2.6.0 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/lib/commands/{org/login/access-token.d.ts → auth/accesstoken/store.d.ts} +1 -1
  2. package/lib/commands/{org/login/access-token.js → auth/accesstoken/store.js} +17 -19
  3. package/lib/commands/auth/accesstoken/store.js.map +1 -0
  4. package/lib/commands/{org/login/device.d.ts → auth/device/login.d.ts} +1 -1
  5. package/lib/commands/{org/login/device.js → auth/device/login.js} +15 -16
  6. package/lib/commands/auth/device/login.js.map +1 -0
  7. package/lib/commands/{org/login/jwt.d.ts → auth/jwt/grant.d.ts} +1 -1
  8. package/lib/commands/{org/login/jwt.js → auth/jwt/grant.js} +17 -18
  9. package/lib/commands/auth/jwt/grant.js.map +1 -0
  10. package/lib/commands/{org/list/auth.d.ts → auth/list.d.ts} +1 -1
  11. package/lib/commands/{org/list/auth.js → auth/list.js} +10 -10
  12. package/lib/commands/auth/list.js.map +1 -0
  13. package/lib/commands/{org → auth}/logout.d.ts +1 -2
  14. package/lib/commands/auth/logout.js +98 -0
  15. package/lib/commands/auth/logout.js.map +1 -0
  16. package/lib/commands/{org/login/sfdx-url.d.ts → auth/sfdxurl/store.d.ts} +1 -1
  17. package/lib/commands/{org/login/sfdx-url.js → auth/sfdxurl/store.js} +14 -14
  18. package/lib/commands/auth/sfdxurl/store.js.map +1 -0
  19. package/lib/commands/{org/login/web.d.ts → auth/web/login.d.ts} +1 -1
  20. package/lib/commands/{org/login/web.js → auth/web/login.js} +19 -21
  21. package/lib/commands/auth/web/login.js.map +1 -0
  22. package/messages/accesstoken.store.md +5 -7
  23. package/messages/device.login.md +7 -14
  24. package/messages/jwt.grant.md +11 -31
  25. package/messages/list.md +4 -6
  26. package/messages/logout.md +18 -54
  27. package/messages/messages.md +15 -23
  28. package/messages/sfdxurl.store.md +12 -18
  29. package/messages/web.login.md +11 -31
  30. package/oclif.manifest.json +123 -137
  31. package/package.json +29 -39
  32. package/lib/commands/org/list/auth.js.map +0 -1
  33. package/lib/commands/org/login/access-token.js.map +0 -1
  34. package/lib/commands/org/login/device.js.map +0 -1
  35. package/lib/commands/org/login/jwt.js.map +0 -1
  36. package/lib/commands/org/login/sfdx-url.js.map +0 -1
  37. package/lib/commands/org/login/web.js.map +0 -1
  38. package/lib/commands/org/logout.js +0 -188
  39. package/lib/commands/org/logout.js.map +0 -1
@@ -16,9 +16,9 @@ const common_1 = require("../../../common");
16
16
  core_1.Messages.importMessagesDirectory(__dirname);
17
17
  const messages = core_1.Messages.loadMessages('@salesforce/plugin-auth', 'web.login');
18
18
  const commonMessages = core_1.Messages.loadMessages('@salesforce/plugin-auth', 'messages');
19
- class LoginWeb extends authBaseCommand_1.AuthBaseCommand {
19
+ class Login extends authBaseCommand_1.AuthBaseCommand {
20
20
  async run() {
21
- const { flags } = await this.parse(LoginWeb);
21
+ const { flags } = await this.parse(Login);
22
22
  this.flags = flags;
23
23
  if (isSFDXContainerMode()) {
24
24
  throw new core_1.SfError(messages.getMessage('deviceWarning'), 'DEVICE_WARNING');
@@ -66,59 +66,57 @@ class LoginWeb extends authBaseCommand_1.AuthBaseCommand {
66
66
  return oauthServer.authorizeAndSave();
67
67
  }
68
68
  }
69
- exports.default = LoginWeb;
70
- LoginWeb.summary = messages.getMessage('summary');
71
- LoginWeb.description = messages.getMessage('description');
72
- LoginWeb.examples = messages.getMessages('examples');
73
- LoginWeb.deprecateAliases = true;
74
- LoginWeb.aliases = ['force:auth:web:login', 'auth:web:login'];
75
- LoginWeb.flags = {
69
+ exports.default = Login;
70
+ Login.summary = messages.getMessage('summary');
71
+ Login.description = messages.getMessage('description');
72
+ Login.examples = messages.getMessages('examples');
73
+ Login.deprecateAliases = true;
74
+ Login.aliases = ['force:auth:web:login'];
75
+ Login.flags = {
76
76
  browser: sf_plugins_core_1.Flags.string({
77
77
  char: 'b',
78
- summary: messages.getMessage('flags.browser.summary'),
79
- description: messages.getMessage('flags.browser.description'),
78
+ summary: messages.getMessage('browser'),
80
79
  options: ['chrome', 'edge', 'firefox'], // These are ones supported by "open" package
81
80
  }),
82
81
  'client-id': sf_plugins_core_1.Flags.string({
83
82
  char: 'i',
84
- summary: commonMessages.getMessage('flags.client-id.summary'),
83
+ summary: commonMessages.getMessage('clientId'),
85
84
  deprecateAliases: true,
86
85
  aliases: ['clientid'],
87
86
  }),
88
87
  'instance-url': sf_plugins_core_1.Flags.url({
89
88
  char: 'r',
90
- summary: commonMessages.getMessage('flags.instance-url.summary'),
91
- description: commonMessages.getMessage('flags.instance-url.description'),
89
+ summary: commonMessages.getMessage('instanceUrl'),
92
90
  deprecateAliases: true,
93
91
  aliases: ['instanceurl'],
94
92
  }),
95
93
  'set-default-dev-hub': sf_plugins_core_1.Flags.boolean({
96
94
  char: 'd',
97
- summary: commonMessages.getMessage('flags.set-default-dev-hub.summary'),
95
+ summary: commonMessages.getMessage('setDefaultDevHub'),
98
96
  deprecateAliases: true,
99
- aliases: ['setdefaultdevhubusername', 'setdefaultdevhub'],
97
+ aliases: ['setdefaultdevhub', 'setdefaultdevhubusername'],
100
98
  }),
101
99
  'set-default': sf_plugins_core_1.Flags.boolean({
102
100
  char: 's',
103
- summary: commonMessages.getMessage('flags.set-default.summary'),
101
+ summary: commonMessages.getMessage('setDefaultUsername'),
104
102
  deprecateAliases: true,
105
103
  aliases: ['setdefaultusername'],
106
104
  }),
107
105
  alias: sf_plugins_core_1.Flags.string({
108
106
  char: 'a',
109
- summary: commonMessages.getMessage('flags.alias.summary'),
107
+ summary: commonMessages.getMessage('setAlias'),
110
108
  deprecateAliases: true,
111
109
  aliases: ['setalias'],
112
110
  }),
113
111
  'disable-masking': sf_plugins_core_1.Flags.boolean({
114
- summary: commonMessages.getMessage('flags.disable-masking.summary'),
112
+ summary: commonMessages.getMessage('disableMasking'),
115
113
  hidden: true,
116
114
  deprecateAliases: true,
117
115
  aliases: ['disablemasking'],
118
116
  }),
119
117
  'no-prompt': sf_plugins_core_1.Flags.boolean({
120
118
  char: 'p',
121
- summary: commonMessages.getMessage('flags.no-prompt.summary'),
119
+ summary: commonMessages.getMessage('noPromptAuth'),
122
120
  required: false,
123
121
  hidden: true,
124
122
  deprecateAliases: true,
@@ -130,4 +128,4 @@ const isSFDXContainerMode = () => {
130
128
  const env = new kit_1.Env();
131
129
  return env.getBoolean('SFDX_CONTAINER_MODE');
132
130
  };
133
- //# sourceMappingURL=web.js.map
131
+ //# sourceMappingURL=login.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"login.js","sourceRoot":"","sources":["../../../../src/commands/auth/web/login.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,6BAA6B;AAE7B,iEAA8D;AAE9D,2CAAmG;AACnG,yCAAsC;AACtC,mDAAqD;AAErD,8DAA2D;AAC3D,4CAAyC;AAEzC,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,WAAW,CAAC,CAAC;AAC/E,MAAM,cAAc,GAAG,eAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC;AAEpF,MAAqB,KAAM,SAAQ,iCAA2B;IA8DrD,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,mBAAmB,EAAE,EAAE;YACzB,MAAM,IAAI,cAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,gBAAgB,CAAC,CAAC;SAC3E;QAED,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAAE,OAAO,EAAE,CAAC;QAEhE,MAAM,WAAW,GAAiB;YAChC,QAAQ,EAAE,MAAM,eAAM,CAAC,eAAe,CAAC,IAAA,cAAG,EAAC,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,IAAI,CAAqB,CAAC;YACpG,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAW;SACvC,CAAC;QAEF,IAAI,KAAK,CAAC,WAAW,CAAC,EAAE;YACtB,WAAW,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;SACpF;QAED,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YAC1D,MAAM,QAAQ,CAAC,6BAA6B,CAAC;gBAC3C,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;gBAChC,gBAAgB,EAAE,KAAK,CAAC,qBAAqB,CAAC;aAC/C,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,eAAQ,CAAC,2BAA2B,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAE7D,MAAM,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACzG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAC5B,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,KAAK,GAAG,GAAY,CAAC;YAC3B,aAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,uBAAuB,EAAE;gBAC1C,MAAM,IAAI,cAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;aAC5E;YACD,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED,4CAA4C;IAC5C,kDAAkD;IAC1C,KAAK,CAAC,gBAAgB,CAAC,WAAyB;QACtD,MAAM,WAAW,GAAG,MAAM,qBAAc,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QACjE,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO;YACpC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAiB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;YAC/E,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QACpB,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,EAAE,WAAW,CAAC,CAAC;QAC3D,OAAO,WAAW,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;;AAjHH,wBAkHC;AAjHwB,aAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,iBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,cAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAC5C,sBAAgB,GAAG,IAAI,CAAC;AACjC,aAAO,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAE1B,WAAK,GAAG;IAC7B,OAAO,EAAE,uBAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;QACvC,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,6CAA6C;KACtF,CAAC;IACF,WAAW,EAAE,uBAAK,CAAC,MAAM,CAAC;QACxB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC;QAC9C,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,UAAU,CAAC;KACtB,CAAC;IACF,cAAc,EAAE,uBAAK,CAAC,GAAG,CAAC;QACxB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,aAAa,CAAC;QACjD,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,aAAa,CAAC;KACzB,CAAC;IACF,qBAAqB,EAAE,uBAAK,CAAC,OAAO,CAAC;QACnC,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,kBAAkB,CAAC;QACtD,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,kBAAkB,EAAE,0BAA0B,CAAC;KAC1D,CAAC;IACF,aAAa,EAAE,uBAAK,CAAC,OAAO,CAAC;QAC3B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,oBAAoB,CAAC;QACxD,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,oBAAoB,CAAC;KAChC,CAAC;IACF,KAAK,EAAE,uBAAK,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC;QAC9C,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,UAAU,CAAC;KACtB,CAAC;IACF,iBAAiB,EAAE,uBAAK,CAAC,OAAO,CAAC;QAC/B,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACpD,MAAM,EAAE,IAAI;QACZ,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,gBAAgB,CAAC;KAC5B,CAAC;IACF,WAAW,EAAE,uBAAK,CAAC,OAAO,CAAC;QACzB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,cAAc,CAAC;QAClD,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,IAAI;QACZ,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,CAAC,UAAU,CAAC;KACtB,CAAC;IACF,QAAQ,EAAR,0BAAQ;CACT,CAAC;AA0DJ,MAAM,mBAAmB,GAAG,GAAY,EAAE;IACxC,MAAM,GAAG,GAAG,IAAI,SAAG,EAAE,CAAC;IACtB,OAAO,GAAG,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAC/C,CAAC,CAAC"}
@@ -1,22 +1,20 @@
1
1
  # summary
2
2
 
3
- Authorize an org using an existing Salesforce access token.
3
+ authorize an org using an existing Salesforce access token
4
4
 
5
5
  # description
6
6
 
7
+ authorize an org using an existing Salesforce access token
7
8
  By default, the command runs interactively and asks you for the access token. If you previously authorized the org, the command prompts whether you want to overwrite the local file. Specify --no-prompt to not be prompted.
8
-
9
9
  To use the command in a CI/CD script, set the SFDX_ACCESS_TOKEN environment variable to the access token. Then run the command with the --no-prompt parameter.
10
10
 
11
11
  # examples
12
12
 
13
- - Authorize an org on https://mycompany.my.salesforce.com; the command prompts you for the access token:
14
-
15
- <%= config.bin %> <%= command.id %> --instance-url https://mycompany.my.salesforce.com
13
+ - $ <%= config.bin %> <%= command.id %> --instance-url https://mycompany.my.salesforce.com
16
14
 
17
- - Authorize the org without being prompted; you must have previously set the SFDX_ACCESS_TOKEN environment variable to the access token:
15
+ - $ export SFDX_ACCESS_TOKEN=00Dxx0000000000!xxxxx
18
16
 
19
- <%= config.bin %> <%= command.id %> --instance-url https://dev-hub.my.salesforce.com --no-prompt
17
+ - $ <%= config.bin %> <%= command.id %> --instance-url https://dev-hub.my.salesforce.com --no-prompt
20
18
 
21
19
  # invalidAccessTokenFormat
22
20
 
@@ -1,26 +1,19 @@
1
1
  # summary
2
2
 
3
- Authorize an org using a device code.
3
+ authorize an org using a device code
4
4
 
5
5
  # description
6
6
 
7
- Use this command to allow a device to connect to an org.
8
-
9
- When you run this command, it first displays an 8-digit device code and the URL for verifying the code on your org. The default instance URL is https://login.salesforce.com, so if the org you're authorizing is on a different instance, use the --instance-url. The command waits while you complete the verification. Open a browser and navigate to the displayed verification URL, enter the code, then click Connect. If you aren't already logged into your org, log in, and then you're prompted to allow the device to connect to the org. After you successfully authorize the org, you can close the browser window.
7
+ authorize an org using a device code
8
+ You must open a browser, navigate to the verification URL, and enter the code. Log in, if not already logged in, and you’ll be prompted to allow the device to connect to the org.
10
9
 
11
10
  # examples
12
11
 
13
- - Authorize an org using a device code, give the org the alias TestOrg1, and set it as your default Dev Hub org:
14
-
15
- <%= config.bin %> <%= command.id %> --set-default-dev-hub --alias TestOrg1
16
-
17
- - Authorize an org in which you've created a custom connected app with the specified client ID (consumer key):
18
-
19
- <%= config.bin %> <%= command.id %> --client-id <OAuth client id>
12
+ - $ <%= config.bin %> <%= command.id %> -d -a TestOrg1
20
13
 
21
- - Authorize a sandbox org with the specified instance URL:
14
+ - $ <%= config.bin %> <%= command.id %> -i <OAuth client id>
22
15
 
23
- <%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com
16
+ - $ <%= config.bin %> <%= command.id %> -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com
24
17
 
25
18
  # actionRequired
26
19
 
@@ -28,7 +21,7 @@ Action Required!
28
21
 
29
22
  # enterCode
30
23
 
31
- Enter %s device code in this verification URL: %s
24
+ Enter %s user code in the verification URL %s
32
25
 
33
26
  # success
34
27
 
@@ -1,48 +1,28 @@
1
1
  # summary
2
2
 
3
- Log in to a Salesforce org using a JSON web token (JWT).
3
+ authorize an org using the JWT flow
4
4
 
5
5
  # description
6
6
 
7
- Use this command in automated environments where you can’t interactively log in with a browser, such as in CI/CD scripts.
8
-
9
- Logging into an org authorizes the CLI to run other commands that connect to that org, such as deploying or retrieving a project. You can log into many types of orgs, such as sandboxes, Dev Hubs, Env Hubs, production orgs, and scratch orgs.
10
-
11
- Complete these steps before you run this command:
12
-
13
- 1. Create a digital certificate (also called digital signature) and the private key to sign the certificate. You can use your own key and certificate issued by a certification authority. Or use OpenSSL to create a key and a self-signed digital certificate.
14
- 2. Store the private key in a file on your computer. When you run this command, you set the --jwt-key-file flag to this file.
15
- 3. Create a custom connected app in your org using the digital certificate. Make note of the consumer key (also called client id) that’s generated for you. Be sure the username of the user logging in is approved to use the connected app. When you run this command, you set the --client-id flag to the consumer key.
16
-
17
- See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_jwt_flow.htm for more information.
18
-
19
- We recommend that you set an alias when you log into an org. Aliases make it easy to later reference this org when running commands that require it. If you don’t set an alias, you use the username that you specified when you logged in to the org. If you run multiple commands that reference the same org, consider setting the org as your default. Use --set-default for your default scratch org or sandbox, or --set-default-dev-hub for your default Dev Hub.
7
+ authorize an org using the JWT flow
8
+ Use a certificate associated with your private key that has been uploaded to a personal connected app.
9
+ If you specify an --instanc-eurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
20
10
 
21
11
  # examples
22
12
 
23
- - Log into an org with username jdoe@example.org and on the default instance URL (https://login.salesforce.org). The private key is stored in the file /Users/jdoe/JWT/server.key and the command uses the connected app with consumer key (client id) 04580y4051234051.
24
-
25
- <%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051
26
-
27
- - Set the org as the default and give it an alias:
28
-
29
- <%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051 --alias ci-org --set-default
30
-
31
- - Set the org as the default Dev Hub and give it an alias:
32
-
33
- <%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051 --alias ci-dev-hub --set-default-dev-hub
13
+ - $ <%= config.bin %> <%= command.id %> -o me@my.org -f <path to jwt key file> -i <OAuth client id>
34
14
 
35
- - Log in to a sandbox using URL https://MyDomainName--SandboxName.sandbox.my.salesforce.com:
15
+ - $ <%= config.bin %> <%= command.id %> -o me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg
36
16
 
37
- <%= config.bin %> <%= command.id %> --username jdoe@example.org --jwt-key-file /Users/jdoe/JWT/server.key --client-id 04580y4051234051 --alias ci-org --set-default --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com
17
+ - $ <%= config.bin %> <%= command.id %> -o me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com
38
18
 
39
- # flags.username.summary
19
+ # username
40
20
 
41
- Username of the user logging in.
21
+ authentication username
42
22
 
43
- # flags.jwt-key-file.summary
23
+ # key
44
24
 
45
- Path to a file containing the private key.
25
+ path to a file containing the private key
46
26
 
47
27
  # JwtGrantError
48
28
 
package/messages/list.md CHANGED
@@ -1,17 +1,15 @@
1
1
  # summary
2
2
 
3
- List authorization information about the orgs you created or logged into.
3
+ List auth connection information
4
4
 
5
5
  # description
6
6
 
7
- This command uses local authorization information that Salesforce CLI caches when you create a scratch org or log into an org. The command doesn't actually connect to the orgs to verify that they're still active. As a result, this command executes very quickly. If you want to view live information about your authorized orgs, such as their connection status, use the "org list" command.
7
+ list auth connection information
8
8
 
9
9
  # examples
10
10
 
11
- - List local authorization information about your orgs:
12
-
13
- <%= config.bin %> <%= command.id %>
11
+ - $ <%= config.bin %> <%= command.id %>
14
12
 
15
13
  # noResultsFound
16
14
 
17
- No results found.
15
+ No results found
@@ -1,81 +1,45 @@
1
1
  # summary
2
2
 
3
- Log out of a Salesforce org.
3
+ log out from authorized orgs
4
4
 
5
5
  # description
6
6
 
7
- If you run this command with no flags, it first displays a list of orgs you've created or logged into, with none of the orgs selected. Use the arrow keys to scroll through the list and the space bar to select the orgs you want to log out of. Press Enter when you're done; the command asks for a final confirmation before logging out of the selected orgs.
8
-
9
- The process is similar if you specify --all, except that in the initial list of orgs, they're all selected. Use --target-org to logout of a specific org. In both these cases by default, you must still confirm that you want to log out. Use --no-prompt to never be asked for confirmation when also using --all or --target-org.
10
-
11
- Be careful! If you log out of a scratch org without having access to its password, you can't access the scratch org again, either through the CLI or the Salesforce UI.
7
+ log out from authorized orgs
8
+ By default, this command logs you out from your default scratch org.
12
9
 
13
10
  # examples
14
11
 
15
- - Interactively select the orgs to log out of:
16
-
17
- <%= config.bin %> <%= command.id %>
12
+ - $ <%= config.bin %> <%= command.id %> -o me@my.org
18
13
 
19
- - Log out of the org with username me@my.org:
14
+ - $ <%= config.bin %> <%= command.id %> -a
20
15
 
21
- <%= config.bin %> <%= command.id %> --target-org me@my.org
16
+ - $ <%= config.bin %> <%= command.id %> -p
22
17
 
23
- - Log out of all orgs after confirmation:
18
+ # flags.target-org.summary
24
19
 
25
- <%= config.bin %> <%= command.id %> --all
20
+ Username or alias of the target org.
26
21
 
27
- - Logout of the org with alias my-scratch and don't prompt for confirmation:
22
+ # all
28
23
 
29
- <%= config.bin %> <%= command.id %> --target-org my-scratch --no-prompt
24
+ include all authenticated orgs
30
25
 
31
- # flags.target-org.summary
26
+ # allLong
32
27
 
33
- Username or alias of the target org.
28
+ Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
34
29
 
35
- # flags.all.summary
30
+ # logoutCommandYesNo
36
31
 
37
- Include all authenticated orgs.
32
+ Are you sure you want to log out from these org(s)?
33
+ %s
38
34
 
39
- # flags.all.description
35
+ Important: You need a password to reauthorize scratch orgs. By default, scratch orgs have no password. If you still need your scratch orgs, run "%s org:generate:password" before logging out. If you don't need the scratch orgs anymore, run "%s org:delete:scratch" or "%s org:delete:sandbox"instead of logging out.
40
36
 
41
- All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.
37
+ Log out?
42
38
 
43
39
  # logoutOrgCommandSuccess
44
40
 
45
41
  Successfully logged out of orgs: %s
46
42
 
47
- # noOrgsFound
43
+ # logoutOrgCommandNoOrgsFound
48
44
 
49
45
  No orgs found to log out of.
50
-
51
- # noOrgsSelected
52
-
53
- No orgs selected for logout.
54
-
55
- # prompt.select-envs
56
-
57
- Select the orgs you want to log out of:
58
-
59
- # prompt.confirm
60
-
61
- Are you sure you want to log out of %d org%s?
62
-
63
- # prompt.confirm-all
64
-
65
- Are you sure you want to log out of all your orgs?
66
-
67
- # prompt.confirm.single
68
-
69
- Are you sure you want to log out of %s?
70
-
71
- # warning
72
-
73
- Warning: If you log out of a scratch org without having access to its password, you can't access this org again, either through the CLI or the Salesforce UI.
74
-
75
- # noOrgSpecifiedWithNoPrompt
76
-
77
- You must specify a target-org (or default target-org config is set) or use --all flag when using the --no-prompt flag.
78
-
79
- # noOrgSpecifiedWithJson
80
-
81
- You must specify a target-org (or default target-org config is set) or use --all flag when using the --json flag.
@@ -1,30 +1,22 @@
1
- # flags.client-id.summary
1
+ # clientId
2
2
 
3
- OAuth client ID (also called consumer key) of your custom connected app.
3
+ OAuth client ID (sometimes called the consumer key)
4
4
 
5
- # flags.set-default-dev-hub.summary
5
+ # setDefaultDevHub
6
6
 
7
- Set the authenticated org as the default Dev Hub.
7
+ set the authenticated org as the default dev hub org for scratch org creation
8
8
 
9
- # flags.set-default.summary
9
+ # setDefaultUsername
10
10
 
11
- Set the authenticated org as the default that all org-related commands run against.
11
+ set the authenticated org as the default username that all commands run against
12
12
 
13
- # flags.alias.summary
13
+ # setAlias
14
14
 
15
- Alias for the org.
15
+ set an alias for the authenticated org
16
16
 
17
- # flags.instance-url.summary
17
+ # instanceUrl
18
18
 
19
- URL of the instance that the org lives on.
20
-
21
- # flags.instance-url.description
22
-
23
- If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file.
24
-
25
- To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.
26
-
27
- To specify a sandbox, set --instance-url to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
19
+ the login URL of the instance the org lives on
28
20
 
29
21
  # authorizeCommandSuccess
30
22
 
@@ -32,17 +24,17 @@ Successfully authorized %s with org ID %s
32
24
 
33
25
  # warnAuth
34
26
 
35
- Logging in to a business or production org is not recommended on a demo or shared machine. Please run "%s org:logout --target-org <your username> --no-prompt" when finished using this org, which is similar to logging out of the org in the browser.
27
+ Logging in to a business or production org is not recommended on a demo or shared machine. Please run "%s auth:logout --target-org <your username> --no-prompt" when finished using this org, which is similar to logging out of the org in the browser.
36
28
 
37
29
  Do you want to authorize this org for use with the Salesforce CLI?
38
30
 
39
- # flags.no-prompt.summary
31
+ # noPromptAuth
40
32
 
41
- Don't prompt for confirmation.
33
+ do not prompt for auth confirmation in demo mode
42
34
 
43
- # flags.disable-masking.summary
35
+ # disableMasking
44
36
 
45
- Disable masking of user input; use with problematic terminals.
37
+ disable masking of user input (for use with problematic terminals)
46
38
 
47
39
  # clientSecretStdin
48
40
 
@@ -1,33 +1,27 @@
1
1
  # summary
2
2
 
3
- Authorize an org using a Salesforce DX authorization URL stored in a file.
3
+ authorize an org using an SFDX auth URL stored within a file
4
4
 
5
5
  # description
6
6
 
7
- The Salesforce DX (SFDX) authorization URL must have the format "%s". NOTE: The SFDX authorization URL uses the "force" protocol, and not "http" or "https". Also, the "instanceUrl" inside the SFDX authorization URL doesn't include the protocol ("https://").
7
+ authorize an org using an SFDX auth URL stored within a file
8
+ The SFDX auth URL must have the format "%s". NOTE: The SFDX auth URL uses the "force" protocol, and not "http" or "https". Also, the "instanceUrl" inside the SFDX auth URL doesn't include the protocol ("https://").
8
9
 
9
- You have three options when creating the authorization file. The easiest option is to redirect the output of the "<%= config.bin %> org display --verbose --json" command into a file. For example, using an org with alias my-org that you've already authorized:
10
+ You have three options when creating the auth file. The easiest option is to redirect the output of the `<%= config.bin %> org:display --verbose --json` command into a file. For example, using an org you have already authorized:
10
11
 
11
- $ <%= config.bin %> org display --target-org my-org --verbose --json > authFile.json
12
+ $ <%= config.bin %> org:display -o <OrgUsername> --verbose --json > authFile.json
13
+ $ <%= config.bin %> <%= command.id %> -f authFile.json
12
14
 
13
- The resulting JSON file contains the URL in the "sfdxAuthUrl" property of the "result" object. You can then reference the file when running this command:
15
+ The resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The `org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow.
14
16
 
15
- $ <%= config.bin %> <%= command.id %> --sfdx-url-file authFile.json
17
+ You can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the auth URL. Finally, you can create a normal text file that includes just the URL and nothing else.
16
18
 
17
- NOTE: The "<%= config.bin %> org display --verbose" command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow.
19
+ # file
18
20
 
19
- You can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the authorization URL. Finally, you can create a normal text file that includes just the URL and nothing else.
20
-
21
- # flags.sfdx-url-file.summary
22
-
23
- Path to a file that contains the Salesforce DX authorization URL.
21
+ path to a file containing the sfdx url
24
22
 
25
23
  # examples
26
24
 
27
- - Authorize an org using the SFDX authorization URL in the files/authFile.json file:
28
-
29
- <%= config.bin %> <%= command.id %> --sfdx-url-file files/authFile.json
30
-
31
- - Similar to previous example, but set the org as your default and give it an alias MyDefaultOrg:
25
+ - $ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file>
32
26
 
33
- <%= config.bin %> <%= command.id %> --sfdx-url-file files/authFile.json --set-default --alias MyDefaultOrg
27
+ - $ <%= config.bin %> <%= command.id %> -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg
@@ -1,50 +1,30 @@
1
1
  # summary
2
2
 
3
- Log in to a Salesforce org using the web server flow.
3
+ authorize an org using the web login flow
4
4
 
5
5
  # description
6
6
 
7
- Opens a Salesforce instance URL in a web browser so you can enter your credentials and log in to your org. After you log in, you can close the browser window.
8
-
9
- Logging into an org authorizes the CLI to run other commands that connect to that org, such as deploying or retrieving metadata. You can log into many types of orgs, such as sandboxes, Dev Hubs, Env Hubs, production orgs, and scratch orgs.
10
-
11
- We recommend that you set an alias when you log into an org. Aliases make it easy to later reference this org when running commands that require it. If you don’t set an alias, you use the username that you specified when you logged in to the org. If you run multiple commands that reference the same org, consider setting the org as your default. Use --set-default for your default scratch org or sandbox, or --set-default-dev-hub for your default Dev Hub.
12
-
13
- By default, this command uses the global out-of-the-box connected app in your org. If you need more security or control, such as setting the refresh token timeout or specifying IP ranges, create your own connected app using a digital certificate. Make note of the consumer key (also called cliend id) that’s generated for you. Then specify the consumer key with the --client-id flag.
7
+ authorize an org using the web login flow
8
+ If you specify an --instance-url value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To log in to a sandbox, set --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
9
+ To open in a specific browser, use the --browser parameter. Supported browsers are "chrome", "edge", and "firefox". If you don't specify --browser, the org opens in your default browser.
14
10
 
15
11
  # examples
16
12
 
17
- - Run the command with no flags to open the default Salesforce login page (https://login.salesforce.com):
18
-
19
- <%= config.bin %> <%= command.id %>
20
-
21
- - Log in to your Dev Hub, set it as your default Dev Hub, and set an alias that you reference later when you create a scratch org:
22
-
23
- <%= config.bin %> <%= command.id %> --set-default-dev-hub --alias dev-hub
24
-
25
- - Log in to a sandbox and set it as your default org:
26
-
27
- <%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default
28
-
29
- - Use --browser to specify a specific browser, such as Google Chrome:
30
-
31
- <%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default --browser chrome
32
-
33
- - Use your own connected app by specifying its consumer key (also called client ID):
13
+ - $ <%= config.bin %> <%= command.id %> -a TestOrg1
34
14
 
35
- <%= config.bin %> <%= command.id %> --instance-url https://MyDomainName--SandboxName.sandbox.my.salesforce.com --set-default --browser chrome --client-id 04580y4051234051
15
+ - $ <%= config.bin %> <%= command.id %> -i <OAuth client id>
36
16
 
37
- # flags.browser.summary
17
+ - $ <%= config.bin %> <%= command.id %> -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com
38
18
 
39
- Browser in which to open the org.
19
+ - $ <%= config.bin %> <%= command.id %> -a TestOrg1 -b firefox
40
20
 
41
- # flags.browser.description
21
+ # browser
42
22
 
43
- If you don’t specify --browser, the command uses your default browser. The exact names of the browser applications differ depending on the operating system you're on; check your documentation for details.
23
+ browser where the org opens
44
24
 
45
25
  # deviceWarning
46
26
 
47
- "<%= config.bin %> <%= command.id %>" doesn't work when authorizing to a headless environment. Use "<%= config.bin %> org login device" instead.
27
+ auth:web:login doesn't work when authorizing to a headless environment. Use auth:device:login instead.
48
28
 
49
29
  # invalidClientId
50
30