Query Users

Query Users

Get a list of users.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/users
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VcdUsers of type(s) application/json;version=39.1
This response body class contains all of the following: Page , InlineVcdUsers1 
{
    "0": "P",
    "1": "a",
    "2": "g",
    "3": "e",
    "4": " ",
    "5": "O",
    "6": "b",
    "7": "j",
    "8": "e",
    "9": "c",
    "10": "t",
    "values": [
        {
            "username": "string",
            "fullName": "string",
            "description": "string",
            "id": "string",
            "roleEntityRefs": [
                {
                    "name": "string",
                    "id": "string"
                }
            ],
            "orgEntityRef": {
                "name": "string",
                "id": "string"
            },
            "password": "string",
            "deployedVmQuota": 0,
            "storedVmQuota": 0,
            "email": "string",
            "nameInSource": "string",
            "enabled": false,
            "isGroupRole": false,
            "providerType": "string",
            "locked": false,
            "stranded": false,
            "phone": "string"
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/users?page=value&pageSize=v
Availability
Added in 35.0
On This Page
User Operations
GET
Query Users
POST
Create User
GET
Get User
PUT
Update User
DELETE
Delete User
GET
Query User Groups
POST
Change Password
POST
Take Ownership