Auth Api Get Session
Returns the signed-in user. Also available while mustChangePassword is true, so the client can render the change-password screen. Accessible to every authenticated role.
200 OK 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
401 Unauthorized: UNAUTHENTICATED
{
"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.
404 Not Found: USER_NOT_FOUND
{
"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.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/auth/session