Users

Create user

Creates a new user account with the provided details and password

post/api/users

Request body

passwordstring required

Example request

{
  "user": {
    "login": "john.doe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "language": "en",
    "timezone": "Europe/Paris"
  }
}

Response

User created successfully

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

loginstring required

The login username of the user.

firstNamestring nullable required

The first name of the user. Can be null if not provided.

lastNamestring nullable required

The last name of the user. Can be null if not provided.

emailstring nullable required

The email address of the user. Can be null if not provided.

language'fr' | 'en' required

Type representing a supported language.

timezonestring required

Represents a timezone as an IANA timezone string.

friendlyNamestring required

The friendly display name of the user.

Example response

{
  "id": "entity123",
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "2023-10-31T12:34:56.789Z",
  "login": "john.doe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "language": "en",
  "timezone": "Europe/Paris",
  "friendlyName": "John Doe"
}

Changes

Changed in 8 of the 73 revisions of this API.121224

Mar 25, 2026cdb5b7ea719924See the full diff
- ●
  removed the optional property creationDate from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 201 status
  response-optional-property-removed
- ○
  added the required property createdAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property createdBy to the response with the 201 status
  response-required-property-added
- ○
  added the required property updatedAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property updatedBy to the response with the 201 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 20, 2026108013c9462942See the full diff
- ▲
  removed the required property createdAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property createdBy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedBy from the response with the 201 status
  response-required-property-removed
- ○
  added the optional property creationDate to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 201 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 19, 2026fb56929c067524See the full diff
- ●
  removed the optional property creationDate from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 201 status
  response-optional-property-removed
- ○
  added the required property createdAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property createdBy to the response with the 201 status
  response-required-property-added
- ○
  added the required property updatedAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property updatedBy to the response with the 201 status
  response-required-property-added
Mar 18, 2026d6e364e3cd4e42See the full diff
- ▲
  removed the required property createdAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property createdBy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedBy from the response with the 201 status
  response-required-property-removed
- ○
  added the optional property creationDate to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 201 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 17, 20263bf1b221f6ef24See the full diff
- ●
  removed the optional property creationDate from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 201 status
  response-optional-property-removed
- ○
  added the required property createdAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property createdBy to the response with the 201 status
  response-required-property-added
- ○
  added the required property updatedAt to the response with the 201 status
  response-required-property-added
- ○
  added the required property updatedBy to the response with the 201 status
  response-required-property-added
This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 10, 202688f262299d5e42See the full diff
- ●
  removed the optional property createdAt from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property createdBy from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property updatedAt from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property updatedBy from the response with the 201 status
  response-optional-property-removed
- ○
  added the optional property creationDate to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 201 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 10, 202676d90b88c3e524See the full diff
- ●
  removed the optional property creationDate from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property lastEditInstant from the response with the 201 status
  response-optional-property-removed
- ○
  added the optional property createdAt to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property createdBy to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property updatedAt to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property updatedBy to the response with the 201 status
  response-optional-property-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 6, 2026d8e7a58e006a42See the full diff
- ▲
  removed the required property createdAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property createdBy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedBy from the response with the 201 status
  response-required-property-removed
- ○
  added the optional property creationDate to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property lastEditInstant to the response with the 201 status
  response-optional-property-added
This revision also has 219 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history