mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
Update python SDK docs: 15458634025
This commit is contained in:
developer-relations-sp
@@ -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]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user