Login

RPC Configuration

Rpc Name:

Plain: Login
Sha1: 1c3a1a3b3c7a95f999a92b2347978fcdc85d4f4b

Rpc Call

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

Rpc Parameters:

"username" : string,
"password" : string 

Parameter Description

@return Array[string|101|102] Liefert das Usertoken als String oder die Zustandscodes

101 => Login gescheitert 102 => TwoFactor erforderlich; Siehe Validate2FA.

 { "usertoken": <string>|101|102 }

Requires Login:

false

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.

false

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.

ANONYMOUS

Requires Subbuilding Merge Strategy:

REPLACE

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",
    "password": "test1234"
}

<-

{
    "userToken": "00VwUSwnLYD5uVOyfDIZoG8YeuSX0IEl"
}