For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Started

Set up your organization

Software Registration

If you are a new user, please consult the Illumina BioInsight Platform Registration Guide for detailed guidance on setting up an account and registering a subscription.

Tenant Setup

Platform Core requires a provisioned tenant in Illumina Account Management (IAM). When a tenant is provisioned, a tenant administrator is assigned. Tenant administrators can manage account access, including adding users, creating workgroups, and adding additional tenant administrators.

Each tenant is assigned a domain name used to access their login page:

https://<domain_name>.login.illumina.com with <domain_name> replaced by the actual domain name assigned to your tenant.

Add users to the tenant

A user account can be added to the tenant in either of the following ways:

  • Tenant administrator: Sign in to the domain and select Illumina Account Management from the profile menu in the top right.

  • User: Go to https://platform.login.illumina.com and select Don't have an account.

After the user has been added to the tenant, a tenant administrator can assign the user to a workgroup. Workgroups grant users permission to use Platform Core. Registered users can be made workgroup administrators by tenant administrators or existing workgroup administrators.


Choose how to access Platform Core

Access via Web UI

The web application provides a visual user interface (UI) for navigating resources in the platform, managing projects, and extended features beyond the API.

To access the web application:

  1. Sign in with your Illumina account.

  2. Confirm you can access your tenant.

You're now ready to use Platform Core. Go to Platform Core Home to become familiar with the interface and begin working.

Access via CLI

The Platform Core command-line interface (CLI) provides command-line access to Platform Core resources and workflows.

To access Platform Core through the CLI:

  1. Download and install the CLI for your operating system. See CLI Installation.

  2. Configure authentication. Create an API key and configure a CLI profile for your Platform Core environment. See CLI Authentication.

  3. Verify your access. Run command to confirm that the CLI can connect to your Platform Core tenant. See Command Index.

You're now ready to use the Platform Core CLI.

Access via API

Platform Core provides HTTP-based APIs for programmatic access to platform resources. See the Swagger API Reference for available APIs, schemas, and endpoints.

To access Platform Core through the API:

  1. Create an API key. See Managing API Keys.

  2. Authenticate and obtain a JSON Web Token (JWT).

  3. Verify your access by making an authenticated API request using the Swagger API Reference.

You're now ready to use the Platform Core API. Go to API to learn more about API access.

Last updated

Was this helpful?