user/insert

Creates new user

Request Message

Authorization

Access JSON Web Token (ManageUser)

Message Representation

In the request body, supply a User resource.

{
    "action": {string},
    "requestId": {object},
    "user": {
        "login": {string},
        "role": {integer},
        "status": {integer},
        "password": {string},
        "oldPassword": {string},
        "data": {object}
    }
}

Message Parameters

Property Name

Required

Type

Description

action

Yes

string

Action name: user/insert

requestId

No

object

Request unique identifier, will be passed back in the response message.

user

Yes

object

User object

user.login

Yes

string

User login using during authentication.

user.role

Yes

integer

User role. Available values:

  • 0: Administrator role
  • 1: Client role

user.status

Yes

integer

User status. Available values:

  • 0: The user is active
  • 1: The user has been locked out due to invalid login attempts
  • 2: The user has been disabled

user.password

Yes

string

User password

user.oldPassword

Yes

string

User old password. Required for non-admin users.

user.data

Yes

object

User data, a JSON object with an arbitrary structure.

Server Message

If successful, this method returns a User resource in the response body.

Message Representation

{
    "action": {string},
    "requestId": {object},
    "status": {string},
    "user": {
        "id": {integer},
        "login": {string},
        "role": {integer},
        "status": {integer},
        "lastLogin": {datetime},
        "data": {object},
        "introReviewed": {boolean}
    }
}

Message Parameters

Property Name

Type

Description

action

string

Action name: user/insert

requestId

object

Request unique identifier, will be passed back in the response message.

status

string

Operation execution status (success or error).

user

object

User object

user.id

integer

User identifier.

user.login

string

User login using during authentication.

user.role

integer

User role. Available values:

  • 0: Administrator role
  • 1: Client role

user.status

integer

User status. Available values:

  • 0: The user is active
  • 1: The user has been locked out due to invalid login attempts
  • 2: The user has been disabled

user.lastLogin

datetime

User last login timestamp (UTC).

user.data

object

User data, a JSON object with an arbitrary structure.

user.introReviewed

boolean

Indicates if user reviewed an intro.