LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13249887478

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-10 20:32:46 +00:00
parent 86c50ab8e0
commit 95d9d2be19
12 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**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**](indices) | The names of the Elasticsearch indices in which to search. | [required]
**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]

2
docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false]
**AuthoritativeSource** | **String** | Source ID. | [required]
**SelectedFormats** | **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional]
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | The query using the 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 extended by SailPoint to support Nested queries. | [required]
**Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**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**](indices) | The names of the Elasticsearch indices in which to search. | [required]
**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]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. | [required]
**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]

2
docs/tools/sdk/powershell/Reference/V2024/Models/Search.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**QueryType** | [**QueryType**](query-type) | | [optional]
**QueryVersion** | **String** | | [optional]
**Query** | [**Query**](query) | | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024S
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | The query using the 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 extended by SailPoint to support Nested queries. | [required]
**Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**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**](indices) | The names of the Elasticsearch indices in which to search. | [required]
**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]

2
docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false]
**AuthoritativeSource** | **String** | Source ID. | [required]
**SelectedFormats** | **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional]
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | The query using the 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 extended by SailPoint to support Nested queries. | [required]
**Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]

2
docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**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**](indices) | The names of the Elasticsearch indices in which to search. | [required]
**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]

2
docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. | [required]
**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]

2
docs/tools/sdk/powershell/Reference/V3/Models/Search.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Search', 'Search']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**QueryType** | [**QueryType**](query-type) | | [optional]
**QueryVersion** | **String** | | [optional]
**Query** | [**Query**](query) | | [optional]

2
docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'Search
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | [**[]Index**](indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional]
**Query** | **String** | The query using the 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 extended by SailPoint to support Nested queries. | [required]
**Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional]
**Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional]