Get Started
Account Management
Command-Line Interface
Get Started
Accessing the platform
The platform requires a provisioned tenant in the Illumina account management system with access to the Illumina Connected Analytics (ICA) application. .
Once a tenant has been provisioned, a tenant administrator will be assigned. The tenant administrator has permission to add users, create workgroups, and manage account access. Each tenant is assigned a domain name used to login to the platform. The domain name is used in the login URL to navigate to the appropriate login page in a web browser. The login URL is
https://<domain>.login.illumina.com, where <domain> is substituted with the domain name assigned to the tenant.New user accounts can be created for a tenant by navigating to the domain login URL and following the links on the page to setup a new account with a valid email address. Once the account has been added to the domain, the tenant administrator may assign registered users to workgroups with permission to use the ICA application. Registered users may also be made workgroup administrators by tenant administrators or existing workgroup administrators.
Generate an API Key
For long-lived credentials to the API, an API Key can be generated from the account console and used with the API and command-line interface. Each user is limited to 10 API Keys.
- 1.Login through the domain URL
- 2.Select your user name in the top-right of the view to open the drop-down and select "Manage API Keys".
- 3.Use the "+" button to generate new API Keys or the action buttons to modify, delete, or change the roles associated with any existing API Keys.
After generating an API key, save the key somewhere secure to be referenced when using the command-line interface or APIs.
Access via the Web User Interface
The web application provides a visual user interface for navigating resources in the platform, managing projects, and extended features beyond the API. To access the web application, navigate to your domain login URL through a web browser and login to the account console. Once logged in, select the ICA application from the list of available applications to be directed to the ICA web application console.
Access via the Command-line Interface
The command-line interface offers a developer-oriented experience for interacting with the APIs to manage resources and launch analysis workflows. Find instructions for using the command-line interface including download links for your operating system in the CLI documentation.
Access via the API
The HTTP-based application programming interfaces (APIs) are listed in the API Reference section of the documentation. The reference documentation provides the ability to call APIs from the browser page and shows detailed information about the API schemas. HTTP client tooling such as Postman or cURL can be used to make direct calls to the API outside of the browser.
When accessing the API using the API Reference page or through REST client tools, theAuthorizationheader must be provided with the value set toBearer <token>where<token>is replaced with a valid JSON Web Token (JWT). For generating a JWT, see JSON Web Token (JWT).
Object Identifiers
The object data models for resources that are created in the platform include a unique
id field for identifying the resource. These fixed machine-readable IDs are used for accessing and modifying the resource through the API or CLI, even if the resource name changes.JSON Web Token (JWT)
Accessing the platform APIs requires authorizing calls using JSON Web Tokens (JWT). A JWT is a standardized trusted claim containing authentication context. This is a primary security mechanism to protect against unauthorized cross-account data access.
A JWT is generated by providing user credentials (API Key or username/password) to the token creation endpoint. Token creation can be performed using the API directly or the CLI.