On this page:

Create a role

{
    "method": "axxonsoft.bl.security.SecurityService.ChangeConfig",
    "data": {
        "added_roles": [
            {
                "index": "60c60ed4-47e3-4d5e-9737-0f00b684f535",
                "name": "newRole",
                "comment": "comment",
                "timezone_id": "00000000-0000-0000-0000-000000000000",
                "supervisor": "00000000-0000-0000-0000-000000000000"
            }
        ]
    }
}

Attention!

timezone_id − id of the time zone. If 00000000-0000-0000-0000-000000000000, then the time zone is Always.

supervisor − id of the role that will be a supervisor (see Roles). If 00000000-0000-0000-0000-000000000000, then the supervisor is not defined.

Creater a user

{
    "method": "axxonsoft.bl.security.SecurityService.ChangeConfig",
    "data": {
        "added_users": [
            {
                "index": "393b06f3-d419-441d-8834-b5d1824c135a",
                "login": "user",
                "name": "user",
                "comment": "comment",
                "date_created": "",
                "date_expires": "",
                "enabled": true,
 				"ldap_link": {
                	"server_id": "",
            		"username": "",
            		"dn": ""
      	 	 	},
                "restrictions": {
                    "web_count": 0,
                    "mobile_count": 0
                },
                "email": "",
                "cloud_id": 160,
          		"extra_fields": {
             	   "SocialId": "test",
              	   "IpAddress": "160.85.208.94",
             	   "CompanyId": "test"
         	   },
                ],
                "locked_till": ""
            }
        ]
    }
}

Add a user to the role

{
    "method": "axxonsoft.bl.security.SecurityService.ChangeConfig",
    "data": {
        "added_users_assignments": [
            {
                "user_id": "52537c93-3efc-4465-b553-1c1ccf42faef",
                "role_id": "75863211-6fe5-4a79-9abf-f8137b1e767c"
            }
        ]
    }
}

Block and unblock the users

{
	"method":"axxonsoft.bl.security.SecurityService.ChangeConfig",
	"data":{
		"modified_users": [
        {
            "index": "fa00ea14-0ff5-4586-b6c8-ea449391a3a8",
            "login": "user1",
            "name": "user1",
            "comment": "",
            "enabled": true,
            "ldap_server_id": "00000000-0000-0000-0000-000000000000",
            "ldap_domain_name": "",
            "restrictions": {
                "web_count": 2147483647,
                "mobile_count": 2147483647
            },
            "email": "",
            "cloud_id": "0",
          	"extra_fields": {
             	   "SocialId": "test",
              	   "IpAddress": "160.85.208.94",
             	   "CompanyId": "test"
            },
            ],
            "locked_till": "29990101T000000"
        }
    ]
	}
}

where the locked_till parameter specifies the date and time in the YYYYMMDDTHHMMSS format until which the user will be blocked.

To unblock a user, set the date and time less than the current one.

Check username availability

{
    "method": "axxonsoft.bl.security.SecurityService.CheckLogin",
    "data": {
        "login": "user"
    }
}

The response will contain the following information:

  • "result": "TAKEN" − a user with that name already exists in the system;
  • "result": "FREE" − there is no user with this name in the system.
  • No labels