Users

Create user

Changed on

Creates a new user account with the provided details and password

post/api/users

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/users
  • Auth: none required

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' | 'zh' 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

  • 0df3f625a5c2Revision changes
    • warning

      added the new zh enum value to the response property for the response status

    • info

      added the new zh enum value to the request property /

  • 21b34a490fa3Revision changes
    • breaking

      removed the enum value zh of the request property /

    • info

      removed the zh enum value from the response property for the response status