Authentication

The Firefly API supports multiple authentication methods, including JWT and Basic Authentication. To use the API, you'll need to create an API key pair (Access Key and Secret Key) for authentication.

Creating an API Key Pair

To create a new API key pair for authentication:

1. In the Firefly web console, navigate to Settings > Users

2. Click Create Key Pair

3. Copy both the Access Key and Secret Key (they will only be shown once)

4. Store your keys securely in a password manager or secrets vault

For detailed instructions on creating and managing API keys, see the Access Management & RBAC documentation.

Authentication

Login with access key

post

Authenticate user using access key and secret key

Body

accessKeystringRequired

User's access key

secretKeystringRequired

User's secret key

durationstringOptional

Custom token validity duration. Defaults to 24h if not provided. Format: where unit is h (hours), d (days), w (weeks), m (months), y (years). Maximum allowed duration is 1 year. Examples: 1h, 12h, 7d, 2w, 6m, 1y.

Example: 24h

Responses

200

Successful login

application/json

accessTokenstringOptional

JWT access token

expiresAtintegerOptional

Token expiration time in seconds

tokenTypestringOptional

Type of token (e.g., "Bearer")

401

Unauthorized Error

application/json

post/login

POST /login HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "accessKey": "text",
  "secretKey": "text",
  "duration": "24h"
}

{
  "accessToken": "text",
  "expiresAt": 1,
  "tokenType": "text"
}

Health Check