DC 5.1.0 6.1.2 - LogOnWithAccessKeyOptions

Owned by Magnus Frank
May 14, 2019
1 min read

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

NameExampleDescription
methodLogOnAccessKeyOptionsFixed parameter that identifies the endpoint method.
accessKeyb77ca504-4335-4343-9109-11166a11ea0fValid access key from Digizuite
options

{
   "dez.configversionid" : "/0/0/0/",
   "dez.dataversionid" : "/0/0/0/",
   "dez.useversionedmetadata" : "0",
   "dez.setmembersystemlanguage": "3"
}

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

curl -X POST \
https://some.dam.com/dmm3bwsv3/ConnectService.js \
-H 'Cache-Control: no-cache' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F method=LogOnAccessKeyOptions \
-F accesskey=24887db8-91af-44da-9470-9e14c4280d4e \
-F 'options={
"dez.configversionid" : "/0/0/0/",
"dez.dataversionid" : "/0/0/0/",
"dez.useversionedmetadata" : "0"
}'

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"      
	}   ]
}