Skip to main content

The edge login command

Abstract

Reference for the Sitecore CLI edge login command for authenticating within an Experience Edge organization.

The Experience Edge plugin for Sitecore CLI provides the edge login command that authenticates you within an organization.

You can use the edge login command as follows:

dotnet sitecore edge login [options]

Running the login command without options initializes an interactive/device authorization login flow for authenticating with an organization. For example:

dotnet sitecore edge login

You can also log directly into a production environment for a specific tenant if you have the necessary credentials. For example:

dotnet sitecore edge login --clientId <your-client-ID> --clientSecret <your-client-secret>

The Experience Edge login command has the following options:

Option

Description

--clientId, --id

Specifies the client ID used to log in to the specific Edge tenant.

Required for non-interactive/client credentials login.

--clientSecret, --secret

Specifies the client secret used to log in to the specific Edge tenant.

Required for non-interactive/client credentials login.

--env, --environment

Specifies the Experience Edge environment to target.

Possible values: preprod, prod

Default: prod

-?, -h, --help

Displays developer help and usage information about the command

Note

Any Experience Edge command memorizes the last used environment option. On subsequent commands for the same Edge environment, you can omit the --env option.

You obtain the client credentials as follows: