Users Endpoint

Filter Users

Changed on Jul 17, 2026

This API returns users according to the filter, sort and pagination parameters. Pagination is not supported across user stores and LDAP multi-attribute group filtering. However, filtering is supported across multiple user stores.

<b>Scope(Permission) required:</b> internal_user_mgt_list
<b>Flow type:</b> Client Credentials OAuth Flow

get/Users

Request

Base URL
https://api.asgardeo.io/t//scim2
Auth
OAuth 2
Client credentials
TypeScript
https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/docs/Users/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

attributesstring

SCIM defined attributes parameter.

excludedAttributesstring

SCIM defined excludedAttribute parameter.

filterstring

The expression used for filtering. Supported filters are ‘Ew’, ‘Eq’, ‘Co’, ‘Sw’, ‘Ne’ and ‘and’.

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 users are found / Valid users are not found

totalResultsinteger

startIndexinteger

itemsPerPageinteger

schemasstring[]

Example response

{
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "meta": {
        "created": "2018-08-17T10:34:29.000Z",
        "location": "https://api.asgardeo.io/t/{org-name}/scim2/Users/008bba85-451d-414b-87de-c03b5a1f4217",
        "lastModified": "2018-08-17T10:34:29.000Z",
        "resourceType": "User"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "username": "DEFAULT/kim@gmail.com",
      "id": "008bba85-451d-414b-87de-c03b5a1f4217",
      "name": {
        "givenName": "Kim",
        "familyName": "Berry"
      },
      "emails": [
        "kim@gmail.com"
      ],
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "manager": {
          "value": "Taylor"
        }
      },
      "roles": [
        {
          "type": "default",
          "value": "Internal/everyone"
        }
      ]
    }
  ]
}

Changes

Jul 17, 20267978594f207e Revision changes
- breaking
  response property Resources/items/emails/items/ list-of-types was widened by adding types string to media type application/scim+json of response 200
- breaking
  the // response's property type changed from object to array for status
- breaking
  the // response's property type changed from object to array for status
- breaking
  the response's property type changed from object to array for status
Aug 14, 2025d290ee2c70fc Revision changes
- breaking
  the // response's property type changed from array to object for status
- breaking
  the // response's property type changed from array to object for status
- breaking
  the response's property type changed from array to object for status
- info
  response property Resources/items/emails/items/ list-of-types was narrowed by removing types string from media type application/scim+json of response 200

Operation history