Update python SDK docs: 15116515953

This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions

View File

@@ -18,17 +18,17 @@ 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
[**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
[**submit-sed-assignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**submit-sed-batch-request**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
[**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
[**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
[**submit-sed-assignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit sed assignment request
[**submit-sed-batch-request**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit sed batch request
## get-sed-batch-stats
Submit Sed Batch Stats Request
Submit sed batch stats request
'Submit Sed Batch Stats Request.
Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id
try:
# Submit Sed Batch Stats Request
# Submit sed batch stats request
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id)
# Below is a request that includes all optional parameters
@@ -91,7 +91,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-sed-batches
List Sed Batch Request
List sed batch request
List Sed Batches.
API responses with Sed Batch Status
@@ -131,7 +131,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Sed Batch Request
# List sed batch request
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
# Below is a request that includes all optional parameters
@@ -147,7 +147,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-seds
List Suggested Entitlement Descriptions
List suggested entitlement descriptions
List of Suggested Entitlement Descriptions (SED)
SED field descriptions:
@@ -218,7 +218,7 @@ with ApiClient(configuration) as api_client:
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
# List suggested entitlement descriptions
results = SuggestedEntitlementDescriptionApi(api_client).list_seds()
# Below is a request that includes all optional parameters
@@ -235,7 +235,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-sed
Patch Suggested Entitlement Description
Patch suggested entitlement description
Patch Suggested Entitlement Description
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed)
@@ -281,7 +281,7 @@ with ApiClient(configuration) as api_client:
sed_patch = '''[sailpoint.v2024.SedPatch()]''' # List[SedPatch] | Sed Patch Request
try:
# Patch Suggested Entitlement Description
# Patch suggested entitlement description
new_sed_patch = SedPatch.from_json(sed_patch)
results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch)
# Below is a request that includes all optional parameters
@@ -297,7 +297,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-approval
Submit Bulk Approval Request
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
@@ -342,7 +342,7 @@ with ApiClient(configuration) as api_client:
sed_approval = '''[sailpoint.v2024.SedApproval()]''' # List[SedApproval] | Sed Approval
try:
# Submit Bulk Approval Request
# Submit bulk approval request
new_sed_approval = SedApproval.from_json(sed_approval)
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval)
# Below is a request that includes all optional parameters
@@ -359,7 +359,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-assignment
Submit Sed Assignment Request
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
@@ -410,7 +410,7 @@ with ApiClient(configuration) as api_client:
}''' # SedAssignment | Sed Assignment Request
try:
# Submit Sed Assignment Request
# Submit sed assignment request
new_sed_assignment = SedAssignment.from_json(sed_assignment)
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment)
# Below is a request that includes all optional parameters
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-sed-batch-request
Submit Sed Batch Request
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
@@ -474,7 +474,7 @@ with ApiClient(configuration) as api_client:
}''' # SedBatchRequest | Sed Batch Request (optional)
try:
# Submit Sed Batch Request
# Submit sed batch request
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request()
# Below is a request that includes all optional parameters