Sign in

v1

latestOpenAPI 3.0.02026-08-04265791.1 MB
Users

Create

You may create a new single user or multiple users using this action.
When creating a single user the body contains a json object, when creating multiple users the body contains an array of objects.
Warning: a maximum of 1000 items can be sent in a single request.

post/public/api/users

Headers

Acceptstring

e.g. application/json

Request body

usernamestring
passwordstring
first_namestring
last_namestring
emailstring
languagestring
store_idstring
photostring
client_rolestring
client_role_extensionstring
client_idsstring[]
tagsstring[]
groupsstring[]

Example request

{
  "username": "johndoe9@houston.com",
  "password": "deqwfVFRE456",
  "first_name": "John",
  "last_name": "Doe",
  "email": "johndoe9@houston.com",
  "language": "en",
  "store_id": "5739b18c6b8e2ac941fbee86",
  "photo": "https://www.w3schools.com/w3images/avatar2.png",
  "client_role": "ROLEVIEWER",
  "client_role_extension": "ROLEVIEWER",
  "client_ids": [
    "CL1",
    "CL2",
    "CL3"
  ],
  "tags": [
    "The Dream"
  ],
  "groups": [
    "test"
  ]
}

Response

OK

user_idstring required
usernamestring required
first_namestring required
last_namestring required
client_rolestring required
emailstring required
groupsstring[] required
languagestring required
photostring required
store_idstring required
tagsstring[] required
client_idsstring[]
created_datestring required
updated_datestring required

Example response

[
  {
    "user_id": "53fb03c6546847ee0d30086a",
    "username": "johndoe9@houston.com",
    "first_name": "John",
    "last_name": "Doe",
    "client_role": "ROLEVIEWER",
    "email": "johndoe9@houston.com",
    "groups": [
      "test"
    ],
    "language": "en",
    "photo": "https://www.w3schools.com/w3images/avatar2.png",
    "store_id": "5739b18c6b8e2ac941fbee86",
    "tags": [
      "The Dream"
    ],
    "client_ids": [
      "CL1",
      "CL2",
      "CL3"
    ],
    "created_date": "2018-05-23T04:51:40.862Z",
    "updated_date": "2018-05-23T04:51:40.862Z"
  },
  {
    "user_id": "53fb03c6546847fe0d30186b",
    "username": "janedoe9@houston.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "client_role": "ROLEMANAGER",
    "email": "janedoe9@houston.com",
    "language": "en",
    "groups": [
      "test"
    ],
    "photo": "https://www.w3schools.com/w3images/avatar4.png",
    "store_id": "5739b18c6b8e2ac941fbee86",
    "tags": [
      "The Dream"
    ],
    "created_date": "2018-05-23T04:51:40.862Z",
    "updated_date": "2018-05-23T04:51:40.862Z"
  }
]