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

Update to powershell SDK docs: 13593177491

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-28 17:21:02 +00:00
parent 324a65a8ff
commit b87617f99f
70 changed files with 5543 additions and 4589 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2024-access-request-recommendation-config-dto
title: AccessRequestRecommendationConfigDto
pagination_label: AccessRequestRecommendationConfigDto
sidebar_label: AccessRequestRecommendationConfigDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-config-dto
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
---
# AccessRequestRecommendationConfigDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ScoreThreshold** | **Double** | The value that internal calculations need to exceed for recommendations to be made. | [required]
**StartDateAttribute** | **String** | Use to map an attribute name for determining identities' start date. | [optional]
**RestrictionAttribute** | **String** | Use to only give recommendations based on this attribute. | [optional]
**MoverAttribute** | **String** | Use to map an attribute name for determining whether identities are movers. | [optional]
**JoinerAttribute** | **String** | Use to map an attribute name for determining whether identities are joiners. | [optional]
**UseRestrictionAttribute** | **Boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$AccessRequestRecommendationConfigDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationConfigDto -ScoreThreshold 0.5 `
-StartDateAttribute startDate `
-RestrictionAttribute location `
-MoverAttribute isMover `
-JoinerAttribute isJoiner `
-UseRestrictionAttribute true
```
- Convert the resource to JSON
```powershell
$AccessRequestRecommendationConfigDto | ConvertTo-JSON
```
[[Back to top]](#)

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

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

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024Ident
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** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024Id
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

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V
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/V2024/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 $false]
**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false]
## Examples

6
docs/tools/sdk/powershell/Reference/V2024/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/V2024/Models/IdentityProfileAllOfOwner.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024Ide
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

75
docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md Normal file
View File

@@ -0,0 +1,75 @@
---
id: v2024-machine-account
title: MachineAccount
pagination_label: MachineAccount
sidebar_label: MachineAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccount', 'V2024MachineAccount']
slug: /tools/sdk/powershell/v2024/models/machine-account
tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2024MachineAccount']
---
# MachineAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
**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** | A description of the machine account | [optional]
**NativeIdentity** | **String** | The unique ID of the machine account generated by the source system | [required]
**Uuid** | **String** | The unique ID of the account as determined by the account schema | [optional]
**ClassificationMethod** | **Enum** [ "SOURCE", "CRITERIA", "DISCOVERY", "MANUAL" ] | Classification Method | [required]
**MachineIdentity** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The machine identity this account is associated with | [optional]
**OwnerIdentity** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The identity who owns this account. | [optional]
**AccessType** | **String** | The connection type of the source this account is from | [optional]
**Subtype** | **String** | The sub-type | [optional]
**Environment** | **String** | Environment | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom attributes specific to the machine account | [optional]
**ConnectorAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The connector attributes for the account | [required]
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [optional] [default to $false]
**ManuallyEdited** | **Boolean** | Indicates if the account has been manually edited | [required][default to $false]
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
**Enabled** | **Boolean** | Indicates if the account is enabled | [required][default to $false]
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required][default to $true]
**Source** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The source this machine account belongs to. | [required]
## Examples
- Prepare the resource
```powershell
$MachineAccount = Initialize-PSSailpoint.V2024MachineAccount -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-Description Service account for Active Directory `
-NativeIdentity 552775 `
-Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} `
-ClassificationMethod SOURCE `
-MachineIdentity {id=1540e5a4-6c2e-4bf1-b88e-c08cae0696e9, type=MACHINE_IDENTITY, name=SVC_ADService} `
-OwnerIdentity {id=2c918084660f45d6016617daa9210584, type=IDENTITY, name=Adam Kennedy} `
-AccessType direct `
-Subtype null `
-Environment TEST `
-Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} `
-ConnectorAttributes {mail=machine-178@sailpoint.com, givenName=Support, displayName=SailPoint Support} `
-ManuallyCorrelated true `
-ManuallyEdited true `
-Locked false `
-Enabled false `
-HasEntitlements false `
-Source {id=8d3e0094e99445de98eef6c75e25jc04, type=SOURCE, name=Active Directory}
```
- Convert the resource to JSON
```powershell
$MachineAccount | ConvertTo-JSON
```
[[Back to top]](#)

49
docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md Normal file
View File

@@ -0,0 +1,49 @@
---
id: v2024-machine-identity
title: MachineIdentity
pagination_label: MachineIdentity
sidebar_label: MachineIdentity
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentity', 'V2024MachineIdentity']
slug: /tools/sdk/powershell/v2024/models/machine-identity
tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2024MachineIdentity']
---
# MachineIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
**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]
**BusinessApplication** | **String** | The business application that the identity represents | [required]
**Description** | **String** | Description of machine identity | [optional]
**ManuallyEdited** | **Boolean** | Indicates if the machine identity has been manually edited | [optional] [default to $false]
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map of custom machine identity attributes | [optional]
## Examples
- Prepare the resource
```powershell
$MachineIdentity = Initialize-PSSailpoint.V2024MachineIdentity -Id id12345 `
-Name aName `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-BusinessApplication ADService `
-Description `
-ManuallyEdited true `
-Attributes {"Region":"EU"}
```
- Convert the resource to JSON
```powershell
$MachineIdentity | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee
-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/V2024/Models/NonEmployeeSourceWithNECount.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-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/V2024/Models/SourceUsage.md
View File

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

2
docs/tools/sdk/powershell/Reference/V2024/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.V2024SpConfigObject -ObjectType TRIGGER_SUBSCRIPTION `
-ReferenceExtractors [$.owner] `
-SignatureRequired false `
-AlwaysResolveById true `
-LegacyObject false `
-OnePerTenant false `
-Exportable true `

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

@@ -17,8 +17,8 @@ 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]
**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.V2024SpConfigRule -Path $.enabled `
-Value null `
-Mode [RESTORE, PROMOTE]
-Modes [RESTORE, PROMOTE]
```
- Convert the resource to JSON

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

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

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024Transform
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/V2024/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