User POST Resources

Create a user

POST /users
Parameter Type Default Required Description
email string - ✓ max. 255 characters.
unique_id string - ✗ max. 255 characters.
firstname string - ✓ max. 255 characters.
lastname string - ✓ max. 255 characters.
language string (language code) - ✓ The interface language for the user.
gender string u ✓ gender code (m = male, f = female, u = unspecified)
location string null ✗ Location specific information (department, etc.). Max. 255 characters.
about text null ✗ Text to describe the user. This information is showed in the user profile.
country string null ✗ Country code in ISO 3166-2 format like ch, de, us.
company text null ✗ Company of the user. Max. 255 characters.
department text null ✗ Department of the user. Max. 255 characters.
position text null ✗ Position of the user. Max. 255 characters.
employment_start datetime null ✗ The employment start date of the user in format yyyy-mm-dd.
is_activated boolean false ✗ Sets the users is_activated status. This is automatically set once the user logs in for the first time and should usually not be set on creation. If you only work on behalf of the user - using an admin user - this must be set manually.
password string - ✗ Password the user can log in with.
The password must contain at least:
  • 8 characters
  • one lowercase-letter
  • one uppercase-letter
  • a number
customfields object - ✗ An object specifying the users custom fields
is_hidden boolean false ✗ Whether the user is a hidden user or not
is_system boolean false ✗ Whether the user is a system user or not

Json Payload

{
  "unique_id": "00.42",
  "firstname": "Sherlock",
  "lastname": "Holmes",
  "email": "sherlock.holmes@example.com",
  "language": "en",
  "gender": "m",
  "password": "aBcDe123",
  "about": "Detective",
  "country": "uk",
  "company": "Ward, Lock & Co",
  "department": "Investigations",
  "position": "Master Detective",
  "location": "London",
  "customfields": { "occupation": "Detective" }
}

Response

{
  "id": 42,
  "unique_id": "00.42",
  "is_deleted": false,
  "is_hidden": false,
  "is_system": false,
  "firstname": "Sherlock",
  "lastname": "Holmes",
  "language": "en",
  "country": "uk",
  "gender": "m",
  "location": "London",
  "about": "Detective",
  "country": "uk", 
  "company": "Ward, Lock & Co",
  "department": "Investigations", 
  "position": "Master Detective",
  "image": "http://appdata.starmind.local/static/user/default.jpg",
  "first_seen": null,
  "last_seen": null,
  "customfields": { "occupation": "Detective" },
  "score_level": null,
  "score_points": null,
  "event_tracking_id": "95543d35-255c-11e9-86c5-0242ac110007",
  "disclaimer_agreement": null
}

Update password

POST /users/:ID/password

or for updating the password of current session user

POST /users/me/password
Parameter Type Default Required Description
current string - ✓ Current password
password string - ✓ New password.
The password must contain at least:
  • 8 characters
  • one lowercase-letter
  • one uppercase-letter
  • a number
confirm string - ✓ Confirmation of the password field

Response

In case of success, a HTTP 200 OK without body will be sent.

Set user-image

Uploads MUST be performed using the `multipart/form-data Content-Type.

The image is resized to 300x300px. Therefore the original image is scaled to cover the entire new canvas size, such that there is no "background". If the source and target dimensions do not have the same aspect ratio then some of the image will be lost as it will have to be "over scaled" to completely cover the target image.

POST /users/:ID/image

or for updating the image of current session user

POST /users/me/image
Parameter Type Default Required Description
file file ✓ Any image file type which is allowed for the network.

Response

{
  "id": 42,
  "unique_id": "00.42",
  "is_deleted": false,
  "is_hidden": false,
  "is_system": false,
  "firstname": "Sherlock",
  "lastname": "Holmes",
  "email": "sherlock.holmes@example.com",
  "language": "en",
  "gender": "m",
  "location": "London",
  "about": "Detective",
  "country": "uk",
  "company": "Ward, Lock & Co",
  "department": "Investigations", 
  "position": "Master Detective",
  "image": "http://appdata.starmind.local/1/user/42/i_23hjk34d23324dt523.jpg",
  "first_seen": "2015-02-02T11:31:05.000Z",
  "last_seen": "2015-08-09T11:31:05.000Z",
  "customfields": { "occupation": "Detective" },
  "score_level": null,
  "score_points": null,
  "disclaimer_agreement": null
}