diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md index a65912635..43af2995d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**get-sp-config-import**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result [**get-sp-config-import-status**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status [**import-sp-config**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job -[**list-sp-config-objects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details +[**list-sp-config-objects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects ## export-sp-config @@ -405,8 +405,8 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## list-sp-config-objects -Get config object details -This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. +List Config Objects +Get a list of object configurations that the tenant export/import service knows. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects) @@ -444,7 +444,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: try: - # Get config object details + # List Config Objects results = SPConfigApi(api_client).list_sp_config_objects() # Below is a request that includes all optional parameters diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md index fdc795f85..87da05e70 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md @@ -11,19 +11,19 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'BetaSpConfigObject' # SpConfigObject -Response model for get object configuration. +Response model for object configuration. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**object_type** | **str** | The object type this configuration is for. | [optional] -**reference_extractors** | **[]str** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] -**signature_required** | **bool** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False] -**always_resolve_by_id** | **bool** | Whether this object type has to be resolved always by ID | [optional] [default to False] -**legacy_object** | **bool** | Whether this is a legacy object | [optional] [default to False] -**one_per_tenant** | **bool** | Whether there is only one object of this type | [optional] [default to False] -**exportable** | **bool** | Whether this object can be exported or it is just a reference object | [optional] [default to False] +**object_type** | **str** | Object type the configuration is for. | [optional] +**reference_extractors** | **[]str** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**signature_required** | **bool** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False] +**always_resolve_by_id** | **bool** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to False] +**legacy_object** | **bool** | Indicates whether this is a legacy object. | [optional] [default to False] +**one_per_tenant** | **bool** | Indicates whether there is only one object of this type. | [optional] [default to False] +**exportable** | **bool** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to False] **rules** | [**SpConfigRules**](sp-config-rules) | | [optional] } diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md index ac57569b0..aa2a75e70 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] # SpConfigRule -Format of Config Hub Object Rules +Format of Config Hub object rules. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] +**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional] **value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] -**modes** | **[]str** | Draft modes to which this rule will apply | [optional] +**modes** | **[]str** | Draft modes the rule will apply to. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md index 0700333f6..49edca554 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRule # SpConfigRuleValue -Value to be assigned at the jsonPath location within the object +Value to be assigned at the jsonPath location within the object. ## Properties diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md index 108de6f7f..8bcc9b44d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'BetaSpConfigRules'] # SpConfigRules -Rules to be applied to the config object during draft process +Rules to be applied to the config object during the draft process. ## Properties @@ -19,7 +19,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **take_from_target_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] **default_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] -**editable** | **bool** | Whether this object can be edited | [optional] [default to False] +**editable** | **bool** | Indicates whether the object can be edited. | [optional] [default to False] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md index 039ce6698..14b9af250 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**get-sp-config-import**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result [**get-sp-config-import-status**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status [**import-sp-config**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job -[**list-sp-config-objects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details +[**list-sp-config-objects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects ## export-sp-config @@ -408,8 +408,8 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## list-sp-config-objects -Get config object details -This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. +List Config Objects +Get a list of object configurations that the tenant export/import service knows. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects) @@ -447,7 +447,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: try: - # Get config object details + # List Config Objects results = SPConfigApi(api_client).list_sp_config_objects() # Below is a request that includes all optional parameters diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md index 6e92048a6..226657ba5 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md @@ -11,19 +11,19 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2024SpConfigObject # SpConfigObject -Response model for get object configuration. +Response model for object configuration. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**object_type** | **str** | The object type this configuration is for. | [optional] -**reference_extractors** | **[]str** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] -**signature_required** | **bool** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False] -**always_resolve_by_id** | **bool** | Whether this object type has to be resolved always by ID | [optional] [default to False] -**legacy_object** | **bool** | Whether this is a legacy object | [optional] [default to False] -**one_per_tenant** | **bool** | Whether there is only one object of this type | [optional] [default to False] -**exportable** | **bool** | Whether this object can be exported or it is just a reference object | [optional] [default to False] +**object_type** | **str** | Object type the configuration is for. | [optional] +**reference_extractors** | **[]str** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**signature_required** | **bool** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False] +**always_resolve_by_id** | **bool** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to False] +**legacy_object** | **bool** | Indicates whether this is a legacy object. | [optional] [default to False] +**one_per_tenant** | **bool** | Indicates whether there is only one object of this type. | [optional] [default to False] +**exportable** | **bool** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to False] **rules** | [**SpConfigRules**](sp-config-rules) | | [optional] } diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md index fb804cd6b..6d75d1a44 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] # SpConfigRule -Format of Config Hub Object Rules +Format of Config Hub object rules. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] +**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional] **value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] -**modes** | **[]str** | Draft modes to which this rule will apply | [optional] +**modes** | **[]str** | Draft modes the rule will apply to. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md index 652a35912..d7e4203a1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'V2024SpConfigRul # SpConfigRuleValue -Value to be assigned at the jsonPath location within the object +Value to be assigned at the jsonPath location within the object. ## Properties diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md index 2555fdee0..f0ac6620d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'V2024SpConfigRules'] # SpConfigRules -Rules to be applied to the config object during draft process +Rules to be applied to the config object during the draft process. ## Properties @@ -19,7 +19,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **take_from_target_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] **default_rules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] -**editable** | **bool** | Whether this object can be edited | [optional] [default to False] +**editable** | **bool** | Indicates whether the object can be edited. | [optional] [default to False] } ## Example diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index 8e567829e..bab9690f6 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -12494,7 +12494,7 @@ with ApiClient(configuration) as api_client: try: - # Get config object details + # List Config Objects results = SPConfigApi(api_client).list_sp_config_objects() # Below is a request that includes all optional parameters diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 9af3eaf92..359e84ddb 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -15841,7 +15841,7 @@ with ApiClient(configuration) as api_client: try: - # Get config object details + # List Config Objects results = SPConfigApi(api_client).list_sp_config_objects() # Below is a request that includes all optional parameters