Auth Api Login

Auth Api Login
Local username and password login

Authenticates a local account. On success sets the HttpOnly VTP_SESSION session cookie and the XSRF-TOKEN cookie. Every refusal (unknown user, wrong password, non-local account, empty fields) answers the same 401 INVALID_CREDENTIALS. Public: no session required. The 429 is produced by the gateway rate limit, not by this service.

Request
URI
POST
https://{api_host}/api/v1/auth/login
COPY
Request Body

The username and password of a local account.

LoginRequest of type(s) application/json
Required  

Show optional properties

{
    "username": "string",
    "password": "string"
}
{
    "username": "alice.example",
    "password": "<redacted>"
}
string
username
Required  

Login username, matched case-insensitively

string As password As password
password
Required  

The account password

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK; the session and XSRF cookies are set, the body is the signed-in user

Returns UserSummaryDto of type(s) application/json
{
    "id": 1,
    "username": "alice.example",
    "displayName": "Alice Example",
    "email": "[email protected]",
    "role": "SECURITY_OPERATOR",
    "authSource": "LOCAL",
    "lastLoginAt": "2026-01-15T09:30:00Z",
    "mustChangePassword": false
}
integer As int64 As int64
id
Required  

Unique user identifier

string
username
Required  

Login username, unique case-insensitively

string
displayName
Required  

Display name shown in the console UI

string As email As email
email
Optional

Contact email address

string
role
Required  

Console user role — Administrator, Security Operator, or read-only Auditor

  • ADMIN: Administrator. Can use the operations open to every role and those restricted to ADMIN, such as user management, SSO settings, syslog destination changes and retention settings changes
  • SECURITY_OPERATOR: Security operator. Can use the operations open to ADMIN and SECURITY_OPERATOR and those open to every role, but not the ADMIN-only operations
  • AUDITOR: Auditor. Can use only the operations open to all three roles, not those restricted to ADMIN or to ADMIN and SECURITY_OPERATOR
Enumeration: ADMIN, SECURITY_OPERATOR, AUDITOR
string
authSource
Required  

Authentication source a console user account was provisioned through

  • LOCAL: Account created in the console with a password held by the console; the only source that can sign in with a username and password
  • SAML: No behaviour is documented for this value. No producing site in the current server code
  • OIDC: Account provisioned automatically at the first successful SSO sign-in; it never sets a password and is not forced to change one
Enumeration: LOCAL, SAML, OIDC
string As date-time As date-time
lastLoginAt
Optional

Timestamp of the most recent successful login as an ISO 8601 date-time with offset

boolean
mustChangePassword
Required  

Whether the user must set a new password before continuing to use the console

Response Headers

string
Set-Cookie

VTP_SESSION (HttpOnly, Secure, SameSite=Strict) and XSRF-TOKEN cookies


400

400 Bad Request: MALFORMED_REQUEST when the body cannot be read

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: INVALID_CREDENTIALS

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


429

429 Too Many Requests: the gateway rate limit for authentication was exceeded. Plain response with no JSON body.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"username":"string","password":"string"}' https://{api_host}/api/v1/auth/login