BAballerina-platform
Users Endpoint

Search Users

Changed on

This API returns users according to the filter, sort and pagination parameters.

  • <b>Scope(Permission) required:</b> internal_user_mgt_list

  • <b>Flow type:</b> Client Credentials OAuth Flow

post/Users/.search

Request

Request body

schemasstring[] required
attributesstring[]

SCIM defined attributes parameter.

filterstring

The expression used for filtering. Supported filters are <code>ew</code>, <code>eq</code>, <code>co</code>, <code>sw</code>, and <code>and</code>.

domainstring

The name of the user store where filtering needs to be applied.

startIndexinteger

The 1-based index of the first query result

countinteger

Specifies the desired maximum number of query results per page. </br>(For organizations created on or after November 19, 2024, a threshold value of 100 will be applied to the count parameter. To fetch more users, use pagination.)

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ],
  "attributes": [
    "name.familyName",
    "userName"
  ],
  "filter": "userName sw ki and name.familyName co err",
  "domain": "DEFAULT",
  "startIndex": 1,
  "count": 10
}

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

  • 7978594f207eRevision changes
    • breaking

      the request property became required

    • 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

  • d290ee2c70fcRevision 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

      the request property became optional

    • 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