Authenticate user and create REST API HTTP session

post

http://127.0.0.1:8080/authentication/login

Authenticates a user using local, RADIUS, or TACACS+ credentials and creates an authenticated HTTP session. Supports optional two-factor authentication (email or app-based TOTP). On successful login, a CSRF token cookie is set for subsequent API calls. Failed login attempts are tracked and may result in temporary account lockout after exceeding the configured threshold.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Login credentials for user authentication. Supports JSON body or form URL-encoded data. Two-factor authentication token required if enabled for user account.

User authentication credentials for login request. Supports local, RADIUS, and TACACS+ authentication methods with optional two-factor authentication.

user

string

required

length ≥ 1

Username or user ID for authentication. Must be a valid user account in the system or configured authentication server.

password

string

required

length ≥ 1

User password. Can be plain text or AES-GCM encrypted if isEncrypted is true. Cannot be null or empty.

loginType

integer

enum

Defaults to 0

Authentication protocol to use. Only Local (0), RADIUS (1), and TACACS+ (2) are supported via this endpoint.

Allowed:

token

string

^[0-9]{4,6}$

Two-factor authentication code (6-digit TOTP from authenticator app or email code). Required only if user has 2FA enabled.

isEncrypted

boolean

Defaults to false

Indicates if password is AES-GCM encrypted. When true, the randomizer field is required.

randomizer

string

Base64-encoded initialization vector (IV) for AES-GCM password decryption. Obtain from /authentication/orchestratorRandomizer endpoint. Required only when isEncrypted is true.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

302

Redirect response for form URL-encoded login. On success, redirects to /webclient/html/gms_main.html.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/html

application/json

200Authentication successful. HTTP session is now authenticated and CSRF token cookie is set.

400Bad request due to invalid login type or no remote authentication server configured for RADIUS/TACACS+.

401Authentication failed. Causes include: invalid credentials, user account locked, exceeded login attempts, or invalid two-factor token.

403Forbidden. GLP mode is enabled on Cloud Orchestrators, requiring authentication via GLP instead. Also returned when form URL-encoded login is attempted with two-factor authentication enabled.