mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update python SDK docs: 15458634025
This commit is contained in:
developer-relations-sp
@@ -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