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

19
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md
View File

@@ -27,11 +27,14 @@ Method | HTTP request | Description
[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
## create-password-org-config
This API creates the password org config. Unspecified fields will use default value.
To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true".
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -67,19 +70,22 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig
# New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-password-org-config
This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,7 +113,7 @@ Code | Description | Data Type
# Get Password Org Config
try {
Get-V2024PasswordOrgConfig
Get-V2024PasswordOrgConfig
# Below is a request that includes all optional parameters
# Get-V2024PasswordOrgConfig
@@ -117,11 +123,14 @@ try {
}
```
[[Back to top]](#)
## put-password-org-config
This API updates the password org config for specified fields. Other fields will keep original value.
You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions.
Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-org-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -157,10 +166,10 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig
# Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig"
Write-Host $_.ErrorDetails