Authorize an org using a device code.
This command is deprecated. As of April 20, 2023, we no longer maintain this section of the
command reference. Refer to the reference information about the sf-style
commands instead, which we update regularly. We keep this reference
information about the sfdx-style commands as-is
for historical reference only.
Don't worry, this command and its flags continue to work the same as
before, and any scripts that use the command won’t break. However, we recommend
that you start using the equivalent sf-style org login device command instead. Here’s how the flags changed between
the old and new commands; if a flag isn't listed, the old and new names are the
same:
- Removed flag: --loglevel. Use the SF_LOG_LEVEL environment variable instead.
- Changed flag name: Old name --clientid. New name: --client-id.
- Changed flag name: Old name --setdefaultdevhubusername. New name: --set-default-dev-hub.
- Changed flag name: Old name --setalias. New name: --alias.
- Changed flag name: Old name --instanceurl. New name: --instance-url.
- Changed flag name: Old name --setdefaultusername. New name: --set-default.
For background information about this change, read this blog post, which describes how
we've updated many of the existing sfdx
commands to use the improvements we made in sf. We improved this particular command on March 2, 2023.
Help for auth:device:login
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.
Examples for auth:device:login
Command Syntax
- sfdx auth:device:login
- [--json]
- [--loglevel LOGLEVEL]
- [-i CLIENTID]
- [-r INSTANCEURL]
- [-d]
- [-s]
- [-a SETALIAS]
Parameters
- --json
- Optional
-
Format output as JSON.
- Type: boolean
-
--loglevel LOGLEVEL
- Optional
-
The logging level for this command invocation. Logs are stored in $HOME/.sf/sf.log.
- Type: enum
- Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL
- Default value: warn
-
-i | --clientid CLIENTID
- Optional
-
OAuth client ID (sometimes called the consumer key).
- Type: string
-
-r | --instanceurl INSTANCEURL
- Optional
-
The login URL of the instance the org lives on.
- Type: url
-
-d | --setdefaultdevhubusername
- Optional
-
Set the authenticated org as the default dev hub org for scratch org creation.
- Type: boolean
-
-s | --setdefaultusername
- Optional
-
Set the authenticated org as the default username that all commands run against.
- Type: boolean
-
-a | --setalias SETALIAS
- Optional
-
Set an alias for the authenticated org.
- Type: string
Aliases for auth:device:login