GetUserData

Class Description

This is an adminstrative method, that allows loading ANY userdata for ANY user by a superadmin! Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: GetUserData
Sha1: a1e801158fa2f6b0c4c7067a51c35599fa184890

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"username" : string 

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

false

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

true

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

SUPERUSER

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Sample Request

->

{
    "username": "testuser"
}

<-

{
    "id": 4,
    "email": "test@contagt.com",
    "group_id": 1,
    "groups": [
        {
            "0": "1",
            "id": "1",
            "1": "Global User Group",
            "name": "Global User Group"
        },
        {
            "0": "2",
            "id": "2",
            "1": "viewer group",
            "name": "viewer group"
        },
        {
            "0": "3",
            "id": "3",
            "1": "admin group",
            "name": "admin group"
        },
        {
            "0": "4",
            "id": "4",
            "1": "public-viewer-group",
            "name": "public-viewer-group"
        }
    ],
    "authorization_level": 5,
    "fa2_required": 0,
    "fail_cntr": 0,
    "max_tries": 5,
    "admin_email": null
}