Update User Entity

Updates User Entity has_dublicates - if user with the same name already exists, has_dublicates will be in true condition To identify users, use info` field

Path Parameters

• user-uid integer required

  Possible values: >= 1

  Unique Identifier for User Item

application/json

Request Body required

• name string required

  User name

• info string required

  Additional info

• 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

• auth_factors object[] required

  List of auth factors

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• has_dublicates boolean

  Parameter describes if user with the same name already exists

{
  "has_dublicates": false
}

{
  "has_dublicates": true
}

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

  "error": "Wrong JSON body"

• Required field is not provided. 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)
• Base
• No value
• Wrong param type
• Auth factors list is empty

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

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

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

{
  "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...