mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
Update python SDK docs: 15146666782
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,51 @@
|
||||
---
|
||||
id: beta-search-criteria
|
||||
title: SearchCriteria
|
||||
pagination_label: SearchCriteria
|
||||
sidebar_label: SearchCriteria
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteria', 'BetaSearchCriteria']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'BetaSearchCriteria']
|
||||
---
|
||||
|
||||
# SearchCriteria
|
||||
|
||||
Represents the search criteria for querying entitlements.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**indices** | **[]str** | 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]
|
||||
**query_type** | **str** | Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. | [optional]
|
||||
**text_query** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional]
|
||||
**include_nested** | **bool** | Whether to include nested objects in the search results. | [optional] [default to False]
|
||||
**sort** | **[]str** | Specifies the sorting order for the results. | [optional]
|
||||
**search_after** | **[]str** | Used for pagination to fetch results after a specific point. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria import SearchCriteria
|
||||
|
||||
search_criteria = SearchCriteria(
|
||||
indices=[entitlements],
|
||||
filters={status={type=TERMS, terms=[active, inactive]}},
|
||||
query=sailpoint.beta.models.search_criteria_query.SearchCriteria_query(),
|
||||
query_type='TEXT',
|
||||
text_query=sailpoint.beta.models.search_criteria_text_query.SearchCriteria_textQuery(
|
||||
terms = [admin, user],
|
||||
fields = [role, name],
|
||||
match_any = True, ),
|
||||
include_nested=True,
|
||||
sort=[name:asc, createdAt:desc],
|
||||
search_after=[12345, 67890]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: beta-search-criteria-filters-value
|
||||
title: SearchCriteriaFiltersValue
|
||||
pagination_label: SearchCriteriaFiltersValue
|
||||
sidebar_label: SearchCriteriaFiltersValue
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValue', 'BetaSearchCriteriaFiltersValue']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria-filters-value
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'BetaSearchCriteriaFiltersValue']
|
||||
---
|
||||
|
||||
# SearchCriteriaFiltersValue
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **str** | The type of filter, e.g., \"TERMS\" or \"RANGE\". | [optional]
|
||||
**terms** | **[]str** | Terms to filter by (for \"TERMS\" type). | [optional]
|
||||
**range** | [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria_filters_value import SearchCriteriaFiltersValue
|
||||
|
||||
search_criteria_filters_value = SearchCriteriaFiltersValue(
|
||||
type='TERMS',
|
||||
terms=[active, inactive],
|
||||
range=sailpoint.beta.models.search_criteria_filters_value_range.SearchCriteria_filters_value_range(
|
||||
lower = sailpoint.beta.models.search_criteria_filters_value_range_lower.SearchCriteria_filters_value_range_lower(
|
||||
value = '10',
|
||||
inclusive = True, ),
|
||||
upper = sailpoint.beta.models.search_criteria_filters_value_range_upper.SearchCriteria_filters_value_range_upper(
|
||||
value = '20',
|
||||
inclusive = False, ), )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: beta-search-criteria-filters-value-range
|
||||
title: SearchCriteriaFiltersValueRange
|
||||
pagination_label: SearchCriteriaFiltersValueRange
|
||||
sidebar_label: SearchCriteriaFiltersValueRange
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValueRange', 'BetaSearchCriteriaFiltersValueRange']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria-filters-value-range
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'BetaSearchCriteriaFiltersValueRange']
|
||||
---
|
||||
|
||||
# SearchCriteriaFiltersValueRange
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**lower** | [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional]
|
||||
**upper** | [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria_filters_value_range import SearchCriteriaFiltersValueRange
|
||||
|
||||
search_criteria_filters_value_range = SearchCriteriaFiltersValueRange(
|
||||
lower=sailpoint.beta.models.search_criteria_filters_value_range_lower.SearchCriteria_filters_value_range_lower(
|
||||
value = '10',
|
||||
inclusive = True, ),
|
||||
upper=sailpoint.beta.models.search_criteria_filters_value_range_upper.SearchCriteria_filters_value_range_upper(
|
||||
value = '20',
|
||||
inclusive = False, )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: beta-search-criteria-filters-value-range-lower
|
||||
title: SearchCriteriaFiltersValueRangeLower
|
||||
pagination_label: SearchCriteriaFiltersValueRangeLower
|
||||
sidebar_label: SearchCriteriaFiltersValueRangeLower
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'BetaSearchCriteriaFiltersValueRangeLower']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria-filters-value-range-lower
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'BetaSearchCriteriaFiltersValueRangeLower']
|
||||
---
|
||||
|
||||
# SearchCriteriaFiltersValueRangeLower
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **str** | The lower bound value. | [optional]
|
||||
**inclusive** | **bool** | Whether the lower bound is inclusive. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria_filters_value_range_lower import SearchCriteriaFiltersValueRangeLower
|
||||
|
||||
search_criteria_filters_value_range_lower = SearchCriteriaFiltersValueRangeLower(
|
||||
value='10',
|
||||
inclusive=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: beta-search-criteria-filters-value-range-upper
|
||||
title: SearchCriteriaFiltersValueRangeUpper
|
||||
pagination_label: SearchCriteriaFiltersValueRangeUpper
|
||||
sidebar_label: SearchCriteriaFiltersValueRangeUpper
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'BetaSearchCriteriaFiltersValueRangeUpper']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria-filters-value-range-upper
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'BetaSearchCriteriaFiltersValueRangeUpper']
|
||||
---
|
||||
|
||||
# SearchCriteriaFiltersValueRangeUpper
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **str** | The upper bound value. | [optional]
|
||||
**inclusive** | **bool** | Whether the upper bound is inclusive. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria_filters_value_range_upper import SearchCriteriaFiltersValueRangeUpper
|
||||
|
||||
search_criteria_filters_value_range_upper = SearchCriteriaFiltersValueRangeUpper(
|
||||
value='20',
|
||||
inclusive=False
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: beta-search-criteria-query
|
||||
title: SearchCriteriaQuery
|
||||
pagination_label: SearchCriteriaQuery
|
||||
sidebar_label: SearchCriteriaQuery
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaQuery', 'BetaSearchCriteriaQuery']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria-query
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'BetaSearchCriteriaQuery']
|
||||
---
|
||||
|
||||
# SearchCriteriaQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**query** | **str** | A structured query for advanced search. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria_query import SearchCriteriaQuery
|
||||
|
||||
search_criteria_query = SearchCriteriaQuery(
|
||||
query='status:active'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: beta-search-criteria-text-query
|
||||
title: SearchCriteriaTextQuery
|
||||
pagination_label: SearchCriteriaTextQuery
|
||||
sidebar_label: SearchCriteriaTextQuery
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaTextQuery', 'BetaSearchCriteriaTextQuery']
|
||||
slug: /tools/sdk/python/beta/models/search-criteria-text-query
|
||||
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'BetaSearchCriteriaTextQuery']
|
||||
---
|
||||
|
||||
# SearchCriteriaTextQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**terms** | **[]str** | Terms to search for. | [optional]
|
||||
**fields** | **[]str** | Fields to search within. | [optional]
|
||||
**match_any** | **bool** | Whether to match any of the terms. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.search_criteria_text_query import SearchCriteriaTextQuery
|
||||
|
||||
search_criteria_text_query = SearchCriteriaTextQuery(
|
||||
terms=[admin, user],
|
||||
fields=[role, name],
|
||||
match_any=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entitlements** | **[]str** | list of entitlement ids | [optional]
|
||||
**seds** | **[]str** | list of sed ids | [optional]
|
||||
**search_criteria** | [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
@@ -32,7 +33,21 @@ entitlements=[
|
||||
],
|
||||
seds=[
|
||||
'016629d1-1d25-463f-97f3-c6686846650'
|
||||
]
|
||||
],
|
||||
search_criteria={
|
||||
'key' : sailpoint.beta.models.search_criteria.SearchCriteria(
|
||||
indices = [entitlements],
|
||||
filters = {status={type=TERMS, terms=[active, inactive]}},
|
||||
query = sailpoint.beta.models.search_criteria_query.SearchCriteria_query(),
|
||||
query_type = 'TEXT',
|
||||
text_query = sailpoint.beta.models.search_criteria_text_query.SearchCriteria_textQuery(
|
||||
terms = [admin, user],
|
||||
fields = [role, name],
|
||||
match_any = True, ),
|
||||
include_nested = True,
|
||||
sort = [name:asc, createdAt:desc],
|
||||
search_after = [12345, 67890], )
|
||||
}
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
id: beta-sed-batch-status
|
||||
title: SedBatchStatus
|
||||
pagination_label: SedBatchStatus
|
||||
sidebar_label: SedBatchStatus
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SedBatchStatus', 'BetaSedBatchStatus']
|
||||
slug: /tools/sdk/python/beta/models/sed-batch-status
|
||||
tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'BetaSedBatchStatus']
|
||||
---
|
||||
|
||||
# SedBatchStatus
|
||||
|
||||
Sed Batch Status
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**status** | **str** | status of batch | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.sed_batch_status import SedBatchStatus
|
||||
|
||||
sed_batch_status = SedBatchStatus(
|
||||
status='OK'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user