Users Operations Create
Creates a console user with a role and an initial LOCAL password; the account must change that password on first login.
The new account: username, display name, optional email, role and the initial password.
Show optional properties
{
"username": "string",
"displayName": "string",
"role": "string",
"initialPassword": "string"
}
{
"username": "carol.example",
"displayName": "Carol Example",
"email": "[email protected]",
"role": "AUDITOR",
"initialPassword": "Exampl3-Passw0rd!"
}
Login username, unique case-insensitively (4-24 chars; letters, digits, '.', '', or ''; no leading/trailing or consecutive '.'/'')
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
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)
201 Created successful response envelope. The created user summary
{
"id": 3,
"username": "carol.example",
"displayName": "Carol Example",
"email": "[email protected]",
"role": "AUDITOR",
"authSource": "LOCAL",
"lastLoginAt": null,
"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
400 Bad Request: USERNAME_REQUIRED or INVALID_USERNAME_FORMAT when the username is missing or malformed; INITIAL_PASSWORD_REQUIRED or INVALID_PASSWORD_FORMAT when the initial password is missing or breaks the password rules; DISPLAY_NAME_REQUIRED or DISPLAY_NAME_TOO_LONG for the display name; EMAIL_TOO_LONG or INVALID_EMAIL_FORMAT when an email is supplied and is not valid; ROLE_REQUIRED or INVALID_ROLE for the role; 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: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"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.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"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.
409 Conflict: USERNAME_ALREADY_EXISTS when the username is already in use, compared without regard to case
{
"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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"username":"string","displayName":"string","role":"string","initialPassword":"string"}' https://{api_host}/api/v1/users