ShareAsset

Class Description

Share an Asset with another Account. That account will be able to read all properties of the asset and it will appear in all its search results. The calling account must have owner-permissions on the asset.

RPC Configuration

Rpc Name:

Plain: ShareAsset
Sha1: aa717559563f89282fc3dee0000d66825fc4c8be

Rpc Call

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

Rpc Parameters:

"userToken" : string,
"sharedSecret" : string,
"assetAlias" : string,
"username" : string,
"writeAccess" : bool = ,
"owner" : bool =  

Parameter Description

@param string username The Username of the User the Asset should be shared with.

@param bool writeAccess If true, the receiving account will also be allowed to modify properties of the asset.

@param bool owner Will also add ownership of the asset to the new account. The new account will have full administrative permissions on the asset.

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.

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.

STANDARD_USER

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

Account Method Authentication

This RPC requires Account Method Authenticaton with the following configuration:

Requires Account Login:

tipp

The Account login is not the default api login. See LoginViaUser and LoginViaEmail

true

Account Usertoken Parameter Name:

tipp

This Usertoken is not the same one, as the api login usertoken.

userToken

Account Shared Secret Parameter Name:

sharedSecret

Requires Asset Permission:

true

Sample Request

->

{
    "userToken": "MX8Tndlt3Qx5LdSsygHfq8gJd3v5Qdb4HKfuD7qXKo5RFU3fF1W7dQeHvEqg1eBL",
    "sharedSecret": "ea75c32046a8be46a47474931df9ffe4",
    "assetAlias": "My_Third_Asset",
    "username": "shareReceiver"
}

<-

true