@@ -69,21 +69,20 @@ sfdx plugins
69
69
# Commands
70
70
71
71
<!-- commands -->
72
-
73
- - [ ` 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 )
74
- - [ ` 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 )
75
- - [ ` sfdx auth:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-authlist---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
76
- - [ ` sfdx auth:logout [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-authlogout--a--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
77
- - [ ` 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 )
78
- - [ ` 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 )
72
+ * [ ` 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 )
73
+ * [ ` 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 )
74
+ * [ ` sfdx auth:list [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-authlist---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
75
+ * [ ` sfdx auth:logout [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] ` ] ( #sfdx-authlogout--a--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal )
76
+ * [ ` 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 )
77
+ * [ ` 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 )
79
78
80
79
## ` 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] `
81
80
82
81
authorize an org using a device code
83
82
84
83
```
85
84
USAGE
86
- $ sfdx auth:device:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
85
+ $ sfdx auth:device:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
87
86
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
88
87
89
88
OPTIONS
@@ -126,7 +125,7 @@ authorize an org using the JWT flow
126
125
127
126
```
128
127
USAGE
129
- $ sfdx auth:jwt:grant -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
128
+ $ sfdx auth:jwt:grant -u <string> -f <filepath> -i <string> [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
130
129
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
131
130
132
131
OPTIONS
@@ -159,8 +158,8 @@ OPTIONS
159
158
160
159
DESCRIPTION
161
160
Use a certificate associated with your private key that has been uploaded to a personal connected app.
162
- If you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To
163
- specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To
161
+ If you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To
162
+ specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To
164
163
specify a sandbox, set --instanceurl to https://test.salesforce.com.
165
164
166
165
ALIASES
@@ -200,7 +199,7 @@ log out from authorized orgs
200
199
201
200
```
202
201
USAGE
203
- $ sfdx auth:logout [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel
202
+ $ sfdx auth:logout [-a] [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel
204
203
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
205
204
206
205
OPTIONS
@@ -234,11 +233,11 @@ _See code: [src/commands/auth/logout.ts](https://github.com/salesforcecli/plugin
234
233
235
234
## ` sfdx auth:sfdxurl:store -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] `
236
235
237
- authorize an org using an SFDX auth URL
236
+ Authorize an org using an SFDX auth URL
238
237
239
238
```
240
239
USAGE
241
- $ sfdx auth:sfdxurl:store -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel
240
+ $ sfdx auth:sfdxurl:store -f <filepath> [-d] [-s] [-a <string>] [--json] [--loglevel
242
241
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
243
242
244
243
OPTIONS
@@ -262,12 +261,14 @@ OPTIONS
262
261
this command invocation
263
262
264
263
DESCRIPTION
265
- Authorize a Salesforce org using an SFDX auth URL stored within a file. The URL must have the format "force://<refreshToken>@<instanceUrl>" or "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".
266
- 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.
264
+ Authorize a Salesforce org using an SFDX auth URL stored within a file. The URL must have the format
265
+ "force://<refreshToken>@<instanceUrl>" or "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".
266
+ You have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx
267
+ force:org:display --verbose --json` command into a file.
267
268
For example, using an org you have already authorized:
268
269
269
- $ sfdx force:org:display -u <DevHub> --verbose --json > authFile.json
270
- $ sfdx auth:sfdxurl:store -f authFile.json
270
+ $ sfdx force:org:display -u <DevHub> --verbose --json > authFile.json
271
+ $ sfdx auth:sfdxurl:store -f authFile.json
271
272
272
273
The resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object.
273
274
You can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the auth URL.
@@ -289,7 +290,7 @@ authorize an org using the web login flow
289
290
290
291
```
291
292
USAGE
292
- $ sfdx auth:web:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
293
+ $ sfdx auth:web:login [-i <string>] [-r <url>] [-d] [-s] [-a <string>] [--json] [--loglevel
293
294
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
294
295
295
296
OPTIONS
@@ -316,8 +317,8 @@ OPTIONS
316
317
this command invocation
317
318
318
319
DESCRIPTION
319
- If you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To
320
- specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To log
320
+ If you specify an --instanceurl value, this value overrides the sfdcLoginUrl value in your sfdx-project.json file. To
321
+ specify a My Domain URL, use the format MyDomainName.my.salesforce.com (not MyDomainName.lightning.force.com). To log
321
322
in to a sandbox, set --instanceurl to https://test.salesforce.com.
322
323
323
324
ALIASES
@@ -330,5 +331,4 @@ EXAMPLES
330
331
```
331
332
332
333
_ See code: [ src/commands/auth/web/login.ts] ( https://github.com/salesforcecli/plugin-auth/blob/v1.4.10/src/commands/auth/web/login.ts ) _
333
-
334
334
<!-- commandsstop -->
0 commit comments