Authentication

This guide covers the complete authentication flow for accessing the PRIME API.

Overview

The platform supports two authentication methods:

1. JWT Bearer Tokens - For user sessions (web/mobile clients)
2. API Keys - For programmatic access (see API Key Creation)

Prerequisites

• Valid user credentials (username/password)
• TOTP authenticator configured (if 2FA is enabled)

Step 1: Login

Authenticate with username and password.

Endpoint: POST /api/rest/v1/users/authentication/login

Request

curl -X POST https://api.t-dx.com/api/rest/v1/users/authentication/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "user@example.com",
    "password": "your-password"
  }'

Request Fields

Response (200 OK)

{
  "result": {
    "accessToken": "eyJhbGciOiJSUzI1NiIs...",
    "refreshToken": "5321bef2-155d-40c7-aa63-5d18f5f6dc29",
    "accessExpiresAt": "2024-01-15T11:30:00Z",
    "sessionExpiresAt": "2024-01-22T10:30:00Z"
  }
}

Response Fields

Step 2: Login with 2FA

If 2FA is enabled, include the TOTP code in the challenge field.

Request

curl -X POST https://api.t-dx.com/api/rest/v1/users/authentication/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "user@example.com",
    "password": "your-password",
    "challenge": "123456"
  }'

The response is the same as a successful login without 2FA.

Step 3: Using the Access Token

Include the access token in the Authorization header for all subsequent API requests.

curl -X GET https://api.t-dx.com/api/rest/v1/users/me \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..."

Step 4: Refreshing Tokens

Before the access token expires, use the refresh token to obtain a new one.

Endpoint: POST /api/rest/v1/users/authentication/refresh

Request

curl -X POST https://api.t-dx.com/api/rest/v1/users/authentication/refresh \
  -H "Content-Type: application/json" \
  -d '{
    "refreshToken": "5321bef2-155d-40c7-aa63-5d18f5f6dc29"
  }'

Request Fields

Response (200 OK)

{
  "result": {
    "accessToken": "eyJhbGciOiJSUzI1NiIs...",
    "refreshToken": "5321bef2-155d-40c7-aa63-5d18f5f6dc29",
    "accessExpiresAt": "2024-01-15T12:30:00Z",
    "sessionExpiresAt": "2024-01-22T10:30:00Z"
  }
}

Step 5: Logout

Invalidate the current session or all sessions.

Endpoint: POST /api/rest/v1/users/authentication/logout

Request (Logout specific session)

curl -X POST https://api.t-dx.com/api/rest/v1/users/authentication/logout \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "refreshToken": "5321bef2-155d-40c7-aa63-5d18f5f6dc29"
  }'

Request (Logout all sessions)

curl -X POST https://api.t-dx.com/api/rest/v1/users/authentication/logout \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{}'

Request Fields

Response (200 OK)

Empty response on success.

Error Scenarios

Related

• API Key Creation - Create API keys for programmatic access
• Getting Started: Authentication - Detailed auth documentation