Creates user entity

Creates user entity

application/json

Request Body

• name string required

  User name

• info string required

  User additional information

• auth_factors object[] required

  List of auth factors

• lock_number integer required

  Possible values: <= 2

  Lock number: 1 - first lock, 2 - second lock, 0 - both locks

• is_custom_user_access boolean required

  Use custom auth factors when enabled

Responses

• 200
• 400
• 401
• 403

---

The uid value returned in the response can be used as the user-uid parameter in next requests:

• POST /access/user/{user-uid}/timeprofile/{timeprofileUid} - to attach timeprofile to user
• POST /access/user/{user-uid}/identifier/{identifier-uid} - to attach identifier to user
• POST /apartment/item/{apartment-uid}/user/{userUId} - to add user to apartment
• DELETE/GET/PATCH /access/users/item/{user-uid} - to read/delete/update user data
• has_dublicates - if user with the same name already exists, has_dublicates will be in true condition
• To identify users, use info` field

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• uid integer

  Possible values: >= -1

  UID for entities references. If value is -1, then it means that is no entity reference for this structure

• has_dublicates boolean

  Parameter describes if user with the same name already exists

{
  "uid": 3,
  "has_dublicates": false
}

{
  "uid": 3,
  "has_dublicates": true
}

• auth_factors must contain at least one item
• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• auth_factors must contain at least one item Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Auth factors list is empty

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "auth_factors must contain at least one item"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...