Creates a new user

POST /users

Creates a new user.

Authentication

Request body

The user to create

user_name string required: The user's identifier
security object required: A user's security information
metadata object: Metadata for a user
full_name string: The user's optional full name
email string: The user's optional email address
builtin boolean: True if the user is a built-in read-only user

Responses

User successfully created

application/json

The provided user name is invalid. Check that it is not empty and it does not contain special characters. (code: user.user_name.invalid)
Some of the provided roles are invalid. (code: user.roles.invalid)
Some of the provided roles are forbidden. (code: user.roles.forbidden)
Trying to set a restricted field. (code: user.restricted_field)

application/json

The username is already in use. (code: user.user_name.conflict)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/users" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "user_name": "string",
    "security": {}
  }'

Generated from the API spec

Response

No example