@salesforce/plugin-auth 2.3.9 → 2.3.11

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.
@@ -1 +1 @@
1
- {"version":"2.3.9","commands":{"auth:list":{"id":"auth:list","description":"list auth connection information","strict":true,"usage":"<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginAlias":"@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)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[],"flagsConfig":{}},"auth:logout":{"id":"auth:logout","description":"log out from authorized orgs\nBy default, this command logs you out from your default scratch org.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"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":[],"supportsUsername":true,"flagsConfig":{"all":{"kind":"boolean","char":"a","description":"include all authenticated orgs","longDescription":"Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.","required":false,"allowNo":false,"type":"boolean"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false,"type":"boolean"}}},"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>\"","strict":true,"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","pluginAlias":"@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)","multiple":false,"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,"multiple":false},"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","multiple":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false}},"args":[],"flagsConfig":{"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","required":true,"input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","default":false,"allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","default":false,"allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"default":false,"allowNo":false,"type":"boolean"}}},"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.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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)","multiple":false},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","multiple":false},"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","multiple":false},"disablemasking":{"name":"disablemasking","type":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false}},"args":[],"flagsConfig":{"clientid":{"kind":"string","char":"i","description":"OAuth client ID (sometimes called the consumer key)","input":[],"multiple":false,"type":"option"},"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"disablemasking":{"kind":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false,"type":"boolean"}}},"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.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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,"multiple":false},"jwtkeyfile":{"name":"jwtkeyfile","type":"option","char":"f","description":"path to a file containing the private key","required":true,"multiple":false},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)","required":true,"multiple":false},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","multiple":false},"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","multiple":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":[],"flagsConfig":{"username":{"kind":"string","char":"u","description":"authentication username","required":true,"input":[],"multiple":false,"type":"option"},"jwtkeyfile":{"kind":"filepath","char":"f","description":"path to a file containing the private key","required":true,"input":[],"multiple":false,"type":"option"},"clientid":{"kind":"string","char":"i","description":"OAuth client ID (sometimes called the consumer key)","required":true,"input":[],"multiple":false,"type":"option"},"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","required":false,"hidden":true,"allowNo":false,"type":"boolean"}}},"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.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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,"multiple":false},"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","multiple":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":[],"flagsConfig":{"sfdxurlfile":{"kind":"filepath","char":"f","description":"path to a file containing the sfdx url","required":true,"input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","required":false,"hidden":true,"allowNo":false,"type":"boolean"}}},"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.\nTo 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.","strict":true,"usage":"<%= command.id %> [-b chrome|edge|firefox] [-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","pluginAlias":"@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","$ sfdx auth:web:login -a TestOrg1 -b firefox"],"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)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"browser":{"name":"browser","type":"option","char":"b","description":"browser where the org opens","helpValue":"(chrome|edge|firefox)","multiple":false,"options":["chrome","edge","firefox"]},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)","multiple":false},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","multiple":false},"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","multiple":false},"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":[],"flagsConfig":{"browser":{"kind":"enum","helpValue":"(chrome|edge|firefox)","char":"b","description":"browser where the org opens","options":["chrome","edge","firefox"],"input":[],"multiple":false,"type":"option"},"clientid":{"kind":"string","char":"i","description":"OAuth client ID (sometimes called the consumer key)","input":[],"multiple":false,"type":"option"},"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"disablemasking":{"kind":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false,"type":"boolean"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","required":false,"hidden":true,"allowNo":false,"type":"boolean"}}}}}
1
+ {"version":"2.3.11","commands":{"auth:list":{"id":"auth:list","description":"list auth connection information","strict":true,"usage":"<%= command.id %> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-auth","pluginAlias":"@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)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"}},"args":[],"flagsConfig":{}},"auth:logout":{"id":"auth:logout","description":"log out from authorized orgs\nBy default, this command logs you out from your default scratch org.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"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":[],"supportsUsername":true,"flagsConfig":{"all":{"kind":"boolean","char":"a","description":"include all authenticated orgs","longDescription":"Includes all authenticated orgs: for example, Dev Hubs, sandboxes, DE orgs, and expired, deleted, and unknown-status scratch orgs.","required":false,"allowNo":false,"type":"boolean"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false,"type":"boolean"}}},"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>\"","strict":true,"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","pluginAlias":"@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)","multiple":false,"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,"multiple":false},"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","multiple":false},"noprompt":{"name":"noprompt","type":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"allowNo":false}},"args":[],"flagsConfig":{"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","required":true,"input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","default":false,"allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","default":false,"allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for confirmation","required":false,"default":false,"allowNo":false,"type":"boolean"}}},"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.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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)","multiple":false},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","multiple":false},"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","multiple":false},"disablemasking":{"name":"disablemasking","type":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false}},"args":[],"flagsConfig":{"clientid":{"kind":"string","char":"i","description":"OAuth client ID (sometimes called the consumer key)","input":[],"multiple":false,"type":"option"},"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"disablemasking":{"kind":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false,"type":"boolean"}}},"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.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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,"multiple":false},"jwtkeyfile":{"name":"jwtkeyfile","type":"option","char":"f","description":"path to a file containing the private key","required":true,"multiple":false},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)","required":true,"multiple":false},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","multiple":false},"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","multiple":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":[],"flagsConfig":{"username":{"kind":"string","char":"u","description":"authentication username","required":true,"input":[],"multiple":false,"type":"option"},"jwtkeyfile":{"kind":"filepath","char":"f","description":"path to a file containing the private key","required":true,"input":[],"multiple":false,"type":"option"},"clientid":{"kind":"string","char":"i","description":"OAuth client ID (sometimes called the consumer key)","required":true,"input":[],"multiple":false,"type":"option"},"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","required":false,"hidden":true,"allowNo":false,"type":"boolean"}}},"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.","strict":true,"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","pluginAlias":"@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)","multiple":false,"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,"multiple":false},"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","multiple":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":[],"flagsConfig":{"sfdxurlfile":{"kind":"filepath","char":"f","description":"path to a file containing the sfdx url","required":true,"input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","required":false,"hidden":true,"allowNo":false,"type":"boolean"}}},"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.\nTo 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.","strict":true,"usage":"<%= command.id %> [-b chrome|edge|firefox] [-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","pluginAlias":"@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","$ sfdx auth:web:login -a TestOrg1 -b firefox"],"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)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"browser":{"name":"browser","type":"option","char":"b","description":"browser where the org opens","helpValue":"(chrome|edge|firefox)","multiple":false,"options":["chrome","edge","firefox"]},"clientid":{"name":"clientid","type":"option","char":"i","description":"OAuth client ID (sometimes called the consumer key)","multiple":false},"instanceurl":{"name":"instanceurl","type":"option","char":"r","description":"the login URL of the instance the org lives on","multiple":false},"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","multiple":false},"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":[],"flagsConfig":{"browser":{"kind":"enum","helpValue":"(chrome|edge|firefox)","char":"b","description":"browser where the org opens","options":["chrome","edge","firefox"],"input":[],"multiple":false,"type":"option"},"clientid":{"kind":"string","char":"i","description":"OAuth client ID (sometimes called the consumer key)","input":[],"multiple":false,"type":"option"},"instanceurl":{"kind":"url","char":"r","description":"the login URL of the instance the org lives on","input":[],"multiple":false,"type":"option"},"setdefaultdevhubusername":{"kind":"boolean","char":"d","description":"set the authenticated org as the default dev hub org for scratch org creation","allowNo":false,"type":"boolean"},"setdefaultusername":{"kind":"boolean","char":"s","description":"set the authenticated org as the default username that all commands run against","allowNo":false,"type":"boolean"},"setalias":{"kind":"string","char":"a","description":"set an alias for the authenticated org","input":[],"multiple":false,"type":"option"},"disablemasking":{"kind":"boolean","description":"disable masking of user input (for use with problematic terminals)","hidden":true,"allowNo":false,"type":"boolean"},"noprompt":{"kind":"boolean","char":"p","description":"do not prompt for auth confirmation in demo mode","required":false,"hidden":true,"allowNo":false,"type":"boolean"}}}}}
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": "2.3.9",
4
+ "version": "2.3.11",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "main": "lib/index.js",
@@ -9,19 +9,19 @@
9
9
  "@oclif/core": "^1.23.1",
10
10
  "@salesforce/command": "^5.2.35",
11
11
  "@salesforce/core": "^3.32.12",
12
- "@salesforce/kit": "^1.7.0",
12
+ "@salesforce/kit": "^1.8.2",
13
13
  "chalk": "^4.1.2",
14
14
  "fs-extra": "^10.0.1",
15
15
  "open": "^8.2.1",
16
16
  "tslib": "^2"
17
17
  },
18
18
  "devDependencies": {
19
- "@oclif/plugin-command-snapshot": "^3.2.12",
19
+ "@oclif/plugin-command-snapshot": "^3.2.16",
20
20
  "@salesforce/cli-plugins-testkit": "^3.2.10",
21
21
  "@salesforce/dev-config": "^3.1.0",
22
22
  "@salesforce/dev-scripts": "^3.1.0",
23
23
  "@salesforce/plugin-command-reference": "^2",
24
- "@salesforce/plugin-config": "^1.4.22",
24
+ "@salesforce/plugin-config": "^1.4.23",
25
25
  "@salesforce/prettier-config": "^0.0.2",
26
26
  "@salesforce/ts-sinon": "^1.4.2",
27
27
  "@swc/core": "^1.3.24",
@@ -32,9 +32,9 @@
32
32
  "@typescript-eslint/parser": "^5.47.1",
33
33
  "chai": "^4.3.7",
34
34
  "eslint": "^8.30.0",
35
- "eslint-config-prettier": "^8.5.0",
35
+ "eslint-config-prettier": "^8.6.0",
36
36
  "eslint-config-salesforce": "^1.1.0",
37
- "eslint-config-salesforce-license": "^0.1.6",
37
+ "eslint-config-salesforce-license": "^0.2.0",
38
38
  "eslint-config-salesforce-typescript": "^1.1.1",
39
39
  "eslint-plugin-header": "^3.0.0",
40
40
  "eslint-plugin-import": "2.26.0",
@@ -129,7 +129,7 @@
129
129
  "access": "public"
130
130
  },
131
131
  "sfdx": {
132
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.3.9.crt",
133
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.3.9.sig"
132
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.3.11.crt",
133
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-auth/2.3.11.sig"
134
134
  }
135
135
  }