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 50
Request
URI
GET
https://{api_host}/vco/api/server/groups
COPY
Query Parameters
string
filter
Optional
filter
integer
maxResult
Optional
Constraints:
default: 50
maxResult
Responses
200
The request is successful
Returns
WsUserGroupsList
of type(s)
application/json
{
"groups": [
{
"relations": {
"startIndex": 0,
"count": 0,
"total": 0,
"link": [
{
"rel": "string",
"type": "string",
"attributes": [
{
"name": "string",
"displayName": "string",
"value": "string",
"displayValue": "string"
}
],
"href": "string"
}
]
},
"commonName": "string",
"distinguishedName": "string",
"info": "string",
"sid": "string",
"email": "string",
"href": "string",
"display-name": "string"
}
],
"partial-result": false
}
array of
object
groups
Optional
groups
boolean
partial-result
Optional
partial-result
401
The user is not authorized.
Returns
WsUserGroupsList
of type(s)
application/json
"WsUserGroupsList Object"
array of
object
groups
Optional
groups
boolean
partial-result
Optional
partial-result
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/server/groups
Vcf Operations Orchestrator Server Instance Service Operations
GET
Enumerate Services
GET
Get Users
GET
Get Groups
GET
Get Authentication
GET
Search For User And Groups By Criteria