diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md index e7e3c13eb..1c52a6f8d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md @@ -87,12 +87,10 @@ with ApiClient(configuration) as api_client: "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | diff --git a/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceResponse.md b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceResponse.md index b5c0be1ad..5230ba2e8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceResponse.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/FormInstanceResponse.md @@ -16,21 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'BetaFormInsta Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | Created is the date the form instance was assigned | [optional] -**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] -**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] -**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] -**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] -**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] -**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] -**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] **id** | **str** | Unique guid identifying this form instance | [optional] -**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] -**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] **stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] **stand_alone_form_url** | **str** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] -**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**created** | **datetime** | Created is the date the form instance was assigned | [optional] +**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] } ## Example @@ -39,11 +39,39 @@ Name | Type | Description | Notes from sailpoint.beta.models.form_instance_response import FormInstanceResponse form_instance_response = FormInstanceResponse( -created='2023-07-12T20:14:57.744860Z', +id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +expire='2023-08-12T20:14:57.74486Z', +state='ASSIGNED', +stand_alone_form=False, +stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', created_by=sailpoint.beta.models.form_instance_created_by.FormInstanceCreatedBy( id = '00000000-0000-0000-0000-000000000000', type = 'WORKFLOW_EXECUTION', ), -expire='2023-08-12T20:14:57.74486Z', +form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', +form_input={input1=Sales}, +form_elements=[ + sailpoint.beta.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_data={department=Engineering}, +form_errors=[ + sailpoint.beta.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.beta.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) + ], + value = Engineering, ) + ], form_conditions=[ sailpoint.beta.models.form_condition.FormCondition( rule_operator = 'AND', @@ -63,41 +91,13 @@ form_conditions=[ element = '8110662963316867', ), ) ], ) ], -form_data={department=Engineering}, -form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', -form_elements=[ - sailpoint.beta.models.form_element.FormElement( - id = '00000000-0000-0000-0000-000000000000', - element_type = 'TEXT', - config = {label=Department}, - key = 'department', - validations = [ - sailpoint.beta.models.form_element_validations_set.FormElementValidationsSet( - validation_type = 'REQUIRED', ) - ], ) - ], -form_errors=[ - sailpoint.beta.models.form_error.FormError( - key = 'department', - messages = [ - sailpoint.beta.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( - locale = 'en-US', - locale_origin = 'DEFAULT', - text = 'This is an error', ) - ], - value = Engineering, ) - ], -form_input={input1=Sales}, -id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +created='2023-07-12T20:14:57.744860Z', modified='2023-07-12T20:14:57.744860Z', recipients=[ sailpoint.beta.models.form_instance_recipient.FormInstanceRecipient( id = '00000000-0000-0000-0000-000000000000', type = 'IDENTITY', ) - ], -stand_alone_form=False, -stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', -state='ASSIGNED' + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md index fea823796..c998da55f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccess.md @@ -28,7 +28,7 @@ from sailpoint.beta.models.identity_with_new_access import IdentityWithNewAccess identity_with_new_access = IdentityWithNewAccess( identity_id='2c91808568c529c60168cca6f90c1313', -access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}] ) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md index 2eac13589..8dbc10bd3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md @@ -19,7 +19,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] **id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] } ## Example @@ -29,8 +28,7 @@ from sailpoint.beta.models.identity_with_new_access_access_refs_inner import Ide identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +id='2c91809773dee32014e13e122092014e' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md index 3eb4d2bd0..14a6c0ecb 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md @@ -281,7 +281,7 @@ Path | identity_profile_id | **str** | True | Identity profile 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. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** ### Return type [**List[LifecycleState]**](../models/lifecycle-state) @@ -315,7 +315,7 @@ with ApiClient(configuration) as api_client: 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) try: # Lists lifecyclestates diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md index 1f37259c5..b59a4a189 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md @@ -83,12 +83,10 @@ with ApiClient(configuration) as api_client: "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | @@ -118,7 +116,7 @@ This API initiates a SOD policy verification asynchronously. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Body | identity_with_new_access1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + Body | identity_with_new_access | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | ### Return type [**SodViolationCheck**](../models/sod-violation-check) @@ -143,21 +141,30 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2024.api.sod_violations_api import SODViolationsApi from sailpoint.v2024.api_client import ApiClient -from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 +from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v2024.models.sod_violation_check import SodViolationCheck from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2" + } ] + }''' # IdentityWithNewAccess | try: # Check sod violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access=new_identity_with_new_access) # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access) print("The response of SODViolationsApi->start_violation_check:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef1.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef1.md deleted file mode 100644 index 886dc77b8..000000000 --- a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef1.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: v2024-entitlement-ref1 -title: EntitlementRef1 -pagination_label: EntitlementRef1 -sidebar_label: EntitlementRef1 -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'EntitlementRef1', 'V2024EntitlementRef1'] -slug: /tools/sdk/python/v2024/models/entitlement-ref1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2024EntitlementRef1'] ---- - -# EntitlementRef1 - -Entitlement including a specific set of access. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] -**id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] -} - -## Example - -```python -from sailpoint.v2024.models.entitlement_ref1 import EntitlementRef1 - -entitlement_ref1 = EntitlementRef1( -type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md index 76bee8b7a..66304c757 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md @@ -16,21 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'V2024FormInst Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | Created is the date the form instance was assigned | [optional] -**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] -**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] -**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] -**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] -**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] -**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] -**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] **id** | **str** | Unique guid identifying this form instance | [optional] -**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] -**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] **stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] **stand_alone_form_url** | **str** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] -**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**created** | **datetime** | Created is the date the form instance was assigned | [optional] +**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] } ## Example @@ -39,11 +39,39 @@ Name | Type | Description | Notes from sailpoint.v2024.models.form_instance_response import FormInstanceResponse form_instance_response = FormInstanceResponse( -created='2023-07-12T20:14:57.744860Z', +id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +expire='2023-08-12T20:14:57.74486Z', +state='ASSIGNED', +stand_alone_form=False, +stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', created_by=sailpoint.v2024.models.form_instance_created_by.FormInstanceCreatedBy( id = '00000000-0000-0000-0000-000000000000', type = 'WORKFLOW_EXECUTION', ), -expire='2023-08-12T20:14:57.74486Z', +form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', +form_input={input1=Sales}, +form_elements=[ + sailpoint.v2024.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_data={department=Engineering}, +form_errors=[ + sailpoint.v2024.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) + ], + value = Engineering, ) + ], form_conditions=[ sailpoint.v2024.models.form_condition.FormCondition( rule_operator = 'AND', @@ -63,41 +91,13 @@ form_conditions=[ element = '8110662963316867', ), ) ], ) ], -form_data={department=Engineering}, -form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', -form_elements=[ - sailpoint.v2024.models.form_element.FormElement( - id = '00000000-0000-0000-0000-000000000000', - element_type = 'TEXT', - config = {label=Department}, - key = 'department', - validations = [ - sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( - validation_type = 'REQUIRED', ) - ], ) - ], -form_errors=[ - sailpoint.v2024.models.form_error.FormError( - key = 'department', - messages = [ - sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( - locale = 'en-US', - locale_origin = 'DEFAULT', - text = 'This is an error', ) - ], - value = Engineering, ) - ], -form_input={input1=Sales}, -id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +created='2023-07-12T20:14:57.744860Z', modified='2023-07-12T20:14:57.744860Z', recipients=[ sailpoint.v2024.models.form_instance_recipient.FormInstanceRecipient( id = '00000000-0000-0000-0000-000000000000', type = 'IDENTITY', ) - ], -stand_alone_form=False, -stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', -state='ASSIGNED' + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md index e75aa211c..4824eae39 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess.md @@ -28,7 +28,7 @@ from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAcces identity_with_new_access = IdentityWithNewAccess( identity_id='2c91808568c529c60168cca6f90c1313', -access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess1.md deleted file mode 100644 index b68ab640a..000000000 --- a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: v2024-identity-with-new-access1 -title: IdentityWithNewAccess1 -pagination_label: IdentityWithNewAccess1 -sidebar_label: IdentityWithNewAccess1 -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] -slug: /tools/sdk/python/v2024/models/identity-with-new-access1 -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] ---- - -# IdentityWithNewAccess1 - -An identity with a set of access to be added - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**identity_id** | **str** | Set of identity IDs to be checked. | [required] -**access_refs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] -**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] -} - -## Example - -```python -from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 - -identity_with_new_access1 = IdentityWithNewAccess1( -identity_id='2c91809050db617d0150e0bf3215385e', -access_refs=[ - null - ], -client_metadata={clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md index a14755812..df2ef399c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md @@ -19,7 +19,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] **id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] } ## Example @@ -29,8 +28,7 @@ from sailpoint.v2024.models.identity_with_new_access_access_refs_inner import Id identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +id='2c91809773dee32014e13e122092014e' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md index d7a1c0d1e..7a8907ed5 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ListFormInstancesByTenantResponse.md @@ -11,13 +11,27 @@ tags: ['SDK', 'Software Development Kit', 'ListFormInstancesByTenantResponse', ' # ListFormInstancesByTenantResponse +List of FormInstanceResponse items ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**count** | **int** | Count number of Results | [optional] -**results** | [**[]FormInstanceResponse**](form-instance-response) | Results holds a list of FormInstanceResponse items | [optional] +**id** | **str** | Unique guid identifying this form instance | [optional] +**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] +**stand_alone_form_url** | **str** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**created** | **datetime** | Created is the date the form instance was assigned | [optional] +**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] } ## Example @@ -26,67 +40,64 @@ Name | Type | Description | Notes from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse list_form_instances_by_tenant_response = ListFormInstancesByTenantResponse( -count=1, -results=[ - sailpoint.v2024.models.form_instance_response.FormInstanceResponse( - created = '2023-07-12T20:14:57.744860Z', - created_by = sailpoint.v2024.models.form_instance_created_by.FormInstanceCreatedBy( - id = '00000000-0000-0000-0000-000000000000', - type = 'WORKFLOW_EXECUTION', ), - expire = '2023-08-12T20:14:57.74486Z', - form_conditions = [ - sailpoint.v2024.models.form_condition.FormCondition( - rule_operator = 'AND', - rules = [ - sailpoint.v2024.models.condition_rule.ConditionRule( - source_type = 'ELEMENT', - source = 'department', - operator = 'EQ', - value_type = 'STRING', - value = 'Engineering', ) - ], - effects = [ - sailpoint.v2024.models.condition_effect.ConditionEffect( - effect_type = 'HIDE', - config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( - default_value_label = 'Access to Remove', - element = '8110662963316867', ), ) - ], ) +id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +expire='2023-08-12T20:14:57.74486Z', +state='ASSIGNED', +stand_alone_form=False, +stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', +created_by=sailpoint.v2024.models.form_instance_created_by.FormInstanceCreatedBy( + id = '00000000-0000-0000-0000-000000000000', + type = 'WORKFLOW_EXECUTION', ), +form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', +form_input={input1=Sales}, +form_elements=[ + sailpoint.v2024.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_data={department=Engineering}, +form_errors=[ + sailpoint.v2024.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) ], - form_data = {department=Engineering}, - form_definition_id = '49841cb8-00a5-4fbd-9888-8bbb28d48331', - form_elements = [ - sailpoint.v2024.models.form_element.FormElement( - id = '00000000-0000-0000-0000-000000000000', - element_type = 'TEXT', - key = 'department', - validations = [ - sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( - validation_type = 'REQUIRED', ) - ], ) + value = Engineering, ) + ], +form_conditions=[ + sailpoint.v2024.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.v2024.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) ], - form_errors = [ - sailpoint.v2024.models.form_error.FormError( - key = 'department', - messages = [ - sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( - locale = 'en-US', - locale_origin = 'DEFAULT', - text = 'This is an error', ) - ], - value = Engineering, ) - ], - form_input = {input1=Sales}, - id = '06a2d961-07fa-44d1-8d0a-2f6470e30fd2', - modified = '2023-07-12T20:14:57.744860Z', - recipients = [ - sailpoint.v2024.models.form_instance_recipient.FormInstanceRecipient( - id = '00000000-0000-0000-0000-000000000000', - type = 'IDENTITY', ) - ], - stand_alone_form = False, - stand_alone_form_url = 'https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', - state = 'ASSIGNED', ) + effects = [ + sailpoint.v2024.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], +created='2023-07-12T20:14:57.744860Z', +modified='2023-07-12T20:14:57.744860Z', +recipients=[ + sailpoint.v2024.models.form_instance_recipient.FormInstanceRecipient( + id = '00000000-0000-0000-0000-000000000000', + type = 'IDENTITY', ) ] ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md index 86f25236e..68e53a80e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md @@ -29,13 +29,14 @@ Name | Type | Description | Notes **redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] **client_type** | [**ManagedClientType**](managed-client-type) | | [required] **ccg_version** | **str** | CCG version used by the ManagedCluster | [required] -**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False] +**pinned_config** | **bool** | boolean flag indicating whether or not the cluster configuration is pinned | [optional] [default to False] **log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional] **operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False] **status** | **Enum** [ 'CONFIGURING', 'FAILED', 'NO_CLIENTS', 'NORMAL', 'WARNING' ] | Cluster status | [optional] **public_key_certificate** | **str** | Public key certificate | [optional] **public_key_thumbprint** | **str** | Public key thumbprint | [optional] **public_key** | **str** | Public key | [optional] +**encryption_configuration** | [**ManagedClusterEncryptionConfig**](managed-cluster-encryption-config) | | [optional] **alert_key** | **str** | Key describing any immediate cluster alerts | [optional] **client_ids** | **[]str** | List of clients in a cluster | [optional] **service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0] @@ -89,6 +90,8 @@ status='NORMAL', public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----', public_key_thumbprint='obc6pLiulGbtZ', public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----', +encryption_configuration=sailpoint.v2024.models.managed_cluster_encryption_configuration.Managed Cluster Encryption Configuration( + format = 'V3', ), alert_key='LIMITED_RESOURCES', client_ids=[1244, 1245], service_count=6, diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterEncryptionConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterEncryptionConfig.md new file mode 100644 index 000000000..43ab03e23 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterEncryptionConfig.md @@ -0,0 +1,34 @@ +--- +id: v2024-managed-cluster-encryption-config +title: ManagedClusterEncryptionConfig +pagination_label: ManagedClusterEncryptionConfig +sidebar_label: ManagedClusterEncryptionConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterEncryptionConfig', 'V2024ManagedClusterEncryptionConfig'] +slug: /tools/sdk/python/v2024/models/managed-cluster-encryption-config +tags: ['SDK', 'Software Development Kit', 'ManagedClusterEncryptionConfig', 'V2024ManagedClusterEncryptionConfig'] +--- + +# ManagedClusterEncryptionConfig + +Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | **Enum** [ 'V2', 'V3' ] | Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_encryption_config import ManagedClusterEncryptionConfig + +managed_cluster_encryption_config = ManagedClusterEncryptionConfig( +format='V3' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md index b5b4dc00d..eeeee5897 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md @@ -289,7 +289,7 @@ Path | identity_profile_id | **str** | True | Identity profile 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. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** ### Return type [**List[LifecycleState]**](../models/lifecycle-state) @@ -323,7 +323,7 @@ with ApiClient(configuration) as api_client: 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) try: # Lists lifecyclestates diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SODViolationsApi.md index f3004a018..cb0bc20cc 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SODViolationsApi.md @@ -83,12 +83,10 @@ with ApiClient(configuration) as api_client: "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | @@ -118,7 +116,7 @@ This API initiates a SOD policy verification asynchronously. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Body | identity_with_new_access1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + Body | identity_with_new_access | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | ### Return type [**SodViolationCheck**](../models/sod-violation-check) @@ -143,21 +141,30 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2025.api.sod_violations_api import SODViolationsApi from sailpoint.v2025.api_client import ApiClient -from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 +from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v2025.models.sod_violation_check import SodViolationCheck from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2" + } ] + }''' # IdentityWithNewAccess | try: # Check sod violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access=new_identity_with_new_access) # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access) print("The response of SODViolationsApi->start_violation_check:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2025/Models/EntitlementRef1.md b/docs/tools/sdk/python/Reference/V2025/Models/EntitlementRef1.md deleted file mode 100644 index 8fbf28b82..000000000 --- a/docs/tools/sdk/python/Reference/V2025/Models/EntitlementRef1.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: v2025-entitlement-ref1 -title: EntitlementRef1 -pagination_label: EntitlementRef1 -sidebar_label: EntitlementRef1 -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'EntitlementRef1', 'V2025EntitlementRef1'] -slug: /tools/sdk/python/v2025/models/entitlement-ref1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2025EntitlementRef1'] ---- - -# EntitlementRef1 - -Entitlement including a specific set of access. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] -**id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] -} - -## Example - -```python -from sailpoint.v2025.models.entitlement_ref1 import EntitlementRef1 - -entitlement_ref1 = EntitlementRef1( -type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2025/Models/FormInstanceResponse.md b/docs/tools/sdk/python/Reference/V2025/Models/FormInstanceResponse.md index c35ad7012..57d7abb0a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/FormInstanceResponse.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/FormInstanceResponse.md @@ -16,21 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'V2025FormInst Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | Created is the date the form instance was assigned | [optional] -**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] -**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] -**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] -**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] -**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] -**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] -**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] **id** | **str** | Unique guid identifying this form instance | [optional] -**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] -**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] **stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] **stand_alone_form_url** | **str** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] -**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**created** | **datetime** | Created is the date the form instance was assigned | [optional] +**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] } ## Example @@ -39,11 +39,39 @@ Name | Type | Description | Notes from sailpoint.v2025.models.form_instance_response import FormInstanceResponse form_instance_response = FormInstanceResponse( -created='2023-07-12T20:14:57.744860Z', +id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +expire='2023-08-12T20:14:57.74486Z', +state='ASSIGNED', +stand_alone_form=False, +stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', created_by=sailpoint.v2025.models.form_instance_created_by.FormInstanceCreatedBy( id = '00000000-0000-0000-0000-000000000000', type = 'WORKFLOW_EXECUTION', ), -expire='2023-08-12T20:14:57.74486Z', +form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', +form_input={input1=Sales}, +form_elements=[ + sailpoint.v2025.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2025.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_data={department=Engineering}, +form_errors=[ + sailpoint.v2025.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.v2025.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) + ], + value = Engineering, ) + ], form_conditions=[ sailpoint.v2025.models.form_condition.FormCondition( rule_operator = 'AND', @@ -63,41 +91,13 @@ form_conditions=[ element = '8110662963316867', ), ) ], ) ], -form_data={department=Engineering}, -form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', -form_elements=[ - sailpoint.v2025.models.form_element.FormElement( - id = '00000000-0000-0000-0000-000000000000', - element_type = 'TEXT', - config = {label=Department}, - key = 'department', - validations = [ - sailpoint.v2025.models.form_element_validations_set.FormElementValidationsSet( - validation_type = 'REQUIRED', ) - ], ) - ], -form_errors=[ - sailpoint.v2025.models.form_error.FormError( - key = 'department', - messages = [ - sailpoint.v2025.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( - locale = 'en-US', - locale_origin = 'DEFAULT', - text = 'This is an error', ) - ], - value = Engineering, ) - ], -form_input={input1=Sales}, -id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +created='2023-07-12T20:14:57.744860Z', modified='2023-07-12T20:14:57.744860Z', recipients=[ sailpoint.v2025.models.form_instance_recipient.FormInstanceRecipient( id = '00000000-0000-0000-0000-000000000000', type = 'IDENTITY', ) - ], -stand_alone_form=False, -stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', -state='ASSIGNED' + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess.md index 76ca85e2a..75df4c572 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess.md @@ -28,7 +28,7 @@ from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAcces identity_with_new_access = IdentityWithNewAccess( identity_id='2c91808568c529c60168cca6f90c1313', -access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess1.md deleted file mode 100644 index 1b9e9a471..000000000 --- a/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: v2025-identity-with-new-access1 -title: IdentityWithNewAccess1 -pagination_label: IdentityWithNewAccess1 -sidebar_label: IdentityWithNewAccess1 -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess1', 'V2025IdentityWithNewAccess1'] -slug: /tools/sdk/python/v2025/models/identity-with-new-access1 -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2025IdentityWithNewAccess1'] ---- - -# IdentityWithNewAccess1 - -An identity with a set of access to be added - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**identity_id** | **str** | Set of identity IDs to be checked. | [required] -**access_refs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] -**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] -} - -## Example - -```python -from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 - -identity_with_new_access1 = IdentityWithNewAccess1( -identity_id='2c91809050db617d0150e0bf3215385e', -access_refs=[ - null - ], -client_metadata={clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md index 930f6bd9f..ccaf51d84 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md @@ -19,7 +19,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] **id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] } ## Example @@ -29,8 +28,7 @@ from sailpoint.v2025.models.identity_with_new_access_access_refs_inner import Id identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +id='2c91809773dee32014e13e122092014e' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ListFormInstancesByTenantResponse.md b/docs/tools/sdk/python/Reference/V2025/Models/ListFormInstancesByTenantResponse.md index a6dc5a6cf..6c27c3711 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ListFormInstancesByTenantResponse.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ListFormInstancesByTenantResponse.md @@ -11,13 +11,27 @@ tags: ['SDK', 'Software Development Kit', 'ListFormInstancesByTenantResponse', ' # ListFormInstancesByTenantResponse +List of FormInstanceResponse items ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**count** | **int** | Count number of Results | [optional] -**results** | [**[]FormInstanceResponse**](form-instance-response) | Results holds a list of FormInstanceResponse items | [optional] +**id** | **str** | Unique guid identifying this form instance | [optional] +**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] +**stand_alone_form_url** | **str** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**created** | **datetime** | Created is the date the form instance was assigned | [optional] +**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] } ## Example @@ -26,67 +40,64 @@ Name | Type | Description | Notes from sailpoint.v2025.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse list_form_instances_by_tenant_response = ListFormInstancesByTenantResponse( -count=1, -results=[ - sailpoint.v2025.models.form_instance_response.FormInstanceResponse( - created = '2023-07-12T20:14:57.744860Z', - created_by = sailpoint.v2025.models.form_instance_created_by.FormInstanceCreatedBy( - id = '00000000-0000-0000-0000-000000000000', - type = 'WORKFLOW_EXECUTION', ), - expire = '2023-08-12T20:14:57.74486Z', - form_conditions = [ - sailpoint.v2025.models.form_condition.FormCondition( - rule_operator = 'AND', - rules = [ - sailpoint.v2025.models.condition_rule.ConditionRule( - source_type = 'ELEMENT', - source = 'department', - operator = 'EQ', - value_type = 'STRING', - value = 'Engineering', ) - ], - effects = [ - sailpoint.v2025.models.condition_effect.ConditionEffect( - effect_type = 'HIDE', - config = sailpoint.v2025.models.condition_effect_config.ConditionEffect_config( - default_value_label = 'Access to Remove', - element = '8110662963316867', ), ) - ], ) +id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +expire='2023-08-12T20:14:57.74486Z', +state='ASSIGNED', +stand_alone_form=False, +stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', +created_by=sailpoint.v2025.models.form_instance_created_by.FormInstanceCreatedBy( + id = '00000000-0000-0000-0000-000000000000', + type = 'WORKFLOW_EXECUTION', ), +form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', +form_input={input1=Sales}, +form_elements=[ + sailpoint.v2025.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2025.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_data={department=Engineering}, +form_errors=[ + sailpoint.v2025.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.v2025.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) ], - form_data = {department=Engineering}, - form_definition_id = '49841cb8-00a5-4fbd-9888-8bbb28d48331', - form_elements = [ - sailpoint.v2025.models.form_element.FormElement( - id = '00000000-0000-0000-0000-000000000000', - element_type = 'TEXT', - key = 'department', - validations = [ - sailpoint.v2025.models.form_element_validations_set.FormElementValidationsSet( - validation_type = 'REQUIRED', ) - ], ) + value = Engineering, ) + ], +form_conditions=[ + sailpoint.v2025.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.v2025.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) ], - form_errors = [ - sailpoint.v2025.models.form_error.FormError( - key = 'department', - messages = [ - sailpoint.v2025.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( - locale = 'en-US', - locale_origin = 'DEFAULT', - text = 'This is an error', ) - ], - value = Engineering, ) - ], - form_input = {input1=Sales}, - id = '06a2d961-07fa-44d1-8d0a-2f6470e30fd2', - modified = '2023-07-12T20:14:57.744860Z', - recipients = [ - sailpoint.v2025.models.form_instance_recipient.FormInstanceRecipient( - id = '00000000-0000-0000-0000-000000000000', - type = 'IDENTITY', ) - ], - stand_alone_form = False, - stand_alone_form_url = 'https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', - state = 'ASSIGNED', ) + effects = [ + sailpoint.v2025.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2025.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], +created='2023-07-12T20:14:57.744860Z', +modified='2023-07-12T20:14:57.744860Z', +recipients=[ + sailpoint.v2025.models.form_instance_recipient.FormInstanceRecipient( + id = '00000000-0000-0000-0000-000000000000', + type = 'IDENTITY', ) ] ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V2025/Models/ManagedCluster.md index 381f177d7..a6fe49a52 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ManagedCluster.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ManagedCluster.md @@ -29,13 +29,14 @@ Name | Type | Description | Notes **redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] **client_type** | [**ManagedClientType**](managed-client-type) | | [required] **ccg_version** | **str** | CCG version used by the ManagedCluster | [required] -**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False] +**pinned_config** | **bool** | boolean flag indicating whether or not the cluster configuration is pinned | [optional] [default to False] **log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional] **operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False] **status** | **Enum** [ 'CONFIGURING', 'FAILED', 'NO_CLIENTS', 'NORMAL', 'WARNING' ] | Cluster status | [optional] **public_key_certificate** | **str** | Public key certificate | [optional] **public_key_thumbprint** | **str** | Public key thumbprint | [optional] **public_key** | **str** | Public key | [optional] +**encryption_configuration** | [**ManagedClusterEncryptionConfig**](managed-cluster-encryption-config) | | [optional] **alert_key** | **str** | Key describing any immediate cluster alerts | [optional] **client_ids** | **[]str** | List of clients in a cluster | [optional] **service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0] @@ -83,6 +84,8 @@ status='NORMAL', public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----', public_key_thumbprint='obc6pLiulGbtZ', public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----', +encryption_configuration=sailpoint.v2025.models.managed_cluster_encryption_configuration.Managed Cluster Encryption Configuration( + format = 'V3', ), alert_key='LIMITED_RESOURCES', client_ids=[1244, 1245], service_count=6, diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ManagedClusterEncryptionConfig.md b/docs/tools/sdk/python/Reference/V2025/Models/ManagedClusterEncryptionConfig.md new file mode 100644 index 000000000..eed10ad8e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/ManagedClusterEncryptionConfig.md @@ -0,0 +1,34 @@ +--- +id: v2025-managed-cluster-encryption-config +title: ManagedClusterEncryptionConfig +pagination_label: ManagedClusterEncryptionConfig +sidebar_label: ManagedClusterEncryptionConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterEncryptionConfig', 'V2025ManagedClusterEncryptionConfig'] +slug: /tools/sdk/python/v2025/models/managed-cluster-encryption-config +tags: ['SDK', 'Software Development Kit', 'ManagedClusterEncryptionConfig', 'V2025ManagedClusterEncryptionConfig'] +--- + +# ManagedClusterEncryptionConfig + +Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | **Enum** [ 'V2', 'V3' ] | Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.managed_cluster_encryption_config import ManagedClusterEncryptionConfig + +managed_cluster_encryption_config = ManagedClusterEncryptionConfig( +format='V3' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md index 64ad329a7..0dbf2a906 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md @@ -281,7 +281,7 @@ Path | identity_profile_id | **str** | True | Identity profile 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. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** ### Return type [**List[LifecycleState]**](../models/lifecycle-state) @@ -315,7 +315,7 @@ with ApiClient(configuration) as api_client: 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) try: # Lists lifecyclestates diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md index 5e6f7d72f..7951c4d16 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md @@ -83,12 +83,10 @@ with ApiClient(configuration) as api_client: "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | @@ -118,7 +116,7 @@ This API initiates a SOD policy verification asynchronously. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Body | identity_with_new_access1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + Body | identity_with_new_access | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | ### Return type [**SodViolationCheck**](../models/sod-violation-check) @@ -143,21 +141,30 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.sod_violations_api import SODViolationsApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 +from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v3.models.sod_violation_check import SodViolationCheck from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2" + } ] + }''' # IdentityWithNewAccess | try: # Check sod violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access=new_identity_with_new_access) # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access) print("The response of SODViolationsApi->start_violation_check:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md deleted file mode 100644 index d62f42c2d..000000000 --- a/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: entitlement-ref1 -title: EntitlementRef1 -pagination_label: EntitlementRef1 -sidebar_label: EntitlementRef1 -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'EntitlementRef1', 'EntitlementRef1'] -slug: /tools/sdk/python/v3/models/entitlement-ref1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'EntitlementRef1'] ---- - -# EntitlementRef1 - -Entitlement including a specific set of access. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] -**id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] -} - -## Example - -```python -from sailpoint.v3.models.entitlement_ref1 import EntitlementRef1 - -entitlement_ref1 = EntitlementRef1( -type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md index 347db8402..f9d13c450 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess.md @@ -28,7 +28,7 @@ from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess identity_with_new_access = IdentityWithNewAccess( identity_id='2c91808568c529c60168cca6f90c1313', -access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +access_refs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}] ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md deleted file mode 100644 index 57bdcb125..000000000 --- a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: identity-with-new-access1 -title: IdentityWithNewAccess1 -pagination_label: IdentityWithNewAccess1 -sidebar_label: IdentityWithNewAccess1 -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] -slug: /tools/sdk/python/v3/models/identity-with-new-access1 -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] ---- - -# IdentityWithNewAccess1 - -An identity with a set of access to be added - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**identity_id** | **str** | Set of identity IDs to be checked. | [required] -**access_refs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] -**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] -} - -## Example - -```python -from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 - -identity_with_new_access1 = IdentityWithNewAccess1( -identity_id='2c91809050db617d0150e0bf3215385e', -access_refs=[ - null - ], -client_metadata={clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md index cf46edec2..4a21516dd 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md @@ -19,7 +19,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] **id** | **str** | Entitlement's ID. | [optional] -**name** | **str** | Entitlement's display name. | [optional] } ## Example @@ -29,8 +28,7 @@ from sailpoint.v3.models.identity_with_new_access_access_refs_inner import Ident identity_with_new_access_access_refs_inner = IdentityWithNewAccessAccessRefsInner( type='ENTITLEMENT', -id='2c91809773dee32014e13e122092014e', -name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +id='2c91809773dee32014e13e122092014e' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md index 90859f17b..5c511b6d3 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedCluster.md @@ -29,13 +29,14 @@ Name | Type | Description | Notes **redis** | [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] **client_type** | [**ManagedClientType**](managed-client-type) | | [required] **ccg_version** | **str** | CCG version used by the ManagedCluster | [required] -**pinned_config** | **bool** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to False] +**pinned_config** | **bool** | boolean flag indicating whether or not the cluster configuration is pinned | [optional] [default to False] **log_configuration** | [**ClientLogConfiguration**](client-log-configuration) | | [optional] **operational** | **bool** | Whether or not the cluster is operational or not | [optional] [default to False] **status** | **Enum** [ 'CONFIGURING', 'FAILED', 'NO_CLIENTS', 'NORMAL', 'WARNING' ] | Cluster status | [optional] **public_key_certificate** | **str** | Public key certificate | [optional] **public_key_thumbprint** | **str** | Public key thumbprint | [optional] **public_key** | **str** | Public key | [optional] +**encryption_configuration** | [**ManagedClusterEncryptionConfig**](managed-cluster-encryption-config) | | [optional] **alert_key** | **str** | Key describing any immediate cluster alerts | [optional] **client_ids** | **[]str** | List of clients in a cluster | [optional] **service_count** | **int** | Number of services bound to a cluster | [optional] [default to 0] @@ -83,6 +84,8 @@ status='NORMAL', public_key_certificate='-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----', public_key_thumbprint='obc6pLiulGbtZ', public_key='-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----', +encryption_configuration=sailpoint.v3.models.managed_cluster_encryption_configuration.Managed Cluster Encryption Configuration( + format = 'V3', ), alert_key='LIMITED_RESOURCES', client_ids=[1244, 1245], service_count=6, diff --git a/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterEncryptionConfig.md b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterEncryptionConfig.md new file mode 100644 index 000000000..d782046c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ManagedClusterEncryptionConfig.md @@ -0,0 +1,34 @@ +--- +id: managed-cluster-encryption-config +title: ManagedClusterEncryptionConfig +pagination_label: ManagedClusterEncryptionConfig +sidebar_label: ManagedClusterEncryptionConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterEncryptionConfig', 'ManagedClusterEncryptionConfig'] +slug: /tools/sdk/python/v3/models/managed-cluster-encryption-config +tags: ['SDK', 'Software Development Kit', 'ManagedClusterEncryptionConfig', 'ManagedClusterEncryptionConfig'] +--- + +# ManagedClusterEncryptionConfig + +Defines the encryption settings for a managed cluster, including the format used for storing and processing encrypted data. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | **Enum** [ 'V2', 'V3' ] | Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.managed_cluster_encryption_config import ManagedClusterEncryptionConfig + +managed_cluster_encryption_config = ManagedClusterEncryptionConfig( +format='V3' +) + +``` +[[Back to top]](#) + diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 7e5459119..4285c9c29 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -12487,12 +12487,10 @@ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | try: diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index fe6c33f64..8fe3120a8 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -10653,7 +10653,7 @@ 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) try: # Lists lifecyclestates @@ -16602,12 +16602,10 @@ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | try: @@ -16628,20 +16626,29 @@ source: | from sailpoint.v2024.api.sod_violations_api import SODViolationsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v2024.models.sod_violation_check import SodViolationCheck from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2" + } ] + }''' # IdentityWithNewAccess | try: # Check sod violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access=new_identity_with_new_access) # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access) print("The response of SODViolationsApi->start_violation_check:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 832bc375e..fd6eddf5d 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -11330,7 +11330,7 @@ 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) try: # Lists lifecyclestates @@ -17509,12 +17509,10 @@ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | try: @@ -17535,20 +17533,29 @@ source: | from sailpoint.v2025.api.sod_violations_api import SODViolationsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v2025.models.sod_violation_check import SodViolationCheck from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2" + } ] + }''' # IdentityWithNewAccess | try: # Check sod violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access=new_identity_with_new_access) # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access) print("The response of SODViolationsApi->start_violation_check:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index de4604930..42fd8681d 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -4142,7 +4142,7 @@ 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) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) try: # Lists lifecyclestates @@ -7822,12 +7822,10 @@ "identityId" : "2c91808568c529c60168cca6f90c1313", "accessRefs" : [ { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c050861ab1" }, { "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + "id" : "2c918087682f9a86016839c0509c1ab2" } ] }''' # IdentityWithNewAccess | try: @@ -7848,20 +7846,29 @@ source: | from sailpoint.v3.api.sod_violations_api import SODViolationsApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess from sailpoint.v3.models.sod_violation_check import SodViolationCheck from sailpoint.configuration import Configuration configuration = Configuration() with ApiClient(configuration) as api_client: - identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2" + } ] + }''' # IdentityWithNewAccess | try: # Check sod violations - new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) - results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access=new_identity_with_new_access) # Below is a request that includes all optional parameters - # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access) print("The response of SODViolationsApi->start_violation_check:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: