BAballerina-platform
Groups Endpoint

Search Groups

Changed on

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

post/Groups/.search

Request

Request body

schemasstring[] required
startIndexinteger
filterstring

Example request

{
  "startIndex": 1,
  "filter": "displayName eq manager"
}

Response

Valid groups are found / Valid groups are not found

totalResultsinteger
startIndexinteger
itemsPerPageinteger
schemasstring[]

Example response

{
  "totalResults": 1,
  "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

  • 7978594f207eRevision changes
    • breaking

      the request property became required

    • breaking

      the request property type changed from object to array

  • d290ee2c70fcRevision changes
    • breaking

      the request property type changed from array to object

    • info

      the request property became optional