--- title: User Group Management slug: singleconnect-2-16/user-group-management description: Learn how to easily manage user groups using a REST API with this comprehensive document. It features code examples in cURL, JavaScript, and C#, showcasing how to add, update, delete, and retrieve user groups. Discover the necessary HTTP requests, includi docTags: createdAt: 2021-02-26T00:31:23.000Z --- :::ApiMethodV2 ```json { "tab": "examples", "url": "http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup", "name": "Add User Group", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "0V7sYdf1wWcSJ5Z2JTicc", "code": "{\n \"id\": \"3c040987-adb7-45ab-9a50-264f04fbe13a\",\n \"eid\": \"testuser\",\n \"personelId\": \"123123\",\n \"name\": \"test\",\n \"passwordAlgorithm\": \"MD5\",\n \"password\": \"21232f297a57a5a743894a0e4a801fc3\",\n \"email\": \"test@test.com\",\n \"surname\": \"user\",\n \"internal\": true,\n \"properties\": {\n \"phoneNumber\": \"5550000000\",\n \"ubaThreshold\": \"50\"\n },\n \"groups\": [\n \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"DEFAULT_GROUP_SYSYEM_USERS\"\n ],\n \"managerGroups\": null,\n \"lastLogin\": null,\n \"lastLoginIp\": null,\n \"recordLimit4Search\": null,\n \"passwordDirty\": false,\n \"passwordAutoGenerated\": false,\n \"phoneNumber\": \"5550000000\",\n \"forceChangePasswordOnNextLogin\": false,\n \"lockReason\": null,\n \"unlockOnPasswordChanged\": false,\n \"unlockTime\": null,\n \"tempUserEndTime\": null,\n \"tempUserStartTime\": null,\n \"tempUser\": false,\n \"externalDirectorySource\": null,\n \"userPropertyKey4Search\": null,\n \"userPropertyValue4Search\": null,\n \"locked\": false\n}", "language": "200" } ], "selectedLanguageId": "0V7sYdf1wWcSJ5Z2JTicc" }, "examples": { "languages": [ { "id": "2FyGCEUr-m8SDS9qglj1c", "code": "var client = new RestClient(\"http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.POST);\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"{\\n\\t\\\"eid\\\": \\\"MyGroup\\\",\\n\\t\\\"description\\\": \\\"user group for test purpose\\\",\\n\\t\\\"passwordTtl\\\": \\\"90\\\",\\n\\t\\\"users\\\": [\\n\\t\\t{\\n\\t\\t\\t\\\"id\\\": \\\"a177be61-8850-4f03-be1c-3ce275f02c1f\\\",\\n\\t\\t\\t\\\"eid\\\": \\\"testuser\\\",\\n\\t\\t\\t\\\"personelId\\\": \\\"123123\\\",\\n\\t\\t\\t\\\"name\\\": \\\"test\\\",\\n\\t\\t\\t\\\"passwordAlgorithm\\\": \\\"SHA256\\\",\\n\\t\\t\\t\\\"password\\\": \\\"123\\\",\\n\\t\\t\\t\\\"email\\\": \\\"test@test.com\\\",\\n\\t\\t\\t\\\"surname\\\": \\\"user\\\",\\n\\t\\t\\t\\\"internal\\\": true,\\n\\t\\t\\t\\\"properties\\\": {\\n\\t\\t\\t\\t\\\"phoneNumber\\\": \\\"5550000000\\\",\\n\\t\\t\\t\\t\\\"ubaThreshold\\\": \\\"50\\\"\\n\\t\\t\\t},\\n\\t\\t\\t\\\"groups\\\": [\\n\\t\\t\\t\\t\\\"DEFAULT_GROUP_SYSYEM_ADMINS\\\",\\n\\t\\t\\t\\t\\\"DEFAULT_GROUP_SYSYEM_USERS\\\"\\n\\t\\t\\t],\\n\\t\\t\\t\\\"managerGroups\\\": [],\\n\\t\\t\\t\\\"lastLogin\\\": null,\\n\\t\\t\\t\\\"lastLoginIp\\\": null,\\n\\t\\t\\t\\\"recordLimit4Search\\\": null,\\n\\t\\t\\t\\\"passwordDirty\\\": true,\\n\\t\\t\\t\\\"passwordAutoGenerated\\\": false,\\n\\t\\t\\t\\\"phoneNumber\\\": \\\"5550000000\\\",\\n\\t\\t\\t\\\"forceChangePasswordOnNextLogin\\\": false,\\n\\t\\t\\t\\\"lockReason\\\": null,\\n\\t\\t\\t\\\"unlockOnPasswordChanged\\\": false,\\n\\t\\t\\t\\\"unlockTime\\\": null,\\n\\t\\t\\t\\\"tempUserEndTime\\\": null,\\n\\t\\t\\t\\\"tempUserStartTime\\\": null,\\n\\t\\t\\t\\\"tempUser\\\": false,\\n\\t\\t\\t\\\"externalDirectorySource\\\": null,\\n\\t\\t\\t\\\"userPropertyKey4Search\\\": null,\\n\\t\\t\\t\\\"userPropertyValue4Search\\\": null,\\n\\t\\t\\t\\\"locked\\\": false\\n\\t\\t}\\n\\t],\\n\\t\\\"managers\\\": [\\n\\t\\t{\\n\\t\\t\\t\\\"id\\\": \\\"a177be61-8850-4f03-be1c-3ce275f02c1f\\\",\\n\\t\\t\\t\\\"eid\\\": \\\"testuser\\\",\\n\\t\\t\\t\\\"personelId\\\": \\\"123123\\\",\\n\\t\\t\\t\\\"name\\\": \\\"test\\\",\\n\\t\\t\\t\\\"passwordAlgorithm\\\": \\\"SHA256\\\",\\n\\t\\t\\t\\\"password\\\": \\\"123\\\",\\n\\t\\t\\t\\\"email\\\": \\\"test@test.com\\\",\\n\\t\\t\\t\\\"surname\\\": \\\"user\\\",\\n\\t\\t\\t\\\"internal\\\": true,\\n\\t\\t\\t\\\"properties\\\": {\\n\\t\\t\\t\\t\\\"phoneNumber\\\": \\\"5550000000\\\",\\n\\t\\t\\t\\t\\\"ubaThreshold\\\": \\\"50\\\"\\n\\t\\t\\t},\\n\\t\\t\\t\\\"groups\\\": [\\n\\t\\t\\t\\t\\\"DEFAULT_GROUP_SYSYEM_ADMINS\\\",\\n\\t\\t\\t\\t\\\"DEFAULT_GROUP_SYSYEM_USERS\\\"\\n\\t\\t\\t],\\n\\t\\t\\t\\\"managerGroups\\\": [],\\n\\t\\t\\t\\\"lastLogin\\\": null,\\n\\t\\t\\t\\\"lastLoginIp\\\": null,\\n\\t\\t\\t\\\"recordLimit4Search\\\": null,\\n\\t\\t\\t\\\"passwordDirty\\\": true,\\n\\t\\t\\t\\\"passwordAutoGenerated\\\": false,\\n\\t\\t\\t\\\"phoneNumber\\\": \\\"5550000000\\\",\\n\\t\\t\\t\\\"forceChangePasswordOnNextLogin\\\": false,\\n\\t\\t\\t\\\"lockReason\\\": null,\\n\\t\\t\\t\\\"unlockOnPasswordChanged\\\": false,\\n\\t\\t\\t\\\"unlockTime\\\": null,\\n\\t\\t\\t\\\"tempUserEndTime\\\": null,\\n\\t\\t\\t\\\"tempUserStartTime\\\": null,\\n\\t\\t\\t\\\"tempUser\\\": false,\\n\\t\\t\\t\\\"externalDirectorySource\\\": null,\\n\\t\\t\\t\\\"userPropertyKey4Search\\\": null,\\n\\t\\t\\t\\\"userPropertyValue4Search\\\": null,\\n\\t\\t\\t\\\"locked\\\": false\\n\\t\\t}\\n\\t]\\n}\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "hbSQAlwVKKJyCkjQPo7wz", "code": "curl --location -g --request POST 'http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\t\"eid\": \"MyGroup\",\n\t\"description\": \"user group for test purpose\",\n\t\"passwordTtl\": \"90\",\n\t\"users\": [\n\t\t{\n\t\t\t\"id\": \"a177be61-8850-4f03-be1c-3ce275f02c1f\",\n\t\t\t\"eid\": \"testuser\",\n\t\t\t\"personelId\": \"123123\",\n\t\t\t\"name\": \"test\",\n\t\t\t\"passwordAlgorithm\": \"SHA256\",\n\t\t\t\"password\": \"123\",\n\t\t\t\"email\": \"test@test.com\",\n\t\t\t\"surname\": \"user\",\n\t\t\t\"internal\": true,\n\t\t\t\"properties\": {\n\t\t\t\t\"phoneNumber\": \"5550000000\",\n\t\t\t\t\"ubaThreshold\": \"50\"\n\t\t\t},\n\t\t\t\"groups\": [\n\t\t\t\t\"DEFAULT_GROUP_SYSYEM_ADMINS\",\n\t\t\t\t\"DEFAULT_GROUP_SYSYEM_USERS\"\n\t\t\t],\n\t\t\t\"managerGroups\": [],\n\t\t\t\"lastLogin\": null,\n\t\t\t\"lastLoginIp\": null,\n\t\t\t\"recordLimit4Search\": null,\n\t\t\t\"passwordDirty\": true,\n\t\t\t\"passwordAutoGenerated\": false,\n\t\t\t\"phoneNumber\": \"5550000000\",\n\t\t\t\"forceChangePasswordOnNextLogin\": false,\n\t\t\t\"lockReason\": null,\n\t\t\t\"unlockOnPasswordChanged\": false,\n\t\t\t\"unlockTime\": null,\n\t\t\t\"tempUserEndTime\": null,\n\t\t\t\"tempUserStartTime\": null,\n\t\t\t\"tempUser\": false,\n\t\t\t\"externalDirectorySource\": null,\n\t\t\t\"userPropertyKey4Search\": null,\n\t\t\t\"userPropertyValue4Search\": null,\n\t\t\t\"locked\": false\n\t\t}\n\t],\n\t\"managers\": [\n\t\t{\n\t\t\t\"id\": \"a177be61-8850-4f03-be1c-3ce275f02c1f\",\n\t\t\t\"eid\": \"testuser\",\n\t\t\t\"personelId\": \"123123\",\n\t\t\t\"name\": \"test\",\n\t\t\t\"passwordAlgorithm\": \"SHA256\",\n\t\t\t\"password\": \"123\",\n\t\t\t\"email\": \"test@test.com\",\n\t\t\t\"surname\": \"user\",\n\t\t\t\"internal\": true,\n\t\t\t\"properties\": {\n\t\t\t\t\"phoneNumber\": \"5550000000\",\n\t\t\t\t\"ubaThreshold\": \"50\"\n\t\t\t},\n\t\t\t\"groups\": [\n\t\t\t\t\"DEFAULT_GROUP_SYSYEM_ADMINS\",\n\t\t\t\t\"DEFAULT_GROUP_SYSYEM_USERS\"\n\t\t\t],\n\t\t\t\"managerGroups\": [],\n\t\t\t\"lastLogin\": null,\n\t\t\t\"lastLoginIp\": null,\n\t\t\t\"recordLimit4Search\": null,\n\t\t\t\"passwordDirty\": true,\n\t\t\t\"passwordAutoGenerated\": false,\n\t\t\t\"phoneNumber\": \"5550000000\",\n\t\t\t\"forceChangePasswordOnNextLogin\": false,\n\t\t\t\"lockReason\": null,\n\t\t\t\"unlockOnPasswordChanged\": false,\n\t\t\t\"unlockTime\": null,\n\t\t\t\"tempUserEndTime\": null,\n\t\t\t\"tempUserStartTime\": null,\n\t\t\t\"tempUser\": false,\n\t\t\t\"externalDirectorySource\": null,\n\t\t\t\"userPropertyKey4Search\": null,\n\t\t\t\"userPropertyValue4Search\": null,\n\t\t\t\"locked\": false\n\t\t}\n\t]\n}'", "language": "curl" }, { "id": "P0N3bkWNIisnrS9EFRhvv", "code": "var settings = {\r\n \"url\": \"http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup\",\r\n \"method\": \"POST\",\r\n \"timeout\": 0,\r\n \"headers\": {\r\n \"Content-Type\": \"application/json\"\r\n },\r\n \"data\": JSON.stringify({\"eid\":\"MyGroup\",\"description\":\"user group for test purpose\",\"passwordTtl\":\"90\",\"users\":[{\"id\":\"a177be61-8850-4f03-be1c-3ce275f02c1f\",\"eid\":\"testuser\",\"personelId\":\"123123\",\"name\":\"test\",\"passwordAlgorithm\":\"SHA256\",\"password\":\"123\",\"email\":\"test@test.com\",\"surname\":\"user\",\"internal\":true,\"properties\":{\"phoneNumber\":\"5550000000\",\"ubaThreshold\":\"50\"},\"groups\":[\"DEFAULT_GROUP_SYSYEM_ADMINS\",\"DEFAULT_GROUP_SYSYEM_USERS\"],\"managerGroups\":[],\"lastLogin\":null,\"lastLoginIp\":null,\"recordLimit4Search\":null,\"passwordDirty\":true,\"passwordAutoGenerated\":false,\"phoneNumber\":\"5550000000\",\"forceChangePasswordOnNextLogin\":false,\"lockReason\":null,\"unlockOnPasswordChanged\":false,\"unlockTime\":null,\"tempUserEndTime\":null,\"tempUserStartTime\":null,\"tempUser\":false,\"externalDirectorySource\":null,\"userPropertyKey4Search\":null,\"userPropertyValue4Search\":null,\"locked\":false}],\"managers\":[{\"id\":\"a177be61-8850-4f03-be1c-3ce275f02c1f\",\"eid\":\"testuser\",\"personelId\":\"123123\",\"name\":\"test\",\"passwordAlgorithm\":\"SHA256\",\"password\":\"123\",\"email\":\"test@test.com\",\"surname\":\"user\",\"internal\":true,\"properties\":{\"phoneNumber\":\"5550000000\",\"ubaThreshold\":\"50\"},\"groups\":[\"DEFAULT_GROUP_SYSYEM_ADMINS\",\"DEFAULT_GROUP_SYSYEM_USERS\"],\"managerGroups\":[],\"lastLogin\":null,\"lastLoginIp\":null,\"recordLimit4Search\":null,\"passwordDirty\":true,\"passwordAutoGenerated\":false,\"phoneNumber\":\"5550000000\",\"forceChangePasswordOnNextLogin\":false,\"lockReason\":null,\"unlockOnPasswordChanged\":false,\"unlockTime\":null,\"tempUserEndTime\":null,\"tempUserStartTime\":null,\"tempUser\":false,\"externalDirectorySource\":null,\"userPropertyKey4Search\":null,\"userPropertyValue4Search\":null,\"locked\":false}]}),\r\n};\r\n\r\n$.ajax(settings).done(function (response) {\r\n console.log(response);\r\n});", "language": "javascript" } ], "selectedLanguageId": "2FyGCEUr-m8SDS9qglj1c" }, "description": " ", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" } } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup", "name": "Update User Group", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "OZdqwvSPjQ9obUthdXlfe", "code": "{\n \"id\": \"cdc00366-56b6-4874-bd8b-7862549510ab\",\n \"eid\": \"testuser\",\n \"personelId\": \"123123\",\n \"name\": \"testtest\",\n \"passwordAlgorithm\": \"MD5\",\n \"password\": \"21232f297a57a5a743894a0e4a801fc3\",\n \"email\": \"test@test.com\",\n \"surname\": \"user\",\n \"internal\": true,\n \"properties\": {\n \"phoneNumber\": \"5550000000\",\n \"ubaThreshold\": \"50\"\n },\n \"groups\": [\n \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"DEFAULT_GROUP_SYSYEM_USERS\"\n ],\n \"managerGroups\": null,\n \"lastLogin\": null,\n \"lastLoginIp\": null,\n \"recordLimit4Search\": null,\n \"passwordDirty\": false,\n \"passwordAutoGenerated\": false,\n \"phoneNumber\": \"5550000000\",\n \"forceChangePasswordOnNextLogin\": false,\n \"lockReason\": null,\n \"unlockOnPasswordChanged\": false,\n \"unlockTime\": null,\n \"tempUserEndTime\": null,\n \"tempUserStartTime\": null,\n \"tempUser\": false,\n \"externalDirectorySource\": null,\n \"userPropertyKey4Search\": null,\n \"userPropertyValue4Search\": null,\n \"locked\": false\n}", "language": "200" } ], "selectedLanguageId": "OZdqwvSPjQ9obUthdXlfe" }, "examples": { "languages": [ { "id": "OXlPsLxmSJY8sfcau20vE", "code": "var client = new RestClient(\"http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.POST);\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"{\\n \\\"id\\\": \\\"35a63ea0-e8b1-44f6-9d1a-afdaf54bd609\\\",\\n \\\"eid\\\": \\\"MyGroup\\\",\\n \\\"description\\\": \\\"user group for test purpose\\\",\\n \\\"users\\\": [\\n {\\n \\\"id\\\": \\\"a177be61-8850-4f03-be1c-3ce275f02c1f\\\",\\n \\\"eid\\\": \\\"testuser\\\",\\n \\\"personelId\\\": \\\"123123\\\",\\n \\\"name\\\": \\\"test\\\",\\n \\\"passwordAlgorithm\\\": \\\"SHA256\\\",\\n \\\"password\\\": \\\"123\\\",\\n \\\"email\\\": \\\"test@test.com\\\",\\n \\\"surname\\\": \\\"user\\\",\\n \\\"internal\\\": true,\\n \\\"properties\\\": {\\n \\\"phoneNumber\\\": \\\"5550000000\\\",\\n \\\"ubaThreshold\\\": \\\"50\\\"\\n },\\n \\\"groups\\\": [\\n \\\"DEFAULT_GROUP_SYSYEM_ADMINS\\\",\\n \\\"DEFAULT_GROUP_SYSYEM_USERS\\\"\\n ],\\n \\\"managerGroups\\\": [],\\n \\\"lastLogin\\\": null,\\n \\\"lastLoginIp\\\": null,\\n \\\"recordLimit4Search\\\": null,\\n \\\"passwordDirty\\\": true,\\n \\\"passwordAutoGenerated\\\": false,\\n \\\"phoneNumber\\\": \\\"5550000000\\\",\\n \\\"forceChangePasswordOnNextLogin\\\": false,\\n \\\"lockReason\\\": null,\\n \\\"unlockOnPasswordChanged\\\": false,\\n \\\"unlockTime\\\": null,\\n \\\"tempUserEndTime\\\": null,\\n \\\"tempUserStartTime\\\": null,\\n \\\"tempUser\\\": false,\\n \\\"externalDirectorySource\\\": null,\\n \\\"userPropertyKey4Search\\\": null,\\n \\\"userPropertyValue4Search\\\": null,\\n \\\"locked\\\": false\\n }\\n ],\\n \\\"managers\\\": [\\n {\\n \\\"id\\\": \\\"a177be61-8850-4f03-be1c-3ce275f02c1f\\\",\\n \\\"eid\\\": \\\"testuser\\\",\\n \\\"personelId\\\": \\\"123123\\\",\\n \\\"name\\\": \\\"test\\\",\\n \\\"passwordAlgorithm\\\": \\\"SHA256\\\",\\n \\\"password\\\": \\\"123\\\",\\n \\\"email\\\": \\\"test@test.com\\\",\\n \\\"surname\\\": \\\"user\\\",\\n \\\"internal\\\": true,\\n \\\"properties\\\": {\\n \\\"phoneNumber\\\": \\\"5550000000\\\",\\n \\\"ubaThreshold\\\": \\\"50\\\"\\n },\\n \\\"groups\\\": [\\n \\\"DEFAULT_GROUP_SYSYEM_ADMINS\\\",\\n \\\"DEFAULT_GROUP_SYSYEM_USERS\\\"\\n ],\\n \\\"managerGroups\\\": [],\\n \\\"lastLogin\\\": null,\\n \\\"lastLoginIp\\\": null,\\n \\\"recordLimit4Search\\\": null,\\n \\\"passwordDirty\\\": true,\\n \\\"passwordAutoGenerated\\\": false,\\n \\\"phoneNumber\\\": \\\"5550000000\\\",\\n \\\"forceChangePasswordOnNextLogin\\\": false,\\n \\\"lockReason\\\": null,\\n \\\"unlockOnPasswordChanged\\\": false,\\n \\\"unlockTime\\\": null,\\n \\\"tempUserEndTime\\\": null,\\n \\\"tempUserStartTime\\\": null,\\n \\\"tempUser\\\": false,\\n \\\"externalDirectorySource\\\": null,\\n \\\"userPropertyKey4Search\\\": null,\\n \\\"userPropertyValue4Search\\\": null,\\n \\\"locked\\\": false\\n }\\n ],\\n \\\"realms\\\": null,\\n \\\"deviceRealms\\\": null,\\n \\\"properties\\\": {\\n \\\"passwordTtlMonths\\\": \\\"90\\\"\\n },\\n \\\"recordLimit4Search\\\": null,\\n \\\"groupPropertyKey4Search\\\": null,\\n \\\"groupPropertyValue4Search\\\": null,\\n \\\"filterGroupIdList\\\": null,\\n \\\"passwordTtl\\\": 90,\\n \\\"systemGroup\\\": false,\\n \\\"registrationRole\\\": false,\\n \\\"allowDirectAccess\\\": false,\\n \\\"allowConsoleAccess\\\": false,\\n \\\"containLocalUser4Search\\\": false,\\n \\\"adminGroup\\\": true,\\n \\\"autonomousGroup\\\": false,\\n \\\"approvalRequired\\\": false,\\n \\\"externalDirectorySources\\\": null,\\n \\\"otpEnabled\\\": false\\n}\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "_CYBvzqH5YEW9ywwsCj_a", "code": "curl --location -g --request POST 'http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"id\": \"35a63ea0-e8b1-44f6-9d1a-afdaf54bd609\",\n \"eid\": \"MyGroup\",\n \"description\": \"user group for test purpose\",\n \"users\": [\n {\n \"id\": \"a177be61-8850-4f03-be1c-3ce275f02c1f\",\n \"eid\": \"testuser\",\n \"personelId\": \"123123\",\n \"name\": \"test\",\n \"passwordAlgorithm\": \"SHA256\",\n \"password\": \"123\",\n \"email\": \"test@test.com\",\n \"surname\": \"user\",\n \"internal\": true,\n \"properties\": {\n \"phoneNumber\": \"5550000000\",\n \"ubaThreshold\": \"50\"\n },\n \"groups\": [\n \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"DEFAULT_GROUP_SYSYEM_USERS\"\n ],\n \"managerGroups\": [],\n \"lastLogin\": null,\n \"lastLoginIp\": null,\n \"recordLimit4Search\": null,\n \"passwordDirty\": true,\n \"passwordAutoGenerated\": false,\n \"phoneNumber\": \"5550000000\",\n \"forceChangePasswordOnNextLogin\": false,\n \"lockReason\": null,\n \"unlockOnPasswordChanged\": false,\n \"unlockTime\": null,\n \"tempUserEndTime\": null,\n \"tempUserStartTime\": null,\n \"tempUser\": false,\n \"externalDirectorySource\": null,\n \"userPropertyKey4Search\": null,\n \"userPropertyValue4Search\": null,\n \"locked\": false\n }\n ],\n \"managers\": [\n {\n \"id\": \"a177be61-8850-4f03-be1c-3ce275f02c1f\",\n \"eid\": \"testuser\",\n \"personelId\": \"123123\",\n \"name\": \"test\",\n \"passwordAlgorithm\": \"SHA256\",\n \"password\": \"123\",\n \"email\": \"test@test.com\",\n \"surname\": \"user\",\n \"internal\": true,\n \"properties\": {\n \"phoneNumber\": \"5550000000\",\n \"ubaThreshold\": \"50\"\n },\n \"groups\": [\n \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"DEFAULT_GROUP_SYSYEM_USERS\"\n ],\n \"managerGroups\": [],\n \"lastLogin\": null,\n \"lastLoginIp\": null,\n \"recordLimit4Search\": null,\n \"passwordDirty\": true,\n \"passwordAutoGenerated\": false,\n \"phoneNumber\": \"5550000000\",\n \"forceChangePasswordOnNextLogin\": false,\n \"lockReason\": null,\n \"unlockOnPasswordChanged\": false,\n \"unlockTime\": null,\n \"tempUserEndTime\": null,\n \"tempUserStartTime\": null,\n \"tempUser\": false,\n \"externalDirectorySource\": null,\n \"userPropertyKey4Search\": null,\n \"userPropertyValue4Search\": null,\n \"locked\": false\n }\n ],\n \"realms\": null,\n \"deviceRealms\": null,\n \"properties\": {\n \"passwordTtlMonths\": \"90\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"passwordTtl\": 90,\n \"systemGroup\": false,\n \"registrationRole\": false,\n \"allowDirectAccess\": false,\n \"allowConsoleAccess\": false,\n \"containLocalUser4Search\": false,\n \"adminGroup\": true,\n \"autonomousGroup\": false,\n \"approvalRequired\": false,\n \"externalDirectorySources\": null,\n \"otpEnabled\": false\n}'", "language": "curl" }, { "id": "9rARNLY5ftjep3680GjrI", "code": "var settings = {\r\n \"url\": \"http://{{hostname}}/aioc-rest-web/rest/user/saveUserGroup\",\r\n \"method\": \"POST\",\r\n \"timeout\": 0,\r\n \"headers\": {\r\n \"Content-Type\": \"application/json\"\r\n },\r\n \"data\": JSON.stringify({\"id\":\"35a63ea0-e8b1-44f6-9d1a-afdaf54bd609\",\"eid\":\"MyGroup\",\"description\":\"user group for test purpose\",\"users\":[{\"id\":\"a177be61-8850-4f03-be1c-3ce275f02c1f\",\"eid\":\"testuser\",\"personelId\":\"123123\",\"name\":\"test\",\"passwordAlgorithm\":\"SHA256\",\"password\":\"123\",\"email\":\"test@test.com\",\"surname\":\"user\",\"internal\":true,\"properties\":{\"phoneNumber\":\"5550000000\",\"ubaThreshold\":\"50\"},\"groups\":[\"DEFAULT_GROUP_SYSYEM_ADMINS\",\"DEFAULT_GROUP_SYSYEM_USERS\"],\"managerGroups\":[],\"lastLogin\":null,\"lastLoginIp\":null,\"recordLimit4Search\":null,\"passwordDirty\":true,\"passwordAutoGenerated\":false,\"phoneNumber\":\"5550000000\",\"forceChangePasswordOnNextLogin\":false,\"lockReason\":null,\"unlockOnPasswordChanged\":false,\"unlockTime\":null,\"tempUserEndTime\":null,\"tempUserStartTime\":null,\"tempUser\":false,\"externalDirectorySource\":null,\"userPropertyKey4Search\":null,\"userPropertyValue4Search\":null,\"locked\":false}],\"managers\":[{\"id\":\"a177be61-8850-4f03-be1c-3ce275f02c1f\",\"eid\":\"testuser\",\"personelId\":\"123123\",\"name\":\"test\",\"passwordAlgorithm\":\"SHA256\",\"password\":\"123\",\"email\":\"test@test.com\",\"surname\":\"user\",\"internal\":true,\"properties\":{\"phoneNumber\":\"5550000000\",\"ubaThreshold\":\"50\"},\"groups\":[\"DEFAULT_GROUP_SYSYEM_ADMINS\",\"DEFAULT_GROUP_SYSYEM_USERS\"],\"managerGroups\":[],\"lastLogin\":null,\"lastLoginIp\":null,\"recordLimit4Search\":null,\"passwordDirty\":true,\"passwordAutoGenerated\":false,\"phoneNumber\":\"5550000000\",\"forceChangePasswordOnNextLogin\":false,\"lockReason\":null,\"unlockOnPasswordChanged\":false,\"unlockTime\":null,\"tempUserEndTime\":null,\"tempUserStartTime\":null,\"tempUser\":false,\"externalDirectorySource\":null,\"userPropertyKey4Search\":null,\"userPropertyValue4Search\":null,\"locked\":false}],\"realms\":null,\"deviceRealms\":null,\"properties\":{\"passwordTtlMonths\":\"90\"},\"recordLimit4Search\":null,\"groupPropertyKey4Search\":null,\"groupPropertyValue4Search\":null,\"filterGroupIdList\":null,\"passwordTtl\":90,\"systemGroup\":false,\"registrationRole\":false,\"allowDirectAccess\":false,\"allowConsoleAccess\":false,\"containLocalUser4Search\":false,\"adminGroup\":true,\"autonomousGroup\":false,\"approvalRequired\":false,\"externalDirectorySources\":null,\"otpEnabled\":false}),\r\n};\r\n\r\n$.ajax(settings).done(function (response) {\r\n console.log(response);\r\n});", "language": "javascript" } ], "selectedLanguageId": "OXlPsLxmSJY8sfcau20vE" }, "description": " ", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" } } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://{{hostname}}/aioc-rest-web/rest/user/deleteUserGroup/{groupId}", "name": "Delete Users Group", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "WuSxGutR42eHN6mfyfIJk", "code": "true", "language": "200" } ], "selectedLanguageId": "WuSxGutR42eHN6mfyfIJk" }, "examples": { "languages": [ { "id": "cUUuXif0x7mfC6pzg-VeI", "code": "var client = new RestClient(\"http://{{hostname}}/aioc-rest-web/rest/user/deleteUserGroup/{groupId}\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.GET);\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nrequest.AddParameter(\"application/json\", \"[\\\"35a63ea0-e8b1-44f6-9d1a-afdaf54bd609\\\"]\", ParameterType.RequestBody);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "gMUUw2v4j4ObZ2v-h5EBk", "code": "curl --location -g --request GET 'http://{{hostname}}/aioc-rest-web/rest/user/deleteUserGroup/{groupId}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\"35a63ea0-e8b1-44f6-9d1a-afdaf54bd609\"]'", "language": "curl" }, { "id": "QDHioOa9C_aZWU_ahFsm7", "code": "var settings = {\r\n \"url\": \"http://{{hostname}}/aioc-rest-web/rest/user/deleteUserGroup/{groupId}\",\r\n \"method\": \"GET\",\r\n \"timeout\": 0,\r\n \"headers\": {\r\n \"Content-Type\": \"application/json\"\r\n },\r\n \"data\": JSON.stringify([\"35a63ea0-e8b1-44f6-9d1a-afdaf54bd609\"]),\r\n};\r\n\r\n$.ajax(settings).done(function (response) {\r\n console.log(response);\r\n});", "language": "javascript" } ], "selectedLanguageId": "cUUuXif0x7mfC6pzg-VeI" }, "description": " ", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" } } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://{{hostname}}/aioc-rest-web/rest/user/groupDetail/USERGROUPID", "name": "Get UserGroup Details By Id", "method": "GET", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "O0HHhzETvBFJkw2wHj5Kk", "code": "{\n \"id\": \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"eid\": \"System.admins\",\n \"description\": \"Single Connect system admin group\",\n \"users\": [\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\",\n \"personelId\": null,\n \"name\": \"Administrator\",\n \"passwordAlgorithm\": null,\n \"password\": \"21232f297a57a5a743894a0e4a801fc3\",\n \"email\": \"admin@kron.com.tr\",\n \"surname\": \"Administrator\",\n \"internal\": true,\n \"properties\": {\n \"ubaThreshold\": \"50\",\n \"phoneNumber\": \"05301494892\"\n },\n \"groups\": [\n \"DEFAULT_GROUP_SYSYEM_USERS\",\n \"b5f97131-344f-40a9-baed-b4ac88bee9ed\",\n \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"1bd23223-8418-4e08-9f8c-0cbf2a9c580a\"\n ],\n \"managerGroups\": [\n \"b5f97131-344f-40a9-baed-b4ac88bee9ed\",\n \"1bd23223-8418-4e08-9f8c-0cbf2a9c580a\"\n ],\n \"lastLogin\": 1614303736600,\n \"lastLoginIp\": \"10.xx.xx.xx\",\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"recordLimit4Search\": null,\n \"passwordDirty\": false,\n \"passwordAutoGenerated\": false,\n \"filterFunctionName\": null,\n \"filterMembershipUserId\": null,\n \"filterManagerId\": null,\n \"filterEidList\": null,\n \"filterManagerOfUserId\": null,\n \"unlockOnPasswordChanged\": false,\n \"unlockTime\": null,\n \"tempUserEndTime\": null,\n \"tempUserStartTime\": null,\n \"tempUser\": false,\n \"externalDirectorySource\": null,\n \"userPropertyKey4Search\": null,\n \"userPropertyValue4Search\": null,\n \"phoneNumber\": \"05301494892\",\n \"forceChangePasswordOnNextLogin\": false,\n \"lockReason\": null,\n \"locked\": false\n }\n ],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [\n 1,\n 971500,\n 3380959\n ],\n \"properties\": {\n \"adminGroup\": \"true\",\n \"otpEnabled\": \"false\",\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false,\n \"registrationRole\": false,\n \"allowConsoleAccess\": false,\n \"adminGroup\": true,\n \"autonomousGroup\": false,\n \"approvalRequired\": false,\n \"externalDirectorySources\": null,\n \"otpEnabled\": false,\n \"passwordTtl\": null,\n \"systemGroup\": true,\n \"allowDirectAccess\": false\n}", "language": "200" } ], "selectedLanguageId": "O0HHhzETvBFJkw2wHj5Kk" }, "examples": { "languages": [ { "id": "d54YZ25UnDbzi8lKruLmu", "code": "var client = new RestClient(\"http://{{hostname}}/aioc-rest-web/rest/user/groupDetail/DEFAULT_GROUP_SYSYEM_ADMINS\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.GET);\r\nrequest.AddHeader(\"Content-Type\", \"application/json\");\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "Yvoe6Zt2DXb2Lirq974Ez", "code": "curl --location -g --request GET 'http://{{hostname}}/aioc-rest-web/rest/user/groupDetail/DEFAULT_GROUP_SYSYEM_ADMINS' \\\n--header 'Content-Type: application/json'", "language": "curl" }, { "id": "8O8Qz2FD2Vsudrx2-dhO6", "code": "var settings = {\r\n \"url\": \"http://{{hostname}}/aioc-rest-web/rest/user/groupDetail/DEFAULT_GROUP_SYSYEM_ADMINS\",\r\n \"method\": \"GET\",\r\n \"timeout\": 0,\r\n \"headers\": {\r\n \"Content-Type\": \"application/json\"\r\n },\r\n};\r\n\r\n$.ajax(settings).done(function (response) {\r\n console.log(response);\r\n});", "language": "javascript" } ], "selectedLanguageId": "d54YZ25UnDbzi8lKruLmu" }, "description": " ", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" } } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://{{hostname}}/aioc-rest-web/rest/user/allGroups", "name": "Get All Users Group", "method": "GET", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "JWQdKOjsmV66hpPb0D0dc", "code": "[\n {\n \"id\": \"DnsAdmins\",\n \"eid\": \"DnsAdmins\",\n \"description\": \"DNS Administrators Group\",\n \"users\": [],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [\n 1598088\n ],\n \"properties\": {\n \"externalDirectorySources\": \"ldap\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false,\n \"registrationRole\": false,\n \"allowConsoleAccess\": false,\n \"adminGroup\": false,\n \"autonomousGroup\": false,\n \"approvalRequired\": false,\n \"externalDirectorySources\": \"ldap\",\n \"otpEnabled\": false,\n \"passwordTtl\": null,\n \"systemGroup\": false,\n \"allowDirectAccess\": false\n },x\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"eid\": \"System.admins\",\n \"description\": \"Single Connect system admin group\",\n \"users\": [\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\",\n \"personelId\": null,\n \"name\": \"Administrator\",\n \"passwordAlgorithm\": null,\n \"password\": \"21232f297a57a5a743894a0e4a801fc3\",\n \"email\": \"admin@kron.com.tr\",\n \"surname\": \"Administrator\",\n \"internal\": true,\n \"properties\": {\n \"ubaThreshold\": \"50\",\n \"phoneNumber\": \"05301494892\"\n },\n \"groups\": [\n \"DEFAULT_GROUP_SYSYEM_USERS\",\n \"b5f97131-344f-40a9-baed-b4ac88bee9ed\",\n \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"1bd23223-8418-4e08-9f8c-0cbf2a9c580a\"\n ],\n \"managerGroups\": [\n \"b5f97131-344f-40a9-baed-b4ac88bee9ed\",\n \"1bd23223-8418-4e08-9f8c-0cbf2a9c580a\"\n ],\n \"lastLogin\": 1614303736600,\n \"lastLoginIp\": \"10.xx.xx.xx\",\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"recordLimit4Search\": null,\n \"passwordDirty\": false,\n \"passwordAutoGenerated\": false,\n \"filterFunctionName\": null,\n \"filterMembershipUserId\": null,\n \"filterManagerId\": null,\n \"filterEidList\": null,\n \"filterManagerOfUserId\": null,\n \"unlockOnPasswordChanged\": false,\n \"unlockTime\": null,\n \"tempUserEndTime\": null,\n \"tempUserStartTime\": null,\n \"tempUser\": false,\n \"externalDirectorySource\": null,\n \"userPropertyKey4Search\": null,\n \"userPropertyValue4Search\": null,\n \"phoneNumber\": \"05301494892\",\n \"forceChangePasswordOnNextLogin\": false,\n \"lockReason\": null,\n \"locked\": false\n }\n ],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [\n 1,\n 971500,\n 3380959\n ],\n \"properties\": {\n \"adminGroup\": \"true\",\n \"otpEnabled\": \"false\",\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false,\n \"registrationRole\": false,\n \"allowConsoleAccess\": false,\n \"adminGroup\": true,\n \"autonomousGroup\": false,\n \"approvalRequired\": false,\n \"externalDirectorySources\": null,\n \"otpEnabled\": false,\n \"passwordTtl\": null,\n \"systemGroup\": true,\n \"allowDirectAccess\": false\n }\n]", "language": "200" } ], "selectedLanguageId": "JWQdKOjsmV66hpPb0D0dc" }, "examples": { "languages": [ { "id": "gyX-kSx5GlBDFYsnyy_UV", "code": "var client = new RestClient(\"http://{{hostname}}/aioc-rest-web/rest/user/allGroups\");\r\nclient.Timeout = -1;\r\nvar request = new RestRequest(Method.GET);\r\nIRestResponse response = client.Execute(request);\r\nConsole.WriteLine(response.Content);", "language": "csharp" }, { "id": "6c27NbHEtEY48HLRgAEC8", "code": "curl --location -g --request GET 'http://{{hostname}}/aioc-rest-web/rest/user/allGroups'", "language": "curl" }, { "id": "3-yuH35tJIro6_KeliKRf", "code": "var settings = {\r\n \"url\": \"http://{{hostname}}/aioc-rest-web/rest/user/allGroups\",\r\n \"method\": \"GET\",\r\n \"timeout\": 0,\r\n};\r\n\r\n$.ajax(settings).done(function (response) {\r\n console.log(response);\r\n});", "language": "javascript" } ], "selectedLanguageId": "gyX-kSx5GlBDFYsnyy_UV" }, "description": " ", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" } } ``` :::