@salesforce/plugin-auth 1.8.0 → 1.8.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.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,12 @@
2
2
 
3
3
  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.
4
4
 
5
+ ### [1.8.1](https://github.com/salesforcecli/plugin-auth/compare/v1.8.0...v1.8.1) (2022-01-31)
6
+
7
+ ### Bug Fixes
8
+
9
+ - use `d` as short form of `setdefaultdevhubusername` flag ([e176462](https://github.com/salesforcecli/plugin-auth/commit/e17646281e6c02a9691612bf20aa8ac5da0e82bd))
10
+
5
11
  ## [1.8.0](https://github.com/salesforcecli/plugin-auth/compare/v1.7.7...v1.8.0) (2021-12-02)
6
12
 
7
13
  ### Features
package/LICENSE.txt CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2021, Salesforce.com, Inc.
1
+ Copyright (c) 2022, Salesforce.com, Inc.
2
2
  All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
package/README.md CHANGED
@@ -70,7 +70,7 @@ sfdx plugins
70
70
 
71
71
  <!-- commands -->
72
72
 
73
- - [`sfdx auth:accesstoken:store -r <url> [-s] [-s] [-a <string>] [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authaccesstokenstore--r-url--s--s--a-string--p---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
73
+ - [`sfdx auth:accesstoken:store -r <url> [-d] [-s] [-a <string>] [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authaccesstokenstore--r-url--d--s--a-string--p---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
74
74
  - [`sfdx auth:device:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authdevicelogin--i-string--r-url--d--s--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
75
75
  - [`sfdx auth:jwt:grant -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authjwtgrant--u-string--f-filepath--i-string--r-url--d--s--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
76
76
  - [`sfdx auth:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authlist---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
@@ -78,32 +78,28 @@ sfdx plugins
78
78
  - [`sfdx auth:sfdxurl:store -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authsfdxurlstore--f-filepath--d--s--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
79
79
  - [`sfdx auth:web:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-authweblogin--i-string--r-url--d--s--a-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
80
80
 
81
- ## `sfdx auth:accesstoken:store -r <url> [-s] [-s] [-a <string>] [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
81
+ ## `sfdx auth:accesstoken:store -r <url> [-d] [-s] [-a <string>] [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
82
82
 
83
83
  authorize an org using an existing Salesforce access token
84
84
 
85
85
  ```
86
- authorize an org using an existing Salesforce access token
87
- 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 --noprompt to not be prompted.
88
- 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 --noprompt parameter. "<org id>!<accesstoken>"
89
-
90
86
  USAGE
91
- $ sfdx auth:accesstoken:store -r <url> [-s] [-s] [-a <string>] [-p] [--json] [--loglevel
87
+ $ sfdx auth:accesstoken:store -r <url> [-d] [-s] [-a <string>] [-p] [--json] [--loglevel
92
88
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
93
89
 
94
90
  OPTIONS
95
91
  -a, --setalias=setalias set an alias for the authenticated
96
92
  org
97
93
 
94
+ -d, --setdefaultdevhubusername set the authenticated org as the
95
+ default dev hub org for scratch org
96
+ creation
97
+
98
98
  -p, --noprompt do not prompt for confirmation
99
99
 
100
100
  -r, --instanceurl=instanceurl (required) the login URL of the
101
101
  instance the org lives on
102
102
 
103
- -s, --setdefaultdevhubusername set the authenticated org as the
104
- default dev hub org for scratch org
105
- creation
106
-
107
103
  -s, --setdefaultusername set the authenticated org as the
108
104
  default username that all commands
109
105
  run against
@@ -117,7 +113,7 @@ DESCRIPTION
117
113
  By default, the command runs interactively and asks you for the access token. If you previously authorized the org,
118
114
  the command prompts whether you want to overwrite the local file. Specify --noprompt to not be prompted.
119
115
  To use the command in a CI/CD script, set the SFDX_ACCESS_TOKEN environment variable to the access token. Then run the
120
- command with the --noprompt parameter. "<org id>!<accesstoken>"
116
+ command with the --noprompt parameter. "<org id>!<accesstoken>"
121
117
 
122
118
  ALIASES
123
119
  $ sfdx force:auth:accesstoken:store
@@ -128,16 +124,13 @@ EXAMPLES
128
124
  sfdx auth:accesstoken:store --instanceurl https://dev-hub.my.salesforce.com --noprompt
129
125
  ```
130
126
 
131
- _See code: [src/commands/auth/accesstoken/store.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/accesstoken/store.ts)_
127
+ _See code: [src/commands/auth/accesstoken/store.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/accesstoken/store.ts)_
132
128
 
133
129
  ## `sfdx auth:device:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
134
130
 
135
131
  authorize an org using a device code
136
132
 
137
133
  ```
138
- authorize an org using a device code
139
- 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.
140
-
141
134
  USAGE
142
135
  $ sfdx auth:device:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
143
136
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -178,17 +171,13 @@ EXAMPLES
178
171
  sfdx auth:device:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com
179
172
  ```
180
173
 
181
- _See code: [src/commands/auth/device/login.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/device/login.ts)_
174
+ _See code: [src/commands/auth/device/login.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/device/login.ts)_
182
175
 
183
176
  ## `sfdx auth:jwt:grant -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
184
177
 
185
178
  authorize an org using the JWT flow
186
179
 
187
180
  ```
188
- authorize an org using the JWT flow
189
- Use a certificate associated with your private key that has been uploaded to a personal connected app.
190
- If you specify an --instanceurl 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 --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.
191
-
192
181
  USAGE
193
182
  $ sfdx auth:jwt:grant -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
194
183
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -236,15 +225,13 @@ EXAMPLES
236
225
  sfdx auth:jwt:grant -u me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com
237
226
  ```
238
227
 
239
- _See code: [src/commands/auth/jwt/grant.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/jwt/grant.ts)_
228
+ _See code: [src/commands/auth/jwt/grant.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/jwt/grant.ts)_
240
229
 
241
230
  ## `sfdx auth:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
242
231
 
243
232
  list auth connection information
244
233
 
245
234
  ```
246
- list auth connection information
247
-
248
235
  USAGE
249
236
  $ sfdx auth:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
250
237
 
@@ -258,16 +245,13 @@ ALIASES
258
245
  $ sfdx force:auth:list
259
246
  ```
260
247
 
261
- _See code: [src/commands/auth/list.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/list.ts)_
248
+ _See code: [src/commands/auth/list.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/list.ts)_
262
249
 
263
250
  ## `sfdx auth:logout [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
264
251
 
265
252
  log out from authorized orgs
266
253
 
267
254
  ```
268
- log out from authorized orgs
269
- By default, this command logs you out from your default scratch org.
270
-
271
255
  USAGE
272
256
  $ sfdx auth:logout [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel
273
257
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -299,25 +283,13 @@ EXAMPLES
299
283
  sfdx auth:logout -p
300
284
  ```
301
285
 
302
- _See code: [src/commands/auth/logout.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/logout.ts)_
286
+ _See code: [src/commands/auth/logout.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/logout.ts)_
303
287
 
304
288
  ## `sfdx auth:sfdxurl:store -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
305
289
 
306
290
  authorize an org using an SFDX auth URL stored within a file
307
291
 
308
292
  ```
309
- authorize an org using an SFDX auth URL stored within a file
310
- The SFDX auth URL must have the format "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>". 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://").
311
-
312
- You have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx force:org:display --verbose --json` command into a file. For example, using an org you have already authorized:
313
-
314
- $ sfdx force:org:display -u <OrgUsername> --verbose --json > authFile.json
315
- $ sfdx auth:sfdxurl:store -f authFile.json
316
-
317
- The resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The `force:org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow.
318
-
319
- 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.
320
-
321
293
  USAGE
322
294
  $ sfdx auth:sfdxurl:store -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel
323
295
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -350,8 +322,8 @@ DESCRIPTION
350
322
  You have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx
351
323
  force:org:display --verbose --json` command into a file. For example, using an org you have already authorized:
352
324
 
353
- $ sfdx force:org:display -u <OrgUsername> --verbose --json > authFile.json
354
- $ sfdx auth:sfdxurl:store -f authFile.json
325
+ $ sfdx force:org:display -u <OrgUsername> --verbose --json > authFile.json
326
+ $ sfdx auth:sfdxurl:store -f authFile.json
355
327
 
356
328
  The resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The
357
329
  `force:org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow,
@@ -368,16 +340,13 @@ EXAMPLES
368
340
  sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg
369
341
  ```
370
342
 
371
- _See code: [src/commands/auth/sfdxurl/store.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/sfdxurl/store.ts)_
343
+ _See code: [src/commands/auth/sfdxurl/store.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/sfdxurl/store.ts)_
372
344
 
373
345
  ## `sfdx auth:web:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
374
346
 
375
347
  authorize an org using the web login flow
376
348
 
377
349
  ```
378
- authorize an org using the web login flow
379
- If you specify an --instanceurl 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.
380
-
381
350
  USAGE
382
351
  $ sfdx auth:web:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
383
352
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
@@ -419,6 +388,6 @@ EXAMPLES
419
388
  sfdx auth:web:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com
420
389
  ```
421
390
 
422
- _See code: [src/commands/auth/web/login.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.7.7/src/commands/auth/web/login.ts)_
391
+ _See code: [src/commands/auth/web/login.ts](https://github.com/salesforcecli/plugin-auth/blob/v1.8.0/src/commands/auth/web/login.ts)_
423
392
 
424
393
  <!-- commandsstop -->
@@ -80,7 +80,7 @@ Store.flagsConfig = {
80
80
  required: true,
81
81
  }),
82
82
  setdefaultdevhubusername: command_1.flags.boolean({
83
- char: 's',
83
+ char: 'd',
84
84
  description: commonMessages.getMessage('setDefaultDevHub'),
85
85
  default: false,
86
86
  }),
@@ -1 +1 @@
1
- {"version":"1.8.0","commands":{"auth:list":{"id":"auth:list","description":"list auth connection information","usage":"<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:list"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[]},"auth:logout":{"id":"auth:logout","description":"log out from authorized orgs\nBy default, this command logs you out from your default scratch org.","usage":"<%= command.id %> [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:logout"],"examples":["sfdx auth:logout -u me@my.org","sfdx auth:logout -a","sfdx auth:logout -p"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"all":{"name":"all","type":"boolean","char":"a","description":"include all authenticated orgs","required":false,"allowNo":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false}},"args":[]},"auth:accesstoken:store":{"id":"auth:accesstoken:store","description":"authorize an org using an existing Salesforce access token\nBy 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 --noprompt to not be prompted.\nTo 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 --noprompt parameter. \"<org id>!<accesstoken>\"","usage":"<%= command.id %> -r <url> [-s] [-s] [-a <string>] [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:accesstoken:store"],"examples":["sfdx auth:accesstoken:store --instanceurl https://mycompany.my.salesforce.com","export SFDX_ACCESS_TOKEN=00Dxx0000000000!xxxxx","sfdx auth:accesstoken:store --instanceurl https://dev-hub.my.salesforce.com --noprompt"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","required":true},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"s","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false}},"args":[]},"auth:device:login":{"id":"auth:device:login","description":"authorize an org using a device code\nYou 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.","usage":"<%= command.id %> [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:device:login"],"examples":["sfdx auth:device:login -d -a TestOrg1","sfdx auth:device:login -i <OAuth client id>","sfdx auth:device:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)"},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on"},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"disablemasking":{"name":"disablemasking","type":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false}},"args":[]},"auth:jwt:grant":{"id":"auth:jwt:grant","description":"authorize an org using the JWT flow\nUse a certificate associated with your private key that has been uploaded to a personal connected app.\nIf you specify an --instanceurl 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 --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.","usage":"<%= command.id %> -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:jwt:grant"],"examples":["sfdx auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id>","sfdx auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg","sfdx auth:jwt:grant -u me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"username":{"name":"username","type":"option","char":"u","description":"authentication username","required":true},"jwtkeyfile":{"name":"jwtkeyfile","type":"option","char":"f","description":"path to a file containing the private key","required":true},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)","required":true},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on"},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","hidden":true,"required":false,"allowNo":false}},"args":[]},"auth:sfdxurl:store":{"id":"auth:sfdxurl:store","description":"authorize an org using an SFDX auth URL stored within a file\nThe SFDX auth URL must have the format \"force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>\". 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://\").\n\nYou have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx force:org:display --verbose --json` command into a file. For example, using an org you have already authorized:\n\n $ sfdx force:org:display -u <OrgUsername> --verbose --json > authFile.json\n $ sfdx auth:sfdxurl:store -f authFile.json\n\nThe resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The `force:org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow. \n\nYou 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.","usage":"<%= command.id %> -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:sfdxurl:store"],"examples":["sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file>","sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sfdxurlfile":{"name":"sfdxurlfile","type":"option","char":"f","description":"path to a file containing the sfdx url","required":true},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","hidden":true,"required":false,"allowNo":false}},"args":[]},"auth:web:login":{"id":"auth:web:login","description":"authorize an org using the web login flow\nIf you specify an --instanceurl 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.","usage":"<%= command.id %> [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:web:login"],"examples":["sfdx auth:web:login -a TestOrg1","sfdx auth:web:login -i <OAuth client id>","sfdx auth:web:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)"},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on"},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"disablemasking":{"name":"disablemasking","type":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","hidden":true,"required":false,"allowNo":false}},"args":[]}}}
1
+ {"version":"1.8.1","commands":{"auth:list":{"id":"auth:list","description":"list auth connection information","usage":"<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:list"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[]},"auth:logout":{"id":"auth:logout","description":"log out from authorized orgs\nBy default, this command logs you out from your default scratch org.","usage":"<%= command.id %> [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:logout"],"examples":["sfdx auth:logout -u me@my.org","sfdx auth:logout -a","sfdx auth:logout -p"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"all":{"name":"all","type":"boolean","char":"a","description":"include all authenticated orgs","required":false,"allowNo":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false}},"args":[]},"auth:accesstoken:store":{"id":"auth:accesstoken:store","description":"authorize an org using an existing Salesforce access token\nBy 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 --noprompt to not be prompted.\nTo 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 --noprompt parameter. \"<org id>!<accesstoken>\"","usage":"<%= command.id %> -r <url> [-d] [-s] [-a <string>] [-p] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:accesstoken:store"],"examples":["sfdx auth:accesstoken:store --instanceurl https://mycompany.my.salesforce.com","export SFDX_ACCESS_TOKEN=00Dxx0000000000!xxxxx","sfdx auth:accesstoken:store --instanceurl https://dev-hub.my.salesforce.com --noprompt"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","required":true},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false}},"args":[]},"auth:device:login":{"id":"auth:device:login","description":"authorize an org using a device code\nYou 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.","usage":"<%= command.id %> [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:device:login"],"examples":["sfdx auth:device:login -d -a TestOrg1","sfdx auth:device:login -i <OAuth client id>","sfdx auth:device:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)"},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on"},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"disablemasking":{"name":"disablemasking","type":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false}},"args":[]},"auth:jwt:grant":{"id":"auth:jwt:grant","description":"authorize an org using the JWT flow\nUse a certificate associated with your private key that has been uploaded to a personal connected app.\nIf you specify an --instanceurl 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 --instanceurl to https://MyDomainName--SandboxName.sandbox.my.salesforce.com.","usage":"<%= command.id %> -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:jwt:grant"],"examples":["sfdx auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id>","sfdx auth:jwt:grant -u me@my.org -f <path to jwt key file> -i <OAuth client id> -s -a MyDefaultOrg","sfdx auth:jwt:grant -u me@acme.org -f <path to jwt key file> -i <OAuth client id> -r https://acme.my.salesforce.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"username":{"name":"username","type":"option","char":"u","description":"authentication username","required":true},"jwtkeyfile":{"name":"jwtkeyfile","type":"option","char":"f","description":"path to a file containing the private key","required":true},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)","required":true},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on"},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","hidden":true,"required":false,"allowNo":false}},"args":[]},"auth:sfdxurl:store":{"id":"auth:sfdxurl:store","description":"authorize an org using an SFDX auth URL stored within a file\nThe SFDX auth URL must have the format \"force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>\". 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://\").\n\nYou have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx force:org:display --verbose --json` command into a file. For example, using an org you have already authorized:\n\n $ sfdx force:org:display -u <OrgUsername> --verbose --json > authFile.json\n $ sfdx auth:sfdxurl:store -f authFile.json\n\nThe resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object. NOTE: The `force:org:display --verbose` command displays the refresh token only for orgs authorized with the web server flow, and not the JWT bearer flow. \n\nYou 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.","usage":"<%= command.id %> -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:sfdxurl:store"],"examples":["sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file>","sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file> -s -a MyDefaultOrg"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"sfdxurlfile":{"name":"sfdxurlfile","type":"option","char":"f","description":"path to a file containing the sfdx url","required":true},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","hidden":true,"required":false,"allowNo":false}},"args":[]},"auth:web:login":{"id":"auth:web:login","description":"authorize an org using the web login flow\nIf you specify an --instanceurl 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.","usage":"<%= command.id %> [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginType":"core","aliases":["force:auth:web:login"],"examples":["sfdx auth:web:login -a TestOrg1","sfdx auth:web:login -i <OAuth client id>","sfdx auth:web:login -r https://MyDomainName--SandboxName.sandbox.my.salesforce.com"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)"},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on"},"setdefaultdevhubusername":{"name":"setdefaultdevhubusername","type":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false},"setdefaultusername":{"name":"setdefaultusername","type":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false},"setalias":{"name":"setalias","type":"option","char":"a","description":"set an alias for the authenticated org"},"disablemasking":{"name":"disablemasking","type":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","hidden":true,"required":false,"allowNo":false}},"args":[]}}}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-auth",
3
3
  "description": "plugin for sfdx auth commands",
4
- "version": "1.8.0",
4
+ "version": "1.8.1",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -36,7 +36,7 @@
36
36
  "eslint-config-salesforce-license": "^0.1.6",
37
37
  "eslint-config-salesforce-typescript": "^0.2.7",
38
38
  "eslint-plugin-header": "^3.0.0",
39
- "eslint-plugin-import": "2.25.2",
39
+ "eslint-plugin-import": "2.25.3",
40
40
  "eslint-plugin-jsdoc": "^35.1.2",
41
41
  "eslint-plugin-prettier": "^3.4.0",
42
42
  "husky": "^7.0.4",
@@ -131,7 +131,7 @@
131
131
  "access": "public"
132
132
  },
133
133
  "sfdx": {
134
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/1.8.0.crt",
135
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/1.8.0.sig"
134
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/1.8.1.crt",
135
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/1.8.1.sig"
136
136
  }
137
137
  }