From aefe42f09768170c31df73e4fcf9df4d77afa36f Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Mon, 31 Mar 2025 21:09:07 +0000 Subject: [PATCH] Update to powershell SDK docs: 14181503118 --- .../Reference/Beta/Methods/BetaSPConfigApi.md | 6 +++--- .../Reference/Beta/Models/SpConfigObject.md | 14 +++++++------- .../Reference/Beta/Models/SpConfigRule.md | 4 ++-- .../Reference/Beta/Models/SpConfigRules.md | 2 +- .../Reference/V2024/Methods/V2024SPConfigApi.md | 6 +++--- .../Reference/V2024/Models/SpConfigObject.md | 14 +++++++------- .../Reference/V2024/Models/SpConfigRule.md | 4 ++-- .../Reference/V2024/Models/SpConfigRules.md | 2 +- .../beta/powershell_code_examples_overlay.yaml | 2 +- .../v2024/powershell_code_examples_overlay.yaml | 2 +- 10 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md index 002fd60c0..0a407aa12 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md @@ -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-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 -[**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 @@ -328,7 +328,7 @@ try { [[Back to top]](#) ## 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) @@ -357,7 +357,7 @@ Code | Description | Data Type ### Example ```powershell -# Get config object details +# List Config Objects try { Get-BetaSpConfigObjects diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md index d0dfc3176..a029d2a9e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md @@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'BetaSpConfigObject' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ObjectType** | **String** | The object type this 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] -**SignatureRequired** | **Boolean** | If true, 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] -**LegacyObject** | **Boolean** | 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] -**Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] +**ObjectType** | **String** | Object type the configuration is for. | [optional] +**ReferenceExtractors** | **[]String** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**SignatureRequired** | **Boolean** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] +**AlwaysResolveById** | **Boolean** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to $false] +**LegacyObject** | **Boolean** | Indicates whether this is a legacy object. | [optional] [default to $false] +**OnePerTenant** | **Boolean** | Indicates whether there is only one object of this type. | [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] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md index 61e9a1113..c7da2a9b9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] 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] -**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] +**Modes** | **[]String** | Draft modes the rule will apply to. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRules.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRules.md index 6db35c04b..565610818 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRules.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRules.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TakeFromTargetRules** | [**[]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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md index f3174428f..bd69a92d8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md @@ -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-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 -[**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 @@ -331,7 +331,7 @@ try { [[Back to top]](#) ## 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) @@ -360,7 +360,7 @@ Code | Description | Data Type ### Example ```powershell -# Get config object details +# List Config Objects try { Get-V2024SpConfigObjects diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md index 207e294e5..496c1068e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md @@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2024SpConfigObject Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ObjectType** | **String** | The object type this 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] -**SignatureRequired** | **Boolean** | If true, 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] -**LegacyObject** | **Boolean** | 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] -**Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] +**ObjectType** | **String** | Object type the configuration is for. | [optional] +**ReferenceExtractors** | **[]String** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [optional] +**SignatureRequired** | **Boolean** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] +**AlwaysResolveById** | **Boolean** | Indicates whether this object type must be always be resolved by ID. | [optional] [default to $false] +**LegacyObject** | **Boolean** | Indicates whether this is a legacy object. | [optional] [default to $false] +**OnePerTenant** | **Boolean** | Indicates whether there is only one object of this type. | [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] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md index 67141faf2..ce5598e2d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] 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] -**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] +**Modes** | **[]String** | Draft modes the rule will apply to. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRules.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRules.md index 85d676f9a..895152d7c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRules.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRules.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **TakeFromTargetRules** | [**[]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 diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 2b0b87122..407d57ebf 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -10662,7 +10662,7 @@ label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects source: | - # Get config object details + # List Config Objects try { Get-BetaSpConfigObjects diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 2b9f2a816..833f00fcd 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -13338,7 +13338,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects source: | - # Get config object details + # List Config Objects try { Get-V2024SpConfigObjects