Update to powershell SDK docs: 13244752616

sailpoint-oss · Feb 10, 2025 · fe68754 · fe68754
1 parent 01e730d
commit fe68754
Show file tree

Hide file tree

Showing 23 changed files with 5,984 additions and 6,322 deletions.
diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 
 - Prepare the resource
 ```powershell
-$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage  -Date Thu Apr 20 20:00:00 EDT 2023 `
+$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage  -Date Fri Apr 21 00:00:00 UTC 2023 `
  -Count 10
 ```
 

diff --git a/...s/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/...s/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md
@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR
  -ApprovalStatus null `
  -Comment approved `
  -CompletionDate 2020-03-24T11:11:41.139-05:00 `
- -StartDate Mon Mar 23 20:00:00 EDT 2020 `
- -EndDate Wed Mar 24 20:00:00 EDT 2021 `
+ -StartDate Tue Mar 24 00:00:00 UTC 2020 `
+ -EndDate Thu Mar 25 00:00:00 UTC 2021 `
  -Modified 2020-03-24T11:11:41.139-05:00 `
  -Created 2020-03-24T11:11:41.139-05:00
 ```

diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PendingApproval.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 **RequestCreated** | **System.DateTime** | When the access-request was created. | [optional] 
 **RequestType** | [**AccessRequestType**](access-request-type) |  | [optional] 
 **Requester** | [**AccessItemRequesterDto**](access-item-requester-dto) |  | [optional] 
-**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [optional] 
+**RequestedFor** | [**AccessItemRequestedForDto**](access-item-requested-for-dto) |  | [optional] 
 **Owner** | [**AccessItemOwnerDto**](access-item-owner-dto) |  | [optional] 
 **RequestedObject** | [**RequestableObjectReference**](requestable-object-reference) |  | [optional] 
 **RequesterComment** | [**CommentDto1**](comment-dto1) |  | [optional] 

diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 
 - Prepare the resource
 ```powershell
-$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage  -Date Thu Apr 20 20:00:00 EDT 2023 `
+$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage  -Date Fri Apr 21 00:00:00 UTC 2023 `
  -Count 10.45
 ```
 

diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md
@@ -388,12 +388,12 @@ Path   | Index | **String** | True  | The index from which to fetch the specifie
 Path   | Id | **String** | True  | ID of the requested document.
 
 ### Return type
-[**SearchDocument**](../models/search-document)
+[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
 
 ### Responses
 Code | Description  | Data Type
 ------------- | ------------- | -------------
-200 | The requested document. | SearchDocument
+200 | The requested document. | SystemCollectionsHashtable
 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
 403 | Forbidden - Returned if the user you are running as, doesn&#39;t have access to this end-point. | ErrorResponseDto
@@ -438,12 +438,12 @@ Param Type | Name | Data Type | Required  | Description
   Query | Count | **Boolean** |   (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
 
 ### Return type
-[**SearchDocument[]**](../models/search-document)
+[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
 
 ### Responses
 Code | Description  | Data Type
 ------------- | ------------- | -------------
-200 | List of matching documents. | SearchDocument[]
+200 | List of matching documents. | SystemCollectionsHashtable[]
 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
 403 | Forbidden - Returned if the user you are running as, doesn&#39;t have access to this end-point. | ErrorResponseDto

diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 
 - Prepare the resource
 ```powershell
-$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage  -Date Thu Apr 20 20:00:00 EDT 2023 `
+$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage  -Date Fri Apr 21 00:00:00 UTC 2023 `
  -Count 10
 ```
 

diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md
@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024Aggregation
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Aggregations** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run.  See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information.  | [optional] 
-**Hits** | [**[]SearchDocument**](search-document) | The results of the aggregation search query.  | [optional] 
+**Hits** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The results of the aggregation search query.  | [optional] 
 
 ## Examples
 

diff --git a/...ershell/Reference/V2024/Models/indices.md → ...owershell/Reference/V2024/Models/Index.md b/...ershell/Reference/V2024/Models/indices.md → ...owershell/Reference/V2024/Models/Index.md
@@ -1,11 +1,11 @@
 ---
-id: v2024-indices
-title: Indices
-pagination_label: Indices
-sidebar_label: Indices
+id: v2024-index
+title: Index
+pagination_label: Index
+sidebar_label: Index
 sidebar_class_name: powershellsdk
 keywords: ['powershell', 'PowerShell', 'sdk', 'Index', 'V2024Index'] 
-slug: /tools/sdk/powershell/v2024/models/indices
+slug: /tools/sdk/powershell/v2024/models/index
 tags: ['SDK', 'Software Development Kit', 'Index', 'V2024Index']
 ---
 

diff --git a/.../sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/.../sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md
@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee
  -ApprovalStatus null `
  -Comment approved `
  -CompletionDate 2020-03-24T11:11:41.139-05:00 `
- -StartDate Mon Mar 23 20:00:00 EDT 2020 `
- -EndDate Wed Mar 24 20:00:00 EDT 2021 `
+ -StartDate Tue Mar 24 00:00:00 UTC 2020 `
+ -EndDate Thu Mar 25 00:00:00 UTC 2021 `
  -Modified 2020-03-24T11:11:41.139-05:00 `
  -Created 2020-03-24T11:11:41.139-05:00
 ```

diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 **RequestCreated** | **System.DateTime** | When the access-request was created. | [optional] 
 **RequestType** | [**AccessRequestType**](access-request-type) |  | [optional] 
 **Requester** | [**AccessItemRequester**](access-item-requester) |  | [optional] 
-**RequestedFor** | [**[]AccessItemRequestedFor**](access-item-requested-for) | Identities access was requested for. | [optional] 
+**RequestedFor** | [**AccessItemRequestedFor**](access-item-requested-for) |  | [optional] 
 **Owner** | [**PendingApprovalOwner**](pending-approval-owner) |  | [optional] 
 **RequestedObject** | [**RequestableObjectReference**](requestable-object-reference) |  | [optional] 
 **RequesterComment** | [**CommentDto**](comment-dto) |  | [optional] 

diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md
diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 
 - Prepare the resource
 ```powershell
-$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage  -Date Thu Apr 20 20:00:00 EDT 2023 `
+$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage  -Date Fri Apr 21 00:00:00 UTC 2023 `
  -Count 10.45
 ```
 

diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md
@@ -388,12 +388,12 @@ Path   | Index | **String** | True  | The index from which to fetch the specifie
 Path   | Id | **String** | True  | ID of the requested document.
 
 ### Return type
-[**SearchDocument**](../models/search-document)
+[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
 
 ### Responses
 Code | Description  | Data Type
 ------------- | ------------- | -------------
-200 | The requested document. | SearchDocument
+200 | The requested document. | SystemCollectionsHashtable
 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
 403 | Forbidden - Returned if the user you are running as, doesn&#39;t have access to this end-point. | ErrorResponseDto
@@ -438,12 +438,12 @@ Param Type | Name | Data Type | Required  | Description
   Query | Count | **Boolean** |   (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
 
 ### Return type
-[**SearchDocument[]**](../models/search-document)
+[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
 
 ### Responses
 Code | Description  | Data Type
 ------------- | ------------- | -------------
-200 | List of matching documents. | SearchDocument[]
+200 | List of matching documents. | SystemCollectionsHashtable[]
 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
 403 | Forbidden - Returned if the user you are running as, doesn&#39;t have access to this end-point. | ErrorResponseDto

diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 
 - Prepare the resource
 ```powershell
-$AccountUsage = Initialize-PSSailpoint.V3AccountUsage  -Date Thu Apr 20 20:00:00 EDT 2023 `
+$AccountUsage = Initialize-PSSailpoint.V3AccountUsage  -Date Fri Apr 21 00:00:00 UTC 2023 `
  -Count 10
 ```