List Groups

Retrieve a list of Groups.

GET

/api/scim/v2/Groups

Headers

Key	Value
Accept	application/json
Authorization	Bearer <API Token>

Query parameters

Parameter	Type	Description
startIndex (optional)	Integer	Index of the first group to be returned
count (optional)	Integer	Number of groups to be returned

Example cURL

curl --location 'http://localhost:8080/api/scim/v2/Groups?startIndex=0&count=10' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

Responses

Status Code	Description	Response
200	List of groups	application/json
400	Invalid Request	empty
401	Unauthorized	empty
500	Internal Server Error	empty

Sample response

200 : List of groups

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "startIndex": 1,
    "totalResults": 3,
    "itemsPerPage": 3,
    "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "Resources": [
        {
            "id": "1234",
            "displayName": "Administrators",
            "members": [
                {
                    "value": 1,
                    "display": "user1@example.com"
                },
                {
                    "value": 2,
                    "display": "user2@example.com"
                }
            ],
            "meta": {
                "location": "http://localhost:8080/api/scim/v2/Groups/group-1",
                "created": "2023-08-04T08:38:02.3732123Z"
            }
        },
        {
            "id": "345",
            "displayName": "Developers",
            "members": [
                {
                    "value": 3,
                    "display": "user3@example.com"
                }
            ],
            "meta": {
                "location": "http://localhost:8080/api/scim/v2/Groups/group-2",
                "created": "2023-08-04T08:38:02.3732123Z"
            }
        },
        {
            "id": "487",
            "displayName": "Testers",
            "members": [
                {
                    "value": 4,
                    "display": "user4@example.com"
                },
                {
                    "value": 5,
                    "display": "user5@example.com"
                },
                {
                    "value": 6,
                    "display": "user6@example.com"
                }
            ],
            "meta": {
                "location": "http://localhost:8080/api/scim/v2/Groups/group-3",
                "created": "2023-08-04T08:38:02.3732123Z"
            }
        }
    ]
}