diff --git a/CHANGELOG.md b/CHANGELOG.md index f6684cf5..22000c51 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## [3.6.57](https://github.com/salesforcecli/plugin-auth/compare/3.6.56...3.6.57) (2024-09-11) + +### Bug Fixes + +- clarify the --help for "org login sfdx-url" ([639b6d7](https://github.com/salesforcecli/plugin-auth/commit/639b6d7cb940d202335b7a893c6afcc2e9ec5144)) +- update the test ([f26d416](https://github.com/salesforcecli/plugin-auth/commit/f26d416c05160ba8fffe55a91df96a17a54e1d87)) + ## [3.6.56](https://github.com/salesforcecli/plugin-auth/compare/3.6.55...3.6.56) (2024-09-08) ### Bug Fixes diff --git a/README.md b/README.md index 1b0144ad..41d6b315 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ EXAMPLES $ sf org list auth ``` -_See code: [src/commands/org/list/auth.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/list/auth.ts)_ +_See code: [src/commands/org/list/auth.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/list/auth.ts)_ ## `sf org login access-token` @@ -162,7 +162,7 @@ FLAG DESCRIPTIONS To specify a sandbox, set --instance-url to "https://--.sandbox.my.salesforce.com". ``` -_See code: [src/commands/org/login/access-token.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/login/access-token.ts)_ +_See code: [src/commands/org/login/access-token.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/login/access-token.ts)_ ## `sf org login device` @@ -222,7 +222,7 @@ FLAG DESCRIPTIONS To specify a sandbox, set --instance-url to "https://--.sandbox.my.salesforce.com". ``` -_See code: [src/commands/org/login/device.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/login/device.ts)_ +_See code: [src/commands/org/login/device.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/login/device.ts)_ ## `sf org login jwt` @@ -313,7 +313,7 @@ FLAG DESCRIPTIONS To specify a sandbox, set --instance-url to "https://--.sandbox.my.salesforce.com". ``` -_See code: [src/commands/org/login/jwt.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/login/jwt.ts)_ +_See code: [src/commands/org/login/jwt.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/login/jwt.ts)_ ## `sf org login sfdx-url` @@ -337,10 +337,15 @@ GLOBAL FLAGS DESCRIPTION Authorize an org using a Salesforce DX authorization URL stored in a file or through standard input (stdin). - The Salesforce DX (SFDX) authorization URL must have the format - "force://::@". 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://"). + You use the Salesforce DX (SFDX) authorization URL to authorize Salesforce CLI to connect to a target org. The URL + contains the required data to accomplish the authorization, such as the client ID, client secret, and instance URL. + You must specify the SFDX authorization URL in this format: + "force://::@". Replace , , , + and with the values specific to your target org. For , don't include a protocol (such as + "https://"). Note that although the SFDX authorization URL starts with "force://", it has nothing to do with the + actual authorization. Salesforce CLI always communicates with your org using HTTPS. + + To see an example of an SFDX authorization URL, run "org display --verbose" on an org. You have three options when creating the authorization file. The easiest option is to redirect the output of the "sf org display --verbose --json" command into a file. For example, using an org with alias my-org that you've already @@ -378,7 +383,7 @@ EXAMPLES $ echo url | sf org login sfdx-url --sfdx-url-stdin ``` -_See code: [src/commands/org/login/sfdx-url.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/login/sfdx-url.ts)_ +_See code: [src/commands/org/login/sfdx-url.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/login/sfdx-url.ts)_ ## `sf org login web` @@ -465,7 +470,7 @@ FLAG DESCRIPTIONS To specify a sandbox, set --instance-url to "https://--.sandbox.my.salesforce.com". ``` -_See code: [src/commands/org/login/web.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/login/web.ts)_ +_See code: [src/commands/org/login/web.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/login/web.ts)_ ## `sf org logout` @@ -526,6 +531,6 @@ FLAG DESCRIPTIONS All orgs includes Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs. ``` -_See code: [src/commands/org/logout.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.56/src/commands/org/logout.ts)_ +_See code: [src/commands/org/logout.ts](https://github.com/salesforcecli/plugin-auth/blob/3.6.57/src/commands/org/logout.ts)_ diff --git a/package.json b/package.json index 50806451..99e40181 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-auth", "description": "plugin for sf auth commands", - "version": "3.6.56", + "version": "3.6.57", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {