CreateUserRequest

CreateUserRequest
CreateUserRequest

Request body to create a new console user

JSON Example
{
    "username": "string",
    "displayName": "string",
    "email": "string",
    "role": "string",
    "initialPassword": "string"
}
string As ^(?=.{4,24}$)(?![_.])(?!.*[_.]{2})[a-zA-Z0-9._\\]+(?<![_.])$
username
Required  
Constraints: minLength: 4 maxLength: 24

Login username, unique case-insensitively (4-24 chars; letters, digits, '.', '', or ''; no leading/trailing or consecutive '.'/'')

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
string As password As ^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%^&+=(){}_-])(?=\S+$).{8,20}$
initialPassword
Required  
Constraints: minLength: 8 maxLength: 20

Initial password for the account; the user must change it on first login (8-20 chars; at least one digit, one lowercase, one uppercase, and one special character from !@#$%^&+=(){}_-; no whitespace)