LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 16633304233

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-30 20:42:39 +00:00
parent 5d76be1d9d
commit cfdbd8d149
37 changed files with 2482 additions and 594 deletions
Download Patch File Download Diff File Expand all files Collapse all files

398
docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md
View File

@@ -18,10 +18,86 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**approve-approval**](#approve-approval) | **POST** `/generic-approvals/{id}/approve` | Post Approvals Approve
[**get-approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval
[**get-approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
[**reject-approval**](#reject-approval) | **POST** `/generic-approvals/{id}/reject` | Post Approvals Reject
[**update-approvals-attributes**](#update-approvals-attributes) | **POST** `/generic-approvals/{id}/attributes` | Post Approvals Attributes
[**update-approvals-comments**](#update-approvals-comments) | **POST** `/generic-approvals/{id}/comments` | Post Approvals Comments
[**update-approvals-reassign**](#update-approvals-reassign) | **POST** `/generic-approvals/{id}/reassign` | Post Approvals Reassign
## approve-approval
Post Approvals Approve
Currently this endpoint only supports Entitlement Description Approvals.
Approves a specified approval request on behalf of the caller. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. The approval request must be in a state that allows it to be approved.
If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/approve-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Approval ID that correlates to an existing approval request that a user wants to approve
Body | approval_approve_request | [**ApprovalApproveRequest**](../models/approval-approve-request) | (optional) |
### Return type
[**Approval**](../models/approval)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Approval object | Approval | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.approvals_api import ApprovalsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.approval import Approval
from sailpoint.v2025.models.approval_approve_request import ApprovalApproveRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | Approval ID that correlates to an existing approval request that a user wants to approve # str | Approval ID that correlates to an existing approval request that a user wants to approve
approval_approve_request = '''{
"comment" : "comment",
"additionalAttributes" : {
"additionalProp1" : "string",
"additionalProp2" : "string",
"additionalProp3" : "string"
}
}''' # ApprovalApproveRequest | (optional)
try:
# Post Approvals Approve
results = ApprovalsApi(api_client).approve_approval(id=id)
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).approve_approval(id, new_approval_approve_request)
print("The response of ApprovalsApi->approve_approval:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ApprovalsApi->approve_approval: %s\n" % e)
```
[[Back to top]](#)
## get-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.
@@ -35,6 +111,7 @@ This API is currently in an experimental state. The API is subject to change bas
```
:::
Get an approval
Currently this endpoint only supports Entitlement Description Approvals.
Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-approval)
@@ -95,20 +172,11 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-approvals
:::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
```
:::
Get approvals
Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
Absence of all query parameters will will default to mine=true.
Currently this endpoint only supports Entitlement Description Approvals.
Get a list of approvals. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals.
Absence of all query parameters for non admins will will default to mine=true.
Absence of all query parameters for admins will return all approvals in the org.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-approvals)
@@ -116,10 +184,19 @@ Absence of all query parameters will will default to mine=true.
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 | mine | **bool** | (optional) | Returns the list of approvals for the current caller
Query | requester_id | **str** | (optional) | Returns the list of approvals for a given requester ID
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: **status**: *eq* **referenceType**: *eq*
Query | mine | **bool** | (optional) (default to False) | Returns the list of approvals for the current caller.
Query | requester_id | **str** | (optional) | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin.
Query | requestee_id | **str** | (optional) | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin.
Query | approver_id | **str** | (optional) | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin.
Query | count | **bool** | (optional) (default to False) | Adds X-Total-Count to the header to give the amount of total approvals returned from the query.
Query | count_only | **bool** | (optional) (default to False) | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects.
Query | include_comments | **bool** | (optional) (default to False) | If set to true in the query, the approval requests returned will include comments.
Query | include_approvers | **bool** | (optional) (default to False) | If set to true in the query, the approval requests returned will include approvers.
Query | include_batch_info | **bool** | (optional) (default to False) | If set to true in the query, the approval requests returned will include batch information.
Query | include_batch_info2 | **bool** | (optional) (default to False) | If set to true in the query, the approval requests returned will include batch 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: **status**: *eq* **referenceType**: *eq* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq*
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.
### Return type
[**List[Approval]**](../models/approval)
@@ -127,7 +204,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of Approvals | List[Approval] | - |
200 | List of approvals. | List[Approval] | - |
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 | - |
@@ -147,20 +224,28 @@ from sailpoint.v2025.models.approval import Approval
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')
mine = true # bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional)
requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID (optional) # str | Returns the list of approvals for a given requester ID (optional)
filters = 'filters=status eq PENDING' # 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: **status**: *eq* **referenceType**: *eq* (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: **status**: *eq* **referenceType**: *eq* (optional)
mine = False # bool | Returns the list of approvals for the current caller. (optional) (default to False) # bool | Returns the list of approvals for the current caller. (optional) (default to False)
requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin. (optional) # str | Returns the list of approvals for a given requester ID. Must match the calling user's identity ID unless they are an admin. (optional)
requestee_id = '27e6334g757e481569df76323169db9sc' # str | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin. (optional) # str | Returns the list of approvals for a given requesteeId ID. Must match the calling user's identity ID unless they are an admin. (optional)
approver_id = '37e6334g557e481569df7g2d3169db9sb' # str | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin. (optional) # str | Returns the list of approvals for a given approverId ID. Must match the calling user's identity ID unless they are an admin. (optional)
count = False # bool | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) (default to False) # bool | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) (default to False)
count_only = False # bool | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) (default to False) # bool | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) (default to False)
include_comments = False # bool | If set to true in the query, the approval requests returned will include comments. (optional) (default to False) # bool | If set to true in the query, the approval requests returned will include comments. (optional) (default to False)
include_approvers = False # bool | If set to true in the query, the approval requests returned will include approvers. (optional) (default to False) # bool | If set to true in the query, the approval requests returned will include approvers. (optional) (default to False)
include_batch_info = False # bool | If set to true in the query, the approval requests returned will include batch information. (optional) (default to False) # bool | If set to true in the query, the approval requests returned will include batch information. (optional) (default to False)
include_batch_info2 = False # bool | If set to true in the query, the approval requests returned will include batch information. (optional) (default to False) # bool | If set to true in the query, the approval requests returned will include batch information. (optional) (default to False)
filters = 'filters=status eq PENDING' # 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: **status**: *eq* **referenceType**: *eq* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq* (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: **status**: *eq* **referenceType**: *eq* **name**: *eq* **priority**: *eq* **type**: *eq* **medium**: *eq* **description**: *eq* **batchId**: *eq* **approvalId**: *eq* **tenantId**: *eq* **createdDate**: *eq* **dueDate**: *eq* **completedDate**: *eq* **search**: *eq* **referenceId**: *eq* **referenceName**: *eq* **requestedTargetType**: *eq* **requestedTargetRequestType**: *eq* **requestedTargetId**: *eq* **modifiedDate**: *eq* **requesterId**: *eq* **requesteeId**: *eq* **approverId**: *eq* (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)
try:
# Get approvals
results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental)
results = ApprovalsApi(api_client).get_approvals()
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters)
# results = ApprovalsApi(api_client).get_approvals(mine, requester_id, requestee_id, approver_id, count, count_only, include_comments, include_approvers, include_batch_info, include_batch_info2, filters, limit, offset)
print("The response of ApprovalsApi->get_approvals:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -170,6 +255,269 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reject-approval
Post Approvals Reject
Currently this endpoint only supports Entitlement Description Approvals.
Rejects a specified approval request on behalf of the caller.
If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/reject-approval)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Approval ID that correlates to an existing approval request that a user wants to reject.
Body | approval_reject_request | [**ApprovalRejectRequest**](../models/approval-reject-request) | (optional) |
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.approvals_api import ApprovalsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.approval_reject_request import ApprovalRejectRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | Approval ID that correlates to an existing approval request that a user wants to reject. # str | Approval ID that correlates to an existing approval request that a user wants to reject.
approval_reject_request = '''{
"comment" : "string"
}''' # ApprovalRejectRequest | (optional)
try:
# Post Approvals Reject
ApprovalsApi(api_client).reject_approval(id=id)
# Below is a request that includes all optional parameters
# ApprovalsApi(api_client).reject_approval(id, new_approval_reject_request)
except Exception as e:
print("Exception when calling ApprovalsApi->reject_approval: %s\n" % e)
```
[[Back to top]](#)
## update-approvals-attributes
Post Approvals Attributes
Currently this endpoint only supports Entitlement Description Approvals.
Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-approvals-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
Body | approval_attributes_request | [**ApprovalAttributesRequest**](../models/approval-attributes-request) | True |
### Return type
[**Approval**](../models/approval)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Approval object | Approval | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.approvals_api import ApprovalsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.approval import Approval
from sailpoint.v2025.models.approval_attributes_request import ApprovalAttributesRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | Approval ID that correlates to an existing approval request that a user wants to change the attributes of. # str | Approval ID that correlates to an existing approval request that a user wants to change the attributes of.
approval_attributes_request = '''{
"removeAttributeKeys" : [ "string" ],
"comment" : "comment",
"additionalAttributes" : {
"additionalProp1" : "string",
"additionalProp2" : "string",
"additionalProp3" : "string"
}
}''' # ApprovalAttributesRequest |
try:
# Post Approvals Attributes
new_approval_attributes_request = ApprovalAttributesRequest.from_json(approval_attributes_request)
results = ApprovalsApi(api_client).update_approvals_attributes(id=id, approval_attributes_request=new_approval_attributes_request)
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).update_approvals_attributes(id, new_approval_attributes_request)
print("The response of ApprovalsApi->update_approvals_attributes:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ApprovalsApi->update_approvals_attributes: %s\n" % e)
```
[[Back to top]](#)
## update-approvals-comments
Post Approvals Comments
Currently this endpoint only supports Entitlement Description Approvals.
Adds comments to a specified approval request.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-approvals-comments)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Approval ID that correlates to an existing approval request that a user wants to add a comment to.
Body | approval_comments_request | [**ApprovalCommentsRequest**](../models/approval-comments-request) | True |
### Return type
[**Approval**](../models/approval)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Approval object | Approval | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.approvals_api import ApprovalsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.approval import Approval
from sailpoint.v2025.models.approval_comments_request import ApprovalCommentsRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | Approval ID that correlates to an existing approval request that a user wants to add a comment to. # str | Approval ID that correlates to an existing approval request that a user wants to add a comment to.
approval_comments_request = '''{
"comment" : "Approval comment."
}''' # ApprovalCommentsRequest |
try:
# Post Approvals Comments
new_approval_comments_request = ApprovalCommentsRequest.from_json(approval_comments_request)
results = ApprovalsApi(api_client).update_approvals_comments(id=id, approval_comments_request=new_approval_comments_request)
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).update_approvals_comments(id, new_approval_comments_request)
print("The response of ApprovalsApi->update_approvals_comments:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling ApprovalsApi->update_approvals_comments: %s\n" % e)
```
[[Back to top]](#)
## update-approvals-reassign
Post Approvals Reassign
Currently this endpoint only supports Entitlement Description Approvals.
Reassigns an approval request to another identity resulting in that identity being added as an authorized approver.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-approvals-reassign)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Approval ID that correlates to an existing approval request that a user wants to reassign.
Body | approval_reassign_request | [**ApprovalReassignRequest**](../models/approval-reassign-request) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.approvals_api import ApprovalsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.approval_reassign_request import ApprovalReassignRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | Approval ID that correlates to an existing approval request that a user wants to reassign. # str | Approval ID that correlates to an existing approval request that a user wants to reassign.
approval_reassign_request = '''{
"reassignTo" : "152354832eb6f8f539fd738592e19ec5",
"comment" : "comment",
"reassignFrom" : "384532516be25f8fdf935ce19e295837"
}''' # ApprovalReassignRequest |
try:
# Post Approvals Reassign
new_approval_reassign_request = ApprovalReassignRequest.from_json(approval_reassign_request)
ApprovalsApi(api_client).update_approvals_reassign(id=id, approval_reassign_request=new_approval_reassign_request)
# Below is a request that includes all optional parameters
# ApprovalsApi(api_client).update_approvals_reassign(id, new_approval_reassign_request)
except Exception as e:
print("Exception when calling ApprovalsApi->update_approvals_reassign: %s\n" % e)
```
[[Back to top]](#)

473
docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md
View File

@@ -15,11 +15,170 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-machine-account-subtype**](#create-machine-account-subtype) | **POST** `/sources/{sourceId}/subtypes` | Create subtype
[**delete-machine-account-subtype**](#delete-machine-account-subtype) | **DELETE** `/sources/{sourceId}/subtypes/{technicalName}` | Delete subtype
[**get-machine-account**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine account details
[**get-machine-account-subtype-by-id**](#get-machine-account-subtype-by-id) | **GET** `/sources/subtype/{subtypeId}` | Retrieve subtype by subtype id
[**get-machine-account-subtype-by-technical-name**](#get-machine-account-subtype-by-technical-name) | **GET** `/sources/{sourceId}/subtypes/{technicalName}` | Retrieve subtype by source and technicalName
[**list-machine-account-subtypes**](#list-machine-account-subtypes) | **GET** `/sources/{sourceId}/subtypes` | Retrieve all subtypes by source
[**list-machine-accounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine accounts list
[**patch-machine-account-subtype**](#patch-machine-account-subtype) | **PATCH** `/sources/{sourceId}/subtypes/{technicalName}` | Patch subtype
[**update-machine-account**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a machine account
## create-machine-account-subtype
:::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
```
:::
Create subtype
Create a new machine account subtype for a source.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-machine-account-subtype)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | The ID of the source.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | source_subtype | [**SourceSubtype**](../models/source-subtype) | True |
### Return type
[**SourceSubtype**](../models/source-subtype)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
201 | Created machine account subtype. | SourceSubtype | - |
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 | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
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')
source_subtype = '''{
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"displayName" : "Mr Foo",
"created" : "2025-07-28T16:13:42.8013Z",
"description" : "fighters",
"modified" : "2025-07-28T16:13:42.75085Z",
"id" : "43bdd144-4b17-4fce-a744-17c7fd3e717b",
"technicalName" : "foo"
}''' # SourceSubtype |
try:
# Create subtype
new_source_subtype = SourceSubtype.from_json(source_subtype)
results = MachineAccountsApi(api_client).create_machine_account_subtype(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental, source_subtype=new_source_subtype)
# Below is a request that includes all optional parameters
# results = MachineAccountsApi(api_client).create_machine_account_subtype(source_id, x_sail_point_experimental, new_source_subtype)
print("The response of MachineAccountsApi->create_machine_account_subtype:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountsApi->create_machine_account_subtype: %s\n" % e)
```
[[Back to top]](#)
## delete-machine-account-subtype
:::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
```
:::
Delete subtype
Delete a machine account subtype by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-machine-account-subtype)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | subtype_id | **str** | True | The ID of the machine account subtype.
Path | technical_name | **str** | True | The technical name of the subtype.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
204 | Subtype deleted successfully. | | - |
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 | - |
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.machine_accounts_api import MachineAccountsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
subtype_id = '43bdd144-4b17-4fce-a744-17c7fd3e717b' # str | The ID of the machine account subtype. # str | The ID of the machine account subtype.
technical_name = 'foo' # str | The technical name of the subtype. # str | The technical name of the subtype.
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:
# Delete subtype
MachineAccountsApi(api_client).delete_machine_account_subtype(subtype_id=subtype_id, technical_name=technical_name, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# MachineAccountsApi(api_client).delete_machine_account_subtype(subtype_id, technical_name, x_sail_point_experimental)
except Exception as e:
print("Exception when calling MachineAccountsApi->delete_machine_account_subtype: %s\n" % e)
```
[[Back to top]](#)
## get-machine-account
:::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.
@@ -91,6 +250,235 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-machine-account-subtype-by-id
:::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
```
:::
Retrieve subtype by subtype id
Get a machine account subtype by its unique ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-account-subtype-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | subtype_id | **str** | True | The ID of the machine account subtype.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SourceSubtype**](../models/source-subtype)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Machine account subtype object. | SourceSubtype | - |
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 | - |
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.machine_accounts_api import MachineAccountsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
subtype_id = '43bdd144-4b17-4fce-a744-17c7fd3e717b' # str | The ID of the machine account subtype. # str | The ID of the machine account subtype.
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:
# Retrieve subtype by subtype id
results = MachineAccountsApi(api_client).get_machine_account_subtype_by_id(subtype_id=subtype_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = MachineAccountsApi(api_client).get_machine_account_subtype_by_id(subtype_id, x_sail_point_experimental)
print("The response of MachineAccountsApi->get_machine_account_subtype_by_id:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountsApi->get_machine_account_subtype_by_id: %s\n" % e)
```
[[Back to top]](#)
## get-machine-account-subtype-by-technical-name
:::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
```
:::
Retrieve subtype by source and technicalName
Get a machine account subtype by source ID and technical name.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-machine-account-subtype-by-technical-name)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | The ID of the source.
Path | technical_name | **str** | True | The technical name of the subtype.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**SourceSubtype**](../models/source-subtype)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Machine account subtype object. | SourceSubtype | - |
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 | - |
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.machine_accounts_api import MachineAccountsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
technical_name = 'foo' # str | The technical name of the subtype. # str | The technical name of the subtype.
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:
# Retrieve subtype by source and technicalName
results = MachineAccountsApi(api_client).get_machine_account_subtype_by_technical_name(source_id=source_id, technical_name=technical_name, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = MachineAccountsApi(api_client).get_machine_account_subtype_by_technical_name(source_id, technical_name, x_sail_point_experimental)
print("The response of MachineAccountsApi->get_machine_account_subtype_by_technical_name:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountsApi->get_machine_account_subtype_by_technical_name: %s\n" % e)
```
[[Back to top]](#)
## list-machine-account-subtypes
:::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
```
:::
Retrieve all subtypes by source
Get all machine account subtypes for a given source.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-machine-account-subtypes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | The ID of the source.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
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: **displayName**: *eq, sw* **technicalName**: *eq, sw*
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, technicalName**
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 | 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.
### Return type
[**List[SourceSubtype]**](../models/source-subtype)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of machine account subtypes. | List[SourceSubtype] | - |
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 | - |
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.machine_accounts_api import MachineAccountsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
source_id = '6d0458373bec4b4b80460992b76016da' # str | The ID of the source. # str | The ID of the source.
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')
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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: **displayName**: *eq, sw* **technicalName**: *eq, sw* (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: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional)
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, technicalName** (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, technicalName** (optional)
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)
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)
try:
# Retrieve all subtypes by source
results = MachineAccountsApi(api_client).list_machine_account_subtypes(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = MachineAccountsApi(api_client).list_machine_account_subtypes(source_id, x_sail_point_experimental, filters, sorters, count, limit, offset)
print("The response of MachineAccountsApi->list_machine_account_subtypes:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountsApi->list_machine_account_subtypes: %s\n" % e)
```
[[Back to top]](#)
## list-machine-accounts
@@ -173,6 +561,91 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-machine-account-subtype
:::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
```
:::
Patch subtype
Update fields of a machine account subtype by its ID.
Patchable fields include: `displayName`, `description`, `technicalName`.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-machine-account-subtype)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | subtype_id | **str** | True | The ID of the machine account subtype.
Path | technical_name | **str** | True | The technical name of the subtype.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | source_subtype | [**SourceSubtype**](../models/source-subtype) | True |
### Return type
[**SourceSubtype**](../models/source-subtype)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Updated machine account subtype. | SourceSubtype | - |
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 | - |
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**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.source_subtype import SourceSubtype
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
subtype_id = '43bdd144-4b17-4fce-a744-17c7fd3e717b' # str | The ID of the machine account subtype. # str | The ID of the machine account subtype.
technical_name = 'foo' # str | The technical name of the subtype. # str | The technical name of the subtype.
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')
source_subtype = '''{
"sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"displayName" : "Mr Foo",
"created" : "2025-07-28T16:13:42.8013Z",
"description" : "fighters",
"modified" : "2025-07-28T16:13:42.75085Z",
"id" : "43bdd144-4b17-4fce-a744-17c7fd3e717b",
"technicalName" : "foo"
}''' # SourceSubtype |
try:
# Patch subtype
new_source_subtype = SourceSubtype.from_json(source_subtype)
results = MachineAccountsApi(api_client).patch_machine_account_subtype(subtype_id=subtype_id, technical_name=technical_name, x_sail_point_experimental=x_sail_point_experimental, source_subtype=new_source_subtype)
# Below is a request that includes all optional parameters
# results = MachineAccountsApi(api_client).patch_machine_account_subtype(subtype_id, technical_name, x_sail_point_experimental, new_source_subtype)
print("The response of MachineAccountsApi->patch_machine_account_subtype:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountsApi->patch_machine_account_subtype: %s\n" % e)
```
[[Back to top]](#)
## update-machine-account

301
docs/tools/sdk/python/Reference/V2025/Models/Approval.md
View File

@@ -17,23 +17,35 @@ Approval Object
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approval_id** | **str** | The Approval ID | [optional]
**id** | **str** | The Approval ID | [optional]
**tenant_id** | **str** | The Tenant ID of the Approval | [optional]
**type** | **str** | The type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL | [optional]
**approvers** | [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional]
**created_date** | **str** | Date the approval was created | [optional]
**type** | **str** | Type of approval | [optional]
**due_date** | **str** | Date the approval is due | [optional]
**escalation_step** | **str** | Step in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain. | [optional]
**serial_step** | **int** | The serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0. | [optional]
**is_escalated** | **bool** | Whether or not the approval has been escalated. Will reset to false when the approval is actioned on. | [optional] [default to False]
**name** | [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional]
**batch_request** | [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional]
**approval_config** | [**ApprovalConfig**](approval-config) | The configuration of the approval, such as the approval criteria and whether it is a parallel or serial approval | [optional]
**description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional]
**medium** | **Enum** [ 'EMAIL', 'SLACK', 'TEAMS' ] | Signifies what medium to use when sending notifications (currently only email is utilized) | [optional]
**priority** | **Enum** [ 'HIGH', 'MEDIUM', 'LOW' ] | The priority of the approval | [optional]
**requester** | [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional]
**requestee** | [**ApprovalIdentity**](approval-identity) | Object representation of the requestee of the approval | [optional]
**comments** | [**[]ApprovalComment1**](approval-comment1) | Object representation of a comment on the approval | [optional]
**approved_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional]
**rejected_by** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional]
**approved_by** | [**[]ApprovalIdentityRecord**](approval-identity-record) | Array of approvers who have approved the approval | [optional]
**rejected_by** | [**[]ApprovalIdentityRecord**](approval-identity-record) | Array of approvers who have rejected the approval | [optional]
**assigned_to** | [**[]ApprovalIdentity**](approval-identity) | Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve. | [optional]
**completed_date** | **str** | Date the approval was completed | [optional]
**approval_criteria** | **Enum** [ 'SINGLE', 'DOUBLE', 'TRIPLE', 'QUARTER', 'HALF', 'ALL' ] | Criteria that needs to be met for an approval to be marked as approved | [optional]
**status** | **Enum** [ 'PENDING', 'APPROVED', 'REJECTED' ] | The current status of the approval | [optional]
**approval_criteria** | [**ApprovalApprovalCriteria**](approval-approval-criteria) | | [optional]
**additional_attributes** | **str** | Json string representing additional attributes known about the object to be approved. | [optional]
**reference_data** | [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional]
**reassignment_history** | [**[]ApprovalReassignmentHistory**](approval-reassignment-history) | History of whom the approval request was assigned to | [optional]
**static_attributes** | **map[string]object** | Field that can include any static additional info that may be needed by the service that the approval request originated from | [optional]
**modified_date** | **datetime** | Date/time that the approval request was last updated | [optional]
**requested_target** | [**[]ApprovalRequestedTarget**](approval-requested-target) | RequestedTarget used to specify the actual object or target the approval request is for | [optional]
}
## Example
@@ -42,57 +54,296 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.approval import Approval
approval = Approval(
approval_id='38453251-6be2-5f8f-df93-5ce19e295837',
id='38453251-6be2-5f8f-df93-5ce19e295837',
tenant_id='38453251-6be2-5f8f-df93-5ce19e295837',
type='ENTITLEMENT_DESCRIPTIONS',
approvers=[
sailpoint.v2025.models.approval_identity.Approval Identity(
id = '85d173e7d57e496569df763231d6deb6a',
type = 'IDENTITY',
name = 'John Doe', )
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', )
],
created_date='2023-04-12T23:20:50.52Z',
type='ENTITLEMENT_DESCRIPTIONS',
due_date='2024-05-12T23:10:50.11Z',
escalation_step='0',
serial_step=0,
is_escalated=True,
name=[
sailpoint.v2025.models.approval_name.Approval Name(
value = 'Audit DB Access',
locale = 'en_US', )
],
batch_request={batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100},
approval_config=sailpoint.v2025.models.approval_config.ApprovalConfig(
tenant_id = 'd3c10266-1a31-4acc-b01e-44a3d1c56615',
id = '5804e7d6-e04b-400f-9fb8-dff894419a2f',
scope = 'APPROVAL_REQUEST',
reminder_config = sailpoint.v2025.models.approval_config_reminder_config.ApprovalConfig_reminderConfig(
enabled = False,
days_until_first_reminder = 0,
reminder_cron_schedule = '1 1 1 1 1',
max_reminders = 5, ),
escalation_config = sailpoint.v2025.models.approval_config_escalation_config.ApprovalConfig_escalationConfig(
enabled = True,
days_until_first_escalation = 2,
escalation_cron_schedule = '*/5 * * * *',
escalation_chain = [
sailpoint.v2025.models.approval_config_escalation_config_escalation_chain_inner.ApprovalConfig_escalationConfig_escalationChain_inner(
chain_id = 'ef85d1a8-41ef-433a-8153-0b1f59e7b26a',
tier = 1,
identity_id = 'fdfda352157d4cc79bb749953131b457',
identity_type = 'IDENTITY', )
], ),
timeout_config = sailpoint.v2025.models.approval_config_timeout_config.ApprovalConfig_timeoutConfig(
enabled = True,
days_until_timeout = 2,
timeout_result = 'EXPIRED', ),
cron_timezone = sailpoint.v2025.models.approval_config_cron_timezone.ApprovalConfig_cronTimezone(
location = 'America/New_York',
offset = '', ),
serial_chain = [
sailpoint.v2025.models.approval_config_serial_chain_inner.ApprovalConfig_serialChain_inner(
chain_id = '23dc206e-2a9e-4f98-93db-8d6e342cca18',
tier = 1,
identity_id = '2c9180858090ea8801809a0465e829da',
identity_type = 'IDENTITY', )
],
requires_comment = 'ALL',
fallback_approver = sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
auto_approve = 'false', ),
description=[
sailpoint.v2025.models.approval_description.Approval Description(
value = 'This access allows viewing and editing of workflow resource',
locale = 'en_US', )
],
medium='EMAIL',
priority='HIGH',
requester={id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe},
requester=sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
requestee=sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
comments=[
sailpoint.v2025.models.approval_comment.Approval Comment(
author = sailpoint.v2025.models.approval_identity.Approval Identity(
id = '85d173e7d57e496569df763231d6deb6a',
type = 'IDENTITY',
name = 'John Doe', ),
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
comment = 'Looks good',
created_date = '2023-04-12T23:20:50.52Z', )
created_date = '2023-04-12T23:20:50.52Z',
comment_id = '38453251-6be2-5f8f-df93-5ce19e295837', )
],
approved_by=[
sailpoint.v2025.models.approval_identity.Approval Identity(
id = '85d173e7d57e496569df763231d6deb6a',
sailpoint.v2025.models.approval_identity_record.ApprovalIdentityRecord(
identity_id = '17e633e7d57e481569df76323169deb6a',
type = 'IDENTITY',
name = 'John Doe', )
name = 'Jim Bob',
actioned_as = [
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
members = [
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
decision_date = '2023-04-12T23:20:50.520Z',
email = 'user@example.com', )
],
rejected_by=[
sailpoint.v2025.models.approval_identity.Approval Identity(
id = '85d173e7d57e496569df763231d6deb6a',
sailpoint.v2025.models.approval_identity_record.ApprovalIdentityRecord(
identity_id = '17e633e7d57e481569df76323169deb6a',
type = 'IDENTITY',
name = 'John Doe', )
name = 'Jim Bob',
actioned_as = [
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
members = [
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
decision_date = '2023-04-12T23:20:50.520Z',
email = 'user@example.com', )
],
assigned_to=[
sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', )
],
completed_date='2023-04-12T23:20:50.52Z',
approval_criteria='SINGLE',
status='PENDING',
approval_criteria=sailpoint.v2025.models.approval_approval_criteria.Approval_approvalCriteria(
type = 'SERIAL',
approval = sailpoint.v2025.models.approval_approval_criteria_approval.Approval_approvalCriteria_approval(
calculation_type = 'COUNT',
value = 70, ),
rejection = sailpoint.v2025.models.approval_approval_criteria_rejection.Approval_approvalCriteria_rejection(
calculation_type = 'COUNT',
value = 30, ), ),
additional_attributes='{ "llm_description": "generated description" }',
reference_data=[
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId', )
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
reassignment_history=[
sailpoint.v2025.models.approval_reassignment_history.ApprovalReassignmentHistory(
comment_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
reassigned_from = sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
reassigned_to = sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
name = 'Jim Bob',
serial_order = 0,
type = 'IDENTITY', ),
reassigner = ,
reassignment_date = '2023-10-01T12:34:56.789Z',
reassignment_type = 'ESCALATION', )
],
static_attributes={serviceName=ApprovalService, requestType=AccessRequest, metadata={environment=production, region=us-east-1}},
modified_date='2023-10-01T12:34:56.789Z',
requested_target=[
sailpoint.v2025.models.approval_requested_target.ApprovalRequestedTarget(
forced_auth_signature = 'string',
id = 'string',
name = 'string',
reauth_required = True,
removal_date = '2025-07-07T18:10:13.687Z',
request_type = 'string',
target_type = 'string', )
]
)

42
docs/tools/sdk/python/Reference/V2025/Models/ApprovalApprovalCriteria.md Normal file
View File

@@ -0,0 +1,42 @@
---
id: v2025-approval-approval-criteria
title: ApprovalApprovalCriteria
pagination_label: ApprovalApprovalCriteria
sidebar_label: ApprovalApprovalCriteria
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalApprovalCriteria', 'V2025ApprovalApprovalCriteria']
slug: /tools/sdk/python/v2025/models/approval-approval-criteria
tags: ['SDK', 'Software Development Kit', 'ApprovalApprovalCriteria', 'V2025ApprovalApprovalCriteria']
---
# ApprovalApprovalCriteria
Criteria that needs to be met for an approval or rejection
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | Type of approval criteria, such as SERIAL or PARALLEL | [optional]
**approval** | [**ApprovalApprovalCriteriaApproval**](approval-approval-criteria-approval) | | [optional]
**rejection** | [**ApprovalApprovalCriteriaRejection**](approval-approval-criteria-rejection) | | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_approval_criteria import ApprovalApprovalCriteria
approval_approval_criteria = ApprovalApprovalCriteria(
type='SERIAL',
approval=sailpoint.v2025.models.approval_approval_criteria_approval.Approval_approvalCriteria_approval(
calculation_type = 'COUNT',
value = 70, ),
rejection=sailpoint.v2025.models.approval_approval_criteria_rejection.Approval_approvalCriteria_rejection(
calculation_type = 'COUNT',
value = 30, )
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/V2025/Models/ApprovalApprovalCriteriaApproval.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2025-approval-approval-criteria-approval
title: ApprovalApprovalCriteriaApproval
pagination_label: ApprovalApprovalCriteriaApproval
sidebar_label: ApprovalApprovalCriteriaApproval
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalApprovalCriteriaApproval', 'V2025ApprovalApprovalCriteriaApproval']
slug: /tools/sdk/python/v2025/models/approval-approval-criteria-approval
tags: ['SDK', 'Software Development Kit', 'ApprovalApprovalCriteriaApproval', 'V2025ApprovalApprovalCriteriaApproval']
---
# ApprovalApprovalCriteriaApproval
Criteria for approval
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**calculation_type** | **Enum** [ 'COUNT', 'PERCENT' ] | This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to approve | [optional]
**value** | **int** | The value that needs to be met for the approval criteria | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_approval_criteria_approval import ApprovalApprovalCriteriaApproval
approval_approval_criteria_approval = ApprovalApprovalCriteriaApproval(
calculation_type='COUNT',
value=70
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/V2025/Models/ApprovalApprovalCriteriaRejection.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2025-approval-approval-criteria-rejection
title: ApprovalApprovalCriteriaRejection
pagination_label: ApprovalApprovalCriteriaRejection
sidebar_label: ApprovalApprovalCriteriaRejection
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalApprovalCriteriaRejection', 'V2025ApprovalApprovalCriteriaRejection']
slug: /tools/sdk/python/v2025/models/approval-approval-criteria-rejection
tags: ['SDK', 'Software Development Kit', 'ApprovalApprovalCriteriaRejection', 'V2025ApprovalApprovalCriteriaRejection']
---
# ApprovalApprovalCriteriaRejection
Criteria for rejection
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**calculation_type** | **Enum** [ 'COUNT', 'PERCENT' ] | This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to reject | [optional]
**value** | **int** | The value that needs to be met for the rejection criteria | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_approval_criteria_rejection import ApprovalApprovalCriteriaRejection
approval_approval_criteria_rejection = ApprovalApprovalCriteriaRejection(
calculation_type='COUNT',
value=30
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/V2025/Models/ApprovalApproveRequest.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2025-approval-approve-request
title: ApprovalApproveRequest
pagination_label: ApprovalApproveRequest
sidebar_label: ApprovalApproveRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalApproveRequest', 'V2025ApprovalApproveRequest']
slug: /tools/sdk/python/v2025/models/approval-approve-request
tags: ['SDK', 'Software Development Kit', 'ApprovalApproveRequest', 'V2025ApprovalApproveRequest']
---
# ApprovalApproveRequest
Approval Approve Request
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**additional_attributes** | **map[string]str** | Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. | [optional]
**comment** | **str** | Comment associated with the request. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_approve_request import ApprovalApproveRequest
approval_approve_request = ApprovalApproveRequest(
additional_attributes={additionalProp1=string, additionalProp2=string, additionalProp3=string},
comment='comment'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2025/Models/ApprovalAttributesRequest.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2025-approval-attributes-request
title: ApprovalAttributesRequest
pagination_label: ApprovalAttributesRequest
sidebar_label: ApprovalAttributesRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalAttributesRequest', 'V2025ApprovalAttributesRequest']
slug: /tools/sdk/python/v2025/models/approval-attributes-request
tags: ['SDK', 'Software Development Kit', 'ApprovalAttributesRequest', 'V2025ApprovalAttributesRequest']
---
# ApprovalAttributesRequest
Approval Attributes Request
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**additional_attributes** | **map[string]str** | Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. | [optional]
**comment** | **str** | Comment associated with the request. | [optional]
**remove_attribute_keys** | **[]str** | List of attribute keys to be removed. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_attributes_request import ApprovalAttributesRequest
approval_attributes_request = ApprovalAttributesRequest(
additional_attributes={additionalProp1=string, additionalProp2=string, additionalProp3=string},
comment='comment',
remove_attribute_keys=[string]
)
```
[[Back to top]](#)

25
docs/tools/sdk/python/Reference/V2025/Models/ApprovalComment1.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**author** | [**ApprovalIdentity**](approval-identity) | | [optional]
**comment** | **str** | Comment to be left on an approval | [optional]
**created_date** | **str** | Date the comment was created | [optional]
**comment_id** | **str** | ID of the comment | [optional]
}
## Example
@@ -29,11 +30,27 @@ from sailpoint.v2025.models.approval_comment1 import ApprovalComment1
approval_comment1 = ApprovalComment1(
author=sailpoint.v2025.models.approval_identity.Approval Identity(
id = '85d173e7d57e496569df763231d6deb6a',
type = 'IDENTITY',
name = 'John Doe', ),
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
comment='Looks good',
created_date='2023-04-12T23:20:50.52Z'
created_date='2023-04-12T23:20:50.52Z',
comment_id='38453251-6be2-5f8f-df93-5ce19e295837'
)
```

33
docs/tools/sdk/python/Reference/V2025/Models/ApprovalCommentsRequest.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2025-approval-comments-request
title: ApprovalCommentsRequest
pagination_label: ApprovalCommentsRequest
sidebar_label: ApprovalCommentsRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalCommentsRequest', 'V2025ApprovalCommentsRequest']
slug: /tools/sdk/python/v2025/models/approval-comments-request
tags: ['SDK', 'Software Development Kit', 'ApprovalCommentsRequest', 'V2025ApprovalCommentsRequest']
---
# ApprovalCommentsRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **str** | Comment associated with the request. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_comments_request import ApprovalCommentsRequest
approval_comments_request = ApprovalCommentsRequest(
comment='Approval comment.'
)
```
[[Back to top]](#)

97
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfig.md Normal file
View File

@@ -0,0 +1,97 @@
---
id: v2025-approval-config
title: ApprovalConfig
pagination_label: ApprovalConfig
sidebar_label: ApprovalConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfig', 'V2025ApprovalConfig']
slug: /tools/sdk/python/v2025/models/approval-config
tags: ['SDK', 'Software Development Kit', 'ApprovalConfig', 'V2025ApprovalConfig']
---
# ApprovalConfig
Approval config Object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tenant_id** | **str** | Tenant ID of the approval configuration. | [optional]
**id** | **str** | ID of the approval configuration. | [optional]
**scope** | **str** | The type/scope of the configuration. Ie APPROVAL_REQUEST, DOMAIN_OBJECT, APPROVAL_TYPE, TENANT | [optional]
**reminder_config** | [**ApprovalConfigReminderConfig**](approval-config-reminder-config) | | [optional]
**escalation_config** | [**ApprovalConfigEscalationConfig**](approval-config-escalation-config) | | [optional]
**timeout_config** | [**ApprovalConfigTimeoutConfig**](approval-config-timeout-config) | | [optional]
**cron_timezone** | [**ApprovalConfigCronTimezone**](approval-config-cron-timezone) | | [optional]
**serial_chain** | [**[]ApprovalConfigSerialChainInner**](approval-config-serial-chain-inner) | If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. | [optional]
**requires_comment** | **Enum** [ 'APPROVAL', 'REJECTION', 'ALL', 'OFF' ] | Determines whether a comment is required when approving or rejecting the approval request. | [optional]
**fallback_approver** | [**ApprovalIdentity**](approval-identity) | Configuration for fallback approver. Used if the user cannot be found for whatever reason and escalation config does not exist. | [optional]
**auto_approve** | **Enum** [ 'OFF', 'DIRECT', 'INDIRECT' ] | OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config import ApprovalConfig
approval_config = ApprovalConfig(
tenant_id='d3c10266-1a31-4acc-b01e-44a3d1c56615',
id='5804e7d6-e04b-400f-9fb8-dff894419a2f',
scope='APPROVAL_REQUEST',
reminder_config=sailpoint.v2025.models.approval_config_reminder_config.ApprovalConfig_reminderConfig(
enabled = False,
days_until_first_reminder = 0,
reminder_cron_schedule = '1 1 1 1 1',
max_reminders = 5, ),
escalation_config=sailpoint.v2025.models.approval_config_escalation_config.ApprovalConfig_escalationConfig(
enabled = True,
days_until_first_escalation = 2,
escalation_cron_schedule = '*/5 * * * *',
escalation_chain = [
sailpoint.v2025.models.approval_config_escalation_config_escalation_chain_inner.ApprovalConfig_escalationConfig_escalationChain_inner(
chain_id = 'ef85d1a8-41ef-433a-8153-0b1f59e7b26a',
tier = 1,
identity_id = 'fdfda352157d4cc79bb749953131b457',
identity_type = 'IDENTITY', )
], ),
timeout_config=sailpoint.v2025.models.approval_config_timeout_config.ApprovalConfig_timeoutConfig(
enabled = True,
days_until_timeout = 2,
timeout_result = 'EXPIRED', ),
cron_timezone=sailpoint.v2025.models.approval_config_cron_timezone.ApprovalConfig_cronTimezone(
location = 'America/New_York',
offset = '', ),
serial_chain=[
sailpoint.v2025.models.approval_config_serial_chain_inner.ApprovalConfig_serialChain_inner(
chain_id = '23dc206e-2a9e-4f98-93db-8d6e342cca18',
tier = 1,
identity_id = '2c9180858090ea8801809a0465e829da',
identity_type = 'IDENTITY', )
],
requires_comment='ALL',
fallback_approver=sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
auto_approve='false'
)
```
[[Back to top]](#)

36
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfigCronTimezone.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: v2025-approval-config-cron-timezone
title: ApprovalConfigCronTimezone
pagination_label: ApprovalConfigCronTimezone
sidebar_label: ApprovalConfigCronTimezone
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfigCronTimezone', 'V2025ApprovalConfigCronTimezone']
slug: /tools/sdk/python/v2025/models/approval-config-cron-timezone
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigCronTimezone', 'V2025ApprovalConfigCronTimezone']
---
# ApprovalConfigCronTimezone
Timezone configuration for cron schedules.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**location** | **str** | Timezone location for cron schedules. | [optional]
**offset** | **str** | Timezone offset for cron schedules. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config_cron_timezone import ApprovalConfigCronTimezone
approval_config_cron_timezone = ApprovalConfigCronTimezone(
location='America/New_York',
offset=''
)
```
[[Back to top]](#)

46
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfigEscalationConfig.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: v2025-approval-config-escalation-config
title: ApprovalConfigEscalationConfig
pagination_label: ApprovalConfigEscalationConfig
sidebar_label: ApprovalConfigEscalationConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfigEscalationConfig', 'V2025ApprovalConfigEscalationConfig']
slug: /tools/sdk/python/v2025/models/approval-config-escalation-config
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigEscalationConfig', 'V2025ApprovalConfigEscalationConfig']
---
# ApprovalConfigEscalationConfig
Configuration for escalations.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Indicates if escalations are enabled. | [optional] [default to False]
**days_until_first_escalation** | **int** | Number of days until the first escalation. | [optional]
**escalation_cron_schedule** | **str** | Cron schedule for escalations. | [optional]
**escalation_chain** | [**[]ApprovalConfigEscalationConfigEscalationChainInner**](approval-config-escalation-config-escalation-chain-inner) | Escalation chain configuration. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config_escalation_config import ApprovalConfigEscalationConfig
approval_config_escalation_config = ApprovalConfigEscalationConfig(
enabled=True,
days_until_first_escalation=2,
escalation_cron_schedule='*/5 * * * *',
escalation_chain=[
sailpoint.v2025.models.approval_config_escalation_config_escalation_chain_inner.ApprovalConfig_escalationConfig_escalationChain_inner(
chain_id = 'ef85d1a8-41ef-433a-8153-0b1f59e7b26a',
tier = 1,
identity_id = 'fdfda352157d4cc79bb749953131b457',
identity_type = 'IDENTITY', )
]
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfigEscalationConfigEscalationChainInner.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-approval-config-escalation-config-escalation-chain-inner
title: ApprovalConfigEscalationConfigEscalationChainInner
pagination_label: ApprovalConfigEscalationConfigEscalationChainInner
sidebar_label: ApprovalConfigEscalationConfigEscalationChainInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfigEscalationConfigEscalationChainInner', 'V2025ApprovalConfigEscalationConfigEscalationChainInner']
slug: /tools/sdk/python/v2025/models/approval-config-escalation-config-escalation-chain-inner
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigEscalationConfigEscalationChainInner', 'V2025ApprovalConfigEscalationConfigEscalationChainInner']
---
# ApprovalConfigEscalationConfigEscalationChainInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**chain_id** | **str** | ID of the escalation chain. | [optional]
**tier** | **int** | Starting at 1 defines the order in which the identities will get assigned | [optional]
**identity_id** | **str** | Identity ID in the escalation chain. | [optional]
**identity_type** | **str** | Type of identity in the escalation chain. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config_escalation_config_escalation_chain_inner import ApprovalConfigEscalationConfigEscalationChainInner
approval_config_escalation_config_escalation_chain_inner = ApprovalConfigEscalationConfigEscalationChainInner(
chain_id='ef85d1a8-41ef-433a-8153-0b1f59e7b26a',
tier=1,
identity_id='fdfda352157d4cc79bb749953131b457',
identity_type='IDENTITY'
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfigReminderConfig.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: v2025-approval-config-reminder-config
title: ApprovalConfigReminderConfig
pagination_label: ApprovalConfigReminderConfig
sidebar_label: ApprovalConfigReminderConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfigReminderConfig', 'V2025ApprovalConfigReminderConfig']
slug: /tools/sdk/python/v2025/models/approval-config-reminder-config
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigReminderConfig', 'V2025ApprovalConfigReminderConfig']
---
# ApprovalConfigReminderConfig
Configuration for reminders.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Indicates if reminders are enabled. | [optional] [default to False]
**days_until_first_reminder** | **int** | Number of days until the first reminder. | [optional]
**reminder_cron_schedule** | **str** | Cron schedule for reminders. | [optional]
**max_reminders** | **int** | Maximum number of reminders. Max is 20. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config_reminder_config import ApprovalConfigReminderConfig
approval_config_reminder_config = ApprovalConfigReminderConfig(
enabled=False,
days_until_first_reminder=0,
reminder_cron_schedule='1 1 1 1 1',
max_reminders=5
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfigSerialChainInner.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-approval-config-serial-chain-inner
title: ApprovalConfigSerialChainInner
pagination_label: ApprovalConfigSerialChainInner
sidebar_label: ApprovalConfigSerialChainInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfigSerialChainInner', 'V2025ApprovalConfigSerialChainInner']
slug: /tools/sdk/python/v2025/models/approval-config-serial-chain-inner
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigSerialChainInner', 'V2025ApprovalConfigSerialChainInner']
---
# ApprovalConfigSerialChainInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**chain_id** | **str** | ID of the serial chain. | [optional]
**tier** | **int** | Starting at 1 defines the order in which the identities will get assigned | [optional]
**identity_id** | **str** | Identity ID in the serial chain. | [optional]
**identity_type** | **str** | Type of identity in the serial chain. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config_serial_chain_inner import ApprovalConfigSerialChainInner
approval_config_serial_chain_inner = ApprovalConfigSerialChainInner(
chain_id='23dc206e-2a9e-4f98-93db-8d6e342cca18',
tier=1,
identity_id='2c9180858090ea8801809a0465e829da',
identity_type='IDENTITY'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2025/Models/ApprovalConfigTimeoutConfig.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2025-approval-config-timeout-config
title: ApprovalConfigTimeoutConfig
pagination_label: ApprovalConfigTimeoutConfig
sidebar_label: ApprovalConfigTimeoutConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalConfigTimeoutConfig', 'V2025ApprovalConfigTimeoutConfig']
slug: /tools/sdk/python/v2025/models/approval-config-timeout-config
tags: ['SDK', 'Software Development Kit', 'ApprovalConfigTimeoutConfig', 'V2025ApprovalConfigTimeoutConfig']
---
# ApprovalConfigTimeoutConfig
TimeoutConfig contains configurations around when the approval request should expire.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Indicates if timeout is enabled. | [optional] [default to False]
**days_until_timeout** | **int** | Number of days until approval request times out. Max value is 90. | [optional]
**timeout_result** | **Enum** [ 'EXPIRED', 'APPROVED' ] | Result of timeout. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_config_timeout_config import ApprovalConfigTimeoutConfig
approval_config_timeout_config = ApprovalConfigTimeoutConfig(
enabled=True,
days_until_timeout=2,
timeout_result='EXPIRED'
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2025/Models/ApprovalIdentity.md
View File

@@ -11,15 +11,19 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'V2025ApprovalIden
# ApprovalIdentity
Identity Object
Approval Identity Object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The identity ID | [optional]
**type** | **Enum** [ 'IDENTITY' ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional]
**name** | **str** | Name of the identity | [optional]
**email** | **str** | Email address. | [optional]
**identity_id** | **str** | Identity ID. | [optional]
**members** | [**[]ApprovalIdentityMembersInner**](approval-identity-members-inner) | List of members of a governance group. Will be omitted if the identity is not a governance group. | [optional]
**name** | **str** | Name of the identity. | [optional]
**owner_of** | [**[]ApprovalIdentityOwnerOfInner**](approval-identity-owner-of-inner) | List of owned items. For example, will show the items in which a ROLE_OWNER owns. Omitted if not an owner of anything. | [optional]
**serial_order** | **int** | The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. | [optional]
**type** | **Enum** [ 'IDENTITY', 'MANAGER_OF', 'GOVERNANCE_GROUP', 'SOURCE_OWNER', 'ROLE_OWNER', 'ACCESS_PROFILE_OWNER', 'ENTITLEMENT_OWNER', 'APPLICATION_OWNER' ] | Type of identity. | [optional]
}
## Example
@@ -28,9 +32,24 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.approval_identity import ApprovalIdentity
approval_identity = ApprovalIdentity(
id='85d173e7d57e496569df763231d6deb6a',
type='IDENTITY',
name='John Doe'
email='mail@mail.com',
identity_id='17e633e7d57e481569df76323169deb6a',
members=[
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name='Jim Bob',
owner_of=[
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order=0,
type='IDENTITY'
)
```

39
docs/tools/sdk/python/Reference/V2025/Models/ApprovalIdentityMembersInner.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-approval-identity-members-inner
title: ApprovalIdentityMembersInner
pagination_label: ApprovalIdentityMembersInner
sidebar_label: ApprovalIdentityMembersInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalIdentityMembersInner', 'V2025ApprovalIdentityMembersInner']
slug: /tools/sdk/python/v2025/models/approval-identity-members-inner
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentityMembersInner', 'V2025ApprovalIdentityMembersInner']
---
# ApprovalIdentityMembersInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **str** | Email of the member. | [optional]
**id** | **str** | ID of the member. | [optional]
**name** | **str** | Name of the member. | [optional]
**type** | **str** | Type of the member. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_identity_members_inner import ApprovalIdentityMembersInner
approval_identity_members_inner = ApprovalIdentityMembersInner(
email='mail@mail.com',
id='17e633e7d57e481569df76323169deb6a',
name='Bob Neil',
type='IDENTITY'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2025/Models/ApprovalIdentityOwnerOfInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2025-approval-identity-owner-of-inner
title: ApprovalIdentityOwnerOfInner
pagination_label: ApprovalIdentityOwnerOfInner
sidebar_label: ApprovalIdentityOwnerOfInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalIdentityOwnerOfInner', 'V2025ApprovalIdentityOwnerOfInner']
slug: /tools/sdk/python/v2025/models/approval-identity-owner-of-inner
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentityOwnerOfInner', 'V2025ApprovalIdentityOwnerOfInner']
---
# ApprovalIdentityOwnerOfInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the object that is owned. | [optional]
**name** | **str** | Name of the object that is owned. | [optional]
**type** | **str** | Type of the object that is owned. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_identity_owner_of_inner import ApprovalIdentityOwnerOfInner
approval_identity_owner_of_inner = ApprovalIdentityOwnerOfInner(
id='string',
name='Access Request App',
type='APPLICATION'
)
```
[[Back to top]](#)

60
docs/tools/sdk/python/Reference/V2025/Models/ApprovalIdentityRecord.md Normal file
View File

@@ -0,0 +1,60 @@
---
id: v2025-approval-identity-record
title: ApprovalIdentityRecord
pagination_label: ApprovalIdentityRecord
sidebar_label: ApprovalIdentityRecord
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalIdentityRecord', 'V2025ApprovalIdentityRecord']
slug: /tools/sdk/python/v2025/models/approval-identity-record
tags: ['SDK', 'Software Development Kit', 'ApprovalIdentityRecord', 'V2025ApprovalIdentityRecord']
---
# ApprovalIdentityRecord
Identity Record Object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_id** | **str** | Identity ID. | [optional]
**type** | **Enum** [ 'IDENTITY' ] | Type of identity. | [optional]
**name** | **str** | Name of the identity. | [optional]
**actioned_as** | [**[]ApprovalReference**](approval-reference) | List of references representing actions taken by the identity. | [optional]
**members** | [**[]ApprovalReference**](approval-reference) | List of references representing members of the identity. | [optional]
**decision_date** | **datetime** | Date when the decision was made. | [optional]
**email** | **str** | Email associated with the identity. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_identity_record import ApprovalIdentityRecord
approval_identity_record = ApprovalIdentityRecord(
identity_id='17e633e7d57e481569df76323169deb6a',
type='IDENTITY',
name='Jim Bob',
actioned_as=[
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
members=[
sailpoint.v2025.models.approval_reference.Approval Reference(
id = '64012350-8fd9-4f6c-a170-1fe123683899',
type = 'AccessRequestId',
name = 'Access Request',
email = 'user@example.com',
serial_order = 0, )
],
decision_date='2023-04-12T23:20:50.520Z',
email='user@example.com'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V2025/Models/ApprovalReassignRequest.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2025-approval-reassign-request
title: ApprovalReassignRequest
pagination_label: ApprovalReassignRequest
sidebar_label: ApprovalReassignRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalReassignRequest', 'V2025ApprovalReassignRequest']
slug: /tools/sdk/python/v2025/models/approval-reassign-request
tags: ['SDK', 'Software Development Kit', 'ApprovalReassignRequest', 'V2025ApprovalReassignRequest']
---
# ApprovalReassignRequest
Request body for reassigning an approval request to another identity. This results in that identity being added as an authorized approver.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **str** | Comment associated with the reassign request. | [optional]
**reassign_from** | **str** | Identity from which the approval is being reassigned. If left blank, and the approval is currently assigned to the user calling this endpoint, it will use the calling user's identity. If left blank, and the approval is not currently assigned to the user calling this endpoint, you need to be an admin, which would add the reassignTo as a new approver. | [optional]
**reassign_to** | **str** | Identity to which the approval is being reassigned. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_reassign_request import ApprovalReassignRequest
approval_reassign_request = ApprovalReassignRequest(
comment='comment',
reassign_from='384532516be25f8fdf935ce19e295837',
reassign_to='152354832eb6f8f539fd738592e19ec5'
)
```
[[Back to top]](#)

98
docs/tools/sdk/python/Reference/V2025/Models/ApprovalReassignmentHistory.md Normal file
View File

@@ -0,0 +1,98 @@
---
id: v2025-approval-reassignment-history
title: ApprovalReassignmentHistory
pagination_label: ApprovalReassignmentHistory
sidebar_label: ApprovalReassignmentHistory
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalReassignmentHistory', 'V2025ApprovalReassignmentHistory']
slug: /tools/sdk/python/v2025/models/approval-reassignment-history
tags: ['SDK', 'Software Development Kit', 'ApprovalReassignmentHistory', 'V2025ApprovalReassignmentHistory']
---
# ApprovalReassignmentHistory
ReassignmentHistoryRecord holds a history record of reassignment and escalation actions for an approval request
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment_id** | **str** | Unique identifier for the comment associated with the reassignment. | [optional]
**reassigned_from** | [**ApprovalIdentity**](approval-identity) | | [optional]
**reassigned_to** | [**ApprovalIdentity**](approval-identity) | | [optional]
**reassigner** | [**ApprovalIdentity**](approval-identity) | | [optional]
**reassignment_date** | **datetime** | Date and time when the reassignment occurred. | [optional]
**reassignment_type** | **Enum** [ 'ESCALATION', 'MANUAL_REASSIGNMENT', 'AUTO_REASSIGNMENT' ] | Type of reassignment, such as escalation or manual reassignment. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_reassignment_history import ApprovalReassignmentHistory
approval_reassignment_history = ApprovalReassignmentHistory(
comment_id='f47ac10b-58cc-4372-a567-0e02b2c3d479',
reassigned_from=sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
reassigned_to=sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
reassigner=sailpoint.v2025.models.approval_identity.Approval Identity(
email = 'mail@mail.com',
identity_id = '17e633e7d57e481569df76323169deb6a',
members = [
sailpoint.v2025.models.approval_identity_members_inner.ApprovalIdentity_members_inner(
email = 'mail@mail.com',
id = '17e633e7d57e481569df76323169deb6a',
name = 'Bob Neil',
type = 'IDENTITY', )
],
name = 'Jim Bob',
owner_of = [
sailpoint.v2025.models.approval_identity_owner_of_inner.ApprovalIdentity_ownerOf_inner(
id = 'string',
name = 'Access Request App',
type = 'APPLICATION', )
],
serial_order = 0,
type = 'IDENTITY', ),
reassignment_date='2023-10-01T12:34:56.789Z',
reassignment_type='ESCALATION'
)
```
[[Back to top]](#)

8
docs/tools/sdk/python/Reference/V2025/Models/ApprovalReference.md
View File

@@ -19,6 +19,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Id of the reference object | [optional]
**type** | **str** | What reference object does this ID correspond to | [optional]
**name** | **str** | Name of the reference object | [optional]
**email** | **str** | Email associated with the reference object | [optional]
**serial_order** | **int** | The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. | [optional]
}
## Example
@@ -28,7 +31,10 @@ from sailpoint.v2025.models.approval_reference import ApprovalReference
approval_reference = ApprovalReference(
id='64012350-8fd9-4f6c-a170-1fe123683899',
type='AccessRequestId'
type='AccessRequestId',
name='Access Request',
email='user@example.com',
serial_order=0
)
```

34
docs/tools/sdk/python/Reference/V2025/Models/ApprovalRejectRequest.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: v2025-approval-reject-request
title: ApprovalRejectRequest
pagination_label: ApprovalRejectRequest
sidebar_label: ApprovalRejectRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalRejectRequest', 'V2025ApprovalRejectRequest']
slug: /tools/sdk/python/v2025/models/approval-reject-request
tags: ['SDK', 'Software Development Kit', 'ApprovalRejectRequest', 'V2025ApprovalRejectRequest']
---
# ApprovalRejectRequest
Request body for rejecting an approval request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **str** | Comment associated with the reject request. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_reject_request import ApprovalRejectRequest
approval_reject_request = ApprovalRejectRequest(
comment='string'
)
```
[[Back to top]](#)

46
docs/tools/sdk/python/Reference/V2025/Models/ApprovalRequestedTarget.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: v2025-approval-requested-target
title: ApprovalRequestedTarget
pagination_label: ApprovalRequestedTarget
sidebar_label: ApprovalRequestedTarget
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalRequestedTarget', 'V2025ApprovalRequestedTarget']
slug: /tools/sdk/python/v2025/models/approval-requested-target
tags: ['SDK', 'Software Development Kit', 'ApprovalRequestedTarget', 'V2025ApprovalRequestedTarget']
---
# ApprovalRequestedTarget
Represents a requested target in an approval process, including details such as ID, name, reauthentication requirements, and removal date.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**forced_auth_signature** | **str** | Signature required for forced authentication. | [optional]
**id** | **str** | ID of the requested target. | [optional]
**name** | **str** | Name of the requested target. | [optional]
**reauth_required** | **bool** | Indicates if reauthentication is required. | [optional] [default to False]
**removal_date** | **datetime** | Date when the target will be removed. | [optional]
**request_type** | **str** | Type of the request. | [optional]
**target_type** | **str** | Type of the target. | [optional]
}
## Example
```python
from sailpoint.v2025.models.approval_requested_target import ApprovalRequestedTarget
approval_requested_target = ApprovalRequestedTarget(
forced_auth_signature='string',
id='string',
name='string',
reauth_required=True,
removal_date='2025-07-07T18:10:13.687Z',
request_type='string',
target_type='string'
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/V2025/Models/SourceSubtype.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2025-source-subtype
title: SourceSubtype
pagination_label: SourceSubtype
sidebar_label: SourceSubtype
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SourceSubtype', 'V2025SourceSubtype']
slug: /tools/sdk/python/v2025/models/source-subtype
tags: ['SDK', 'Software Development Kit', 'SourceSubtype', 'V2025SourceSubtype']
---
# SourceSubtype
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique identifier for the subtype. | [optional]
**source_id** | **str** | The ID of the source. | [optional] [readonly]
**technical_name** | **str** | Technical name of the subtype. | [required]
**display_name** | **str** | Display name of the subtype. | [required]
**description** | **str** | Description of the subtype. | [required]
**created** | **datetime** | Creation timestamp. | [optional]
**modified** | **datetime** | Last modified timestamp. | [optional]
}
## Example
```python
from sailpoint.v2025.models.source_subtype import SourceSubtype
source_subtype = SourceSubtype(
id='43bdd144-4b17-4fce-a744-17c7fd3e717b',
source_id='',
technical_name='foo',
display_name='Mr Foo',
description='fighters',
created='2025-07-28T16:13:42.801300Z',
modified='2025-07-28T16:13:42.750850Z'
)
```
[[Back to top]](#)