Get Paginated Org Users Info

Get Paginated Org Users Info

Get response encapsulating organization users.

Fetched page is according to the page start and page limit passed as optional parameters. Defaults to page size of 20 and start from the first page. Note that pageStart is 1-based index.

We are currently not supporting the optional serviceDefinitionId which is to filter users having access to a service in CSP.

Request
URI
GET
https://sc2-10-185-6-200.eng.vmware.com//csp/gateway/am/api/orgs/{orgId}/users
COPY
Path Parameters
string
orgId
Required

orgId

Query Parameters
string
serviceDefinitionId
Optional

serviceDefinitionId

integer
pageStart
Optional

pageStart

integer
pageLimit
Optional

pageLimit

Header Parameters
string
Authorization
Optional

Authorization

string
csp-auth-token
Optional

csp-auth-token


Responses
200

default response

Returns PagedResponseExpandedTypedUser of type(s) */*
{
    "results": [
        {
            "user": {
                "username": "string",
                "firstName": "string",
                "lastName": "string",
                "domain": "string",
                "idpId": "string",
                "accessible": false
            },
            "orgId": "string",
            "organizationRoles": [
                {
                    "id": "string",
                    "name": "string",
                    "displayName": "string",
                    "membershipType": "string"
                }
            ],
            "serviceRoles": [
                {
                    "serviceDefinitionId": "string",
                    "serviceRoles": [
                        {
                            "roleName": "string",
                            "roleDisplayName": "string",
                            "membershipType": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "nextLink": "string",
    "prevLink": "string",
    "totalResults": 0
}
results
Optional

The list of results.

string
nextLink
Optional

URL to the next page of results.

string
prevLink
Optional

URL to the previous page of result.

integer As int32 As int32
totalResults
Optional

The total number of results on all pages.