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

18
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-password-dictionary
title: PasswordDictionary
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-dictionary
tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'BetaPasswordDictionary']
---
# PasswordDictionary
Use this API to implement password dictionary functionality.
With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords.
@@ -68,9 +68,7 @@ Method | HTTP request | Description
[**Get-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
## get-password-dictionary
This gets password dictionary for the organization.
The password dictionary file can contain lines that are:
1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing
@@ -106,7 +104,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
**String**
### Responses
@@ -121,13 +118,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain, application/json
### Example
```powershell
# Get Password Dictionary
try {
Get-BetaPasswordDictionary
@@ -138,11 +136,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-password-dictionary
This updates password dictionary for the organization.
The password dictionary file can contain lines that are:
1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing
@@ -179,7 +174,6 @@ Param Type | Name | Data Type | Required | Description
| File | **System.IO.FileInfo** | (optional) |
### Return type
(empty response body)
### Responses
@@ -195,14 +189,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$File = # System.IO.FileInfo | (optional)
# Update Password Dictionary
try {
Send-BetaPasswordDictionary
@@ -213,7 +208,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)