Creates user entity

Creates user entity

application/json

Request Body

• name string required

  Possible values: <= 100 characters

  Name of the user entity

• info string required

  Possible values: <= 255 characters

  Extra information about of the user entity

• is_security boolean required

  Security user has access to blocked doors.

Responses

• 200
• 400
• 401

---

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

• POST /access/users/{user-id}/time-profiles/{time-profile-id} - to attach time profile to user
• POST /access/users/{user-id}/identifiers/{identifier-id} - to attach identifier to user
• POST /apartments/{apartment-id}/users/{user-id} - to add user to apartment
• DELETE/GET/PATCH /access/users/{user-id} - to read/delete/update user data
• has_duplicates - if user with the same name already exists, has_duplicates will be in true condition
• To identify users, use info` field

application/json

• Schema
• Example (from schema)

---

Schema

• id integer

  Possible values: >= -1

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

• has_duplicates boolean

  Determines if entity has duplicates

{
  "id": 3,
  "has_duplicates": false
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...