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: 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/BetaPasswordPoliciesApi.md
View File

@@ -32,9 +32,12 @@ Method | HTTP request | Description
[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
## create-password-policy
This API creates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -98,19 +101,22 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result
New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto
# New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-password-policy
This API deletes the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -141,19 +147,22 @@ $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to
# Delete Password Policy by ID
try {
Remove-BetaPasswordPolicy -BetaId $Id
Remove-BetaPasswordPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-BetaPasswordPolicy -BetaId $Id
# Remove-BetaPasswordPolicy -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-policy-by-id
This API returns the password policy for the specified ID.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-policy-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -184,20 +193,23 @@ $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to
# Get Password Policy by ID
try {
Get-BetaPasswordPolicyById -BetaId $Id
Get-BetaPasswordPolicyById -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaPasswordPolicyById -BetaId $Id
# Get-BetaPasswordPolicyById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-password-policies
This gets list of all Password Policies.
Requires role of ORG_ADMIN
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-password-policies)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -231,19 +243,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Password Policies
try {
Get-BetaPasswordPolicies
Get-BetaPasswordPolicies
# Below is a request that includes all optional parameters
# Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count
# Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-password-policy
This API updates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-password-policy)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -309,10 +324,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $Result
Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto
# Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy"
Write-Host $_.ErrorDetails