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

35
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md
View File

@@ -55,9 +55,12 @@ Method | HTTP request | Description
[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
## create-password-sync-group
This API creates a password sync group based on the specifications provided.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $PasswordSyncGroup
# New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-sync-group
This API deletes the specified password sync group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -137,19 +143,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync
# Delete Password Sync Group by ID
try {
Remove-V2024PasswordSyncGroup -V2024Id $Id
Remove-V2024PasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PasswordSyncGroup -V2024Id $Id
# Remove-V2024PasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-sync-group
This API returns the sync group for the specified ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -180,19 +189,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync
# Get Password Sync Group by ID
try {
Get-V2024PasswordSyncGroup -V2024Id $Id
Get-V2024PasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordSyncGroup -V2024Id $Id
# Get-V2024PasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-sync-groups
This API returns a list of password sync groups.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-groups)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -226,19 +238,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Get Password Sync Group List
try {
Get-V2024PasswordSyncGroups
Get-V2024PasswordSyncGroups
# Below is a request that includes all optional parameters
# Get-V2024PasswordSyncGroups -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count
# Get-V2024PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## update-password-sync-group
This API updates the specified password sync group.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $Result
Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $PasswordSyncGroup
# Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup"
Write-Host $_.ErrorDetails