LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 14181508242

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-31 21:09:30 +00:00
parent aefe42f097
commit 732d59b82d
12 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md
View File

@@ -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

16
docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md
View File

@@ -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]
}

6
docs/tools/sdk/python/Reference/Beta/Models/SpConfigRule.md
View File

@@ -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

2
docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md
View File

@@ -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

4
docs/tools/sdk/python/Reference/Beta/Models/SpConfigRules.md
View File

@@ -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

8
docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md
View File

@@ -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

16
docs/tools/sdk/python/Reference/V2024/Models/SpConfigObject.md
View File

@@ -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]
}

6
docs/tools/sdk/python/Reference/V2024/Models/SpConfigRule.md
View File

@@ -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

2
docs/tools/sdk/python/Reference/V2024/Models/SpConfigRuleValue.md
View File

@@ -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

4
docs/tools/sdk/python/Reference/V2024/Models/SpConfigRules.md
View File

@@ -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