UserSummaryDto

UserSummaryDto
UserSummaryDto

Summary representation of a console user account

JSON Example
{
    "id": 0,
    "username": "string",
    "displayName": "string",
    "email": "string",
    "role": "string",
    "authSource": "string",
    "lastLoginAt": "string",
    "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

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
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