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

Update PowerShell SDK docs: 15141274669

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteria.md Normal file
View File

@@ -0,0 +1,49 @@
---
id: v2024-search-criteria
title: SearchCriteria
pagination_label: SearchCriteria
sidebar_label: SearchCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteria', 'V2024SearchCriteria']
slug: /tools/sdk/powershell/v2024/models/search-criteria
tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2024SearchCriteria']
---
# SearchCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Indices** | **[]String** | A list of indices to search within. Must contain exactly one item, typically ""entitlements"". | [required]
**Filters** | [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional]
**Query** | [**SearchCriteriaQuery**](search-criteria-query) | | [optional]
**QueryType** | **String** | Specifies the type of query. Must be ""TEXT"" if `textQuery` is used. | [optional]
**TextQuery** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional]
**IncludeNested** | **Boolean** | Whether to include nested objects in the search results. | [optional] [default to $false]
**Sort** | **[]String** | Specifies the sorting order for the results. | [optional]
**SearchAfter** | **[]String** | Used for pagination to fetch results after a specific point. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteria = Initialize-V2024SearchCriteria -Indices [entitlements] `
-Filters {status={type=TERMS, terms=[active, inactive]}} `
-Query null `
-QueryType TEXT `
-TextQuery null `
-IncludeNested true `
-Sort [name:asc, createdAt:desc] `
-SearchAfter [12345, 67890]
```
- Convert the resource to JSON
```powershell
$SearchCriteria | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValue.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-search-criteria-filters-value
title: SearchCriteriaFiltersValue
pagination_label: SearchCriteriaFiltersValue
sidebar_label: SearchCriteriaFiltersValue
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue']
---
# SearchCriteriaFiltersValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **String** | The type of filter, e.g., ""TERMS"" or ""RANGE"". | [optional]
**Terms** | **[]String** | Terms to filter by (for ""TERMS"" type). | [optional]
**Range** | [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValue = Initialize-V2024SearchCriteriaFiltersValue -Type TERMS `
-Terms [active, inactive] `
-Range null
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValue | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-filters-value-range
title: SearchCriteriaFiltersValueRange
pagination_label: SearchCriteriaFiltersValueRange
sidebar_label: SearchCriteriaFiltersValueRange
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange']
---
# SearchCriteriaFiltersValueRange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Lower** | [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional]
**Upper** | [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValueRange = Initialize-V2024SearchCriteriaFiltersValueRange -Lower null `
-Upper null
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValueRange | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-filters-value-range-lower
title: SearchCriteriaFiltersValueRangeLower
pagination_label: SearchCriteriaFiltersValueRangeLower
sidebar_label: SearchCriteriaFiltersValueRangeLower
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range-lower
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower']
---
# SearchCriteriaFiltersValueRangeLower
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **String** | The lower bound value. | [optional]
**Inclusive** | **Boolean** | Whether the lower bound is inclusive. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValueRangeLower = Initialize-V2024SearchCriteriaFiltersValueRangeLower -Value 10 `
-Inclusive true
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValueRangeLower | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-filters-value-range-upper
title: SearchCriteriaFiltersValueRangeUpper
pagination_label: SearchCriteriaFiltersValueRangeUpper
sidebar_label: SearchCriteriaFiltersValueRangeUpper
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper']
slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range-upper
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper']
---
# SearchCriteriaFiltersValueRangeUpper
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **String** | The upper bound value. | [optional]
**Inclusive** | **Boolean** | Whether the upper bound is inclusive. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaFiltersValueRangeUpper = Initialize-V2024SearchCriteriaFiltersValueRangeUpper -Value 20 `
-Inclusive false
```
- Convert the resource to JSON
```powershell
$SearchCriteriaFiltersValueRangeUpper | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaQuery.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-search-criteria-query
title: SearchCriteriaQuery
pagination_label: SearchCriteriaQuery
sidebar_label: SearchCriteriaQuery
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery']
slug: /tools/sdk/powershell/v2024/models/search-criteria-query
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery']
---
# SearchCriteriaQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Query** | **String** | A structured query for advanced search. | [optional]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaQuery = Initialize-V2024SearchCriteriaQuery -Query status:active
```
- Convert the resource to JSON
```powershell
$SearchCriteriaQuery | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaTextQuery.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-search-criteria-text-query
title: SearchCriteriaTextQuery
pagination_label: SearchCriteriaTextQuery
sidebar_label: SearchCriteriaTextQuery
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery']
slug: /tools/sdk/powershell/v2024/models/search-criteria-text-query
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery']
---
# SearchCriteriaTextQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Terms** | **[]String** | Terms to search for. | [optional]
**Fields** | **[]String** | Fields to search within. | [optional]
**MatchAny** | **Boolean** | Whether to match any of the terms. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$SearchCriteriaTextQuery = Initialize-V2024SearchCriteriaTextQuery -Terms [admin, user] `
-Fields [role, name] `
-MatchAny true
```
- Convert the resource to JSON
```powershell
$SearchCriteriaTextQuery | ConvertTo-JSON
```
[[Back to top]](#)

51
docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRecord.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2024-sed-batch-record
title: SedBatchRecord
pagination_label: SedBatchRecord
sidebar_label: SedBatchRecord
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRecord', 'V2024SedBatchRecord']
slug: /tools/sdk/powershell/v2024/models/sed-batch-record
tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2024SedBatchRecord']
---
# SedBatchRecord
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TenantId** | **String** | The tenant ID associated with the batch. | [optional]
**BatchId** | **String** | The unique ID of the batch. | [optional]
**Name** | **String** | The name of the batch. | [optional]
**ProcessedState** | **String** | The current state of the batch (e.g., submitted, materialized, completed). | [optional]
**RequestedBy** | **String** | The ID of the user who requested the batch. | [optional]
**MaterializedCount** | **Int32** | The number of items materialized in the batch. | [optional]
**ProcessedCount** | **Int32** | The number of items processed in the batch. | [optional]
**CreatedAt** | **System.DateTime** | The timestamp when the batch was created. | [optional]
**UpdatedAt** | **System.DateTime** | The timestamp when the batch was last updated. | [optional]
## Examples
- Prepare the resource
```powershell
$SedBatchRecord = Initialize-V2024SedBatchRecord -TenantId 123e4567-e89b-12d3-a456-426614174000 `
-BatchId 016629d1-1d25-463f-97f3-0c6686846650 `
-Name Example Batch Name `
-ProcessedState submitted | materialized | completed | failed `
-RequestedBy 987e6543-e21b-45d3-b123-123456789abc `
-MaterializedCount 50 `
-ProcessedCount 45 `
-CreatedAt 2023-10-01T12:00Z `
-UpdatedAt 2023-10-02T15:30Z
```
- Convert the resource to JSON
```powershell
$SedBatchRecord | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRequest.md
View File

@@ -18,13 +18,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Entitlements** | **[]String** | list of entitlement ids | [optional]
**Seds** | **[]String** | list of sed ids | [optional]
**SearchCriteria** | [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional]
## Examples
- Prepare the resource
```powershell
$SedBatchRequest = Initialize-V2024SedBatchRequest -Entitlements null `
-Seds null
-Seds null `
-SearchCriteria null
```
- Convert the resource to JSON

35
docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchStatus.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-sed-batch-status
title: SedBatchStatus
pagination_label: SedBatchStatus
sidebar_label: SedBatchStatus
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus']
slug: /tools/sdk/powershell/v2024/models/sed-batch-status
tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus']
---
# SedBatchStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Status** | **String** | status of batch | [optional]
## Examples
- Prepare the resource
```powershell
$SedBatchStatus = Initialize-V2024SedBatchStatus -Status OK
```
- Convert the resource to JSON
```powershell
$SedBatchStatus | ConvertTo-JSON
```
[[Back to top]](#)