Sign in

v1

latestOpenAPI 3.0.12026-08-06151265417.9 KB
Administration - Groups

Get All Organization Groups

Returns a list of all groups within an organization

get/api/v3.0/orgs/{orgUuid}/groups

Path parameters

orgUuidstring required

org UUID (from the Mend App: Administration General > Organization UUID).

Query parameters

cursorstring

Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.

limitstring

Specifies the maximum number of items to be returned in the response.

Response

OK

additionalDataobject
  • totalItems: The total count of data points returned in an API response.
supportTokenstring

Example response

{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426655440000",
      "name": "Group A",
      "description": "Group description",
      "users": 22,
      "affectedApplications": 5,
      "roles": [
        {
          "scopeUuid": "123e4567-e89b-12d3-a456-426655440000",
          "scopeName": "My Project",
          "scopeType": "organization"
        }
      ]
    }
  ]
}