Update to python SDK docs: 14926960824

This commit is contained in:
developer-relations-sp
2025-05-09 10:30:37 +00:00
parent f308ff9041
commit c5ed7d487d
19 changed files with 1392 additions and 107 deletions

View File

@@ -61,6 +61,9 @@ Method | HTTP request | Description
## create-account ## create-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Create Account Create Account
Submits an account creation task - the API then returns the task ID. Submits an account creation task - the API then returns the task ID.
@@ -140,6 +143,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## delete-account ## delete-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Delete Account Delete Account
Use this API to delete an account. Use this API to delete an account.
This endpoint submits an account delete task and returns the task ID. This endpoint submits an account delete task and returns the task ID.
@@ -267,6 +273,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## disable-account ## disable-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable Account Disable Account
This API submits a task to disable the account and returns the task ID. This API submits a task to disable the account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -333,6 +342,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## disable-account-for-identity ## disable-account-for-identity
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable IDN Account for Identity Disable IDN Account for Identity
This API submits a task to disable IDN account for a single identity. This API submits a task to disable IDN account for a single identity.
@@ -391,6 +403,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## disable-accounts-for-identities ## disable-accounts-for-identities
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Disable IDN Accounts for Identities Disable IDN Accounts for Identities
This API submits tasks to disable IDN account for each identity provided in the request body. This API submits tasks to disable IDN account for each identity provided in the request body.
@@ -453,6 +468,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## enable-account ## enable-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable Account Enable Account
This API submits a task to enable account and returns the task ID. This API submits a task to enable account and returns the task ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -519,6 +537,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## enable-account-for-identity ## enable-account-for-identity
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable IDN Account for Identity Enable IDN Account for Identity
This API submits a task to enable IDN account for a single identity. This API submits a task to enable IDN account for a single identity.
@@ -577,6 +598,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## enable-accounts-for-identities ## enable-accounts-for-identities
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Enable IDN Accounts for Identities Enable IDN Accounts for Identities
This API submits tasks to enable IDN account for each identity provided in the request body. This API submits tasks to enable IDN account for each identity provided in the request body.
@@ -639,6 +663,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-account ## get-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Details Account Details
Use this API to return the details for a single account by its ID. Use this API to return the details for a single account by its ID.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -699,6 +726,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-account-entitlements ## get-account-entitlements
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Account Entitlements Account Entitlements
This API returns entitlements of the account. This API returns entitlements of the account.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -766,8 +796,11 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-accounts ## list-accounts
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Accounts List Accounts List
List accounts. List accounts.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts) [API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts)
@@ -835,6 +868,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## put-account ## put-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account Update Account
Use this API to update an account with a PUT request. Use this API to update an account with a PUT request.
@@ -912,6 +948,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## submit-reload-account ## submit-reload-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Reload Account Reload Account
This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API.
@@ -972,6 +1011,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## unlock-account ## unlock-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Unlock Account Unlock Account
This API submits a task to unlock an account and returns the task ID. This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required.
@@ -1040,6 +1082,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## update-account ## update-account
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Account Update Account
Use this API to update account details. Use this API to update account details.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.

View File

@@ -30,6 +30,9 @@ Method | HTTP request | Description
## get-public-identity-config ## get-public-identity-config
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get Public Identity Config Get Public Identity Config
This gets details of public identity config. This gets details of public identity config.
@@ -84,6 +87,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## update-public-identity-config ## update-public-identity-config
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Update Public Identity Config Update Public Identity Config
This updates the details of public identity config. This updates the details of public identity config.

View File

@@ -32,7 +32,6 @@ Method | HTTP request | Description
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item [**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items [**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item [**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**forward-work-item**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items [**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items [**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items [**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
@@ -42,9 +41,13 @@ Method | HTTP request | Description
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item [**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items [**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections [**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
[**submit-forward-work-item**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
## approve-approval-item ## approve-approval-item
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Approve an Approval Item Approve an Approval Item
This API approves an Approval Item. Either an admin, or the owning/current user must make this request. This API approves an Approval Item. Either an admin, or the owning/current user must make this request.
@@ -64,9 +67,12 @@ Path | approval_item_id | **str** | True | The ID of the approval item.
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | A work items details object. | WorkItems | - | 200 | A work items details object. | WorkItems | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -103,6 +109,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## approve-approval-items-in-bulk ## approve-approval-items-in-bulk
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Bulk approve Approval Items Bulk approve Approval Items
This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request.
@@ -121,9 +130,12 @@ Path | id | **str** | True | The ID of the work item
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | A work items details object. | WorkItems | - | 200 | A work items details object. | WorkItems | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -159,6 +171,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## complete-work-item ## complete-work-item
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Complete a Work Item Complete a Work Item
This API completes a work item. Either an admin, or the owning/current user must make this request. This API completes a work item. Either an admin, or the owning/current user must make this request.
@@ -217,71 +232,12 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## forward-work-item
Forward a Work Item
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the work item
Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Success, but no data is returned. | | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
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. | ListAccessModelMetadataAttribute429Response | - |
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.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_item_forward import WorkItemForward
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = '''{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}''' # WorkItemForward |
try:
# Forward a Work Item
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).forward_work_item(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
# WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward)
except Exception as e:
print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e)
```
[[Back to top]](#) [[Back to top]](#)
## get-completed-work-items ## get-completed-work-items
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Completed Work Items Completed Work Items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
@@ -303,9 +259,12 @@ Param Type | Name | Data Type | Required | Description
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | List of completed work items. | List[WorkItems] | - | 200 | List of completed work items. | List[WorkItems] | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -322,7 +281,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) owner_id = '2c91808571bcfcf80171c23e4b4221fc' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) 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) 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)
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) 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)
@@ -345,6 +304,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-count-completed-work-items ## get-count-completed-work-items
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Count Completed Work Items Count Completed Work Items
This gets a count of completed work items belonging to either the specified user(admin required), or the current user. This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
@@ -355,6 +317,8 @@ This gets a count of completed work items belonging to either the specified user
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Query | owner_id | **str** | (optional) | ID of the work item owner. Query | owner_id | **str** | (optional) | ID of the work item owner.
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 ### Return type
[**List[WorkItemsCount]**](../models/work-items-count) [**List[WorkItemsCount]**](../models/work-items-count)
@@ -363,9 +327,12 @@ Param Type | Name | Data Type | Required | Description
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | List of work items | List[WorkItemsCount] | - | 200 | List of work items | List[WorkItemsCount] | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -382,14 +349,16 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (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: try:
# Count Completed Work Items # Count Completed Work Items
results = WorkItemsApi(api_client).get_count_completed_work_items() results = WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id, limit, offset)
print("The response of WorkItemsApi->get_count_completed_work_items:\n") print("The response of WorkItemsApi->get_count_completed_work_items:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -402,6 +371,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-count-work-items ## get-count-work-items
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Count Work Items Count Work Items
This gets a count of work items belonging to either the specified user(admin required), or the current user. This gets a count of work items belonging to either the specified user(admin required), or the current user.
@@ -420,9 +392,12 @@ Param Type | Name | Data Type | Required | Description
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | List of work items | WorkItemsCount | - | 200 | List of work items | WorkItemsCount | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -439,7 +414,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try: try:
# Count Work Items # Count Work Items
@@ -458,6 +433,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-work-item ## get-work-item
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Get a Work Item Get a Work Item
This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
@@ -518,6 +496,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-work-items-summary ## get-work-items-summary
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Work Items Summary Work Items Summary
This gets a summary of work items belonging to either the specified user(admin required), or the current user. This gets a summary of work items belonging to either the specified user(admin required), or the current user.
@@ -536,9 +517,12 @@ Param Type | Name | Data Type | Required | Description
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | List of work items | WorkItemsSummary | - | 200 | List of work items | WorkItemsSummary | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -555,7 +539,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try: try:
# Work Items Summary # Work Items Summary
@@ -574,6 +558,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-work-items ## list-work-items
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
List Work Items List Work Items
This gets a collection of work items belonging to either the specified user(admin required), or the current user. This gets a collection of work items belonging to either the specified user(admin required), or the current user.
@@ -595,9 +582,12 @@ Param Type | Name | Data Type | Required | Description
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | List of work items | List[WorkItems] | - | 200 | List of work items | List[WorkItems] | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -617,7 +607,7 @@ with ApiClient(configuration) as api_client:
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) 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) 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)
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) 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)
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try: try:
# List Work Items # List Work Items
@@ -637,6 +627,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## reject-approval-item ## reject-approval-item
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Reject an Approval Item Reject an Approval Item
This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. This API rejects an Approval Item. Either an admin, or the owning/current user must make this request.
@@ -656,9 +649,12 @@ Path | approval_item_id | **str** | True | The ID of the approval item.
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | A work items details object. | WorkItems | - | 200 | A work items details object. | WorkItems | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -695,6 +691,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## reject-approval-items-in-bulk ## reject-approval-items-in-bulk
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Bulk reject Approval Items Bulk reject Approval Items
This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request.
@@ -713,9 +712,12 @@ Path | id | **str** | True | The ID of the work item
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | A work items details object. | WorkItems | - | 200 | A work items details object. | WorkItems | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
@@ -751,6 +753,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## submit-account-selection ## submit-account-selection
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Submit Account Selections Submit Account Selections
This API submits account selections. Either an admin, or the owning/current user must make this request. This API submits account selections. Either an admin, or the owning/current user must make this request.
@@ -770,9 +775,12 @@ Path | id | **str** | True | The ID of the work item
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | A work items details object. | WorkItems | - | 200 | A work items details object. | WorkItems | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 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 | - | 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. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers ### HTTP request headers
- **Content-Type**: application/json - **Content-Type**: application/json
@@ -806,6 +814,71 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## submit-forward-work-item
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
Forward a Work Item
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-forward-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the work item
Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Success, but no data is returned. | | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
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. | ListAccessModelMetadataAttribute429Response | - |
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.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_item_forward import WorkItemForward
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = '''{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}''' # WorkItemForward |
try:
# Forward a Work Item
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).submit_forward_work_item(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
# WorkItemsApi(api_client).submit_forward_work_item(id, new_work_item_forward)
except Exception as e:
print("Exception when calling WorkItemsApi->submit_forward_work_item: %s\n" % e)
```
[[Back to top]](#) [[Back to top]](#)

View File

@@ -0,0 +1,83 @@
---
id: v2024-machine-account-classify
title: Machine_Account_Classify
pagination_label: Machine_Account_Classify
sidebar_label: Machine_Account_Classify
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Machine_Account_Classify', 'V2024Machine_Account_Classify']
slug: /tools/sdk/python/v2024/methods/machine-account-classify
tags: ['SDK', 'Software Development Kit', 'Machine_Account_Classify', 'V2024Machine_Account_Classify']
---
# sailpoint.v2024.MachineAccountClassifyApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**send-classify-machine-account**](#send-classify-machine-account) | **POST** `/accounts/{id}/classify` | Classify a Single Machine Account
## send-classify-machine-account
Classify a Single Machine Account
Use this API to classify a single machine account.
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-classify-machine-account)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Account ID.
Query | classification_mode | **str** | (optional) (default to default) | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human.
### Return type
[**SendClassifyMachineAccount200Response**](../models/send-classify-machine-account200-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Account classified as Machine. | SendClassifyMachineAccount200Response | - |
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.v2024.api.machine_account_classify_api import MachineAccountClassifyApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.send_classify_machine_account200_response import SendClassifyMachineAccount200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
classification_mode = default # str | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to default) # str | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to default)
try:
# Classify a Single Machine Account
results = MachineAccountClassifyApi(api_client).send_classify_machine_account(id=id)
# Below is a request that includes all optional parameters
# results = MachineAccountClassifyApi(api_client).send_classify_machine_account(id, classification_mode)
print("The response of MachineAccountClassifyApi->send_classify_machine_account:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountClassifyApi->send_classify_machine_account: %s\n" % e)
```
[[Back to top]](#)

View File

@@ -0,0 +1,310 @@
---
id: v2024-machine-account-mappings
title: Machine_Account_Mappings
pagination_label: Machine_Account_Mappings
sidebar_label: Machine_Account_Mappings
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Machine_Account_Mappings', 'V2024Machine_Account_Mappings']
slug: /tools/sdk/python/v2024/methods/machine-account-mappings
tags: ['SDK', 'Software Development Kit', 'Machine_Account_Mappings', 'V2024Machine_Account_Mappings']
---
# sailpoint.v2024.MachineAccountMappingsApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-machine-account-mappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings
[**delete-machine-account-mappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete Source's Machine Account Mappings
[**list-machine-account-mappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source
[**set-machine-account-mappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings
## create-machine-account-mappings
Create Machine Account Mappings
Creates Machine Account Mappings for both identities and accounts for a source.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-account-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID.
Body | attribute_mappings | [**AttributeMappings**](../models/attribute-mappings) | True |
### Return type
[**List[AttributeMappings]**](../models/attribute-mappings)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Newly created Attribute Mapping Object | List[AttributeMappings] | - |
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.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
attribute_mappings = '''{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}''' # AttributeMappings |
try:
# Create Machine Account Mappings
new_attribute_mappings = AttributeMappings.from_json(attribute_mappings)
results = MachineAccountMappingsApi(api_client).create_machine_account_mappings(id=id, attribute_mappings=new_attribute_mappings)
# Below is a request that includes all optional parameters
# results = MachineAccountMappingsApi(api_client).create_machine_account_mappings(id, new_attribute_mappings)
print("The response of MachineAccountMappingsApi->create_machine_account_mappings:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->create_machine_account_mappings: %s\n" % e)
```
[[Back to top]](#)
## delete-machine-account-mappings
Delete Source's Machine Account Mappings
Use this API to remove machine account attribute mappings for a Source.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-account-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | source ID.
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | source ID. # str | source ID.
try:
# Delete Source's Machine Account Mappings
MachineAccountMappingsApi(api_client).delete_machine_account_mappings(id=id)
# Below is a request that includes all optional parameters
# MachineAccountMappingsApi(api_client).delete_machine_account_mappings(id)
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->delete_machine_account_mappings: %s\n" % e)
```
[[Back to top]](#)
## list-machine-account-mappings
Machine Account Mapping for Source
Retrieves Machine account mappings for a specified source using Source ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-account-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID
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[AttributeMappings]**](../models/attribute-mappings)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | An array of Attribute Mapping Objects | List[AttributeMappings] | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID # str | Source ID
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:
# Machine Account Mapping for Source
results = MachineAccountMappingsApi(api_client).list_machine_account_mappings(id=id)
# Below is a request that includes all optional parameters
# results = MachineAccountMappingsApi(api_client).list_machine_account_mappings(id, limit, offset)
print("The response of MachineAccountMappingsApi->list_machine_account_mappings:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->list_machine_account_mappings: %s\n" % e)
```
[[Back to top]](#)
## set-machine-account-mappings
Update Source's Machine Account Mappings
Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-account-mappings)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID.
Body | attribute_mappings | [**AttributeMappings**](../models/attribute-mappings) | True |
### Return type
[**List[AttributeMappings]**](../models/attribute-mappings)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Updated Machine Account Attributes for a Source. | List[AttributeMappings] | - |
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.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
attribute_mappings = '''{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}''' # AttributeMappings |
try:
# Update Source's Machine Account Mappings
new_attribute_mappings = AttributeMappings.from_json(attribute_mappings)
results = MachineAccountMappingsApi(api_client).set_machine_account_mappings(id=id, attribute_mappings=new_attribute_mappings)
# Below is a request that includes all optional parameters
# results = MachineAccountMappingsApi(api_client).set_machine_account_mappings(id, new_attribute_mappings)
print("The response of MachineAccountMappingsApi->set_machine_account_mappings:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->set_machine_account_mappings: %s\n" % e)
```
[[Back to top]](#)

View File

@@ -0,0 +1,207 @@
---
id: v2024-machine-classification-config
title: Machine_Classification_Config
pagination_label: Machine_Classification_Config
sidebar_label: Machine_Classification_Config
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Machine_Classification_Config', 'V2024Machine_Classification_Config']
slug: /tools/sdk/python/v2024/methods/machine-classification-config
tags: ['SDK', 'Software Development Kit', 'Machine_Classification_Config', 'V2024Machine_Classification_Config']
---
# sailpoint.v2024.MachineClassificationConfigApi
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-machine-classification-config**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete Source's Classification Config
[**get-machine-classification-config**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source
[**set-machine-classification-config**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update Source's Classification Config
## delete-machine-classification-config
Delete Source's Classification Config
Use this API to remove Classification Config for a Source.
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-classification-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID.
### Return type
(empty response body)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | 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**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
try:
# Delete Source's Classification Config
MachineClassificationConfigApi(api_client).delete_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
# MachineClassificationConfigApi(api_client).delete_machine_classification_config(id)
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->delete_machine_classification_config: %s\n" % e)
```
[[Back to top]](#)
## get-machine-classification-config
Machine Classification Config for Source
This API returns a Machine Classification Config for a Source using Source ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-classification-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID
### Return type
[**MachineClassificationConfig**](../models/machine-classification-config)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | A Config Object | MachineClassificationConfig | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID # str | Source ID
try:
# Machine Classification Config for Source
results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
# results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id)
print("The response of MachineClassificationConfigApi->get_machine_classification_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->get_machine_classification_config: %s\n" % e)
```
[[Back to top]](#)
## set-machine-classification-config
Update Source's Classification Config
Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-machine-classification-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source ID.
Body | machine_classification_config | [**MachineClassificationConfig**](../models/machine-classification-config) | True |
### Return type
[**MachineClassificationConfig**](../models/machine-classification-config)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | Updated Machine Classification Config Object. | MachineClassificationConfig | - |
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.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{
"criteria" : "criteria",
"created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE",
"enabled" : true
}''' # MachineClassificationConfig |
try:
# Update Source's Classification Config
new_machine_classification_config = MachineClassificationConfig.from_json(machine_classification_config)
results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id=id, machine_classification_config=new_machine_classification_config)
# Below is a request that includes all optional parameters
# results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id, new_machine_classification_config)
print("The response of MachineClassificationConfigApi->set_machine_classification_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->set_machine_classification_config: %s\n" % e)
```
[[Back to top]](#)

View File

@@ -1100,7 +1100,7 @@ with ApiClient(configuration) as api_client:
## test-workflow ## test-workflow
Test Workflow By Id Test Workflow By Id
::: info :::info
Workflow must be disabled in order to use this endpoint. Workflow must be disabled in order to use this endpoint.

View File

@@ -0,0 +1,43 @@
---
id: v2024-attribute-mappings
title: AttributeMappings
pagination_label: AttributeMappings
sidebar_label: AttributeMappings
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeMappings', 'V2024AttributeMappings']
slug: /tools/sdk/python/v2024/models/attribute-mappings
tags: ['SDK', 'Software Development Kit', 'AttributeMappings', 'V2024AttributeMappings']
---
# AttributeMappings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**target** | [**AttributeMappingsAllOfTarget**](attribute-mappings-all-of-target) | | [optional]
**transform_definition** | [**AttributeMappingsAllOfTransformDefinition**](attribute-mappings-all-of-transform-definition) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
attribute_mappings = AttributeMappings(
target=sailpoint.v2024.models.attribute_mappings_all_of_target.AttributeMappings_allOf_target(
type = 'IDENTITY',
attribute_name = 'businessApplication',
source_id = '2c9180835d2e5168015d32f890ca1581', ),
transform_definition=sailpoint.v2024.models.attribute_mappings_all_of_transform_definition.AttributeMappings_allOf_transformDefinition(
type = 'reference',
attributes = sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes.AttributeMappings_allOf_transformDefinition_attributes(
input = sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input.AttributeMappings_allOf_transformDefinition_attributes_input(
type = 'accountAttribute', ), ),
id = 'ToUpper', )
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,38 @@
---
id: v2024-attribute-mappings-all-of-target
title: AttributeMappingsAllOfTarget
pagination_label: AttributeMappingsAllOfTarget
sidebar_label: AttributeMappingsAllOfTarget
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTarget', 'V2024AttributeMappingsAllOfTarget']
slug: /tools/sdk/python/v2024/models/attribute-mappings-all-of-target
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTarget', 'V2024AttributeMappingsAllOfTarget']
---
# AttributeMappingsAllOfTarget
Targeted Entity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | The type of target entity | [optional]
**attribute_name** | **str** | Name of the targeted attribute | [optional]
**source_id** | **str** | The ID of Source | [optional]
}
## Example
```python
from sailpoint.v2024.models.attribute_mappings_all_of_target import AttributeMappingsAllOfTarget
attribute_mappings_all_of_target = AttributeMappingsAllOfTarget(
type='IDENTITY',
attribute_name='businessApplication',
source_id='2c9180835d2e5168015d32f890ca1581'
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,39 @@
---
id: v2024-attribute-mappings-all-of-transform-definition
title: AttributeMappingsAllOfTransformDefinition
pagination_label: AttributeMappingsAllOfTransformDefinition
sidebar_label: AttributeMappingsAllOfTransformDefinition
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTransformDefinition', 'V2024AttributeMappingsAllOfTransformDefinition']
slug: /tools/sdk/python/v2024/models/attribute-mappings-all-of-transform-definition
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinition', 'V2024AttributeMappingsAllOfTransformDefinition']
---
# AttributeMappingsAllOfTransformDefinition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type of transform | [optional]
**attributes** | [**AttributeMappingsAllOfTransformDefinitionAttributes**](attribute-mappings-all-of-transform-definition-attributes) | | [optional]
**id** | **str** | Transform Operation | [optional]
}
## Example
```python
from sailpoint.v2024.models.attribute_mappings_all_of_transform_definition import AttributeMappingsAllOfTransformDefinition
attribute_mappings_all_of_transform_definition = AttributeMappingsAllOfTransformDefinition(
type='reference',
attributes=sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes.AttributeMappings_allOf_transformDefinition_attributes(
input = sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input.AttributeMappings_allOf_transformDefinition_attributes_input(
type = 'accountAttribute', ), ),
id='ToUpper'
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,39 @@
---
id: v2024-attribute-mappings-all-of-transform-definition-attributes
title: AttributeMappingsAllOfTransformDefinitionAttributes
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributes
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributes']
slug: /tools/sdk/python/v2024/models/attribute-mappings-all-of-transform-definition-attributes
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributes']
---
# AttributeMappingsAllOfTransformDefinitionAttributes
attributes object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**input** | [**AttributeMappingsAllOfTransformDefinitionAttributesInput**](attribute-mappings-all-of-transform-definition-attributes-input) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes import AttributeMappingsAllOfTransformDefinitionAttributes
attribute_mappings_all_of_transform_definition_attributes = AttributeMappingsAllOfTransformDefinitionAttributes(
input=sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input.AttributeMappings_allOf_transformDefinition_attributes_input(
type = 'accountAttribute',
attributes = sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input_attributes.AttributeMappings_allOf_transformDefinition_attributes_input_attributes(
attribute_name = 'givenName',
source_name = 'delimited-src',
name = '8d3e0094e99445de98eef6c75e25jc04', ), )
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,39 @@
---
id: v2024-attribute-mappings-all-of-transform-definition-attributes-input
title: AttributeMappingsAllOfTransformDefinitionAttributesInput
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributesInput
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributesInput
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInput']
slug: /tools/sdk/python/v2024/models/attribute-mappings-all-of-transform-definition-attributes-input
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInput']
---
# AttributeMappingsAllOfTransformDefinitionAttributesInput
Input Object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The Type of Attribute | [optional]
**attributes** | [**AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes**](attribute-mappings-all-of-transform-definition-attributes-input-attributes) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input import AttributeMappingsAllOfTransformDefinitionAttributesInput
attribute_mappings_all_of_transform_definition_attributes_input = AttributeMappingsAllOfTransformDefinitionAttributesInput(
type='accountAttribute',
attributes=sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input_attributes.AttributeMappings_allOf_transformDefinition_attributes_input_attributes(
attribute_name = 'givenName',
source_name = 'delimited-src',
name = '8d3e0094e99445de98eef6c75e25jc04', )
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,38 @@
---
id: v2024-attribute-mappings-all-of-transform-definition-attributes-input-attributes
title: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes']
slug: /tools/sdk/python/v2024/models/attribute-mappings-all-of-transform-definition-attributes-input-attributes
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2024AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes']
---
# AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
Attibute Mapping Object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attribute_name** | **str** | The name of attribute | [optional]
**source_name** | **str** | Name of the Source | [optional]
**name** | **str** | ID of the Source | [optional]
}
## Example
```python
from sailpoint.v2024.models.attribute_mappings_all_of_transform_definition_attributes_input_attributes import AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes
attribute_mappings_all_of_transform_definition_attributes_input_attributes = AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes(
attribute_name='givenName',
source_name='delimited-src',
name='8d3e0094e99445de98eef6c75e25jc04'
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,41 @@
---
id: v2024-machine-classification-config
title: MachineClassificationConfig
pagination_label: MachineClassificationConfig
sidebar_label: MachineClassificationConfig
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationConfig', 'V2024MachineClassificationConfig']
slug: /tools/sdk/python/v2024/models/machine-classification-config
tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024MachineClassificationConfig']
---
# MachineClassificationConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Indicates if the Classification is enabled for a Source | [optional] [default to False]
**classification_method** | **Enum** [ 'SOURCE' ] | Classification Method | [optional]
**criteria** | **str** | A classification criteria object | [optional]
**created** | **datetime** | Time when the config was created | [optional]
**modified** | **datetime** | Time when the config was last updated | [optional]
}
## Example
```python
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
machine_classification_config = MachineClassificationConfig(
enabled=True,
classification_method='SOURCE',
criteria='',
created='2017-07-11T18:45:37.098Z',
modified='2018-06-25T20:22:28.104Z'
)
```
[[Back to top]](#)

View File

@@ -0,0 +1,33 @@
---
id: v2024-send-classify-machine-account200-response
title: SendClassifyMachineAccount200Response
pagination_label: SendClassifyMachineAccount200Response
sidebar_label: SendClassifyMachineAccount200Response
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SendClassifyMachineAccount200Response', 'V2024SendClassifyMachineAccount200Response']
slug: /tools/sdk/python/v2024/models/send-classify-machine-account200-response
tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccount200Response', 'V2024SendClassifyMachineAccount200Response']
---
# SendClassifyMachineAccount200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is_machine** | **bool** | Indicates if account is classified as machine | [optional] [default to False]
}
## Example
```python
from sailpoint.v2024.models.send_classify_machine_account200_response import SendClassifyMachineAccount200Response
send_classify_machine_account200_response = SendClassifyMachineAccount200Response(
is_machine=True
)
```
[[Back to top]](#)

View File

@@ -1100,7 +1100,7 @@ with ApiClient(configuration) as api_client:
## test-workflow ## test-workflow
Test Workflow By Id Test Workflow By Id
::: info :::info
Workflow must be disabled in order to use this endpoint. Workflow must be disabled in order to use this endpoint.

View File

@@ -1112,7 +1112,7 @@ with ApiClient(configuration) as api_client:
## test-workflow ## test-workflow
Test Workflow By Id Test Workflow By Id
::: info :::info
Workflow must be disabled in order to use this endpoint. Workflow must be disabled in order to use this endpoint.

View File

@@ -16264,34 +16264,6 @@
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e)
- path: /work-items/{id}/forward
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/beta/methods/work-items#forward-work-item
source: |
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_item_forward import WorkItemForward
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = '''{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}''' # WorkItemForward |
try:
# Forward a Work Item
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).forward_work_item(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
# WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward)
except Exception as e:
print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e)
- path: /work-items/completed - path: /work-items/completed
method: GET method: GET
xCodeSample: xCodeSample:
@@ -16306,7 +16278,7 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) owner_id = '2c91808571bcfcf80171c23e4b4221fc' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) 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) 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)
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) 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)
@@ -16335,13 +16307,15 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (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: try:
# Count Completed Work Items # Count Completed Work Items
results = WorkItemsApi(api_client).get_count_completed_work_items() results = WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id, limit, offset)
print("The response of WorkItemsApi->get_count_completed_work_items:\n") print("The response of WorkItemsApi->get_count_completed_work_items:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -16361,7 +16335,7 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try: try:
# Count Work Items # Count Work Items
@@ -16411,7 +16385,7 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try: try:
# Work Items Summary # Work Items Summary
@@ -16439,7 +16413,7 @@
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) 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) 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)
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) 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)
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try: try:
# List Work Items # List Work Items
@@ -16528,6 +16502,34 @@
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e)
- path: /work-items/{id}/forward
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/beta/methods/work-items#submit-forward-work-item
source: |
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_item_forward import WorkItemForward
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = '''{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}''' # WorkItemForward |
try:
# Forward a Work Item
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).submit_forward_work_item(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
# WorkItemsApi(api_client).submit_forward_work_item(id, new_work_item_forward)
except Exception as e:
print("Exception when calling WorkItemsApi->submit_forward_work_item: %s\n" % e)
- path: /reassignment-configurations - path: /reassignment-configurations
method: POST method: POST
xCodeSample: xCodeSample:

View File

@@ -10763,6 +10763,176 @@
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e)
- path: /accounts/{id}/classify
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-account-classify#send-classify-machine-account
source: |
from sailpoint.v2024.api.machine_account_classify_api import MachineAccountClassifyApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.send_classify_machine_account200_response import SendClassifyMachineAccount200Response
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
classification_mode = default # str | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to default) # str | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to default)
try:
# Classify a Single Machine Account
results = MachineAccountClassifyApi(api_client).send_classify_machine_account(id=id)
# Below is a request that includes all optional parameters
# results = MachineAccountClassifyApi(api_client).send_classify_machine_account(id, classification_mode)
print("The response of MachineAccountClassifyApi->send_classify_machine_account:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountClassifyApi->send_classify_machine_account: %s\n" % e)
- path: /sources/{sourceId}/machine-account-mappings
method: POST
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-account-mappings#create-machine-account-mappings
source: |
from sailpoint.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
attribute_mappings = '''{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}''' # AttributeMappings |
try:
# Create Machine Account Mappings
new_attribute_mappings = AttributeMappings.from_json(attribute_mappings)
results = MachineAccountMappingsApi(api_client).create_machine_account_mappings(id=id, attribute_mappings=new_attribute_mappings)
# Below is a request that includes all optional parameters
# results = MachineAccountMappingsApi(api_client).create_machine_account_mappings(id, new_attribute_mappings)
print("The response of MachineAccountMappingsApi->create_machine_account_mappings:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->create_machine_account_mappings: %s\n" % e)
- path: /sources/{sourceId}/machine-account-mappings
method: DELETE
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-account-mappings#delete-machine-account-mappings
source: |
from sailpoint.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | source ID. # str | source ID.
try:
# Delete Source's Machine Account Mappings
MachineAccountMappingsApi(api_client).delete_machine_account_mappings(id=id)
# Below is a request that includes all optional parameters
# MachineAccountMappingsApi(api_client).delete_machine_account_mappings(id)
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->delete_machine_account_mappings: %s\n" % e)
- path: /sources/{sourceId}/machine-account-mappings
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-account-mappings#list-machine-account-mappings
source: |
from sailpoint.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID # str | Source ID
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:
# Machine Account Mapping for Source
results = MachineAccountMappingsApi(api_client).list_machine_account_mappings(id=id)
# Below is a request that includes all optional parameters
# results = MachineAccountMappingsApi(api_client).list_machine_account_mappings(id, limit, offset)
print("The response of MachineAccountMappingsApi->list_machine_account_mappings:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->list_machine_account_mappings: %s\n" % e)
- path: /sources/{sourceId}/machine-mappings
method: PUT
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-account-mappings#set-machine-account-mappings
source: |
from sailpoint.v2024.api.machine_account_mappings_api import MachineAccountMappingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_mappings import AttributeMappings
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
attribute_mappings = '''{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}''' # AttributeMappings |
try:
# Update Source's Machine Account Mappings
new_attribute_mappings = AttributeMappings.from_json(attribute_mappings)
results = MachineAccountMappingsApi(api_client).set_machine_account_mappings(id=id, attribute_mappings=new_attribute_mappings)
# Below is a request that includes all optional parameters
# results = MachineAccountMappingsApi(api_client).set_machine_account_mappings(id, new_attribute_mappings)
print("The response of MachineAccountMappingsApi->set_machine_account_mappings:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineAccountMappingsApi->set_machine_account_mappings: %s\n" % e)
- path: /machine-accounts/{id} - path: /machine-accounts/{id}
method: GET method: GET
xCodeSample: xCodeSample:
@@ -10850,6 +11020,85 @@
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e)
- path: /sources/{sourceId}/machine-classification-config
method: DELETE
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-classification-config#delete-machine-classification-config
source: |
from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
try:
# Delete Source's Classification Config
MachineClassificationConfigApi(api_client).delete_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
# MachineClassificationConfigApi(api_client).delete_machine_classification_config(id)
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->delete_machine_classification_config: %s\n" % e)
- path: /sources/{sourceId}/machine-classification-config
method: GET
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-classification-config#get-machine-classification-config
source: |
from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID # str | Source ID
try:
# Machine Classification Config for Source
results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id=id)
# Below is a request that includes all optional parameters
# results = MachineClassificationConfigApi(api_client).get_machine_classification_config(id)
print("The response of MachineClassificationConfigApi->get_machine_classification_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->get_machine_classification_config: %s\n" % e)
- path: /sources/{sourceId}/machine-classification-config
method: PUT
xCodeSample:
- lang: Python
label: SDK_tools/sdk/python/v2024/methods/machine-classification-config#set-machine-classification-config
source: |
from sailpoint.v2024.api.machine_classification_config_api import MachineClassificationConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.machine_classification_config import MachineClassificationConfig
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{
"criteria" : "criteria",
"created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE",
"enabled" : true
}''' # MachineClassificationConfig |
try:
# Update Source's Classification Config
new_machine_classification_config = MachineClassificationConfig.from_json(machine_classification_config)
results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id=id, machine_classification_config=new_machine_classification_config)
# Below is a request that includes all optional parameters
# results = MachineClassificationConfigApi(api_client).set_machine_classification_config(id, new_machine_classification_config)
print("The response of MachineClassificationConfigApi->set_machine_classification_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling MachineClassificationConfigApi->set_machine_classification_config: %s\n" % e)
- path: /machine-identities - path: /machine-identities
method: POST method: POST
xCodeSample: xCodeSample: