developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-search	Search	Search	Search	powershellsdk	powershell PowerShell sdk Search V2024Search	/tools/sdk/powershell/v2024/models/search	SDK Software Development Kit Search V2024Search

Search

Properties

Name	Type	Description	Notes
Indices	Pointer to []Index	The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched.	[optional]
QueryType	Pointer to QueryType		[optional]
QueryVersion	Pointer to String		[optional]
Query	Pointer to Query		[optional]
QueryDsl	Pointer to [SystemCollectionsHashtable]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0	The search query using the Elasticsearch Query DSL syntax.	[optional]
TextQuery	Pointer to TextQuery		[optional]
TypeAheadQuery	Pointer to TypeAheadQuery		[optional]
IncludeNested	Pointer to Boolean	Indicates whether nested objects from returned search results should be included.	[optional] [default to $true]
QueryResultFilter	Pointer to QueryResultFilter		[optional]
AggregationType	Pointer to AggregationType		[optional]
AggregationsVersion	Pointer to String		[optional]
AggregationsDsl	Pointer to [SystemCollectionsHashtable]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0	The aggregation search query using Elasticsearch Aggregations syntax.	[optional]
Aggregations	Pointer to SearchAggregationSpecification		[optional]
Sort	Pointer to []String	The fields to be used to sort the search results. Use + or - to specify the sort direction.	[optional]
SearchAfter	Pointer to []String	Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [""displayName"", ""id""]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is ""John Doe"", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [""John Doe"",""2c91808375d8e80a0175e1f88a575221""]	[optional]
Filters	Pointer to map[string]ModelFilter	The filters to be applied for each filtered field name.	[optional]

Examples

• Prepare the resource

$Search = Initialize-PSSailpoint.V2024Search  -Indices [identities] `
 -QueryType null `
 -QueryVersion null `
 -Query null `
 -QueryDsl {match={name=john.doe}} `
 -TextQuery null `
 -TypeAheadQuery null `
 -IncludeNested true `
 -QueryResultFilter null `
 -AggregationType null `
 -AggregationsVersion null `
 -AggregationsDsl {} `
 -Aggregations null `
 -Sort [displayName, +id] `
 -SearchAfter [John Doe, 2c91808375d8e80a0175e1f88a575221] `
 -Filters {}

• Convert the resource to JSON

$Search | ConvertTo-JSON

[Back to top]