Auth Api 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.
The username and password of a local account.
Show optional properties
{
"username": "string",
"password": "string"
}
{
"username": "alice.example",
"password": "<redacted>"
}
Login username, matched case-insensitively
The account password
200 OK; the session and XSRF cookies are set, the body is the signed-in user
{
"id": 1,
"username": "alice.example",
"displayName": "Alice Example",
"email": "[email protected]",
"role": "SECURITY_OPERATOR",
"authSource": "LOCAL",
"lastLoginAt": "2026-01-15T09:30:00Z",
"mustChangePassword": false
}
Unique user identifier
Login username, unique case-insensitively
Display name shown in the console UI
Contact email address
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 changesSECURITY_OPERATOR: Security operator. Can use the operations open to ADMIN and SECURITY_OPERATOR and those open to every role, but not the ADMIN-only operationsAUDITOR: Auditor. Can use only the operations open to all three roles, not those restricted to ADMIN or to ADMIN and SECURITY_OPERATOR
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 passwordSAML: No behaviour is documented for this value. No producing site in the current server codeOIDC: Account provisioned automatically at the first successful SSO sign-in; it never sets a password and is not forced to change one
Timestamp of the most recent successful login as an ISO 8601 date-time with offset
Whether the user must set a new password before continuing to use the console
Response Headers
VTP_SESSION (HttpOnly, Secure, SameSite=Strict) and XSRF-TOKEN cookies
400 Bad Request: MALFORMED_REQUEST when the body cannot be read
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 Unauthorized: INVALID_CREDENTIALS
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 Too Many Requests: the gateway rate limit for authentication was exceeded. Plain response with no JSON body.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"username":"string","password":"string"}' https://{api_host}/api/v1/auth/login