Authenticate
Add authentication credentials to the API, to qualify for the download of a specialized guide.
RPC Configuration
Rpc Name:
Plain: Authenticate
Sha1: 6f6f83b437d811b1ee455f0f0f54db381d75875e
RPCs can be called by their plain name or their SHA1 representation.
Rpc Parameters:
"type" : string,
"value" : string
@param string type The Authentication Type, "BUN", "PW" or "CERT"
@param string value The Passcode for type "BUN", Password for "PW" or Certificate for "CERT"
Requires Login:
false
Requires 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:
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:
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
All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache
and readonly.
Cache enabled:
false