Authentication and accounts

This page explains how to authenticate with SuperPlane as a human user or an automated system. It covers UI login methods, account management, API tokens, and CLI authentication.

Log in to the UI

When logging into the SuperPlane UI, choose between the following methods (depending on your organization’s configuration):

• Single Sign-On (SSO): Log in securely using your Google or GitHub account.
• Email and password: Standard login using your registered email and password.
• Passwordless sign-in: Log in without a password by requesting a magic link or access code sent to your email. Use this if you forget your password or prefer not to use one.

The login screen remembers your last-used login method to speed up future sign-ins.

Manage your account

Access your Profile settings in the UI to manage your account details:

• Change your password: Update your password at any time.
• Manage API tokens: Generate and revoke personal API tokens.

Create personal API tokens

Personal API tokens are tied to your user account and inherit your permissions. Use them to authenticate the SuperPlane CLI or make direct API requests on your behalf.

To create a personal token:

1. Go to Profile > API token in the SuperPlane UI.
2. Click Generate Token (or Regenerate Token if you already have one).
3. Copy the token immediately. It will not be shown again.

Note: If you need a token for an automated script or integration that shouldn’t be tied to a specific human user, use a Service account instead.

Session expiration

When you log in to the UI, your session remains active as long as you continue to use SuperPlane. Your session token validity is automatically extended in the background with your activity. If you are inactive for an extended period, you will be prompted to log in again.

Authenticate the CLI

The SuperPlane CLI requires an API token to communicate with your organization. Authenticate using either a personal API token or a service account token.

Choose between interactive login or environment variables.

Connect interactively

Run the connect command and follow the prompts:

superplane connect <SUPERPLANE_URL> <API_TOKEN>

This saves your credentials locally and sets up your CLI context.

Use environment variables

For automated environments like CI/CD pipelines, authenticate the CLI via environment variables without running superplane connect.

Set the following variables in your environment:

export SUPERPLANE_URL="https://app.superplane.com"
export SUPERPLANE_TOKEN="your-api-token"

When these variables are present, the CLI automatically uses them for all commands.

Authenticate automated systems

For programmatic access by external systems, scripts, or integrations, use service accounts. Service accounts are non-human identities that you can assign specific roles via RBAC.

See the Service accounts documentation for more details.