IDM

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}
Method	GET
Request headers	Authorization	Required	The token acquired from the Authentication Service. Formated "Boknett TGT-...."
	Date	Required	The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
Response body on success	{ "id": "ola.nordmann@norge.no", "active": "Ola", "surname": "Nordmann", }
Returns	200	OK
	400	Bad Request
	401	Unauthorized
	403	Forbidden
	404	Not found (returned if the requested user is not found)
	406	Not Acceptable
	500	Internal Server Error

Example of successful response based on email address:

curl -i -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 "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 OK

Date: 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

URL	https://idp.dds.boknett.no/register
Method	POST
Request headers	Authorization	Required	The token acquired from the Authentication Service. Formated "Boknett TGT-...."
	Date	Required	The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT
JSON attributes	email	Required	Email of the user (unique in bokskya)
	name	Required	First name of the user
	surname	Required	Surname of the user
Response body	{"id":"743a3b25-e71f-4544-82c7-b5e66358b08a","active":true}
Returns	200	OK
	400	Bad Request
	401	Unauthorized
	403	Forbidden
	406	Not Acceptable
	500	Internal Server Error

Example of successful creation of user:

$curl -i -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}