This WCF web service handles all the security related operations. The following methods are available:
Syntax |
|
Description | Updates an existing security token with the current session ID |
Parameters |
|
Return Value | The
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Tries to perform a user login against server or ActiveDirectory. The login will be done in one single operation. If login fails, an exception will be thrown. |
Parameters |
|
Return Value | A security token which can be used in all subsequent secured operations or an error code if the operation fails. The following error codes can be returned in case of login failure:
|
Syntax |
|
Description | Logs out the currently logged in user |
Parameters |
|
Return Value | A true or false depending on the success of the logout operation |
Syntax |
|
Description | Logs out the currently logged in user using the security token |
Parameters |
|
Return Value | A true or false depending on the success of the logout operation |
Syntax |
|
Description | Checks if the current user is still logged in |
Parameters |
|
Return Value | True if the current user (identified by the security token) is still logged in; otherwise, false. |
Syntax |
|
Description | Gets the username of the user that is logged in |
Parameters |
|
Return Value | The UserDTO object, containing:
|
Syntax |
|
Description | Gets an object which contains all authorizations (both system and project authorizations) for the currently logged in user |
Parameters |
|
Return Value | The
|
Syntax |
|
Description | Gets an object which contains all system authorizations for the currently logged in user |
Parameters |
|
Return Value | A list of SystemAuthorizationDTO objects, each containing:
|
Syntax |
|
Description | Checks if the current user has some specific system authorizations |
Parameters |
|
Return Value | A dictionary which has for each requested authorization a flag which indicates if the user has (or not) that authorization |
Syntax |
|
Description | Gets all system authorizations for a specific user, based on the provided parameters |
Parameters |
|
Return Value | A list of SystemAuthorizationDTO objects, each containing:
|
Syntax |
|
Description | Gets all system authorizations for a specific user, based on the provided token |
Parameters |
|
Return Value | A list of SystemAuthorizationDTO objects, each containing:
|
Syntax |
|
Description | Gets an object which contains all project authorizations for the currently logged in user |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Checks if the current user has some specific project authorizations |
Parameters |
|
Return Value | A dictionary which has for each requested authorization a flag which indicates if the user has (or not) that authorization |
Syntax |
|
Description | Gets all project authorizations based on the provided token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Adds a new project authorization using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Adds a new project authorization using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Updates an existing project authorization using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Updates an existing project authorization using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Deletes an existing project authorization using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Deletes an existing project authorization using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Gets all access authorizations based on the provided parameters |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Gets all access authorizations based on the provided token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Adds a new access authorization using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Adds a new access authorization using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Updates an existing access authorization using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Updates an existing access authorization using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Deletes an existing access authorization using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Deletes an existing access authorization using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Gets all access groups based on the provided parameters |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Gets all access groups based on the provided token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Gets all access groups details based on the provided parameters |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Gets all access groups details based on the provided token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Adds a new access group using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Adds a new access group using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Updates an existing access group using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Updates an existing access group using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Deletes an existing access group using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Deletes an existing access group using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Gets the authorization groups for the currently logged in user, based on the provided security token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Gets all authorization groups based on the provided parameters |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Gets all authorization groups based on the provided token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Gets all authorization groups details based on the provided parameters |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Gets all authorization groups details based on the provided token |
Parameters |
|
Return Value | A list of
|
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Adds a new authorization group using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Adds a new authorization group using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Updates an existing authorization group using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Updates an existing authorization group using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Deletes an existing authorization group using the provided parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
Syntax |
|
Description | Deletes an existing authorization group using the provided security token and parameters |
Parameters |
|
Return Value | Returns true if the operation succeeded or false if the operation failed |
This method follows the WEBfactory i4scada Security Protocol.
Syntax |
|
Description | Gets all scheduler locations based on the provided parameters |
Parameters |
|
Return Value | A list of
|
Syntax |
|
Description | Gets all scheduler locations based on the provided token |
Parameters |
|
Return Value | A list of
|