Get Groups

Get Groups

A REST endpoint for getting all available user groups that can be used for setting permissions. If maxResult request parameters is not used the groups returned will be limited to 200.

Request
URI
GET
https://{api_host}/vco/api/server/groups
COPY
Query Parameters
string
filter
Optional

filter

integer
maxResult
Required

maxResult


Responses
200

The request is successful

Returns user-groups of type(s) application/json
{
    "groups": [
        {
            "display-name": "string",
            "cn": "string",
            "dn": "string",
            "info": "string",
            "sid": "string",
            "email": "string",
            "href": "string",
            "relations": {
                "total": 0,
                "start": 0,
                "link": [
                    {
                        "attribute": [
                            {
                                "displayValue": "string",
                                "value": "string",
                                "name": "string"
                            }
                        ],
                        "href": "string",
                        "type": "string",
                        "rel": "string"
                    }
                ]
            }
        }
    ],
    "partial-result": false
}
array of user-group
groups
Optional

groups

boolean
partial-result
Optional

partial-result


401

The user is not authorized.

Operation doesn't return any data structure