Update to python SDK docs: 14926960824

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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