mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update python SDK docs: 16836068438
This commit is contained in:
developer-relations-sp
@@ -767,6 +767,17 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-administrators-access-request-status
|
||||
:::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
|
||||
```
|
||||
:::
|
||||
Access request status for administrators
|
||||
Use this API to get access request statuses of all the access requests in the org based on the specified query parameters.
|
||||
Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses
|
||||
@@ -777,6 +788,7 @@ Any user with user level ORG_ADMIN or scope idn:access-request-administration:re
|
||||
|
||||
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 | requested_for | **str** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
||||
Query | requested_by | **str** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.
|
||||
Query | regarding_identity | **str** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.
|
||||
@@ -814,8 +826,10 @@ from sailpoint.v2025.models.access_request_admin_item_status import AccessReques
|
||||
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')
|
||||
requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
|
||||
requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
|
||||
regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
|
||||
@@ -830,9 +844,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Access request status for administrators
|
||||
|
||||
results = AccessRequestsApi(api_client).list_administrators_access_request_status()
|
||||
results = AccessRequestsApi(api_client).list_administrators_access_request_status(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
|
||||
# results = AccessRequestsApi(api_client).list_administrators_access_request_status(x_sail_point_experimental, requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
|
||||
print("The response of AccessRequestsApi->list_administrators_access_request_status:\n")
|
||||
for item in results:
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
|
||||
@@ -20,6 +20,7 @@ Method | HTTP request | Description
|
||||
[**create-managed-client**](#create-managed-client) | **POST** `/managed-clients` | Create managed client
|
||||
[**delete-managed-client**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client
|
||||
[**get-managed-client**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client
|
||||
[**get-managed-client-health-indicators**](#get-managed-client-health-indicators) | **GET** `/managed-clients/{id}/health-indicators` | Get managed client health indicators
|
||||
[**get-managed-client-status**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status
|
||||
[**get-managed-clients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients
|
||||
[**update-managed-client**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client
|
||||
@@ -202,6 +203,65 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-managed-client-health-indicators
|
||||
Get managed client health indicators
|
||||
Get a managed client's health indicators, using its ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-managed-client-health-indicators)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Managed client ID to get health indicators for.
|
||||
|
||||
### Return type
|
||||
[**ManagedClientHealthIndicators**](../models/managed-client-health-indicators)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Response with the managed client health indicators, with the given ID. | ManagedClientHealthIndicators | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.managed_clients_api import ManagedClientsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.models.managed_client_health_indicators import ManagedClientHealthIndicators
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID to get health indicators for. # str | Managed client ID to get health indicators for.
|
||||
|
||||
try:
|
||||
# Get managed client health indicators
|
||||
|
||||
results = ManagedClientsApi(api_client).get_managed_client_health_indicators(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ManagedClientsApi(api_client).get_managed_client_health_indicators(id)
|
||||
print("The response of ManagedClientsApi->get_managed_client_health_indicators:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ManagedClientsApi->get_managed_client_health_indicators: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-managed-client-status
|
||||
|
||||
@@ -24,6 +24,7 @@ Method | HTTP request | Description
|
||||
[**get-workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id
|
||||
[**get-workflow-execution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution
|
||||
[**get-workflow-execution-history**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history
|
||||
[**get-workflow-execution-history-v2**](#get-workflow-execution-history-v2) | **GET** `/workflow-executions/{id}/history-v2` | Get updated workflow execution history
|
||||
[**get-workflow-executions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions
|
||||
[**list-complete-workflow-library**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library
|
||||
[**list-workflow-library-actions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions
|
||||
@@ -500,6 +501,65 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-workflow-execution-history-v2
|
||||
Get updated workflow execution history
|
||||
Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-execution-history-v2)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Id of the workflow execution
|
||||
|
||||
### Return type
|
||||
[**WorkflowExecutionHistory**](../models/workflow-execution-history)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of workflow workflow definition, execution events, and workflow trigger for the given workflow execution | WorkflowExecutionHistory | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.workflows_api import WorkflowsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.models.workflow_execution_history import WorkflowExecutionHistory
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution
|
||||
|
||||
try:
|
||||
# Get updated workflow execution history
|
||||
|
||||
results = WorkflowsApi(api_client).get_workflow_execution_history_v2(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = WorkflowsApi(api_client).get_workflow_execution_history_v2(id)
|
||||
print("The response of WorkflowsApi->get_workflow_execution_history_v2:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling WorkflowsApi->get_workflow_execution_history_v2: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-workflow-executions
|
||||
|
||||
Reference in New Issue
Block a user