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

Update PowerShell SDK docs: 16967723041

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-14 14:16:43 +00:00
parent 207021796c
commit d505994712
35 changed files with 2770 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/tools/sdk/powershell/Reference/V2024/Models/GetLaunchers200Response.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-get-launchers200-response
title: GetLaunchers200Response
pagination_label: GetLaunchers200Response
sidebar_label: GetLaunchers200Response
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'GetLaunchers200Response', 'V2024GetLaunchers200Response']
slug: /tools/sdk/powershell/v2024/models/get-launchers200-response
tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'V2024GetLaunchers200Response']
---
# GetLaunchers200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Next** | **String** | Pagination marker | [optional]
**Items** | [**[]Launcher**](launcher) | | [optional]
## Examples
- Prepare the resource
```powershell
$GetLaunchers200Response = Initialize-V2024GetLaunchers200Response -Next null `
-Items null
```
- Convert the resource to JSON
```powershell
$GetLaunchers200Response | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/IdentityEntitlementDetails.md Normal file
View File

@@ -0,0 +1,41 @@
---
id: v2024-identity-entitlement-details
title: IdentityEntitlementDetails
pagination_label: IdentityEntitlementDetails
sidebar_label: IdentityEntitlementDetails
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetails', 'V2024IdentityEntitlementDetails']
slug: /tools/sdk/powershell/v2024/models/identity-entitlement-details
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2024IdentityEntitlementDetails']
---
# IdentityEntitlementDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityId** | **String** | Id of Identity | [optional]
**Entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional]
**SourceId** | **String** | Id of Source | [optional]
**AccountTargets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional]
## Examples
- Prepare the resource
```powershell
$IdentityEntitlementDetails = Initialize-V2024IdentityEntitlementDetails -IdentityId 5928c61f-3f2e-417a-8d65-f76451e2050a `
-Entitlement null `
-SourceId b56728da-a24d-4177-a207-2bc4d42cba27 `
-AccountTargets [{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}]
```
- Convert the resource to JSON
```powershell
$IdentityEntitlementDetails | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,49 @@
---
id: v2024-identity-entitlement-details-account-target
title: IdentityEntitlementDetailsAccountTarget
pagination_label: IdentityEntitlementDetailsAccountTarget
sidebar_label: IdentityEntitlementDetailsAccountTarget
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2024IdentityEntitlementDetailsAccountTarget']
slug: /tools/sdk/powershell/v2024/models/identity-entitlement-details-account-target
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2024IdentityEntitlementDetailsAccountTarget']
---
# IdentityEntitlementDetailsAccountTarget
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **String** | The id of account | [optional]
**AccountName** | **String** | The name of account | [optional]
**AccountUUID** | **String** | The UUID representation of the account if available | [optional]
**SourceId** | **String** | The id of Source | [optional]
**SourceName** | **String** | The name of Source | [optional]
**RemoveDate** | **String** | The removal date scheduled for the entitlement on the Identity | [optional]
**AssignmentId** | **String** | The assignmentId of the entitlement on the Identity | [optional]
**Revocable** | **Boolean** | If the entitlement can be revoked | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$IdentityEntitlementDetailsAccountTarget = Initialize-V2024IdentityEntitlementDetailsAccountTarget -AccountId c5ef070e-92c6-4276-a006-98490f132dec `
-AccountName Adalberto.XYZ `
-AccountUUID 2236c29e-68a6-494d-a469-d072172f46cf `
-SourceId 9269d764-8358-4ab9-9748-d4b7418548ca `
-SourceName JDBC XYZ Source `
-RemoveDate 2035-01-01T12:00:00.000Z `
-AssignmentId 77a5b7b4-262f-4b6a-a2aa-87f84f45f96f `
-Revocable true
```
- Convert the resource to JSON
```powershell
$IdentityEntitlementDetailsAccountTarget | ConvertTo-JSON
```
[[Back to top]](#)

55
docs/tools/sdk/powershell/Reference/V2024/Models/IdentityEntitlementDetailsEntitlementDto.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: v2024-identity-entitlement-details-entitlement-dto
title: IdentityEntitlementDetailsEntitlementDto
pagination_label: IdentityEntitlementDetailsEntitlementDto
sidebar_label: IdentityEntitlementDetailsEntitlementDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2024IdentityEntitlementDetailsEntitlementDto']
slug: /tools/sdk/powershell/v2024/models/identity-entitlement-details-entitlement-dto
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2024IdentityEntitlementDetailsEntitlementDto']
---
# IdentityEntitlementDetailsEntitlementDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The entitlement id | [optional]
**Name** | **String** | The entitlement name | [optional]
**Created** | **System.DateTime** | Time when the entitlement was last modified | [optional]
**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional]
**Description** | **String** | The description of the entitlement | [optional]
**Type** | **String** | The type of the object, will always be ""ENTITLEMENT"" | [optional]
**SourceId** | **String** | The source ID | [optional]
**SourceName** | **String** | The source name | [optional]
**Owner** | [**OwnerDto**](owner-dto) | | [optional]
**Value** | **String** | The value of the entitlement | [optional]
**Flags** | **[]String** | a list of properties informing the viewer about the entitlement | [optional]
## Examples
- Prepare the resource
```powershell
$IdentityEntitlementDetailsEntitlementDto = Initialize-V2024IdentityEntitlementDetailsEntitlementDto -Id 2c91808874ff91550175097daaec161c `
-Name LauncherTest2 `
-Created 2020-10-08T18:33:52.029Z `
-Modified 2020-10-08T18:33:52.029Z `
-Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
-Type ENTITLEMENT `
-SourceId 2c9180827ca885d7017ca8ce28a000eb `
-SourceName ODS-AD-Source `
-Owner null `
-Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
-Flags [privileged]
```
- Convert the resource to JSON
```powershell
$IdentityEntitlementDetailsEntitlementDto | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/IdentityEntitlements.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-identity-entitlements
title: IdentityEntitlements
pagination_label: IdentityEntitlements
sidebar_label: IdentityEntitlements
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlements', 'V2024IdentityEntitlements']
slug: /tools/sdk/powershell/v2024/models/identity-entitlements
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlements', 'V2024IdentityEntitlements']
---
# IdentityEntitlements
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ObjectRef** | [**TaggedObjectDto**](tagged-object-dto) | | [optional]
**Tags** | **[]String** | Labels to be applied to object. | [optional]
## Examples
- Prepare the resource
```powershell
$IdentityEntitlements = Initialize-V2024IdentityEntitlements -ObjectRef null `
-Tags [BU_FINANCE, PCI]
```
- Convert the resource to JSON
```powershell
$IdentityEntitlements | ConvertTo-JSON
```
[[Back to top]](#)

53
docs/tools/sdk/powershell/Reference/V2024/Models/Launcher.md Normal file
View File

@@ -0,0 +1,53 @@
---
id: v2024-launcher
title: Launcher
pagination_label: Launcher
sidebar_label: Launcher
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Launcher', 'V2024Launcher']
slug: /tools/sdk/powershell/v2024/models/launcher
tags: ['SDK', 'Software Development Kit', 'Launcher', 'V2024Launcher']
---
# Launcher
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | ID of the Launcher | [required]
**Created** | **System.DateTime** | Date the Launcher was created | [required]
**Modified** | **System.DateTime** | Date the Launcher was last modified | [required]
**Owner** | [**LauncherOwner**](launcher-owner) | | [required]
**Name** | **String** | Name of the Launcher, limited to 255 characters | [required]
**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required]
**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required]
**Disabled** | **Boolean** | State of the Launcher | [required]
**Reference** | [**LauncherReference**](launcher-reference) | | [optional]
**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
## Examples
- Prepare the resource
```powershell
$Launcher = Initialize-V2024Launcher -Id 1b630bed-0941-4792-a712-57a5868ca34d `
-Created 2024-04-16T20:07:30.601016489Z `
-Modified 2024-04-17T18:02:07.320143194Z `
-Owner null `
-Name Group Create `
-Description Create a new Active Directory Group `
-Type INTERACTIVE_PROCESS `
-Disabled false `
-Reference null `
-Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}
```
- Convert the resource to JSON
```powershell
$Launcher | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/LauncherOwner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-launcher-owner
title: LauncherOwner
pagination_label: LauncherOwner
sidebar_label: LauncherOwner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherOwner', 'V2024LauncherOwner']
slug: /tools/sdk/powershell/v2024/models/launcher-owner
tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'V2024LauncherOwner']
---
# LauncherOwner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **String** | Owner type | [required]
**Id** | **String** | Owner ID | [required]
## Examples
- Prepare the resource
```powershell
$LauncherOwner = Initialize-V2024LauncherOwner -Type IDENTITY `
-Id 123180847373330f0173c7e1756b6890
```
- Convert the resource to JSON
```powershell
$LauncherOwner | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/LauncherReference.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-launcher-reference
title: LauncherReference
pagination_label: LauncherReference
sidebar_label: LauncherReference
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherReference', 'V2024LauncherReference']
slug: /tools/sdk/powershell/v2024/models/launcher-reference
tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'V2024LauncherReference']
---
# LauncherReference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [optional]
**Id** | **String** | ID of Launcher reference | [optional]
## Examples
- Prepare the resource
```powershell
$LauncherReference = Initialize-V2024LauncherReference -Type WORKFLOW `
-Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
```
- Convert the resource to JSON
```powershell
$LauncherReference | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,45 @@
---
id: v2024-launcher-request
title: LauncherRequest
pagination_label: LauncherRequest
sidebar_label: LauncherRequest
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequest', 'V2024LauncherRequest']
slug: /tools/sdk/powershell/v2024/models/launcher-request
tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'V2024LauncherRequest']
---
# LauncherRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | Name of the Launcher, limited to 255 characters | [required]
**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required]
**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required]
**Disabled** | **Boolean** | State of the Launcher | [required]
**Reference** | [**LauncherRequestReference**](launcher-request-reference) | | [optional]
**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required]
## Examples
- Prepare the resource
```powershell
$LauncherRequest = Initialize-V2024LauncherRequest -Name Group Create `
-Description Create a new Active Directory Group `
-Type INTERACTIVE_PROCESS `
-Disabled false `
-Reference null `
-Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"}
```
- Convert the resource to JSON
```powershell
$LauncherRequest | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/LauncherRequestReference.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-launcher-request-reference
title: LauncherRequestReference
pagination_label: LauncherRequestReference
sidebar_label: LauncherRequestReference
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequestReference', 'V2024LauncherRequestReference']
slug: /tools/sdk/powershell/v2024/models/launcher-request-reference
tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'V2024LauncherRequestReference']
---
# LauncherRequestReference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [required]
**Id** | **String** | ID of Launcher reference | [required]
## Examples
- Prepare the resource
```powershell
$LauncherRequestReference = Initialize-V2024LauncherRequestReference -Type WORKFLOW `
-Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5
```
- Convert the resource to JSON
```powershell
$LauncherRequestReference | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V2024/Models/StartLauncher200Response.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-start-launcher200-response
title: StartLauncher200Response
pagination_label: StartLauncher200Response
sidebar_label: StartLauncher200Response
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'StartLauncher200Response', 'V2024StartLauncher200Response']
slug: /tools/sdk/powershell/v2024/models/start-launcher200-response
tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'V2024StartLauncher200Response']
---
# StartLauncher200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**InteractiveProcessId** | **String** | ID of the Interactive Process that was launched | [required]
## Examples
- Prepare the resource
```powershell
$StartLauncher200Response = Initialize-V2024StartLauncher200Response -InteractiveProcessId 5da68cfe-2d60-4b09-858f-0d03acd2f47a
```
- Convert the resource to JSON
```powershell
$StartLauncher200Response | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/V2024/Models/Tag.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: v2024-tag
title: Tag
pagination_label: Tag
sidebar_label: Tag
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Tag', 'V2024Tag']
slug: /tools/sdk/powershell/v2024/models/tag
tags: ['SDK', 'Software Development Kit', 'Tag', 'V2024Tag']
---
# Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Tag id | [required][readonly]
**Name** | **String** | Name of the tag. | [required]
**Created** | **System.DateTime** | Date the tag was created. | [required][readonly]
**Modified** | **System.DateTime** | Date the tag was last modified. | [required][readonly]
**TagCategoryRefs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly]
## Examples
- Prepare the resource
```powershell
$Tag = Initialize-V2024Tag -Id 449ecdc0-d4ff-4341-acf6-92f6f7ce604f `
-Name PCI `
-Created 2022-05-04T14:48:49Z `
-Modified 2022-07-14T16:31:11Z `
-TagCategoryRefs null
```
- Convert the resource to JSON
```powershell
$Tag | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/TagTagCategoryRefsInner.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-tag-tag-category-refs-inner
title: TagTagCategoryRefsInner
pagination_label: TagTagCategoryRefsInner
sidebar_label: TagTagCategoryRefsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'TagTagCategoryRefsInner', 'V2024TagTagCategoryRefsInner']
slug: /tools/sdk/powershell/v2024/models/tag-tag-category-refs-inner
tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'V2024TagTagCategoryRefsInner']
---
# TagTagCategoryRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type of the tagged object's category. | [optional]
**Id** | **String** | Tagged object's ID. | [optional]
**Name** | **String** | Tagged object's display name. | [optional]
## Examples
- Prepare the resource
```powershell
$TagTagCategoryRefsInner = Initialize-V2024TagTagCategoryRefsInner -Type ENTITLEMENT `
-Id 2c91809773dee32014e13e122092014e `
-Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
```
- Convert the resource to JSON
```powershell
$TagTagCategoryRefsInner | ConvertTo-JSON
```
[[Back to top]](#)