Skip to main content

Log in

In Elara development, you launch Elara solutions on the Elara platform. In this tutorial, you will log-in to Elara platform from your machine in readiness to launch solutions. You will:

  • perform the first-time log-in steps
  • switch to, or create a permissioned tenant on Elara platform, and
  • learn how to log-in to the EDK CLI on your development machine.

Log-in for the first time

Set up the prerequisites

To log-in to Elara platform, you need to have:

  • your user log-in credentials added to the instance, and
  • a valid developer API token, and
  • access to a Tenant of Elara platform

If your organisation already has Elara platform, contact your Elara System Administrator to set up your user credentials and retrieve the URL for a running instance of Elara platform.

Log-in via the UI

To log into the UI, navigate in a browser to the URL for your Elara platform instance, enter your credentials to load the application. If enabled by your system administrator you may have the ability to log-in using third party authentication, such as "Microsoft". If you are unsure of the credentials you have been assigned, check with an administrator or

contact Elara.

Create an API token

In order to log in with the CLI, you need a developer API token. To create an api token, perform the following:

  • Select "My Account" from your profile icon and navigate to the "Developer settings".
  • The "Developer Settings" tab displays a table of your API tokens, if the table is empty, click the "+" button to create a new one.
  • The table will now show an API token.

Log-in via the command-line

To log-in via the command-line, you run the edk auth login command in the EDK CLI. You can get help with usage of the command by running edk auth login --help in the command-line.

  • Run edk auth login in the command-line. Provide the URL for your Elara platform instance as the first argument.
  • In your web browser, navigate to the verification link URL provided in the output of the command-line query and Log-in using your user credentials.
  • Once logged-in, you are re-directed to a page to complete device verification. Enter the 8 digit user code provided in the output of the command-line query and click Complete Device Verification.
  • Click the Select button on your API Client token, then click Verify Device.

You are now verified and logged-in to Elara platform, and accessing the Elara Management Portal in your browser. In your command-line output, you should see the following message in the output of your edk auth login command. The Elara Portal in your browser allows you to manage your deployed Elara solutions, access solution UIs and manage user access. In later lessons, you will learn how to use the Portal.

Server version

In some cases the platform version may differ from the version of the EDK you have installed locally. Both the platform and EDK use semantic versioning in the form of MAJOR.MINOR.PATCH. To function correctly, your EDK MAJOR version must be identical to the platform, and the MINOR version of the EDK must be equal to or greater than the platform version.

You can check the platform version by running the following command:

edk auth version

Which would result in a response such as:

✔ version of http://my-elara-instance.com is 6.0.0

List available tenants

The Elara platform contains Tenant's which are secure areas that contain solutions. To launch Elara solutions on the Elara platform, you must be logged in to a tenant.

You can list the Tenants available to you using the edk tenant list command in the command-line. You can get help with the command by running edk tenant list --help in the command-line.

Run the following in the command-line:

edk tenant list

The command will result in a list of the the available tenants.

Tenants available at http://my-elara-instance.com.


UUID                                 NAME     CREATEDAT                UPDATEDAT
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX Training YYYY-MM-DDTHH:MM:SS.MSZ  YYYY-MM-DDTHH:MM:SS.MSZ

Otherwise, if you don't have access to any Tenants, you will see the following message:

⚠ No tenants found at http://my-elara-instance.com

Contact a tenant administrator if you do not have access to a Tenant, and have not been provided the tenant_admin role.

Switch to a tenant

If you have access to more than one tenant, you may switch the tenant context by with the edk tenant switch command in the command-line. You can get help with the command by running edk tenant switch --help.

Run edk tenant switch in the command-line, and select the appropriate tenant to access for this tutorial course.

edk tenant switch

The command will result result in notification of the switch. If the command outputs ✖ No tenants available and you have to appropriate permissions you can "Create a Tenant" as above.

✔ Select a tenant to switch context to › MyTenant
Tenant context successfully updated to XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Next steps

You have now logged-in to Elara platform from your machine in readiness to launch solutions. Continue to the next lesson to initialise a project on your machine in preparation for development of a template for a solution.

On this page