DC 5.4 LogOnWithAccessKeyOptions
- Tobias Thornfeldt Wolters
- Gosia Creosteanu (Unlicensed)
LogOnWithAccesKeyOptions is for generating a product specific accesskey for a user or for when a user changes language selection. It takes an accesskey and a json object with options.
URL : /ConnectService.js
Method : POST
Auth required : Yes
Required parameters
| Name | Example | Description |
|---|---|---|
| method | LogOnAccessKeyOptions | Fixed parameter that identifies the endpoint method. |
| accessKey | b77ca504-4335-4343-9109-11166a11ea0f | Valid access key from Digizuite |
| options | { | A JSON object with options for generating an accesskey. dez.configversionid (mandatory): This refers to the version ID of the channel which is logged on to. dez.dataversionid (mandatory): This refers to the version ID of the channel which data must be saved to and is used only for editing config data. It must be equal to the config version ID in all other contexts. dez.useversionedmetadata (optional): This is a boolean referring to the use of versioned metadata. This is used for setting and retrieving config data so must be 1 in this context but 0 in all others. The parameter is optional when using this API method and defaults to 0. dez.setmembersystemlanguage (optional): This parameter changes the members language and gets an accesskey for this language in one go. It is used when a user changes language. |
cUrl data example
Success Response
Code : 200 OK
Content example
{
"success": "true",
"items": [{
"accessKey": "2d8319f4-7a57-4ca0-a027-c44c2f259aac",
"memberId": "23",
"itemid": "3154",
"languageId": "3"
}
]
}
Error Response
Code : 200 OK
Content example
{
"success": "false",
"error": "Access Denied",
"items": [{
"accessKey": "",
"memberId": "0",
"languageId": "0"
} ]
}