mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
merge changes from main and pull the latest from python docs
This commit is contained in:
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | If the profile or mapping is enabled | [optional] [default to True]
|
||||
**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to True]
|
||||
**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
|
||||
}
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Defines all the identity attribute mapping configurations. This defines how to g
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enabled** | **bool** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to False]
|
||||
**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to False]
|
||||
**attribute_transforms** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional]
|
||||
}
|
||||
|
||||
|
||||
@@ -11,12 +11,13 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde
|
||||
|
||||
# IdentityAttributeTransform
|
||||
|
||||
Transform definition for an identity attribute.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**identity_attribute_name** | **str** | Name of the identity attribute | [optional]
|
||||
**identity_attribute_name** | **str** | Identity attribute's name. | [optional]
|
||||
**transform_definition** | [**TransformDefinition**](transform-definition) | | [optional]
|
||||
}
|
||||
|
||||
|
||||
@@ -11,13 +11,13 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId
|
||||
|
||||
# IdentityAttributeTransform1
|
||||
|
||||
Defines a transformation definition for an identity attribute.
|
||||
Transform definition for an identity attribute.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**identity_attribute_name** | **str** | Name of the identity attribute. | [optional]
|
||||
**identity_attribute_name** | **str** | Identity attribute's name. | [optional]
|
||||
**transform_definition** | [**TransformDefinition1**](transform-definition1) | | [optional]
|
||||
}
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**task_result_id** | **str** | The id of the task result | [optional]
|
||||
**report_name** | **str** | The name of the report | [optional]
|
||||
**task_result_id** | **str** | Task result ID. | [optional]
|
||||
**report_name** | **str** | Report name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', '
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**task_result_id** | **str** | The id of the task result. | [optional]
|
||||
**report_name** | **str** | The name of the report. | [optional]
|
||||
**task_result_id** | **str** | Task result ID. | [optional]
|
||||
**report_name** | **str** | Report name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -20,15 +20,15 @@ Name | Type | Description | Notes
|
||||
**name** | **str** | Name of the Object | [required]
|
||||
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
|
||||
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
|
||||
**description** | **str** | The description of the Identity Profile. | [optional]
|
||||
**description** | **str** | Identity profile's description. | [optional]
|
||||
**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
|
||||
**priority** | **int** | The priority for an Identity Profile. | [optional]
|
||||
**priority** | **int** | Identity profile's priority. | [optional]
|
||||
**authoritative_source** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required]
|
||||
**identity_refresh_required** | **bool** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to False]
|
||||
**identity_count** | **int** | The number of identities that belong to the Identity Profile. | [optional]
|
||||
**identity_refresh_required** | **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to False]
|
||||
**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional]
|
||||
**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional]
|
||||
**identity_exception_report_reference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional]
|
||||
**has_time_based_attr** | **bool** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to True]
|
||||
**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to True]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -20,15 +20,15 @@ Name | Type | Description | Notes
|
||||
**name** | **str** | Name of the Object | [required]
|
||||
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
|
||||
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
|
||||
**description** | **str** | The description of the Identity Profile. | [optional]
|
||||
**description** | **str** | Identity profile's description. | [optional]
|
||||
**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
|
||||
**priority** | **int** | The priority for an Identity Profile. | [optional]
|
||||
**priority** | **int** | Identity profile's priority. | [optional]
|
||||
**authoritative_source** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required]
|
||||
**identity_refresh_required** | **bool** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to False]
|
||||
**identity_count** | **int** | The number of identities that belong to the Identity Profile. | [optional]
|
||||
**identity_refresh_required** | **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to False]
|
||||
**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional]
|
||||
**identity_attribute_config** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional]
|
||||
**identity_exception_report_reference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional]
|
||||
**has_time_based_attr** | **bool** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to False]
|
||||
**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'SOURCE' ] | Type of the object to which this reference applies | [optional]
|
||||
**id** | **str** | ID of the object to which this reference applies | [optional]
|
||||
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional]
|
||||
**id** | **str** | Authoritative source's ID. | [optional]
|
||||
**name** | **str** | Authoritative source's name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour
|
||||
|
||||
# IdentityProfileAllOfAuthoritativeSource
|
||||
|
||||
The authoritative source for this Identity Profile.
|
||||
Identity profile's authoritative source.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'SOURCE' ] | Type of the object to which this reference applies | [optional]
|
||||
**id** | **str** | ID of the object to which this reference applies | [optional]
|
||||
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional]
|
||||
**id** | **str** | Authoritative source's ID. | [optional]
|
||||
**name** | **str** | Authoritative source's name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden
|
||||
|
||||
# IdentityProfileAllOfOwner
|
||||
|
||||
The owner of the Identity Profile.
|
||||
Identity profile's owner.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY' ] | Type of the object to which this reference applies | [optional]
|
||||
**id** | **str** | ID of the object to which this reference applies | [optional]
|
||||
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**type** | **Enum** [ 'IDENTITY' ] | Owner's object type. | [optional]
|
||||
**id** | **str** | Owner's ID. | [optional]
|
||||
**name** | **str** | Owner's name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -17,7 +17,7 @@ Object created or updated by import.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional]
|
||||
**type** | **Enum** [ 'CONNECTOR_RULE', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional]
|
||||
**id** | **str** | ID of object created or updated by import. | [optional]
|
||||
**name** | **str** | Display name of object created or updated by import. | [optional]
|
||||
}
|
||||
|
||||
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
|
||||
**account_managers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional]
|
||||
**modified** | **datetime** | When the request was last modified. | [optional]
|
||||
**created** | **datetime** | When the request was created. | [optional]
|
||||
**non_employee_count** | **int** | Number of non-employee records associated with this source. | [optional]
|
||||
**non_employee_count** | **int** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedI
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | The ID of the access request. | [optional]
|
||||
**name** | **str** | Human-readable display name of the item being requested. | [optional]
|
||||
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
|
||||
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
|
||||
@@ -48,6 +49,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.beta.models.requested_item_status import RequestedItemStatus
|
||||
|
||||
requested_item_status = RequestedItemStatus(
|
||||
id='2c9180926cbfbddd016cbfc7c3b10010',
|
||||
name='AccessProfile1',
|
||||
type='ACCESS_PROFILE',
|
||||
cancelled_request_details=,
|
||||
|
||||
@@ -17,7 +17,7 @@ Self block for imported/exported object.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'LIFECYCLE_STATE', 'NOTIFICATION_TEMPLATE', 'PASSWORD_POLICY', 'PASSWORD_SYNC_GROUP', 'PUBLIC_IDENTITIES_CONFIG', 'ROLE', 'RULE', 'SEGMENT', 'SERVICE_DESK_INTEGRATION', 'SOD_POLICY', 'SOURCE', 'TAG', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION', 'WORKFLOW' ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
|
||||
**type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'CONNECTOR_RULE', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'LIFECYCLE_STATE', 'NOTIFICATION_TEMPLATE', 'PASSWORD_POLICY', 'PASSWORD_SYNC_GROUP', 'PUBLIC_IDENTITIES_CONFIG', 'ROLE', 'RULE', 'SEGMENT', 'SERVICE_DESK_INTEGRATION', 'SOD_POLICY', 'SOURCE', 'TAG', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION', 'WORKFLOW' ] | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
|
||||
**id** | **str** | Imported/exported object's ID. | [optional]
|
||||
**name** | **str** | Imported/exported object's display name. | [optional]
|
||||
}
|
||||
|
||||
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
||||
**object_type** | **str** | The object type this configuration is for. | [optional]
|
||||
**reference_extractors** | **[]str** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional]
|
||||
**signature_required** | **bool** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False]
|
||||
**always_resolve_by_id** | **bool** | Whether this object type has to be resolved always by ID | [optional] [default to False]
|
||||
**legacy_object** | **bool** | Whether this is a legacy object | [optional] [default to False]
|
||||
**one_per_tenant** | **bool** | Whether there is only one object of this type | [optional] [default to False]
|
||||
**exportable** | **bool** | Whether this object can be exported or it is just a reference object | [optional] [default to False]
|
||||
@@ -35,6 +36,7 @@ sp_config_object = SpConfigObject(
|
||||
object_type='TRIGGER_SUBSCRIPTION',
|
||||
reference_extractors=[$.owner],
|
||||
signature_required=False,
|
||||
always_resolve_by_id=True,
|
||||
legacy_object=False,
|
||||
one_per_tenant=False,
|
||||
exportable=True,
|
||||
@@ -42,14 +44,13 @@ rules=sailpoint.beta.models.config_object_rules.Config Object Rules(
|
||||
take_from_target_rules = [
|
||||
sailpoint.beta.models.config_object_rule.Config Object Rule(
|
||||
path = '$.enabled',
|
||||
value = sailpoint.beta.models.value.value(),
|
||||
mode = [RESTORE, PROMOTE], )
|
||||
value = null,
|
||||
modes = [RESTORE, PROMOTE], )
|
||||
],
|
||||
default_rules = [
|
||||
sailpoint.beta.models.config_object_rule.Config Object Rule(
|
||||
path = '$.enabled',
|
||||
value = sailpoint.beta.models.value.value(),
|
||||
mode = [RESTORE, PROMOTE], )
|
||||
modes = [RESTORE, PROMOTE], )
|
||||
],
|
||||
editable = True, )
|
||||
)
|
||||
|
||||
@@ -18,8 +18,8 @@ Format of Config Hub Object Rules
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional]
|
||||
**value** | **object** | Value to be assigned at the jsonPath location within the object | [optional]
|
||||
**mode** | **[]str** | Draft modes to which this rule will apply | [optional]
|
||||
**value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional]
|
||||
**modes** | **[]str** | Draft modes to which this rule will apply | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
@@ -29,8 +29,8 @@ from sailpoint.beta.models.sp_config_rule import SpConfigRule
|
||||
|
||||
sp_config_rule = SpConfigRule(
|
||||
path='$.enabled',
|
||||
value=sailpoint.beta.models.value.value(),
|
||||
mode=[RESTORE, PROMOTE]
|
||||
value=,
|
||||
modes=[RESTORE, PROMOTE]
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
id: beta-sp-config-rule-value
|
||||
title: SpConfigRuleValue
|
||||
pagination_label: SpConfigRuleValue
|
||||
sidebar_label: SpConfigRuleValue
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
|
||||
slug: /tools/sdk/python/beta/models/sp-config-rule-value
|
||||
tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
|
||||
---
|
||||
|
||||
# SpConfigRuleValue
|
||||
|
||||
Value to be assigned at the jsonPath location within the object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.beta.models.sp_config_rule_value import SpConfigRuleValue
|
||||
|
||||
sp_config_rule_value = SpConfigRuleValue(
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -31,14 +31,14 @@ sp_config_rules = SpConfigRules(
|
||||
take_from_target_rules=[
|
||||
sailpoint.beta.models.config_object_rule.Config Object Rule(
|
||||
path = '$.enabled',
|
||||
value = sailpoint.beta.models.value.value(),
|
||||
mode = [RESTORE, PROMOTE], )
|
||||
value = null,
|
||||
modes = [RESTORE, PROMOTE], )
|
||||
],
|
||||
default_rules=[
|
||||
sailpoint.beta.models.config_object_rule.Config Object Rule(
|
||||
path = '$.enabled',
|
||||
value = sailpoint.beta.models.value.value(),
|
||||
mode = [RESTORE, PROMOTE], )
|
||||
value = null,
|
||||
modes = [RESTORE, PROMOTE], )
|
||||
],
|
||||
editable=True
|
||||
)
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **str** | The type of the transform definition. | [optional]
|
||||
**type** | **str** | Transform definition type. | [optional]
|
||||
**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional]
|
||||
}
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **str** | The type of the transform definition. | [optional]
|
||||
**type** | **str** | Transform definition type. | [optional]
|
||||
**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional]
|
||||
}
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
|
||||
**request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional]
|
||||
**start_time** | **datetime** | Date/time when the workflow started. | [optional]
|
||||
**close_time** | **datetime** | Date/time when the workflow ended. | [optional]
|
||||
**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Executing' ] | Workflow execution status. | [optional]
|
||||
**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
Reference in New Issue
Block a user