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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md
View File

@@ -33,9 +33,15 @@ Method | HTTP request | Description
[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
## create-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API creates a new Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +89,25 @@ $WorkgroupDto = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
# Below is a request that includes all optional parameters
# New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $WorkgroupDto
# New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API deletes a Governance Group by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -127,22 +139,28 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete a Governance Group
try {
Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroup-members
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API removes one or more members from a Governance Group. A
> **Following field of Identity is an optional field in the request.**
> **name**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -178,17 +196,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity
# Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-workgroups-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API initiates a bulk deletion of one or more Governance Groups.
@@ -202,6 +224,8 @@ This API initiates a bulk deletion of one or more Governance Groups.
> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroups-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -236,19 +260,25 @@ $WorkgroupBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest
# Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns a Governance Groups by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +310,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Governance Group by Id
try {
Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-connections
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns list of connections associated with a Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connections)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -332,19 +368,25 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List connections for Governance Group
try {
Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroup-members
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns list of members associated with a Governance Group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -384,19 +426,25 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Governance Group Members
try {
Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters
# Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-workgroups
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns list of Governance Groups
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -436,22 +484,28 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Governance Groups
try {
Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-workgroup
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates an existing governance group by ID. The following fields and objects are patchable:
* name
* description
* owner
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workgroup)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -490,23 +544,29 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Patch a Governance Group
try {
Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation
# Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-workgroup-members
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
> **Following field of Identity is an optional field in the request.**
> **name**
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-workgroup-members)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -542,10 +602,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity
Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity
# Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers"
Write-Host $_.ErrorDetails