List Users

Retrieve a list of users based on the provided email filter

GET

/api/scim/v2/Users

Headers

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

Query parameters

Parameter	Type	Description
filter (optional)	String	Query for filtering documents. eg. userEmail eq "user@example.com"
startIndex (optional)	Integer	Index of the first user to be returned
count (optional)	Integer	Number of users to be returned

Example cURL

curl --location 'http://localhost:8080/api/scim/v2/Users?filter=userEmail eq "user@example.com"&startIndex=0&count=10' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

Responses

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

Sample response

200 : Success

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "Resources": [
        {
            "groups": [
                {
                    "display": "Default",
                    "value": 3966
                }
            ],
            "emails": [
                {
                    "value": "user@example.com",
                    "primary": true
                }
            ],
            "meta": {
                "location": "http://localhost:8080/api/scim/v2/Users/563504",
                "created": "2023-08-04T08:38:02.3732123Z"
            },
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "name": {
                "givenName": null,
                "familyName": null
            },
            "photos": [],
            "nickName": null,
            "userName": "user@example.com",
            "displayName": "Rishabh Jain",
            "externalId": null,
            "timezone": null,
            "title": null,
            "active": true,
            "profileUrl": "",
            "id": "563504"
        }
    ],
    "startIndex": 1,
    "totalResults": 50,
    "itemsPerPage": 1
}