List Users Using GET 1

Get a list of users. Supported selectors: firstName, lastName, email, status.

Pre-authorized roles: Administrator

Request

URI

GET

https://{api_host}//vcp.vmware.com/api/aggregator/v1/users

COPY

Query Parameters

string

filter

Optional

FIQL format

integer

limit

Optional

limit

integer

offset

Optional

offset

string

sort

Optional

sort

Responses

200

Returns PageOfUser of type(s) application/json

{
    "content": [
        {
            "id": "8dec8aaa-xxxx-xxxx-xxxx-760aa839aeb3",
            "firstName": "James",
            "lastName": "Smith",
            "email": "[email protected]",
            "status": "ACTIVE",
            "roles": [
                {
                    "id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
                    "name": "Administrator"
                }
            ]
        }
    ],
    "total": 1
}

array of User

content

Optional

content

integer As int64 As int64

total

Optional

total

400

Bad Request

Operation doesn't return any data structure

401