Authenticating with flexVDI Manager
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
Method | POST |
---|---|
URL | /authenticate |
Request contents | Authenticate Object |
Answer contents | AuthResult Object |
Unexpected error format | HTTP 500 |
Authenticate Object
Schema
username | String | flexVDI Manager's registered username |
---|---|---|
password | String | Password for this username |
JSON example
{ "username": "admin", "password": "flexvdi" }
AuthResult Object
Schema
status | String | Authentication result. Either "Error" or "OK" |
---|---|---|
message | String | 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:
- Log into Manager's instance using SSH.
- Edit /flexvdi/external/manager/application.conf
- Change flexvdi.secure_server option from on tooff
- Restart Manager with the this command: service flexvdi-manager restart
Logout
The current session can be destroyed with this API call. As a result, an empty session cookie is returned.
Format
Method | GET |
---|---|
URL | /logout |
Request contents | None |
Answer contents | ManagerResult Object |
Unexpected error format | HTTP 500 |
ManagerResult Object
Schema
status | String | Always "OK" |
---|---|---|
message | String | Informative message |