Authentication and Configuration

Overview

This section details the process of connecting to the LINQ cloud and authenticating using the Command Line Interface (CLI). It explores different authentication methods for secure access.

To view all linq auth commands in the CLI, use:

linq auth --help

LINQ Cloud

In order to use the LINQ SDK and API, a user must be added to LINQ Cloud in the environment that workflow planning, deployment, and publication will occur.

To add a user, consult the LINQ Cloud user manual.

Configuration

To configure the LINQ SDK’s environment connection, run:

linq configure

and provide your api_domain, auth0_domain, and client_id as provided by your Automata Customer Success Manager.

SSO (Browser) Auth

To authenticate via a LINQ Cloud browser session, run:

linq auth login

and follow the prompts in the browser window that opens.

Machine to Machine Authentication

To be able to authenticate with LINQ Cloud without opening a browser window, you need to create a machine credential. This can be done by running the following command:

linq auth credentials create --name <credential_name>

This will return output similar to the following example:

Machine credentials `<credential_name>` with ID `<linq_client_id>` rotated successfully

╭─ Your new credentials secret is: ─────────────────────────────────────────────────────────╮
│ <linq_client_secret>                                                                      │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
Please save this secret securely, you will not be able to view it again!
Be careful with who can access these credentials - using these credentials acts as the creator user, and they will stop working if the creator account is
deleted.

The important values you’ll need are:

• linq_client_id - This is the credential ID (e.g., <linq_client_id> from the output above)

• linq_client_secret - This is the secret shown in the box (e.g., <linq_client_secret> from the output above)

The client secret is only displayed once and never stored by Automata, so make sure to save it in a secure location.

To authenticate with the CLI, you can run the following command using your credentials:

LINQ_CLIENT_ID=<linq_client_id> LINQ_CLIENT_SECRET=<linq_client_secret> linq auth login --machine

You will see a message that you have successfully authenticated with the CLI.

You can also list, delete and rotate a machine credential by running the following commands:

linq auth credentials list
linq auth credentials delete --id <id>
linq auth credentials rotate-secret --id <id>

Note

Each user is limited to 2 machine credentials. Please make sure to delete any unused credentials to avoid reaching the limit.