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

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-custom-password-instructions
title: CustomPasswordInstructions
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/custom-password-instructions
tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'BetaCustomPasswordInstructions']
---
# CustomPasswordInstructions
Use this API to implement custom password instruction functionality.
With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames.
@@ -33,9 +33,7 @@ Method | HTTP request | Description
[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
## create-custom-password-instructions
This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -44,7 +42,6 @@ Param Type | Name | Data Type | Required | Description
Body | CustomPasswordInstruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True |
### Return type
[**CustomPasswordInstruction**](../models/custom-password-instruction)
### Responses
@@ -56,7 +53,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -67,7 +63,9 @@ $CustomPasswordInstruction = @"{
"pageId" : "change-password:enter-password",
"locale" : "en"
}"@
# Create Custom Password Instructions
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
New-BetaCustomPasswordInstructions-BetaCustomPasswordInstruction $Result
@@ -79,11 +77,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-custom-password-instructions
This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -93,7 +88,6 @@ Path | PageId | **String** | True | The page ID of custom password instructio
Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"".
### Return type
(empty response body)
### Responses
@@ -106,7 +100,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -114,7 +107,9 @@ Code | Description | Data Type
```powershell
$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)
# Delete Custom Password Instructions by page ID
try {
Remove-BetaCustomPasswordInstructions-BetaPageId $PageId
@@ -125,11 +120,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-custom-password-instructions
This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API.
### Parameters
@@ -139,7 +131,6 @@ Path | PageId | **String** | True | The page ID of custom password instructio
Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"".
### Return type
[**CustomPasswordInstruction**](../models/custom-password-instruction)
### Responses
@@ -152,7 +143,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -160,7 +150,9 @@ Code | Description | Data Type
```powershell
$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)
# Get Custom Password Instructions by Page ID
try {
Get-BetaCustomPasswordInstructions-BetaPageId $PageId
@@ -171,7 +163,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)