Authentication System Overview (Auth)

Overview

The admin management APIs use a multi-level authentication mechanism. Common levels include: Public, User, Admin, and Root.

Authentication Methods (Choose One)

Session

Obtain a Session through the login API:

• POST /api/user/login

Access Token (Recommended)

Include the following in the request header:

Authorization: Bearer {token}

A Token can be generated in Personal Settings - Security Settings - System Access Token.

Required Request Headers

Some APIs require a user identifier request header:

New-Api-User: {user_id}

Here, {user_id} must match the currently logged-in user.

Permission Levels

• Public: No authentication required
• User: Requires login or an Access Token
• Admin: Requires admin privileges
• Root: Highest privilege level