HasAccessTo

Class Description

Allows a user to check if it can access one or a set of specific RPCs on a specific guide with the currently configured permissions.

RPC Configuration

Rpc Name:

Plain: HasAccessTo
Sha1: 6e74cf246737ad7b3de97d21ee46b90cbd7b4a3a

Rpc Call

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

Rpc Parameters:

"building_id" : int,
"methods" : array,
"groups" : bool = 1 

Parameter Description

@param int building_id The building context in which to run the checks

@param string[] methods A set of RPCs. Will fail to execute if RPC does not exist.

@param bool groups If set to true, the RPC will verify the group level permissions, otherwise the individual user permissions.

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.

true

Requires contextParamName:

building_id

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.

STANDARD_USER

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

->

{
    "building_id": 131,
    "methods": [
        "Search"
    ]
}

<-

{
    "Search": null
}