AlterAccount

Class Description

Allows the Account-Owner to change or delete the Accounts Userdata. All Values have to be re-transmitted. Null values will delete the current Value for the Key.

RPC Configuration

Rpc Name:

Plain: AlterAccount
Sha1: 8047112d1578d5f8e38ad8c7251c20eca08fcbbd

Rpc Call

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

Rpc Parameters:

"userToken" : string,
"sharedSecret" : string,
"account_id" : int,
"firstname" : string,
"lastname" : string,
"email" : string,
"showEmail" : bool,
"birthday" : ?string = null,
"twitter" : ?string = null,
"facebook" : ?string = null,
"instagram" : ?string = null,
"linkedin" : ?string = null,
"xing" : ?string = null,
"skype" : ?string = null,
"teams" : ?string = null,
"zoom" : ?string = null,
"biography" : ?string = null 

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

File Receiver Configuration

This RPC can receive Files.

Maximum Filesize

4 MB

Accepted File MimeTypes:

[
    "image/png",
    "image/jpeg",
    "image/jpg",
    "image/svg+xml"
]

File Param Name(s):

[
    "image"
]

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:

false

Account Context

This RPC requires a valid account context as an account-id. The context must be provided within the following named parameter.

Account ID Parameter Name:

account_id

Sample Request

->

{
    "account_id": 2,
    "userToken": "MX8Tndlt3Qx5LdSsygHfq8gJd3v5Qdb4HKfuD7qXKo5RFU3fF1W7dQeHvEqg1eBR",
    "sharedSecret": "WHXKc4ory4FnuGUdg07yEyA2tPN4LgeZ",
    "firstname": "Altered",
    "lastname": "Account Name",
    "email": "altered.account@contagt.com",
    "showEmail": true,
    "birthday": "29.10.1986"
}

<-

{
    "account_id": 2,
    "username": "shareReceiver",
    "firstname": "Altered",
    "lastname": "Account Name",
    "email": "altered.account@contagt.com",
    "birthday": "0000-00-00 00:00:00",
    "twitter": false,
    "facebook": false,
    "instagram": false,
    "linkedin": false,
    "xing": false,
    "skype": false,
    "teams": false,
    "zoom": false,
    "biography": false
}