Authentication

These APIs are used for logging in and out. Login will need to be called before any other calls are made.

This page includes the following:

Requests

You can use the following authentication requests:

HTTP Verb	Resource	Input	Expected Ouptup (HTTP/1.1)
POST	/authentication/login	{ “user” : [String], “password” : [String], “domain” : [String] }	Success Code: 200 OK Content: { "meta": { "type": [String], "id": [String], "uri": "http://.../users/{id}" }, "canUseVision": [Boolean], "canUseInsight": [Boolean], "canEdit": [Boolean], "canDelete": [Boolean], "canDisconnect": [Boolean], "isAdmin": [Boolean], "name": [String] }
POST	/authentication/loginWithAuthToken/{token}	N/A	Success Code: 200 OK
POST	/authentication/logout	N/A	Success Code: 200 OK Content: { “success” : [Boolean], “message” : [String] }

HTTP Verb

Resource

Input

Expected Ouptup (HTTP/1.1)

POST

/authentication/login

{
“user” : [String],
“password” : [String],
“domain” : [String]
}

Success Code: 200 OK

Content:

{
  "meta": {
    "type": [String],
    "id": [String],
    "uri": "http://.../users/{id}"
  },
  "canUseVision": [Boolean],
  "canUseInsight": [Boolean],
  "canEdit": [Boolean],
  "canDelete": [Boolean],
  "canDisconnect": [Boolean],
  "isAdmin": [Boolean],
  "name": [String]
}

POST

/authentication/loginWithAuthToken/{token}

N/A

Success Code: 200 OK

POST

/authentication/logout

N/A

Success Code: 200 OK

Content:

{
“success” : [Boolean],
“message” : [String]
}

Authentication Data Dictionary

user

Allowed values: Any valid Jaws user
password

Allowed values: Password for user
domain

Allowed values: Domain associated with user