Creates a new user

POST /users

Auth

Creates a new user.

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

user_name string required: The user's identifier
security object required: A user's security information; Same fields as security
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

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

{
  "user_name": "string",
  "security": {
    "roles": [
      "string"
    ],
    "permissions": [
      "string"
    ],
    "elevated_permissions": {
      "enabled": false,
      "expires_at": "string"
    },
    "password": "string",
    "enabled": false,
    "security_realm": {
      "type": "native",
      "id": "string"
    }
  },
  "metadata": {
    "created_by": "string",
    "created_at": "string",
    "updated_by": "string",
    "updated_at": "string",
    "first_login_at": "string",
    "last_login_at": "string"
  },
  "full_name": "string",
  "email": "string",
  "builtin": false
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec