Creates user entity
Creates user entity
- application/json
Request Body
- name string required
- info string required
- auth_factors string[] required
Possible values: [
card
,input_code
,face_id
,qr
] - lock_number integer required
- is_custom_user_access boolean required
Responses
- 200
- 400
- 401
- 403
The uid
value returned in the response can be used as the userUid
parameter in next requests:
POST /access/user/{userUid}/timeprofile/{timeprofileUid}
- to attach timeprofile to userPOST /access/user/{userUid}/identifier/{identifierUid}
- to attach identifier to userPOST /apartment/item/{apartmentUid}/user/{userUId}
- to add user to apartmentDELETE/GET/PATCH /access/users/item/{userUid}
- to read/delete/update user datahas_dublicates
- if user with the same name already exists,has_dublicates
will be in true conditionTo identify users, use
info` field
- application/json
- Schema
- Example (from schema)
- Example
Schema
- uid integer
Possible values:
>= -1
UID for entities referenses. If value is
-1
, then it means that is no entity reference for this structure - has_dublicates boolean
{
"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": 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": "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": "Administrator rights required"
}
{
"error": "Administrator rights required"
}
Loading...