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

Update to powershell SDK docs: 14181503118

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-31 21:09:07 +00:00
parent 3d1257a42c
commit aefe42f097
10 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md
View File

@@ -23,7 +23,7 @@ Method | HTTP request | Description
[**Get-BetaSpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result [**Get-BetaSpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result
[**Get-BetaSpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status [**Get-BetaSpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status
[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job [**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details [**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects
## export-sp-config ## export-sp-config
@@ -328,7 +328,7 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-sp-config-objects ## list-sp-config-objects
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. 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) [API Spec](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects)
@@ -357,7 +357,7 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
# Get config object details # List Config Objects
try { try {
Get-BetaSpConfigObjects Get-BetaSpConfigObjects

14
docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md
View File

@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'BetaSpConfigObject'
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**ObjectType** | **String** | The object type this configuration is for. | [optional] **ObjectType** | **String** | Object type the configuration is for. | [optional]
**ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] **ReferenceExtractors** | **[]String** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional]
**SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] **SignatureRequired** | **Boolean** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false]
**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false] **AlwaysResolveById** | **Boolean** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to $false]
**LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false] **LegacyObject** | **Boolean** | Indicates whether this is a legacy object. | [optional] [default to $false]
**OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false] **OnePerTenant** | **Boolean** | Indicates whether there is only one object of this type. | [optional] [default to $false]
**Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] **Exportable** | **Boolean** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to $false]
**Rules** | [**SpConfigRules**](sp-config-rules) | | [optional] **Rules** | [**SpConfigRules**](sp-config-rules) | | [optional]
## Examples ## Examples

4
docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule']
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] **Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional]
**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] **Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional]
**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] **Modes** | **[]String** | Draft modes the rule will apply to. | [optional]
## Examples ## Examples

2
docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRules.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**TakeFromTargetRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] **TakeFromTargetRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional]
**DefaultRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] **DefaultRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional]
**Editable** | **Boolean** | Whether this object can be edited | [optional] [default to $false] **Editable** | **Boolean** | Indicates whether the object can be edited. | [optional] [default to $false]
## Examples ## Examples

6
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md
View File

@@ -23,7 +23,7 @@ Method | HTTP request | Description
[**Get-V2024SpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result [**Get-V2024SpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result
[**Get-V2024SpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status [**Get-V2024SpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status
[**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job [**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details [**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects
## export-sp-config ## export-sp-config
@@ -331,7 +331,7 @@ try {
[[Back to top]](#) [[Back to top]](#)
## list-sp-config-objects ## list-sp-config-objects
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. 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) [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects)
@@ -360,7 +360,7 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
# Get config object details # List Config Objects
try { try {
Get-V2024SpConfigObjects Get-V2024SpConfigObjects

14
docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md
View File

@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2024SpConfigObject
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**ObjectType** | **String** | The object type this configuration is for. | [optional] **ObjectType** | **String** | Object type the configuration is for. | [optional]
**ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] **ReferenceExtractors** | **[]String** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional]
**SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] **SignatureRequired** | **Boolean** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false]
**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false] **AlwaysResolveById** | **Boolean** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to $false]
**LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false] **LegacyObject** | **Boolean** | Indicates whether this is a legacy object. | [optional] [default to $false]
**OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false] **OnePerTenant** | **Boolean** | Indicates whether there is only one object of this type. | [optional] [default to $false]
**Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] **Exportable** | **Boolean** | Indicates whether the object can be exported or is just a reference object. | [optional] [default to $false]
**Rules** | [**SpConfigRules**](sp-config-rules) | | [optional] **Rules** | [**SpConfigRules**](sp-config-rules) | | [optional]
## Examples ## Examples

4
docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule']
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] **Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [optional]
**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] **Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional]
**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] **Modes** | **[]String** | Draft modes the rule will apply to. | [optional]
## Examples ## Examples

2
docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRules.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**TakeFromTargetRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] **TakeFromTargetRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional]
**DefaultRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional] **DefaultRules** | [**[]SpConfigRule**](sp-config-rule) | | [optional]
**Editable** | **Boolean** | Whether this object can be edited | [optional] [default to $false] **Editable** | **Boolean** | Indicates whether the object can be edited. | [optional] [default to $false]
## Examples ## Examples

2
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

@@ -10662,7 +10662,7 @@
label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects
source: | source: |
# Get config object details # List Config Objects
try { try {
Get-BetaSpConfigObjects Get-BetaSpConfigObjects

2
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -13338,7 +13338,7 @@
label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects
source: | source: |
# Get config object details # List Config Objects
try { try {
Get-V2024SpConfigObjects Get-V2024SpConfigObjects