Get local groups for a virtual server
Get a list of the local security groups for a virtual server.
There are always some predefined local groups that are always present, but any additional local groups are only created once members are added to them.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/local-groups
Parameters
Name | Type | Required | Values | Description |
virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
Return codes
Code | Data | Description |
200 | localGroups | Local groups retrieved successfully. |
400 | Error Message | Missing or invalid request contents. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 200 indicates that the API did not complete successfully.
Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/1/local-groups
Response example
HTTP/1.1 200 OK { "localGroups": [ { "context": "GLOBAL", "groupName": "Administrators", "groupSid": "S-1-5-32-544", "objectId": "303a3a3a532d312d352d33322d3534343a3a3a303a3a3a4f49445f24232140255f56" }, { "context": "GLOBAL", "groupName": "Backup Operators", "groupSid": "S-1-5-32-551", "objectId": "303a3a3a532d312d352d33322d3535313a3a3a303a3a3a4f49445f24232140255f56" }, { "context": "GLOBAL", "groupName": "Root Users", "groupSid": "S-1-5-32-21060", "objectId": "303a3a3a532d312d352d33322d32313036303a3a3a303a3a3a4f49445f24232140255f56" }, { "context": "GLOBAL", "groupName": "Unix group\\512", "groupSid": "S-1-77-1-512", "objectId": "303a3a3a532d312d37372d312d3531323a3a3a303a3a3a4f49445f24232140255f56" } ] }