From 8f6f789bb437fda7d3a7b1553226e712af71d7b5 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Mon, 10 Feb 2025 07:19:47 -0500 Subject: [PATCH] fixed index file and added latest doc files --- .../Reference/V2024/Models/CreateSavedSearchRequest.md | 2 +- .../powershell/Reference/V2024/Models/ReportDetailsArguments.md | 2 +- docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md | 2 +- .../sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md | 2 +- docs/tools/sdk/powershell/Reference/V2024/Models/Search.md | 2 +- .../Reference/V2024/Models/SearchExportReportArguments.md | 2 +- .../powershell/Reference/V3/Models/CreateSavedSearchRequest.md | 2 +- .../powershell/Reference/V3/Models/ReportDetailsArguments.md | 2 +- docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md | 2 +- .../sdk/powershell/Reference/V3/Models/SavedSearchDetail.md | 2 +- docs/tools/sdk/powershell/Reference/V3/Models/Search.md | 2 +- .../Reference/V3/Models/SearchExportReportArguments.md | 2 +- docs/tools/sdk/powershell/Reference/index.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md index 32dcea19c..a207250a5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md index 317e8e20b..dfd7a165c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md index 747bb3ecf..82aed2bd6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md index dbf171b39..00c33b973 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md index db75fbea9..ee33753d1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md index 24d6eec96..6d0c3562c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md index c939a69ea..78aa0b498 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md index b2950ee29..acb087567 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md index 094f192a7..24a67ae87 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md index 094cdbcc6..f98721fa8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Search.md b/docs/tools/sdk/powershell/Reference/V3/Models/Search.md index d0ee77ddd..8e0883739 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Search.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Search.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md index 20571f801..76d2c3fb3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md @@ -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**](indices) | 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] diff --git a/docs/tools/sdk/powershell/Reference/index.md b/docs/tools/sdk/powershell/Reference/index.md index 2e76d206c..896286181 100644 --- a/docs/tools/sdk/powershell/Reference/index.md +++ b/docs/tools/sdk/powershell/Reference/index.md @@ -18,7 +18,7 @@ Welcome to the **PowerShell SDK Reference**. This reference guide provides detai - **[Beta Model Definitions](/docs/tools/sdk/powershell/beta/models)** – Descriptions of Beta objects and data structures the SDK uses. - **[V3 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – List of available V3 cmdlets, their parameters, and expected outputs. - **[V3 Model Definitions](/docs/tools/sdk/powershell/v3/models)** – Descriptions of V3 objects and data structures the SDK uses. -- **[V2024 Method Reference](/docs/tools/sdk/powershell/v3/methods)** – List of available V2024 cmdlets, their parameters, and expected outputs. +- **[V2024 Method Reference](/docs/tools/sdk/powershell/v2024/methods)** – List of available V2024 cmdlets, their parameters, and expected outputs. - **[V2024 Model Definitions](/docs/tools/sdk/powershell/v2024/models)** – Descriptions of V2024 objects and data structures the SDK uses. - **Usage Examples** – Practical PowerShell scripts demonstrating common tasks.