mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: beta-password-policies
|
||||
title: PasswordPolicies
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-policies
|
||||
tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'BetaPasswordPolicies']
|
||||
---
|
||||
|
||||
|
||||
# PasswordPolicies
|
||||
Use these APIs to implement password policies functionality.
|
||||
These APIs allow you to define the policy parameters for choosing passwords.
|
||||
@@ -33,9 +33,7 @@ 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.
|
||||
|
||||
### Parameters
|
||||
@@ -44,7 +42,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
|
||||
|
||||
### Responses
|
||||
@@ -59,7 +56,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
|
||||
|
||||
@@ -98,7 +94,9 @@ $PasswordPolicyV3Dto = @"{
|
||||
"name" : "PasswordPolicy Example",
|
||||
"maxLength" : 25
|
||||
}"@
|
||||
|
||||
# Create Password Policy
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
New-BetaPasswordPolicy-BetaPasswordPolicyV3Dto $Result
|
||||
@@ -110,11 +108,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-password-policy
|
||||
|
||||
This API deletes the specified password policy.
|
||||
|
||||
### Parameters
|
||||
@@ -123,7 +118,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | Id | **String** | True | The ID of password policy to delete.
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
@@ -138,14 +132,15 @@ 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
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
|
||||
|
||||
# Delete Password Policy by ID
|
||||
|
||||
try {
|
||||
Remove-BetaPasswordPolicy-BetaId $Id
|
||||
|
||||
@@ -156,11 +151,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-password-policy-by-id
|
||||
|
||||
This API returns the password policy for the specified ID.
|
||||
|
||||
### Parameters
|
||||
@@ -169,7 +161,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | Id | **String** | True | The ID of password policy to retrieve.
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
|
||||
|
||||
### Responses
|
||||
@@ -184,14 +175,15 @@ 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
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
|
||||
|
||||
# Get Password Policy by ID
|
||||
|
||||
try {
|
||||
Get-BetaPasswordPolicyById-BetaId $Id
|
||||
|
||||
@@ -202,11 +194,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-password-policies
|
||||
|
||||
This gets list of all Password Policies.
|
||||
Requires role of ORG_ADMIN
|
||||
|
||||
@@ -218,7 +207,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordPolicyV3Dto[]**](../models/password-policy-v3-dto)
|
||||
|
||||
### Responses
|
||||
@@ -232,7 +220,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
|
||||
|
||||
@@ -241,7 +228,9 @@ Code | Description | Data Type
|
||||
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
|
||||
# List Password Policies
|
||||
|
||||
try {
|
||||
Get-BetaPasswordPolicies
|
||||
|
||||
@@ -252,11 +241,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-password-policy
|
||||
|
||||
This API updates the specified password policy.
|
||||
|
||||
### Parameters
|
||||
@@ -266,7 +252,6 @@ Path | Id | **String** | True | The ID of password policy to update.
|
||||
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
|
||||
|
||||
### Responses
|
||||
@@ -281,7 +266,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
|
||||
|
||||
@@ -321,7 +305,9 @@ $PasswordPolicyV3Dto = @"{
|
||||
"name" : "PasswordPolicy Example",
|
||||
"maxLength" : 25
|
||||
}"@
|
||||
|
||||
# Update Password Policy by ID
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
Set-BetaPasswordPolicy-BetaId $Id -BetaPasswordPolicyV3Dto $Result
|
||||
@@ -333,7 +319,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user