Update python SDK docs: 16269863689

This commit is contained in:
developer-relations-sp
2025-07-14 14:39:17 +00:00
parent e415929308
commit b09e87e16d
28 changed files with 521 additions and 724 deletions

View File

@@ -231,17 +231,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## close-access-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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Close access request
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
@@ -262,7 +251,6 @@ This API triggers the [Provisioning Completed event trigger](https://developer.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 | close_access_request | [**CloseAccessRequest**](../models/close-access-request) | True |
### Return type
@@ -291,10 +279,8 @@ from sailpoint.v2024.models.close_access_request import CloseAccessRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
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')
close_access_request = '''{
"executionStatus" : "Terminated",
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
@@ -305,9 +291,9 @@ with ApiClient(configuration) as api_client:
try:
# Close access request
new_close_access_request = CloseAccessRequest.from_json(close_access_request)
results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request)
results = AccessRequestsApi(api_client).close_access_request(close_access_request=new_close_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
# results = AccessRequestsApi(api_client).close_access_request(new_close_access_request)
print("The response of AccessRequestsApi->close_access_request:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: