BAballerina-platform
Groups Endpoint

Filter Groups

This API returns groups according to the specified filter, sort, and pagination parameters.

  • <b>Scope(Permission) required:</b> internal_group_mgt_view

  • <b>Flow type:</b> Client Credentials OAuth Flow

get/Groups

Request

Query parameters

attributesstring

SCIM defined attributes parameter.

excludedAttributesstring

SCIM defined excludedAttribute parameter.

filterstring

Filter expression for filtering

startIndexinteger

The 1-based index of the first query result

countinteger

Specifies the desired maximum number of query results per page.

domainstring

The name of the user store where filtering needs to be applied.

Response

Valid groups are found / No Group found

totalResultsinteger
startIndexinteger
itemsPerPageinteger
schemasstring[]

Example response

{
  "totalResults": 3,
  "startIndex": 1,
  "itemsPerPage": 3,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "displayName": "DEFAULT/manager",
      "meta": {
        "created": "2019-08-26T14:27:36.000Z",
        "location": "https://api.asgardeo.io/t/{org-name}/scim2/Groups/7bac6a86-1f21-4937-9fb1-5be4a93ef469",
        "lastModified": "2019-08-26T14:27:36.000Z"
      },
      "members": [
        {
          "$ref": "https://api.asgardeo.io/t/{org-name}/scim2/Users/3a12bae9-4386-44be-befd-caf349297f45",
          "display": "kim",
          "value": "008bba85-451d-414b-87de-c03b5a1f4217"
        }
      ],
      "roles": [
        {
          "$ref": "https://api.asgardeo.io/t/{org-name}/scim2/Roles/4645709c-ea8c-4495-8590-e1fa0efe3de0",
          "display": "loginRole",
          "value": "4645709c-ea8c-4495-8590-e1fa0efe3de0"
        }
      ],
      "id": "7bac6a86-1f21-4937-9fb1-5be4a93ef469"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.