Query: flexSearchUsers

Queries for Users using FlexSearch.

Return Type

User

User

Args

Name	Type	Description
after	String	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.
filter	UserFilter	Renamed to postFilter. Use postFilter instead.
first	Int	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).
flexSearchFilter	UserFlexSearchFilter
orderBy	UserOrderBy	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.
postFilter	UserFilter	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.
skip	Int	The number of items in the list or collection to skip. Is applied after the `after` argument if both are specified.

Properties

Name	Type	Description
_cursor	String	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
_revision	ID	An identifier that is updated automatically on each update of this root entity (but not on relation changes)
createdAt	DateTime	The instant this object has been created
deletedAt	DateTime	The date in which the user was deleted from the app
email	String	Email address of the user
eulaAcceptedAt	DateTime	The date the user accepted the EULA
groups	[Group]	Groups or Business Units that the user belongs to
id	ID	An auto-generated string that identifies this root entity uniquely among others of the same type
legacyDeletedAt	DateTime	The date in which the user was deleted from the legacy application
organization	Organization	Organization that the user belongs to
role	UserRole	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.
settings	UserSettings	The user-configured settings for the Finite State Platform
updatedAt	DateTime	The instant this object has been updated the last time (not including relation updates)

This page was generated: 2024-11-06