LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +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/Beta/Methods/BetaPasswordSyncGroupsApi.md
View File

@@ -55,9 +55,12 @@ Method | HTTP request | Description
[**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-BetaPasswordSyncGroup**](#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/beta/create-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result
New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup
# New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup"
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/beta/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-BetaPasswordSyncGroup -BetaId $Id
Remove-BetaPasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaPasswordSyncGroup -BetaId $Id
# Remove-BetaPasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup"
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/beta/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-BetaPasswordSyncGroup -BetaId $Id
Get-BetaPasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaPasswordSyncGroup -BetaId $Id
# Get-BetaPasswordSyncGroup -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup"
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/beta/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-BetaPasswordSyncGroups
Get-BetaPasswordSyncGroups
# Below is a request that includes all optional parameters
# Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups"
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/beta/update-password-sync-group)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $Result
Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup
# Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup"
Write-Host $_.ErrorDetails