Jump to: navigation, search

Authentication

API METHOD Syntax Request Body Response Body HTTP Status Codes Notes
Login GET [+]Show N/A [+]Show
  • 200 OK—Response Body Provided
  • 401 Unauthorized—Userid/Password not valid
  • 422 Unprocessable Entry
[+]Show
  • 503—Service Unavailable

Additional Errors:

  • 1001—No User Connection
  • 1002—Client port bind failed
  • 1003—Max Connections Exceeded
Userid and Password are provided in the basic authorization header.
  • apiToken—A unique session "apiToken" is returned on a successful login. "Userid" and "apiToken" must be included on subsequent requests via the basic authorization header.
  • lastLogin—(if available from config server) is returned as a long representing time in ms since epoch.
Change Password and Login PUT [+]Show [+]Show [+]Show
  • 200 OK—Response Body Provided
  • 401Unauthorized—Userid / Original Password not valid
  • 503—Service Unavailable
A user cannot simply change their password at any time. The password must expire or the flag to "reset" password must be enabled in Configuration Server. When a user attempts to log in and gets the "Password Change Required" error, they can then use this API to change their password and log in.

UserID and Original Password are provided in the basic authorization header. The new password is passed in the request body. If the password change is successful, the API token and last login time (if available) will be returned (just like normal login).

Logout GET [+]Show N/A N/A
  • 204 No Content—Logout successful
  • 401 Unauthorized&mdashUser not logged in or API Token not otherwise recognized
  • 422 Unprocessable Entry —User has locked resources:
[+]Show
  • 503—Service Unavailable
 
Query Locks GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 204 No Content—User has no locked resources
  • 401 Unauthorized—APIToken not valid
  • 503—Service Unavailable
 
Permissions GET [+]Show N/A [+]Show
  • 200 OK—Response body provided
  • 401 Unauthorized—APIToken not valid
  • 403 Forbidden—User does not have permission for the specified tenant
  • 503—Service Unavailable
User must have permission to the specified tenant ID. Use Query Tenants to get a list of valid tenant IDs for this logged in user.
This page was last modified on July 30, 2015, at 06:17.

Feedback

Comment on this article:

blog comments powered by Disqus