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: 13658483765

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-04 16:37:37 +00:00
parent 7bdfe448a8
commit e0b9b0dbe0
70 changed files with 5543 additions and 4589 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10
```

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Enabled** | **Boolean** | If the profile or mapping is enabled | [optional] [default to $true]
**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $true]
**AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdent
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false]
**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false]
**AttributeTransforms** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityAttributeName** | **String** | Name of the identity attribute | [optional]
**IdentityAttributeName** | **String** | Identity attribute's name. | [optional]
**TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional]
**IdentityAttributeName** | **String** | Identity attribute's name. | [optional]
**TransformDefinition** | [**TransformDefinition1**](transform-definition1) | | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TaskResultId** | **String** | The id of the task result | [optional]
**ReportName** | **String** | The name of the report | [optional]
**TaskResultId** | **String** | Task result ID. | [optional]
**ReportName** | **String** | Report name. | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', '
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TaskResultId** | **String** | The id of the task result. | [optional]
**ReportName** | **String** | The name of the report. | [optional]
**TaskResultId** | **String** | Task result ID. | [optional]
**ReportName** | **String** | Report name. | [optional]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md
View File

@@ -20,15 +20,15 @@ Name | Type | Description | Notes
**Name** | **String** | Name of the Object | [required]
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
**Description** | **String** | The description of the Identity Profile. | [optional]
**Description** | **String** | Identity profile's description. | [optional]
**Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
**Priority** | **Int64** | The priority for an Identity Profile. | [optional]
**Priority** | **Int64** | Identity profile's priority. | [optional]
**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required]
**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false]
**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional]
**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false]
**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional]
**IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional]
**IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional]
**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true]
**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $true]
## Examples

10
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md
View File

@@ -20,15 +20,15 @@ Name | Type | Description | Notes
**Name** | **String** | Name of the Object | [required]
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
**Description** | **String** | The description of the Identity Profile. | [optional]
**Description** | **String** | Identity profile's description. | [optional]
**Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
**Priority** | **Int64** | The priority for an Identity Profile. | [optional]
**Priority** | **Int64** | Identity profile's priority. | [optional]
**AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required]
**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false]
**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional]
**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false]
**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional]
**IdentityAttributeConfig** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional]
**IdentityExceptionReportReference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional]
**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false]
**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false]
## Examples

6
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional]
**Id** | **String** | ID of the object to which this reference applies | [optional]
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional]
**Id** | **String** | Authoritative source's ID. | [optional]
**Name** | **String** | Authoritative source's name. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional]
**Id** | **String** | ID of the object to which this reference applies | [optional]
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional]
**Id** | **String** | Authoritative source's ID. | [optional]
**Name** | **String** | Authoritative source's name. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional]
**Id** | **String** | ID of the object to which this reference applies | [optional]
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional]
**Id** | **String** | Owner's ID. | [optional]
**Name** | **String** | Owner's name. | [optional]
## Examples

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

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR
-ApprovalStatus null `
-Comment approved `
-CompletionDate 2020-03-24T11:11:41.139-05:00 `
-StartDate Mon Mar 23 20:00:00 EDT 2020 `
-EndDate Wed Mar 24 20:00:00 EDT 2021 `
-StartDate Tue Mar 24 00:00:00 UTC 2020 `
-EndDate Thu Mar 25 00:00:00 UTC 2021 `
-Modified 2020-03-24T11:11:41.139-05:00 `
-Created 2020-03-24T11:11:41.139-05:00
```

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

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**AccountManagers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional]
**Modified** | **System.DateTime** | When the request was last modified. | [optional]
**Created** | **System.DateTime** | When the request was created. | [optional]
**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional]
**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional]
## Examples

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

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 `
$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 `
-Count 10.45
```

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

@@ -19,6 +19,7 @@ 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]
@@ -31,6 +32,7 @@ Name | Type | Description | Notes
$SpConfigObject = Initialize-PSSailpoint.BetaSpConfigObject -ObjectType TRIGGER_SUBSCRIPTION `
-ReferenceExtractors [$.owner] `
-SignatureRequired false `
-AlwaysResolveById true `
-LegacyObject false `
-OnePerTenant false `
-Exportable true `

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

@@ -17,8 +17,8 @@ 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]
**Value** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional]
**Mode** | **[]String** | Draft modes to which this rule will apply | [optional]
**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional]
**Modes** | **[]String** | Draft modes to which this rule will apply | [optional]
## Examples
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
```powershell
$SpConfigRule = Initialize-PSSailpoint.BetaSpConfigRule -Path $.enabled `
-Value null `
-Mode [RESTORE, PROMOTE]
-Modes [RESTORE, PROMOTE]
```
- Convert the resource to JSON

34
docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: beta-sp-config-rule-value
title: SpConfigRuleValue
pagination_label: SpConfigRuleValue
sidebar_label: SpConfigRuleValue
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
slug: /tools/sdk/powershell/beta/models/sp-config-rule-value
tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
---
# SpConfigRuleValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
## Examples
- Prepare the resource
```powershell
$SpConfigRuleValue = Initialize-PSSailpoint.BetaSpConfigRuleValue
```
- Convert the resource to JSON
```powershell
$SpConfigRuleValue | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **String** | The type of the transform definition. | [optional]
**Type** | **String** | Transform definition type. | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **String** | The type of the transform definition. | [optional]
**Type** | **String** | Transform definition type. | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional]
## Examples

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

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional]
**StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional]
**CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional]
**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional]
**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional]
## Examples