auth

Available methods

Description

This namespace provides methods to authenticate with the system’s management server.

Namespace:

auth

Method: login

HTTP POST

Description:

Login using a username and password. Returns the session key used by most other API methods.

Parameters:

  • string username

  • string password

Returns:

  • string sessionKey

Method: login

HTTP POST

Description:

Login using a username and password. Returns the session key used by other methods.

Parameters:

  • string username

  • string password

  • int duration - Length of session.

Returns:

  • string sessionKey

Method: logout

HTTP POST

Description:

Logout the user with the given session key.

Parameters:

  • string sessionKey

Returns:

  • int - 1 on success, exception thrown otherwise.