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.

Request Message


Access JSON Web Token (ManageUser)

Message Representation

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

Message Parameters

Parameter NameRequiredTypeDescription
actionYesstringAction name: user/get
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
userIdYeslongUser identifier.

Server Message

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

Message 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}

Message Parameters

Property NameTypeDescription
actionstringAction name: user/get
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
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.networksarrayArray of networks associated with the user
user.networks[].networkobjectAssociated network object.
user.networks[].network.idintegerNetwork identifier.
user.networks[].network.namestringNetwork display name.
user.networks[].network.descriptionstringNetwork description.
user.introReviewedbooleanIndicates if user reviewed an intro.