Gets information about user and its assigned networks.

Only administrators are allowed to get information about any user. User-level accounts can only retrieve information about themselves.

Authorization

Access JSON Web Token (ManageUser)

Request Topic and Payload

Topic

dh/request

Payload Representation

{
    "action": {string},
    "requestId": {object},
    "userId": {long}
}

Payload Parameters

Parameter Name

Required

Type

Description

action

Yes

string

Action name: user/get

requestId

No

object

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

userId

Yes

long

User identifier.

Response Topic and Payload

Topic

dh/response/user/[email protected]{clientId}

Payload Representation

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

Payload Parameters

Property Name

Type

Description

action

string

Action name: user/get

status

string

Operation execution status (success or error).

requestId

object

Request unique identifier as specified in the request message.

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.networks

array

Array of networks associated with the user

user.networks[].network

object

Associated network object.

user.networks[].network.id

integer

Network identifier.

user.networks[].network.name

string

Network display name.

user.networks[].network.description

string

Network description.

user.introReviewed

boolean

Indicates if user reviewed an intro.