Class QueryUsersRequestDataAttributes

Attributes for filtering and shaping the user query results.

Hierarchy

  • QueryUsersRequestDataAttributes

Constructors

constructor

Properties

additionalProperties? limit? query? selectColumns? sort? wildcardSearchTerm?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional limit

limit?: number

Maximum number of user records to return in the response.

Optional query

query?: string

Filter expression using user attribute conditions to narrow results.

Optional selectColumns

selectColumns?: string[]

List of user attribute column names to include in the response.

Optional sort

sort?: QueryUsersRequestDataAttributesSort

Sorting configuration specifying the field and direction for ordering user query results.

Optional wildcardSearchTerm

wildcardSearchTerm?: string

Free-text term used for wildcard search across user attribute values.

Settings

Member Visibility

Theme

Generated using TypeDoc