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
@@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
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/beta/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[Sed]**](../models/sed)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Status of batch | SedBatchStatus | - |
|
||||
200 | List of Sed Batch Records | List[Sed] | - |
|
||||
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. | ListAccessModelMetadataAttribute401Response | - |
|
||||
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.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
|
||||
from sailpoint.beta.api_client import ApiClient
|
||||
from sailpoint.beta.models.sed_batch_status import SedBatchStatus
|
||||
from sailpoint.beta.models.sed import Sed
|
||||
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)
|
||||
```
|
||||
@@ -471,7 +484,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:
|
||||
|
||||
Reference in New Issue
Block a user