Get login form - GET /Authenticate

Returns a a login form allowing browser-based authentication.


VERB

Header

Resource/Id/Selector

Description

Parameters

Return data

GET

No

/Authenticate

Displays a login form allowing browser-based authentication for test purposes. An API key, a user name and a password must be specified to authenticate against the API.

-

Web page allowing a user to authenticate against the API using a standard web browser.


Login to Barium Live - POST /Authenticate

Post login details to authenticate user.


VERB

Header

Resource/Id/Selector

Description

Parameters

Return data

POST

No

/Authenticate

Authenticate the user using an API key, a user name and a password.


Set the querystring parameter format=json to get a JSON-formatted response when authenticating.


If authenticating with format=json, the return JSON format will be: { success=true, Ticket="TICKET" }


Set the querystring parameter webTicket=true to get an extra ticket for logging in to the web user interface (the tickets for the API and the web user interface are different).


If requesting a WebTicket, the return format will always be in the JSON format: { success=true, Ticket="TICKET", WebTicket="WEB_TICKET" }


To use the webTicket for web user interface login, just add it to the web user interface URL, such as http://bariumlive.com/tasks/{id}?ticket={WebTicket}

APIKey Username Password


(format=json)


(webTicket=true)

Ticket


Single Sign-on authentication to Barium Live - POST /SSOAuthenticate



VERB

Header

Resource/Id/Selector

Description

Parameters

Return data

POST

No

/SSOAuthenticate

Authenticate the user using an API key and a uid (user id). Note that the uid is not the Barium Live user name, instead it is the user identifier replicated to Barium Live from the local identity provider, such as a local LDAP catalogue or Active Directory.


Please contact http://bariumlive.com/support if you want to enable single sign-on for a space in Barium Live. Note that you need a special API key for this purpose.


Set the querystring parameter format=json to get a JSON-formatted response when authenticating.


If authenticating with format=json, the return JSON format will be: { success=true, Ticket="TICKET" }


Set the querystring parameter webTicket=true to get an extra ticket for logging in to the web user interface (the tickets for the API and the web user interface are different).


If requesting a WebTicket, the return format will always be in the JSON format: { success=true, Ticket="TICKET", WebTicket="WEB_TICKET" }


To use the webTicket for web user interface login, just add it to the web user interface URL, such as https://live.barium.se?ticket={WebTicket} and open a web browser with that URL.

APIKey

uid


(format=json) (webTicket=true)

Ticket