--- title: List All User Groups slug: kronpam-api-collection-350/list-all-user-groups docTags: createdAt: 2024-07-22T09:58:47.220Z --- { "id": "I9Gdt6xBtZ7gHii7v--eN", "type": "api-oas-v2", "data": { "method": "GET", "url": "{{url}}/aioc-rest-web/rest/user/searchUserGroups", "name": "", "description": "

Overview

\n

This method responds to all registered user groups with whom requestor is authorized to see in detail.

", "contentType": "application/json", "request": { "headerParameters": [ { "name": "X-XSRF-TOKEN", "description": "", "default": "{{csrftoken}}", "value": "{{csrftoken}}", "type": "string" } ], "queryParameters": [], "pathParameters": [ { "name": "url", "description": "", "default": "url", "value": "url", "type": "string" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "List All User Groups", "jsonExample": "[\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_USERS\",\n \"eid\": \"System.users\",\n \"description\": \"Default user group\",\n \"users\": [\n {\n \"id\": \"d41dc066-68cc-438d-bfff-70e213a3949c\",\n \"eid\": \"test\"\n },\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\"\n },\n {\n \"id\": \"1424250e-647c-4cd5-a6ba-9804c07e02e6\",\n \"eid\": \"testManager\"\n }\n ],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [\n 1\n ],\n \"properties\": {\n \"allowDirectAccess\": \"true\",\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"e5968108-ed9b-4c16-9688-cf687b0893ac\",\n \"eid\": \"manager\",\n \"description\": null,\n \"users\": [\n {\n \"id\": \"1424250e-647c-4cd5-a6ba-9804c07e02e6\",\n \"eid\": \"testManager\"\n }\n ],\n \"managers\": [\n {\n \"id\": \"1424250e-647c-4cd5-a6ba-9804c07e02e6\",\n \"eid\": \"testManager\"\n }\n ],\n \"realms\": [],\n \"deviceRealms\": [\n 9447\n ],\n \"properties\": {\n \"adminGroup\": \"false\",\n \"autonomousGroup\": \"false\",\n \"allowConsoleAccess\": \"false\",\n \"allowDirectAccess\": \"false\",\n \"approvalRequiredForConnection\": \"false\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_LI_USERS\",\n \"eid\": \"System.li\",\n \"description\": \"Default system LI users group\",\n \"users\": [],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [],\n \"properties\": {\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"896b64cf-22d5-45aa-97c9-a70c7147357d\",\n \"eid\": \"test\",\n \"description\": null,\n \"users\": [\n {\n \"id\": \"d41dc066-68cc-438d-bfff-70e213a3949c\",\n \"eid\": \"test\"\n }\n ],\n \"managers\": [\n {\n \"id\": \"d41dc066-68cc-438d-bfff-70e213a3949c\",\n \"eid\": \"test\"\n }\n ],\n \"realms\": [],\n \"deviceRealms\": [\n 9447\n ],\n \"properties\": {\n \"adminGroup\": \"false\",\n \"autonomousGroup\": \"false\",\n \"allowConsoleAccess\": \"false\",\n \"allowDirectAccess\": \"false\",\n \"approvalRequiredForConnection\": \"false\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"eid\": \"System.admins\",\n \"description\": \"Default system admin group\",\n \"users\": [\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\"\n }\n ],\n \"managers\": [\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\"\n }\n ],\n \"realms\": [],\n \"deviceRealms\": [],\n \"properties\": {\n \"adminGroup\": \"true\",\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n }\n]" } ], "examples": { "languages": [ { "id": "EnRAoyrr1XeACG5dAPFMh", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url {{url}}/aioc-rest-web/rest/user/searchUserGroups \\\n --header 'accept: application/json' \\\n --header 'x-xsrf-token: {{csrftoken}}'" }, { "id": "VuXRCwqCZg9XZf9YnfTk4", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-xsrf-token\", \"{{csrftoken}}\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"{{url}}/aioc-rest-web/rest/user/searchUserGroups\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kWDUrG4NBtzBUYV92La3-", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"{{url}}/aioc-rest-web/rest/user/searchUserGroups\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-xsrf-token\"] = \"{{csrftoken}}\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "VGCm3KGJWEKpRb04f9IXF", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"{{url}}/aioc-rest-web/rest/user/searchUserGroups\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-xsrf-token': '{{csrftoken}}'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "EnRAoyrr1XeACG5dAPFMh" }, "results": { "languages": [ { "id": "BMAvRhxCaZtmpLGtjyXGz", "language": "200", "code": "[\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_USERS\",\n \"eid\": \"System.users\",\n \"description\": \"Default user group\",\n \"users\": [\n {\n \"id\": \"d41dc066-68cc-438d-bfff-70e213a3949c\",\n \"eid\": \"test\"\n },\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\"\n },\n {\n \"id\": \"1424250e-647c-4cd5-a6ba-9804c07e02e6\",\n \"eid\": \"testManager\"\n }\n ],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [\n 1\n ],\n \"properties\": {\n \"allowDirectAccess\": \"true\",\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"e5968108-ed9b-4c16-9688-cf687b0893ac\",\n \"eid\": \"manager\",\n \"description\": null,\n \"users\": [\n {\n \"id\": \"1424250e-647c-4cd5-a6ba-9804c07e02e6\",\n \"eid\": \"testManager\"\n }\n ],\n \"managers\": [\n {\n \"id\": \"1424250e-647c-4cd5-a6ba-9804c07e02e6\",\n \"eid\": \"testManager\"\n }\n ],\n \"realms\": [],\n \"deviceRealms\": [\n 9447\n ],\n \"properties\": {\n \"adminGroup\": \"false\",\n \"autonomousGroup\": \"false\",\n \"allowConsoleAccess\": \"false\",\n \"allowDirectAccess\": \"false\",\n \"approvalRequiredForConnection\": \"false\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_LI_USERS\",\n \"eid\": \"System.li\",\n \"description\": \"Default system LI users group\",\n \"users\": [],\n \"managers\": [],\n \"realms\": [],\n \"deviceRealms\": [],\n \"properties\": {\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"896b64cf-22d5-45aa-97c9-a70c7147357d\",\n \"eid\": \"test\",\n \"description\": null,\n \"users\": [\n {\n \"id\": \"d41dc066-68cc-438d-bfff-70e213a3949c\",\n \"eid\": \"test\"\n }\n ],\n \"managers\": [\n {\n \"id\": \"d41dc066-68cc-438d-bfff-70e213a3949c\",\n \"eid\": \"test\"\n }\n ],\n \"realms\": [],\n \"deviceRealms\": [\n 9447\n ],\n \"properties\": {\n \"adminGroup\": \"false\",\n \"autonomousGroup\": \"false\",\n \"allowConsoleAccess\": \"false\",\n \"allowDirectAccess\": \"false\",\n \"approvalRequiredForConnection\": \"false\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n },\n {\n \"id\": \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n \"eid\": \"System.admins\",\n \"description\": \"Default system admin group\",\n \"users\": [\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\"\n }\n ],\n \"managers\": [\n {\n \"id\": \"25e53f47-ce66-4df2-9abc-6961dc668264\",\n \"eid\": \"admin\"\n }\n ],\n \"realms\": [],\n \"deviceRealms\": [],\n \"properties\": {\n \"adminGroup\": \"true\",\n \"systemGroup\": \"true\"\n },\n \"recordLimit4Search\": null,\n \"groupPropertyKey4Search\": null,\n \"groupPropertyValue4Search\": null,\n \"filterGroupIdList\": null,\n \"containLocalUser4Search\": false\n }\n]" } ], "selectedLanguageId": "BMAvRhxCaZtmpLGtjyXGz" } }, "children": [ { "text": "" } ] }