KOkontainer
Users

Create a single or shared user with the specified data

Create User

Endpoint for creating a User.

A normal user (the default) requires a name and an email. A shared user requires a name, username and password; its email is optional and it must not set isClientAdmin. Creating a shared user requires the shared users feature to be enabled for the client, otherwise the request is rejected with a 403.

When sendInvite is true and the created user has an email, an invite (welcome) email containing the invite link is sent.

post/users

Request

Query parameters

sendInvitestring

if true an invite will be sent to user (only when the user has an email)

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "{Benny Armstrong}",
      "email": "{bennyA@gmail.com}",
      "username": "{reception}",
      "password": "{sup3rSecretP@ss!}",
      "company": "{Bike A/S}",
      "show_brand_section": true,
      "hide_menu_by_default": true,
      "custom_metadata": "Not part of the organization",
      "internal_metadata": "Hidden metadata"
    }
  }
}

Response

created

Example response

{
  "data": {
    "id": "55211",
    "type": "user",
    "attributes": {
      "name": "John Doe",
      "username": "john.doe@email.com",
      "email": "john.doe@email.com",
      "active": true,
      "last_login": "2023-10-01T12:00:00.000000Z",
      "status": "verified",
      "is_client_admin": true,
      "signature": "Kind regards, John",
      "company": "John's Company",
      "expires": "2023-12-31 23:59:59",
      "type": "normal",
      "user_type": "SINGLE",
      "can_create_lightbox": true,
      "can_edit_profile": true,
      "show_brand_section": true,
      "hide_menu_by_default": true,
      "custom_metadata": "Custom metadata for the user",
      "internal_metadata": "Internal metadata for the user"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.