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
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 UserGroups of type(s) application/json;version=39.1
This response body class contains all of the following: InlineUserGroups0 , 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"
        }
    ]
}

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