The CLI login command

Usage

The Sitecore CLI login command is initiated within the Sitecore CLI by using the following:

dotnet sitecore login [options]

Options

You can use the following options with the login command:

• --authority, --auth: not required. Identity authority for the environment, such as identity server or AAD tenant URL.

• --audience: not required. The unique identifier of the audience that issued the token.

• --environment, -n: not required. Named Sitecore environment to use. Default: default.

• --cm: not required. Sitecore content management hostname to connect to.

• --allow-write: not required. Enable writing data to the environment.

• --client-credentials: not required. Use client credentials (for CI/CD, shared secret).

• --client-id: not required. The OAuth ClientID to send. Defaults to Device for device auth, and SitecoreCLIServer for client credentials.

• --client-secret: not required. The OAuth client secret to send. Only used for client credentials authentication.

• --config, -c: not required. Path to the root sitecore.json directory. Default: current working directory.

• --help, -h, -?: not required. Display developer help and usage information about the command.

• --trace, -t: not required. Outputs additional diagnostics and detailed information about the command.

• --insecure, -k: not required. Allows using an insecure (http) authority URL. Only applicable with the client credentials flow (--client-credentials true). Available in version 4.1.0 and later.

• --ref, -r: not required. Log in to an existing environment and use its credentials. Requires that you provide the --cm and --allow-write parameters.

  For example:

dotnet sitecore login --ref <your environment> --cm https://<sitecore instance> --allow-write true

Examples

The following are examples of using the login command for interactive user login:

dotnet sitecore login --authority https://<sitecore identity server> --cm https://<sitecore instance> --allow-write true

Output:

Logging in to Sitecore. You should see a browser window open shortly.
[DeviceLogin] User Code : 1234
[DeviceLogin] Authentication url : https://<sitecore identity server>/device?userCode=1234
[DeviceLogin] Authorization pending. Waiting.
[DeviceLogin] Authorization pending. Waiting.
Your login is complete. You can close the browser tab now.
Login information has been saved.

The following are examples of using the login command for noninteractive user login:

• Use the non-interactive client login:

dotnet sitecore login --authority https://<sitecore identity server> --cm https://<sitecore instance> --allow-write true --client-credentials true --client-id <client id> --client-secret <client secret>

• Bypass the https protocol restriction:

dotnet sitecore login --cm https://<sitecore instance> --auth http://<sitecore identity server> --allow-write true --client-id <client id> --client-secret <client secret> --client-credentials true --insecure

For more information, refer to logging in to a Sitecore instance using the CLI.