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

Update python SDK docs: 15146666782

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 19:57:29 +00:00
parent 63f5371396
commit 75e337e73e
35 changed files with 1210 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md
View File

@@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-sed-batch-stats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request
[**get-sed-batches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List sed batch request
[**get-sed-batches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Record
[**list-seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions
[**patch-sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch suggested entitlement description
[**submit-sed-approval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit bulk approval request
@@ -91,22 +91,29 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sed-batches
List sed batch request
List Sed Batch Record
List Sed Batches.
API responses with Sed Batch Status
API responses with Sed Batch Records
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches)
### Parameters
This endpoint does not need any parameter.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | offset | **int** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
Query | limit | **int** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
Query | count | **bool** | (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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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.
Query | count_only | **bool** | (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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array.
Query | status | **str** | (optional) | Batch Status
### Return type
[**SedBatchStatus**](../models/sed-batch-status)
[**List[SedBatchRecord]**](../models/sed-batch-record)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Status of batch | SedBatchStatus | - |
200 | List of Sed Batch Records | List[SedBatchRecord] | - |
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't have access to this end-point. | ErrorResponseDto | - |
@@ -123,21 +130,27 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_status import SedBatchStatus
from sailpoint.v2024.models.sed_batch_record import SedBatchRecord
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
count = False # bool | 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional) (default to False) # bool | 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional) (default to False)
count_only = False # bool | 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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) # bool | 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. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False)
status = 'completed, failed, submitted, materialized, failed' # str | Batch Status (optional) # str | Batch Status (optional)
try:
# List sed batch request
# List Sed Batch Record
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(offset, limit, count, count_only, status)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n")
print(results.model_dump_json(by_alias=True, indent=4))
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e)
```
@@ -470,7 +483,30 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
sed_batch_request = '''{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"searchCriteria" : {
"key" : {
"indices" : [ "entitlements" ],
"query" : {
"query" : "status:active"
},
"textQuery" : {
"terms" : [ "admin", "user" ],
"matchAny" : true,
"fields" : [ "role", "name" ]
},
"searchAfter" : [ "12345", "67890" ],
"filters" : {
"status" : {
"type" : "TERMS",
"terms" : [ "active", "inactive" ]
}
},
"sort" : [ "name:asc", "createdAt:desc" ],
"queryType" : "TEXT",
"includeNested" : true
}
}
}''' # SedBatchRequest | Sed Batch Request (optional)
try:

51
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteria.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: v2024-search-criteria
title: SearchCriteria
pagination_label: SearchCriteria
sidebar_label: SearchCriteria
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteria', 'V2024SearchCriteria']
slug: /tools/sdk/python/v2024/models/search-criteria
tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2024SearchCriteria']
---
# 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.v2024.models.search_criteria import SearchCriteria
search_criteria = SearchCriteria(
indices=[entitlements],
filters={status={type=TERMS, terms=[active, inactive]}},
query=sailpoint.v2024.models.search_criteria_query.SearchCriteria_query(),
query_type='TEXT',
text_query=sailpoint.v2024.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]](#)

43
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteriaFiltersValue.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-search-criteria-filters-value
title: SearchCriteriaFiltersValue
pagination_label: SearchCriteriaFiltersValue
sidebar_label: SearchCriteriaFiltersValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue']
slug: /tools/sdk/python/v2024/models/search-criteria-filters-value
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue']
---
# 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.v2024.models.search_criteria_filters_value import SearchCriteriaFiltersValue
search_criteria_filters_value = SearchCriteriaFiltersValue(
type='TERMS',
terms=[active, inactive],
range=sailpoint.v2024.models.search_criteria_filters_value_range.SearchCriteria_filters_value_range(
lower = sailpoint.v2024.models.search_criteria_filters_value_range_lower.SearchCriteria_filters_value_range_lower(
value = '10',
inclusive = True, ),
upper = sailpoint.v2024.models.search_criteria_filters_value_range_upper.SearchCriteria_filters_value_range_upper(
value = '20',
inclusive = False, ), )
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-search-criteria-filters-value-range
title: SearchCriteriaFiltersValueRange
pagination_label: SearchCriteriaFiltersValueRange
sidebar_label: SearchCriteriaFiltersValueRange
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange']
slug: /tools/sdk/python/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]
}
## Example
```python
from sailpoint.v2024.models.search_criteria_filters_value_range import SearchCriteriaFiltersValueRange
search_criteria_filters_value_range = SearchCriteriaFiltersValueRange(
lower=sailpoint.v2024.models.search_criteria_filters_value_range_lower.SearchCriteria_filters_value_range_lower(
value = '10',
inclusive = True, ),
upper=sailpoint.v2024.models.search_criteria_filters_value_range_upper.SearchCriteria_filters_value_range_upper(
value = '20',
inclusive = False, )
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-search-criteria-filters-value-range-lower
title: SearchCriteriaFiltersValueRangeLower
pagination_label: SearchCriteriaFiltersValueRangeLower
sidebar_label: SearchCriteriaFiltersValueRangeLower
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower']
slug: /tools/sdk/python/v2024/models/search-criteria-filters-value-range-lower
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower']
---
# 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.v2024.models.search_criteria_filters_value_range_lower import SearchCriteriaFiltersValueRangeLower
search_criteria_filters_value_range_lower = SearchCriteriaFiltersValueRangeLower(
value='10',
inclusive=True
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-search-criteria-filters-value-range-upper
title: SearchCriteriaFiltersValueRangeUpper
pagination_label: SearchCriteriaFiltersValueRangeUpper
sidebar_label: SearchCriteriaFiltersValueRangeUpper
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper']
slug: /tools/sdk/python/v2024/models/search-criteria-filters-value-range-upper
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper']
---
# 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.v2024.models.search_criteria_filters_value_range_upper import SearchCriteriaFiltersValueRangeUpper
search_criteria_filters_value_range_upper = SearchCriteriaFiltersValueRangeUpper(
value='20',
inclusive=False
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteriaQuery.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-search-criteria-query
title: SearchCriteriaQuery
pagination_label: SearchCriteriaQuery
sidebar_label: SearchCriteriaQuery
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery']
slug: /tools/sdk/python/v2024/models/search-criteria-query
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery']
---
# SearchCriteriaQuery
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**query** | **str** | A structured query for advanced search. | [optional]
}
## Example
```python
from sailpoint.v2024.models.search_criteria_query import SearchCriteriaQuery
search_criteria_query = SearchCriteriaQuery(
query='status:active'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/SearchCriteriaTextQuery.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-search-criteria-text-query
title: SearchCriteriaTextQuery
pagination_label: SearchCriteriaTextQuery
sidebar_label: SearchCriteriaTextQuery
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery']
slug: /tools/sdk/python/v2024/models/search-criteria-text-query
tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery']
---
# 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.v2024.models.search_criteria_text_query import SearchCriteriaTextQuery
search_criteria_text_query = SearchCriteriaTextQuery(
terms=[admin, user],
fields=[role, name],
match_any=True
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/V2024/Models/SedBatchRecord.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: v2024-sed-batch-record
title: SedBatchRecord
pagination_label: SedBatchRecord
sidebar_label: SedBatchRecord
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SedBatchRecord', 'V2024SedBatchRecord']
slug: /tools/sdk/python/v2024/models/sed-batch-record
tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2024SedBatchRecord']
---
# SedBatchRecord
Sed Batch Record
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tenant_id** | **str** | The tenant ID associated with the batch. | [optional]
**batch_id** | **str** | The unique ID of the batch. | [optional]
**name** | **str** | The name of the batch. | [optional]
**processed_state** | **str** | The current state of the batch (e.g., submitted, materialized, completed). | [optional]
**requested_by** | **str** | The ID of the user who requested the batch. | [optional]
**materialized_count** | **int** | The number of items materialized in the batch. | [optional]
**processed_count** | **int** | The number of items processed in the batch. | [optional]
**created_at** | **datetime** | The timestamp when the batch was created. | [optional]
**updated_at** | **datetime** | The timestamp when the batch was last updated. | [optional]
}
## Example
```python
from sailpoint.v2024.models.sed_batch_record import SedBatchRecord
sed_batch_record = SedBatchRecord(
tenant_id='123e4567-e89b-12d3-a456-426614174000',
batch_id='016629d1-1d25-463f-97f3-0c6686846650',
name='Example Batch Name',
processed_state='submitted | materialized | completed | failed',
requested_by='987e6543-e21b-45d3-b123-123456789abc',
materialized_count=50,
processed_count=45,
created_at='2023-10-01T12:00Z',
updated_at='2023-10-02T15:30Z'
)
```
[[Back to top]](#)

17
docs/tools/sdk/python/Reference/V2024/Models/SedBatchRequest.md
View File

@@ -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.v2024.models.search_criteria.SearchCriteria(
indices = [entitlements],
filters = {status={type=TERMS, terms=[active, inactive]}},
query = sailpoint.v2024.models.search_criteria_query.SearchCriteria_query(),
query_type = 'TEXT',
text_query = sailpoint.v2024.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], )
}
)
```

34
docs/tools/sdk/python/Reference/V2024/Models/SedBatchStatus.md
View File

@@ -1,34 +0,0 @@
---
id: v2024-sed-batch-status
title: SedBatchStatus
pagination_label: SedBatchStatus
sidebar_label: SedBatchStatus
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus']
slug: /tools/sdk/python/v2024/models/sed-batch-status
tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus']
---
# SedBatchStatus
Sed Batch Status
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | status of batch | [optional]
}
## Example
```python
from sailpoint.v2024.models.sed_batch_status import SedBatchStatus
sed_batch_status = SedBatchStatus(
status='OK'
)
```
[[Back to top]](#)