latestSwagger 2.02026-08-1024042.7 KB

a3ea128a9743

Users

Create user

    Create a user by specifying personal and review related attributes.

    When specifying review details (form, process, manager, and archive date), a corresponding Review Set and Review will be created.

    If review details are not supplied, no Review will exist for this user and their ability to interact with the system will be limited.

post/api/v1/users

Query parameters

includestring

value can be 'groups' to include user group information in results

Headers

Content-Typestring required

Request body

Example request

{
  "data": {
    "type": "users",
    "attributes": {
      "first_name": "Jane",
      "last_name": "Doe",
      "employee_number": "employee123",
      "username": "username1",
      "email": "my_email@example.com",
      "hire_date": "2019-09-29",
      "base_date": "2019-09-29",
      "password": "MyPassword!",
      "form_name": "Manager in training",
      "unrecognized_form_name_action": "copy",
      "form_name_for_copy": "Older form to Copy",
      "process_name": "Annual",
      "manager_user_id": "64",
      "review_archive_date": "2020-03-31",
      "group_ids": [
        "1",
        "2",
        "3"
      ],
      "group_names": [
        {
          "group_type_name": "Location",
          "group_name": "Dragonstone"
        }
      ],
      "roles": [
        "admin",
        "manager"
      ],
      "locale_format": "en_GB",
      "locale_lang": "fr_CA"
    }
  }
}

Response

user successfully created