Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

 

Bokskya is our cloud storage services for the end consumer. This API describes how to create and administrate user accounts and authorize reading devices and applications. Bokskya ID is the consumers unique ID. The ID is created using e-mail address as identifier.

These services should be integrated in your user registration process, so that you ensure that all your user accounts have a corresponding Bokskya account.

 

Validate account

Validate state for a Bokskya account by ddsId or email.

 

URL

https://idp.dds.boknett.no/validate/{ddsid}

https://idp.dds.boknett.no/validate/{email}

MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
AcceptRequiredapplication/json (We recommend all new implementations to use this header, XML support will be phased out in the future)
Response
body on success
{
  "id": "212c60f9-57db-4b5b-b32a-ed561346eda1",
  "active": true
}
Returns200OK (Will also be returned if user not found, see response body)
40XOn error

 

Curl examples

Example of successful response based on email address:

 

curl -i -H "Accept: application/json" -H "Authorization: Boknett TGT-28905-pOzdvVr50wpTMl10DooFrDjTarMdwkeRzhlJ4KcMrQfEl13fxK-login.boknett.no" -H "Date: Thu, 13 Aug 2015 12:16:39 GMT" 'https://idp.dds.boknett.no/validate/ola.nordmann@norge.no'
HTTP/1.1 200 OK
Content-Length: 59

{"id":"212c60f9-57db-4b5b-b32a-ed561346eda1","active":true}

 

Example of request where user does not exist:

curl -i -H "Accept: application/json" -H "Authorization: Boknett TGT-28905-pOzdvVr50wpTMl10DooFrDjTarMdwkeRzhlJ4KcMrQfEl13fxK-login.boknett.no" -H "Date: Thu, 13 Aug 2015 12:16:39 GMT" 'https://idp.dds.boknett.no/validate/kari.nordmann@norge.no'HTTP/1.1 200 OKDate: Thu, 13 Aug 2015 12:24:30 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 25
{"data":"USER_NOT_FOUND"}

 

Register Account

Create a new DDS Bokskya user account
URLhttps://idp.dds.boknett.no/register
MethodPOST
Request
headers
Authorization
RequiredThe token acquired from the Authentication Service.Formated "Boknett TGT-...."
DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
AcceptRequiredapplication/json (We recommend all new implementations to use this header, XML support will be phased out in the future)
Content-typeRequiredapplication/json
JSON attributesemailRequiredEmail of the user (unique in bokskya)
nameRequiredFirst name of the user (minimum length 2)
surnameRequiredSurname of the user (minimum length 2)
Response
body
{"id":"743a3b25-e71f-4544-82c7-b5e66358b08a","active":true}
Returns200OK
40XOn error

 Curl example 

Example of successful creation of user:


$curl -i -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Boknett TGT-29061-mbdeGwDnbGTJ4qlSv4IYTm5Cpu5iDO1XxOSgg2IPAXNPhGEa0v-login.boknett.no" -H "Date: Thu, 13 Aug 2015 14:40:00 GMT" -d '{"email":"ola.nordmann@norge.no","name":"Ola","surname":"Nordmann"}' "https://idp.dds.boknett.no/register"HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{"id":"743a3b25-e71f-4544-82c7-b5e66358b08a","active":true}

 

 

Auth user by partner

 Service to authenticate a Bokskya account on behalf of a user and  to support Bokskya implementation of Adobe Content Server VendorID.  

URL

https://idp.dds.boknett.no/authenticate/{ddsid}

https://idp.dds.boknett.no/authenticate/{email}

MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
AcceptRequiredapplication/json (We recommend all new implementations to use this header, XML support will be phased out in the future)
Response
body on success

{"id":"QVFJQzV3TTJMWTRTZmN3clFvSjlsdzNuRkEzOXBwZjhYOEtBZEl4bWQ0bGRIVUkuKkFBSlRTUUFDTURFLio="}

Note: id attribute is base64 encoded token for authenticated {ddsId} (AQIC5wM2LY4SfcwrQoJ9lw3nFA39ppf8X8KAdIxmd4ldHUI.
*AAJTSQACMDE.*)

Returns200OK
40xOn errors

 

Get adobeId

Look up AdobeID for a Bokskya account by ddsId or email 

URL

https://idp.dds.boknett.no/adobeid/{ddsid}

https://idp.dds.boknett.no/adobeid/{email}

MethodGET
Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "Boknett TGT-...."

DateRequiredThe timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
AcceptRequiredapplication/json (We recommend all new implementations to use this header, XML support will be phased out in the future)
Response
body on success

When request is valid, user found and adobeId exist:

{"adobeid":"adobeId..."}

When request is valid, user found and adobeId not exist 

{"data":"NO_ADOBEID_EXIST"}

Returns200OK
40xOn error

 

 

 


 



  • No labels