Create a new user

Create a new user with the specified configuration.

POST /v1/users

Try it

Create a new user

cURL

curl --request POST \
  --url https://api.example.com/v1/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "email": "<string>",
    "username": "<string>",
    "role": "SYSTEM",
    "auth_method": "<string>",
    "password": "<string>"
  },
  "send_welcome_email": true
}
'

201

{
  "data": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "username": "<string>",
    "role": "SYSTEM",
    "auth_method": "<string>",
    "password_needs_reset": true,
    "password": "<string>"
  }
}

Body

application/json

user · LocalUserData · object · required

LocalUserData

OAuth2UserData

LDAPUserData

Show child attributes

user. email · string · required

user. username · string · required

user. role · enum<string> · required

Available options: SYSTEM, ADMIN, MEMBER, VIEWER

user. auth_method · string · required

Allowed value: "LOCAL"

user. password · string

send_welcome_email · boolean · default: true

Response

201

application/json

The newly created user.

data · LocalUser · object · required

LocalUser

OAuth2User

LDAPUser

Show child attributes

data. id · string · required

data. created_at · string<date-time> · required

data. updated_at · string<date-time> · required

data. email · string · required

data. username · string · required

data. role · enum<string> · required

Available options: SYSTEM, ADMIN, MEMBER, VIEWER

data. auth_method · string · required

Allowed value: "LOCAL"

data. password_needs_reset · boolean · required

data. password · string