Get Users

Get Users

A REST endpoint for getting all available users that can be used for setting permissions. If maxResult requestparameters is not used the groups returned will be limited to 50

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

filter

integer
maxResult
Optional
Constraints: default: 50

maxResult


Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns WsUsersList of type(s) application/json
{
    "users": [
        {
            "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",
            "email": "string",
            "href": "string",
            "display-name": "string"
        }
    ],
    "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",
            "email": "string",
            "href": "string",
            "display-name": "string"
        }
    ],
    "partial-result": false
}
array of object
users
Optional

users

array of object
groups
Optional

groups

boolean
partial-result
Optional

partial-result


401

The user is not authorized.

Returns WsUsersList of type(s) application/json
"WsUsersList Object"
array of object
users
Optional

users

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/users