1. The CLI edge command

The edge login command

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

Usage

You can use the edge login command as follows:

shell
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:

shell
dotnet sitecore edge login
Note

This command requires that you obtain a tenant ID from a list of tenants and select a specific Edge tenant for subsequent commands.

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

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

Options

The Experience Edge login command has the following options:

OptionDescription
--clientId, --idSpecifies the client ID used to log in to the specific Edge tenant.Required for non-interactive/client credentials login.
--clientSecret, --secretSpecifies the client secret used to log in to the specific Edge tenant.Required for non-interactive/client credentials login.
--aud, --audienceSpecifies the custom audience. This might be useful for the older Edge tenants (provisioned with the Provisioning API v1).
--env, --environmentSpecifies the Experience Edge environment to target.Possible values: preprod, prodDefault: prod
-?, -h, --helpDisplays 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:

If you have suggestions for improving this article, let us know!