add method and model docs for powershell and python v2025

This commit is contained in:
darrell-thobe-sp
2025-04-01 09:23:12 -04:00
parent c12ffb7efc
commit 5d8f458a33
2414 changed files with 191212 additions and 0 deletions

View File

@@ -0,0 +1,63 @@
---
id: v2025-saved-search
title: SavedSearch
pagination_label: SavedSearch
sidebar_label: SavedSearch
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearch', 'V2025SavedSearch']
slug: /tools/sdk/powershell/v2025/models/saved-search
tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2025SavedSearch']
---
# SavedSearch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | The name of the saved search. | [optional]
**Description** | **String** | The description of the saved search. | [optional]
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required]
**Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional]
**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required]
**Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional]
**OrderBy** | **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. | [optional]
**Filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional]
**Id** | **String** | The saved search ID. | [optional]
**Owner** | [**TypedReference**](typed-reference) | | [optional]
**OwnerId** | **String** | The ID of the identity that owns this saved search. | [optional]
**Public** | **Boolean** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SavedSearch = Initialize-PSSailpoint.V2025SavedSearch -Name Disabled accounts `
-Description Disabled accounts `
-Created 2018-06-25T20:22:28.104Z `
-Modified 2018-06-25T20:22:28.104Z `
-Indices [identities] `
-Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} `
-Query @accounts(disabled:true) `
-Fields [disabled] `
-OrderBy {identity=[lastName, firstName], role=[name]} `
-Sort [displayName] `
-Filters null `
-Id 0de46054-fe90-434a-b84e-c6b3359d0c64 `
-Owner null `
-OwnerId 2c91808568c529c60168cca6f90c1313 `
-Public false
```
- Convert the resource to JSON
```powershell
$SavedSearch | ConvertTo-JSON
```
[[Back to top]](#)