UpdateUser

Class Description

Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: UpdateUser
Sha1: 2d7fe66f1e98ded8622845f29e8b38cc95ce25cc

Rpc Call

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

Rpc Parameters:

"username" : string,
"user_id" : int,
"email" : string,
"password" : ?string = null,
"passwordRetype" : ?string = null,
"group_id" : int = 1,
"authorizationLevel" : int = 1,
"resetAuthRequests" : bool = ,
"fa2" : bool = ,
"maxTries" : int = 5,
"adminEmail" : ?string = null 

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": "apiTestUser",
    "user_id": 1,
    "email": "apitest@contagt.com",
    "password": "testme",
    "passwordRetype": "testme"
}

<-

[
    "The password did not match or did not meet the minimum security requirements"
]