mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 20:37:46 +00:00
Update python SDK docs: 15458634025
This commit is contained in:
developer-relations-sp
@@ -18,7 +18,7 @@ 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
|
||||
[**set-machine-account-mappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings
|
||||
|
||||
|
||||
## create-machine-account-mappings
|
||||
@@ -225,7 +225,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-machine-account-mappings
|
||||
Update source's 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)
|
||||
@@ -290,7 +290,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # AttributeMappings |
|
||||
|
||||
try:
|
||||
# Update source's machine account mappings
|
||||
# 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
|
||||
|
||||
@@ -0,0 +1,199 @@
|
||||
---
|
||||
id: v2025-classify-source
|
||||
title: Classify_Source
|
||||
pagination_label: Classify_Source
|
||||
sidebar_label: Classify_Source
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Classify_Source', 'V2025Classify_Source']
|
||||
slug: /tools/sdk/python/v2025/methods/classify-source
|
||||
tags: ['SDK', 'Software Development Kit', 'Classify_Source', 'V2025Classify_Source']
|
||||
---
|
||||
|
||||
# sailpoint.v2025.ClassifySourceApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**delete-classify-machine-account-from-source**](#delete-classify-machine-account-from-source) | **DELETE** `/sources/{sourceId}/classify` | Cancel classify source's accounts process
|
||||
[**get-classify-machine-account-from-source-status**](#get-classify-machine-account-from-source-status) | **GET** `/sources/{sourceId}/classify` | Source accounts classification status
|
||||
[**send-classify-machine-account-from-source**](#send-classify-machine-account-from-source) | **POST** `/sources/{sourceId}/classify` | Classify source's all accounts
|
||||
|
||||
|
||||
## delete-classify-machine-account-from-source
|
||||
Cancel classify source's accounts process
|
||||
Use this API to cancel account classification process on 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/v2025/delete-classify-machine-account-from-source)
|
||||
|
||||
### 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 |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.classify_source_api import ClassifySourceApi
|
||||
from sailpoint.v2025.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:
|
||||
# Cancel classify source's accounts process
|
||||
|
||||
ClassifySourceApi(api_client).delete_classify_machine_account_from_source(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# ClassifySourceApi(api_client).delete_classify_machine_account_from_source(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ClassifySourceApi->delete_classify_machine_account_from_source: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-classify-machine-account-from-source-status
|
||||
Source accounts classification status
|
||||
Use this API to get the status of Machine Account Classification process 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/v2025/get-classify-machine-account-from-source-status)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Source ID.
|
||||
|
||||
### Return type
|
||||
[**SourceClassificationStatus**](../models/source-classification-status)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Source Accounts Classification Status object. | SourceClassificationStatus | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.classify_source_api import ClassifySourceApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.models.source_classification_status import SourceClassificationStatus
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
|
||||
|
||||
try:
|
||||
# Source accounts classification status
|
||||
|
||||
results = ClassifySourceApi(api_client).get_classify_machine_account_from_source_status(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ClassifySourceApi(api_client).get_classify_machine_account_from_source_status(id)
|
||||
print("The response of ClassifySourceApi->get_classify_machine_account_from_source_status:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ClassifySourceApi->get_classify_machine_account_from_source_status: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## send-classify-machine-account-from-source
|
||||
Classify source's all accounts
|
||||
Use this API to classify all the accounts from 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/v2025/send-classify-machine-account-from-source)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Source ID.
|
||||
|
||||
### Return type
|
||||
[**SendClassifyMachineAccountFromSource200Response**](../models/send-classify-machine-account-from-source200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Source's all accounts submitted for classification. | SendClassifyMachineAccountFromSource200Response | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.api.classify_source_api import ClassifySourceApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.models.send_classify_machine_account_from_source200_response import SendClassifyMachineAccountFromSource200Response
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
|
||||
|
||||
try:
|
||||
# Classify source's all accounts
|
||||
|
||||
results = ClassifySourceApi(api_client).send_classify_machine_account_from_source(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = ClassifySourceApi(api_client).send_classify_machine_account_from_source(id)
|
||||
print("The response of ClassifySourceApi->send_classify_machine_account_from_source:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
print("Exception when calling ClassifySourceApi->send_classify_machine_account_from_source: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
id: v2025-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', 'V2025Machine_Account_Classify']
|
||||
slug: /tools/sdk/python/v2025/methods/machine-account-classify
|
||||
tags: ['SDK', 'Software Development Kit', 'Machine_Account_Classify', 'V2025Machine_Account_Classify']
|
||||
---
|
||||
|
||||
# sailpoint.v2025.MachineAccountClassifyApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
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/v2025/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.v2025.api.machine_account_classify_api import MachineAccountClassifyApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.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]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,310 @@
|
||||
---
|
||||
id: v2025-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', 'V2025Machine_Account_Mappings']
|
||||
slug: /tools/sdk/python/v2025/methods/machine-account-mappings
|
||||
tags: ['SDK', 'Software Development Kit', 'Machine_Account_Mappings', 'V2025Machine_Account_Mappings']
|
||||
---
|
||||
|
||||
# sailpoint.v2025.MachineAccountMappingsApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
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/v2025/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.v2025.api.machine_account_mappings_api import MachineAccountMappingsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.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/v2025/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.v2025.api.machine_account_mappings_api import MachineAccountMappingsApi
|
||||
from sailpoint.v2025.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/v2025/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.v2025.api.machine_account_mappings_api import MachineAccountMappingsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.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/v2025/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.v2025.api.machine_account_mappings_api import MachineAccountMappingsApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.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]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,207 @@
|
||||
---
|
||||
id: v2025-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', 'V2025Machine_Classification_Config']
|
||||
slug: /tools/sdk/python/v2025/methods/machine-classification-config
|
||||
tags: ['SDK', 'Software Development Kit', 'Machine_Classification_Config', 'V2025Machine_Classification_Config']
|
||||
---
|
||||
|
||||
# sailpoint.v2025.MachineClassificationConfigApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
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/v2025/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.v2025.api.machine_classification_config_api import MachineClassificationConfigApi
|
||||
from sailpoint.v2025.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/v2025/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.v2025.api.machine_classification_config_api import MachineClassificationConfigApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.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/v2025/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.v2025.api.machine_classification_config_api import MachineClassificationConfigApi
|
||||
from sailpoint.v2025.api_client import ApiClient
|
||||
from sailpoint.v2025.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]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2025-attribute-mappings
|
||||
title: AttributeMappings
|
||||
pagination_label: AttributeMappings
|
||||
sidebar_label: AttributeMappings
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeMappings', 'V2025AttributeMappings']
|
||||
slug: /tools/sdk/python/v2025/models/attribute-mappings
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappings', 'V2025AttributeMappings']
|
||||
---
|
||||
|
||||
# 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.v2025.models.attribute_mappings import AttributeMappings
|
||||
|
||||
attribute_mappings = AttributeMappings(
|
||||
target=sailpoint.v2025.models.attribute_mappings_all_of_target.AttributeMappings_allOf_target(
|
||||
type = 'IDENTITY',
|
||||
attribute_name = 'businessApplication',
|
||||
source_id = '2c9180835d2e5168015d32f890ca1581', ),
|
||||
transform_definition=sailpoint.v2025.models.attribute_mappings_all_of_transform_definition.AttributeMappings_allOf_transformDefinition(
|
||||
type = 'reference',
|
||||
attributes = sailpoint.v2025.models.attribute_mappings_all_of_transform_definition_attributes.AttributeMappings_allOf_transformDefinition_attributes(
|
||||
input = sailpoint.v2025.models.attribute_mappings_all_of_transform_definition_attributes_input.AttributeMappings_allOf_transformDefinition_attributes_input(
|
||||
type = 'accountAttribute', ), ),
|
||||
id = 'ToUpper', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2025-attribute-mappings-all-of-target
|
||||
title: AttributeMappingsAllOfTarget
|
||||
pagination_label: AttributeMappingsAllOfTarget
|
||||
sidebar_label: AttributeMappingsAllOfTarget
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTarget', 'V2025AttributeMappingsAllOfTarget']
|
||||
slug: /tools/sdk/python/v2025/models/attribute-mappings-all-of-target
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTarget', 'V2025AttributeMappingsAllOfTarget']
|
||||
---
|
||||
|
||||
# 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.v2025.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]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-attribute-mappings-all-of-transform-definition
|
||||
title: AttributeMappingsAllOfTransformDefinition
|
||||
pagination_label: AttributeMappingsAllOfTransformDefinition
|
||||
sidebar_label: AttributeMappingsAllOfTransformDefinition
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTransformDefinition', 'V2025AttributeMappingsAllOfTransformDefinition']
|
||||
slug: /tools/sdk/python/v2025/models/attribute-mappings-all-of-transform-definition
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinition', 'V2025AttributeMappingsAllOfTransformDefinition']
|
||||
---
|
||||
|
||||
# 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.v2025.models.attribute_mappings_all_of_transform_definition import AttributeMappingsAllOfTransformDefinition
|
||||
|
||||
attribute_mappings_all_of_transform_definition = AttributeMappingsAllOfTransformDefinition(
|
||||
type='reference',
|
||||
attributes=sailpoint.v2025.models.attribute_mappings_all_of_transform_definition_attributes.AttributeMappings_allOf_transformDefinition_attributes(
|
||||
input = sailpoint.v2025.models.attribute_mappings_all_of_transform_definition_attributes_input.AttributeMappings_allOf_transformDefinition_attributes_input(
|
||||
type = 'accountAttribute', ), ),
|
||||
id='ToUpper'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-attribute-mappings-all-of-transform-definition-attributes
|
||||
title: AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
pagination_label: AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
sidebar_label: AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2025AttributeMappingsAllOfTransformDefinitionAttributes']
|
||||
slug: /tools/sdk/python/v2025/models/attribute-mappings-all-of-transform-definition-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributes', 'V2025AttributeMappingsAllOfTransformDefinitionAttributes']
|
||||
---
|
||||
|
||||
# AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
|
||||
attributes object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**input** | [**AttributeMappingsAllOfTransformDefinitionAttributesInput**](attribute-mappings-all-of-transform-definition-attributes-input) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.attribute_mappings_all_of_transform_definition_attributes import AttributeMappingsAllOfTransformDefinitionAttributes
|
||||
|
||||
attribute_mappings_all_of_transform_definition_attributes = AttributeMappingsAllOfTransformDefinitionAttributes(
|
||||
input=sailpoint.v2025.models.attribute_mappings_all_of_transform_definition_attributes_input.AttributeMappings_allOf_transformDefinition_attributes_input(
|
||||
type = 'accountAttribute',
|
||||
attributes = sailpoint.v2025.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]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2025-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', 'V2025AttributeMappingsAllOfTransformDefinitionAttributesInput']
|
||||
slug: /tools/sdk/python/v2025/models/attribute-mappings-all-of-transform-definition-attributes-input
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInput', 'V2025AttributeMappingsAllOfTransformDefinitionAttributesInput']
|
||||
---
|
||||
|
||||
# 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.v2025.models.attribute_mappings_all_of_transform_definition_attributes_input import AttributeMappingsAllOfTransformDefinitionAttributesInput
|
||||
|
||||
attribute_mappings_all_of_transform_definition_attributes_input = AttributeMappingsAllOfTransformDefinitionAttributesInput(
|
||||
type='accountAttribute',
|
||||
attributes=sailpoint.v2025.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]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2025-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', 'V2025AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes']
|
||||
slug: /tools/sdk/python/v2025/models/attribute-mappings-all-of-transform-definition-attributes-input-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes', 'V2025AttributeMappingsAllOfTransformDefinitionAttributesInputAttributes']
|
||||
---
|
||||
|
||||
# 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.v2025.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]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2025-machine-classification-config
|
||||
title: MachineClassificationConfig
|
||||
pagination_label: MachineClassificationConfig
|
||||
sidebar_label: MachineClassificationConfig
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'MachineClassificationConfig', 'V2025MachineClassificationConfig']
|
||||
slug: /tools/sdk/python/v2025/models/machine-classification-config
|
||||
tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2025MachineClassificationConfig']
|
||||
---
|
||||
|
||||
# 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.v2025.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]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2025-send-classify-machine-account200-response
|
||||
title: SendClassifyMachineAccount200Response
|
||||
pagination_label: SendClassifyMachineAccount200Response
|
||||
sidebar_label: SendClassifyMachineAccount200Response
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SendClassifyMachineAccount200Response', 'V2025SendClassifyMachineAccount200Response']
|
||||
slug: /tools/sdk/python/v2025/models/send-classify-machine-account200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccount200Response', 'V2025SendClassifyMachineAccount200Response']
|
||||
---
|
||||
|
||||
# SendClassifyMachineAccount200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**is_machine** | **bool** | Indicates if account is classified as machine | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.send_classify_machine_account200_response import SendClassifyMachineAccount200Response
|
||||
|
||||
send_classify_machine_account200_response = SendClassifyMachineAccount200Response(
|
||||
is_machine=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
id: v2025-send-classify-machine-account-from-source200-response
|
||||
title: SendClassifyMachineAccountFromSource200Response
|
||||
pagination_label: SendClassifyMachineAccountFromSource200Response
|
||||
sidebar_label: SendClassifyMachineAccountFromSource200Response
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SendClassifyMachineAccountFromSource200Response', 'V2025SendClassifyMachineAccountFromSource200Response']
|
||||
slug: /tools/sdk/python/v2025/models/send-classify-machine-account-from-source200-response
|
||||
tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccountFromSource200Response', 'V2025SendClassifyMachineAccountFromSource200Response']
|
||||
---
|
||||
|
||||
# SendClassifyMachineAccountFromSource200Response
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**accounts_submitted_for_processing** | **int** | Returns the number of all the accounts from source submitted for processing. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.send_classify_machine_account_from_source200_response import SendClassifyMachineAccountFromSource200Response
|
||||
|
||||
send_classify_machine_account_from_source200_response = SendClassifyMachineAccountFromSource200Response(
|
||||
accounts_submitted_for_processing=100
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
id: v2025-source-classification-status
|
||||
title: SourceClassificationStatus
|
||||
pagination_label: SourceClassificationStatus
|
||||
sidebar_label: SourceClassificationStatus
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SourceClassificationStatus', 'V2025SourceClassificationStatus']
|
||||
slug: /tools/sdk/python/v2025/models/source-classification-status
|
||||
tags: ['SDK', 'Software Development Kit', 'SourceClassificationStatus', 'V2025SourceClassificationStatus']
|
||||
---
|
||||
|
||||
# SourceClassificationStatus
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**status** | **Enum** [ 'STARTED', 'COLLECTED', 'COMPLETED', 'CANCELLED', 'TERMINATED' ] | Status of Classification Process | [optional]
|
||||
**started** | **datetime** | Time when the process was started | [optional]
|
||||
**updated** | **datetime** | Time when the process status was last updated | [optional]
|
||||
**counts** | [**SourceClassificationStatusAllOfCounts**](source-classification-status-all-of-counts) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.source_classification_status import SourceClassificationStatus
|
||||
|
||||
source_classification_status = SourceClassificationStatus(
|
||||
status='COMPLETED',
|
||||
started='2017-07-11T18:45:37.098Z',
|
||||
updated='2018-06-25T20:22:28.104Z',
|
||||
counts=sailpoint.v2025.models.source_classification_status_all_of_counts.SourceClassificationStatus_allOf_counts(
|
||||
expected = 1000,
|
||||
received = 800,
|
||||
completed = 500, )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2025-source-classification-status-all-of-counts
|
||||
title: SourceClassificationStatusAllOfCounts
|
||||
pagination_label: SourceClassificationStatusAllOfCounts
|
||||
sidebar_label: SourceClassificationStatusAllOfCounts
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SourceClassificationStatusAllOfCounts', 'V2025SourceClassificationStatusAllOfCounts']
|
||||
slug: /tools/sdk/python/v2025/models/source-classification-status-all-of-counts
|
||||
tags: ['SDK', 'Software Development Kit', 'SourceClassificationStatusAllOfCounts', 'V2025SourceClassificationStatusAllOfCounts']
|
||||
---
|
||||
|
||||
# SourceClassificationStatusAllOfCounts
|
||||
|
||||
A map containing numbers relevant to the source classification process
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**expected** | **int** | total number of source accounts | [required]
|
||||
**received** | **int** | number of accounts that have been sent for processing (should be the same as expected when all accounts are collected) | [required]
|
||||
**completed** | **int** | number of accounts that have been classified | [required]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2025.models.source_classification_status_all_of_counts import SourceClassificationStatusAllOfCounts
|
||||
|
||||
source_classification_status_all_of_counts = SourceClassificationStatusAllOfCounts(
|
||||
expected=1000,
|
||||
received=800,
|
||||
completed=500
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user