authentication.update

Description

object authentication.update(object authentication)

This method allows to update existing authentication settings.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Authentication properties to be updated.

Return values

(array) Returns an array with the names of updated parameters.

Examples

Request:

{
           "jsonrpc": "2.0",
           "method": "authentication.update",
           "params": {
               "http_auth_enabled": 1,
               "http_case_sensitive": 0,
               "http_login_form": 1
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               "http_auth_enabled",
               "http_case_sensitive",
               "http_login_form"
           ],
           "id": 1
       }

Source

CAuthentication::update() in ui/include/classes/api/services/CAuthentication.php.

Documentation