Query: flexSearchUsers

Queries for Users using FlexSearch.

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterUserFilter

Renamed to postFilter. Use postFilter instead.

firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

flexSearchFilterUserFlexSearchFilter
orderByUserOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

postFilterUserFilter

Filters that will be applied in memory after the flexSearchFilter.

This will not use any indices and will only work if applied on less than 10 000 objects.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_groupsMeta_QueryMeta

Groups or Business Units that the user belongs to

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

createdAtDateTime

The instant this object has been created

deletedAtDateTime

The date in which the user was deleted from the app

emailString

Email address of the user

eulaAcceptedAtDateTime

The date the user accepted the EULA

groups[Group]

Groups or Business Units that the user belongs to

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

legacyDeletedAtDateTime

The date in which the user was deleted from the legacy application

organizationOrganization

Organization that the user belongs to

roleUserRole

The role the user has within the Organization. This field is being deprecated in favor of the roles field.

roles[String]

The roles the user has within the Organization.

settingsUserSettings

The user-configured settings for the Finite State Platform

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)


This page was generated: 2024-05-17