Authenticating with flexVDI Manager

Owned by Sergio L. Pascual (Unlicensed)
Nov 17, 2016

By default, flexVDI Manager requires a session to be authenticated before it can send any kind of query or task.

The authentication process requires sending the proper credentials in a JSON message. If the authentication success, Manager's answer will inject a session cookie, which needs to be preserved and included in the next HTTP requests.

Format

MethodPOST
URL

/authenticate

Request contentsAuthenticate Object
Answer contentsAuthResult Object
Unexpected error format

HTTP 500

Authenticate Object

Schema

usernameStringflexVDI Manager's registered username
passwordString

Password for this username

JSON example

 

{
    "username": "admin",
    "password": "flexvdi"
}

 

AuthResult Object

Schema

statusStringAuthentication result. Either "Error" or "OK"
messageString

Session identification string

JSON example

 

{
    "status": "OK",
    "message": "27d2b548-0284-4bd1-ad28-f3419d930aa3"
}

 

Disabling flexVDI Manager authentication

Disabling flexVDI Manager authentication can be useful sometimes, as it allows to send queries and tasks directly to every interface, without doing any kind of session validation. This shouldn't be done in production or publicly exposed environments.

To disable flexVDI Manager authentication requirement, follow these steps:

  1. Log into Manager's instance using SSH.
  2. Edit /flexvdi/external/manager/application.conf
  3. Change flexvdi.secure_server option from on to off
  4. Restart Manager with the this command: service flexvdi-manager restart