UpdateUserRequest

UpdateUserRequest
UpdateUserRequest

Request body to update an existing console user's details or role

JSON Example
{
    "displayName": "string",
    "email": "string",
    "role": "string"
}
string
displayName
Required  
Constraints: minLength: 1 maxLength: 128

Display name shown in the console UI

string As email As email
email
Optional
Constraints: maxLength: 254

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