---
id: login-index
title: login
sidebar_position: 10
---
# login

Authenticate user with signageOS via Auth0


## Description

Authenticates the user via the Auth0 Device Authorization Flow.
Opens a browser-based verification page where the user logs in,
then stores the resulting JWT tokens in `~/.sosrc`.

## Usage

```bash
sos login [options]
```

## Options

| Option                  | Description                                                                        |
| ----------------------- | ---------------------------------------------------------------------------------- |
| `--interactive-profile` | Prompt for custom Auth0 and connection settings (for custom deployments) (boolean) |

## Examples

```bash
# Interactive login (opens browser for Auth0 authentication)
sos login

# Login with custom configuration (prompts for Auth0 and connection settings)
sos login --interactive-profile

# Login with a specific profile
sos --profile staging login
```

## Advanced Usage

### Configuration Management

#### Run Control File

Login credentials are stored in `~/.sosrc` file. For the default profile, it contains:

```ini
identification=xxxxxxxxxxxxxxxxxxxx
apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```

#### Multiple Profiles

You can manage multiple accounts/configurations using profiles with the `SOS_PROFILE` environment variable or `--profile` argument:

```bash
# Login with specific profile
sos login --profile production

# Use profile in subsequent commands
sos --profile production applet upload
```

The configuration file uses INI sections for named profiles:

```ini
[profile production]
identification=xxxxxxxxxxxxxxxxxxxx
apiSecurityToken=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

[profile staging]
identification=yyyyyyyyyyyyyyyyyyyy
apiSecurityToken=yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
```

#### Environment Variables

You can override login credentials using environment variables:

- **`SOS_API_IDENTIFICATION`**: Override stored identification
- **`SOS_API_SECURITY_TOKEN`**: Override stored security token  
- **`SOS_PROFILE`**: Specify which profile to use

Generate tokens at: https://box.signageos.io/settings

### Requirements

- Active account. It can be obtained by manual sign-up in [https://box.signageos.io](https://box.signageos.io)
- Login account credentials are stored in `~/.sosrc` file


## Since

4.0.0

## Global Options

All commands support the following global options:

| Option | Alias | Description |
|--------|-------|-------------|
| `--help` | `-h` | Display help information for any command |
| `--version` | `-v` | Display the installed version of the CLI |
| `--api-url` | `-u` | Override the API URL for REST requests |
| `--profile` | | Use a specific profile from ~/.sosrc config |

### Examples

```bash
# Show version
sos --version

# Get help for any command
sos applet --help
sos applet upload --help

# Use custom API endpoint
sos --api-url https://api.example.com applet upload

# Use specific profile
sos --profile production organization list
```