Sign in
Users Endpoint

Filter Users

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

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

Changes

Changed in 2 of the 4 revisions of this API.71

  • 7978594f207e4See the full diff
    • ▲

      response property Resources/items/emails/items/ list-of-types was widened by adding types string to media type application/scim+json of response 200

      response-property-list-of-types-widened

    • ▲

      the Resources/items/roles response's property type/format changed from object/ to array/ for status 200

      response-property-type-changed

    • ▲

      the Resources/items/schemas response's property type/format changed from object/ to array/ for status 200

      response-property-type-changed

    • ▲

      the schemas response's property type/format changed from object/ to array/ for status 200

      response-property-type-changed

  • d290ee2c70fc31See the full diff
    • ▲

      the Resources/items/roles response's property type/format changed from array/ to object/ for status 200

      response-property-type-changed

    • ▲

      the Resources/items/schemas response's property type/format changed from array/ to object/ for status 200

      response-property-type-changed

    • ▲

      the schemas response's property type/format changed from array/ to object/ for status 200

      response-property-type-changed

    • ○

      response property Resources/items/emails/items/ list-of-types was narrowed by removing types string from media type application/scim+json of response 200

      response-property-list-of-types-narrowed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog