merge changes from main and pull the latest from python docs

This commit is contained in:
darrell-thobe-sp
2025-03-10 11:34:32 -04:00
3122 changed files with 95404 additions and 24060 deletions

View File

@@ -28,9 +28,6 @@ Method | HTTP request | Description
## get-sed-batch-stats
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Sed Batch Stats Request
'Submit Sed Batch Stats Request.
@@ -45,7 +42,6 @@ Submit Sed Batch Stats Request
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | batch_id | **str** | True | Batch Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SedBatchStats**](../models/sed-batch-stats)
@@ -78,14 +74,13 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Submit Sed Batch Stats Request
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n")
pprint(results)
except Exception as e:
@@ -97,9 +92,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sed-batches
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List Sed Batch Request
List Sed Batches.
API responses with Sed Batch Status
@@ -107,10 +99,7 @@ API responses with Sed Batch Status
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
This endpoint does not need any parameter.
### Return type
[**SedBatchStatus**](../models/sed-batch-status)
@@ -142,14 +131,13 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# List Sed Batch Request
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n")
pprint(results)
except Exception as e:
@@ -161,9 +149,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-seds
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
List Suggested Entitlement Descriptions
List of Suggested Entitlement Descriptions (SED)
@@ -187,14 +172,14 @@ SED field descriptions:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Query | limit | **int** | (optional) | 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 | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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. 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.
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co*
Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status**
Query | count | **bool** | (optional) | 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) | 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 Coun parameter in that this one skip executing the actual query and always return an empty array.
Query | requested_by_anyone | **bool** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
Query | show_pending_status_only | **bool** | (optional) | Will limit records to items that are in \"suggested\" or \"approved\" status
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 | requested_by_anyone | **bool** | (optional) (default to False) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
Query | show_pending_status_only | **bool** | (optional) (default to False) | Will limit records to items that are in \"suggested\" or \"approved\" status
### Return type
[**List[Sed]**](../models/sed)
@@ -226,21 +211,21 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
limit = limit=25 # int | 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) # int | 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)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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. 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. (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. 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. (optional) (default to False)
filters = 'displayName co \"Read and Write\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
sorters = 'sorters=displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional)
count = count=true # 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) # 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)
count_only = count-only=true # 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # 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 Coun parameter in that this one skip executing the actual query and always return an empty array. (optional)
requested_by_anyone = requested-by-anyone=true # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional)
show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional)
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)
requested_by_anyone = False # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False)
show_pending_status_only = False # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False)
try:
# List Suggested Entitlement Descriptions
results =SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, )
results =SuggestedEntitlementDescriptionApi(api_client).list_seds()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only)
print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n")
pprint(results)
except Exception as e:
@@ -252,9 +237,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-sed
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Patch Suggested Entitlement Description
Patch Suggested Entitlement Description
@@ -265,7 +247,6 @@ Patch Suggested Entitlement Description
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | id is sed id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | sed_patch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request
### Return type
@@ -300,7 +281,6 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
[sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request
sed_patch = {
"op" : "replace",
@@ -313,9 +293,9 @@ with ApiClient(configuration) as api_client:
# Patch Suggested Entitlement Description
new_sed_patch = SedPatch()
new_sed_patch.from_json(sed_patch)
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch)
print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n")
pprint(results)
except Exception as e:
@@ -327,9 +307,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-approval
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Bulk Approval Request
Submit Bulk Approval Request for SED.
Request body takes list of SED Ids. API responses with list of SED Approval Status
@@ -340,7 +317,6 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | sed_approval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval
### Return type
@@ -374,7 +350,6 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
[sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval
sed_approval = {
"items" : "016629d1-1d25-463f-97f3-c6686846650"
@@ -385,9 +360,9 @@ with ApiClient(configuration) as api_client:
# Submit Bulk Approval Request
new_sed_approval = SedApproval()
new_sed_approval.from_json(sed_approval)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n")
pprint(results)
except Exception as e:
@@ -399,9 +374,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-assignment
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Sed Assignment Request
Submit Assignment Request.
Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together
@@ -412,7 +384,6 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | sed_assignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request
### Return type
@@ -446,7 +417,6 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
sed_assignment = {
"assignee" : {
"type" : "SOURCE_OWNER",
@@ -459,9 +429,9 @@ with ApiClient(configuration) as api_client:
# Submit Sed Assignment Request
new_sed_assignment = SedAssignment()
new_sed_assignment.from_json(sed_assignment)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n")
pprint(results)
except Exception as e:
@@ -473,9 +443,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-batch-request
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Submit Sed Batch Request
Submit Sed Batch Request.
Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together
@@ -486,7 +453,6 @@ Request body has one of the following: - a list of entitlement Ids - a list of S
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | sed_batch_request | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request
### Return type
@@ -520,7 +486,6 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
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" ]
@@ -529,9 +494,9 @@ with ApiClient(configuration) as api_client:
try:
# Submit Sed Batch Request
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, )
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, new_sed_batch_request)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n")
pprint(results)
except Exception as e: