user/insert

Creates new user

Authorization

Access JSON Web Token (ManageUser)

Request Topic and Payload

Topic

dh/request

Payload Representation

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

Payload Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: user/insert
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
userYesobjectUser object
user.loginYesstringUser login using during authentication.
user.roleYesintegerUser role. Available values:
0: Administrator role
1: Client role
user.statusYesintegerUser 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.passwordYesstringUser password
user.oldPasswordYesstringUser old password. Required for non-admin users.
user.dataYesobjectUser data, a JSON object with an arbitrary structure.

Response Topic and Payload

Topic

dh/response/user/insert@{clientId}

Payload Representation

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

Payload Parameters

Property NameTypeDescription
actionstringAction name: user/insert
requestIdobjectRequest unique identifier, will be passed back in the response message.
statusstringOperation execution status (success or error).
userobjectUser object
user.idintegerUser identifier.
user.loginstringUser login using during authentication.
user.roleintegerUser role. Available values:
0: Administrator role
1: Client role
user.statusintegerUser 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.lastLogindatetimeUser last login timestamp (UTC).
user.dataobjectUser data, a JSON object with an arbitrary structure.
user.introReviewedbooleanIndicates if user reviewed an intro.