Skip to content

get-all-groups.md

Latest commit

 

History

History
105 lines (84 loc) · 2.68 KB

get-all-groups.md

File metadata and controls

105 lines (84 loc) · 2.68 KB
sidebar_position 17

Get all groups

Description

Gets a list of all groups in CloudShell.

URL

http://{Admin API IP}:{port#}/api/v1/groups

HTTP method

GET

Request

Headers

Example header format:

Authorization: Basic <authorization token returned from the login method>

Content-Type: application/json

Query parameters
Parameter Description/Comments
paginationProperties.limit (integer) Number of results to return per page. Can retrieve up to 250 results per page. Default if unspecified: 50. Optional.
Default value : 50
paginationProperties.sort-by (string) Field to use to sort the results.
Default value : Name
paginationProperties.sort-order (integer) 1 for ascending, -1 for descending. Defaults to ascending. Optional.
Default value : 1
paginationProperties.cursor (string) When paging, the response will include a cursor field. Use the cursor to get next set of results. Optional.
paginationProperties.filter (string) String to use to filter for domains containing this string. For example: "lab" would return lab1, testlab, olabo. Optional.

Response

Response example 
{
    "Groups": [
        {
            "ParentIds": null,
            "Sid": "fa414b79-174f-4906-9c95-976caf363864",
            "Name": "System Administrators",
            "Description": "Built in group, all members have administrative rights.",
            "ViewOnly": false,
            "groupType": "System",
            "groupRole": "SystemAdmin",
            "Id": -1
        },
        {
            "ParentIds": null,
            "Sid": "88fc9928-a1f3-45c3-99cd-45a46d256592",
            "Name": "Everyone",
            "Description": null,
            "ViewOnly": false,
            "groupType": "System",
            "groupRole": "Regular",
            "Id": 1
        },
        {
            "ParentIds": null,
            "Sid": "1c7a0c13-600e-43ae-ab2d-6f594e245912",
            "Name": "domain admin",
            "Description": null,
            "ViewOnly": false,
            "groupType": "UserDefined",
            "groupRole": "DomainAdmin",
            "Id": 2
        },
        {
            "ParentIds": null,
            "Sid": "a2bf342a-5883-4e1a-87a5-5bb6e13b421b",
            "Name": "regular users",
            "Description": null,
            "ViewOnly": false,
            "groupType": "UserDefined",
            "groupRole": "Regular",
            "Id": 3
        }
    ],
    "Cursor": null
}
Response code 
200 OK