JoinShareGroup
An existing share, that has to be legit or the caller, can be added to a group. If no share is wanted, submit null (leave empty), wich results in a Read-Only Mode.
RPC Configuration
Rpc Name:
Plain: JoinShareGroup
Sha1: 81aba9a5c40d4b9525bb2c620886797bcf6d10fb
RPCs can be called by their plain name or their SHA1 representation.
Rpc Parameters:
"userToken" : string,
"sharedSecret" : string,
"groupName" : string,
"secret" : ?string = null,
"alias" : ?string = null
Requires Login:
true
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
Has Named Parameters:
true
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.
STANDARD_USER
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
Account Method Authentication
This RPC requires Account Method Authenticaton with the following configuration:
Requires Account Login:
The Account login is not the default api login. See LoginViaUser and LoginViaEmail
true
Account Usertoken Parameter Name:
This Usertoken is not the same one, as the api login usertoken.
userToken
Account Shared Secret Parameter Name:
sharedSecret
Requires Asset Permission:
false
Realtime API
This RPC is applicable to the Realtime API. You can subscribe to events that reflect in a response to your request.