Query Groups

Query Groups

Get a list of groups.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/groups
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

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserGroups of type(s) application/json;version=36.2
This response body class contains all of the following: Page , InlineUserGroups1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "name": "string",
            "id": "string",
            "description": "string",
            "orgEntityRef": {
                "name": "string",
                "id": "string"
            },
            "sourceEntityRef": {
                "name": "string",
                "id": "string"
            },
            "roleEntityRef": {
                "name": "string",
                "id": "string"
            },
            "nameInSource": "string",
            "providerType": "string"
        }
    ]
}

Availability
Added in 35.0
On This Page
Group Operations
POST
Create Group
DELETE
Delete Group
GET
Get Group
GET
Query Groups
GET
Query Group Users
PUT
Update Group