ANanzworldline-solutions
Users

Create user

Changed on

Creates a new user. Requires admin privileges or access to Users and Roles portlets. FirstName, LastName, Email and Password are required

post/api/v1/users

Request

Request body

userIdstring
activeboolean
firstNamestring required
middleNamestring
lastNamestring required
nickNamestring
emailstring required
maleboolean
birthdaystring
languageIdstring
timeZoneIdstring
passwordstring[]
additionalInfoobject
rolesstring[]

Role keys or role IDs (roles created without a key can only be referenced by ID). On update: field absent = roles untouched; [] = remove all user-assignable roles; otherwise the complete user-assignable role set. On create: absent or empty = default Front-end User role. Unknown entries are ignored.

Example request

{
  "roles": [
    "DOTCMS_BACK_END_USER",
    "48190c8c-42c4-46af-8d1a-0cd5db894797"
  ]
}

Response

User created successfully

entityobject
i18nMessagesMapobject
permissionsstring[]

Changes

  • 4fd8e917d458Revision changes
    • breaking

      request body became required

    • breaking

      removed the media type */* from the request body

    • info

      api operation id create_2 removed and replaced with createUser

    • info

      api tag Users added

    • info

      added the media type application/json to the request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status