GET Users by Filter

Description: This API will fetch users' details when you add a filter query parameter in the form of filter=userName eq "username". When a filter is not provided, the response will contain all users. For more information, see GET Users by Filter

Usage: GET /api/v1/scim/v2/Users?filter=userName eq “username”

Query parameters (optional): ?filter=userName eq “username”

Produces: application/scim+json; charset=UTF-8

Header parameter: Authorization: Bearer

Sample response:

200 - OK - user exists

{
   "totalResults": 1,
   "itemsPerPage": 20,
   "startIndex": 1,
   "Resources": [
       {
           "id": "bjensenexamplecom",
           "userName": "bjensenexamplecom",
           "active": true,
           "emails": [
               {
                   "primary": true,
                   "value": "bjensen@wso2.com"
               }
           ],
           "groups": [
               {
                   "value": "readers"
               }
           ],
           "schemas": [
               "urn:ietf:params:scim:schemas:core:2.0:User"
           ],
           "meta": {
               "resourceType": "User"
           }
       }
   ],
   "schemas": [
       "urn:ietf:params:scim:api:messages:2.0:ListResponse"
   ]
}

Sample response when user does not exist:

200 - OK - user does not exist

{
   "totalResults": 0,
   "itemsPerPage": 20,
   "startIndex": 1,
   "Resources": [],
   "schemas": [
       "urn:ietf:params:scim:api:messages:2.0:ListResponse"
   ]
}