user/getCurrent

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

Authorization

Access JSON Web Token (GetCurrentUser)

Message Representation

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

Message Parameters

actionYesstringAction name: user/getCurrent
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},
    "current": {
        "id": {string},
        "login": {string},
        "role": {integer},
        "status": {integer},
        "lastLogin": {datetime},
        "networks": [{
            id: {integer},
            name: {string},
            description: {string}
        }],
        "data": {object},
        "introReviewed": {boolean}
    }
}
Property NameTypeDescription
actionstringAction name: user/getCurrent
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
currentobjectCurrent user object.
current.idintegerUser identifier.
current.loginstringUser login using during authentication.
current.roleintegerUser role. Available values:
0: Administrator role
1: Client role
current.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
current.lastLogindatetimeUser last login timestamp (UTC).
current.networksarrayArray of networks associated with the user
current.networks[].idintegerNetwork identifier.
current.networks[].namestringNetwork display name.
current.networks[].descriptionstringNetwork description.
current.dataobjectUser data, a JSON object with an arbitrary structure.
current.introReviewedbooleanIndicates if user reviewed an intro.