mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
add method and model docs for powershell and python v2025
This commit is contained in:
darrell-thobe-sp
@@ -0,0 +1,335 @@
|
||||
---
|
||||
id: v2025-password-policies
|
||||
title: PasswordPolicies
|
||||
pagination_label: PasswordPolicies
|
||||
sidebar_label: PasswordPolicies
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicies', 'V2025PasswordPolicies']
|
||||
slug: /tools/sdk/powershell/v2025/methods/password-policies
|
||||
tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'V2025PasswordPolicies']
|
||||
---
|
||||
|
||||
# PasswordPolicies
|
||||
Use these APIs to implement password policies functionality.
|
||||
These APIs allow you to define the policy parameters for choosing passwords.
|
||||
|
||||
IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns.
|
||||
If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org.
|
||||
|
||||
In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups.
|
||||
Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies.
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2025PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy
|
||||
[**Remove-V2025PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID
|
||||
[**Get-V2025PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID
|
||||
[**Get-V2025PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
|
||||
[**Set-V2025PasswordPolicy**](#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/v2025/create-password-policy)
|
||||
|
||||
### Parameters
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Reference to the password policy. | PasswordPolicyV3Dto
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$PasswordPolicyV3Dto = @"{
|
||||
"validateAgainstAccountName" : true,
|
||||
"minLength" : 8,
|
||||
"description" : "Information about the Password Policy",
|
||||
"requireStrongAuthUntrustedGeographies" : true,
|
||||
"enablePasswdExpiration" : true,
|
||||
"minNumeric" : 8,
|
||||
"lastUpdated" : 1939056206564,
|
||||
"validateAgainstAccountId" : false,
|
||||
"dateCreated" : 1639056206564,
|
||||
"accountNameMinWordLength" : 6,
|
||||
"minUpper" : 8,
|
||||
"firstExpirationReminder" : 45,
|
||||
"modified" : "modified",
|
||||
"id" : "2c91808e7d976f3b017d9f5ceae440c8",
|
||||
"requireStrongAuthn" : true,
|
||||
"useDictionary" : false,
|
||||
"minSpecial" : 8,
|
||||
"sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ],
|
||||
"passwordExpiration" : 8,
|
||||
"maxRepeatedChars" : 3,
|
||||
"minCharacterTypes" : 5,
|
||||
"minAlpha" : 5,
|
||||
"created" : "created",
|
||||
"useAccountAttributes" : false,
|
||||
"accountIdMinWordLength" : 4,
|
||||
"minLower" : 8,
|
||||
"useIdentityAttributes" : false,
|
||||
"defaultPolicy" : true,
|
||||
"requireStrongAuthOffNetwork" : true,
|
||||
"name" : "PasswordPolicy Example",
|
||||
"maxLength" : 25
|
||||
}"@
|
||||
|
||||
# Create Password Policy
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-password-policy
|
||||
This API deletes the specified password policy.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The ID of password policy to delete.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
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-V2025PasswordPolicy -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2025PasswordPolicy -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy"
|
||||
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/v2025/get-password-policy-by-id)
|
||||
|
||||
### Parameters
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Reference to the password policy. | PasswordPolicyV3Dto
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
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-V2025PasswordPolicyById -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordPolicyById -Id $Id
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById"
|
||||
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/v2025/list-password-policies)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | Offset | **Int32** | (optional) (default to 0) | 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.
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of all Password Policies. | PasswordPolicyV3Dto[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$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-V2025PasswordPolicies
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-password-policy
|
||||
This API updates the specified password policy.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-password-policy)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
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
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Reference to the password policy. | PasswordPolicyV3Dto
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update.
|
||||
$PasswordPolicyV3Dto = @"{
|
||||
"validateAgainstAccountName" : true,
|
||||
"minLength" : 8,
|
||||
"description" : "Information about the Password Policy",
|
||||
"requireStrongAuthUntrustedGeographies" : true,
|
||||
"enablePasswdExpiration" : true,
|
||||
"minNumeric" : 8,
|
||||
"lastUpdated" : 1939056206564,
|
||||
"validateAgainstAccountId" : false,
|
||||
"dateCreated" : 1639056206564,
|
||||
"accountNameMinWordLength" : 6,
|
||||
"minUpper" : 8,
|
||||
"firstExpirationReminder" : 45,
|
||||
"modified" : "modified",
|
||||
"id" : "2c91808e7d976f3b017d9f5ceae440c8",
|
||||
"requireStrongAuthn" : true,
|
||||
"useDictionary" : false,
|
||||
"minSpecial" : 8,
|
||||
"sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ],
|
||||
"passwordExpiration" : 8,
|
||||
"maxRepeatedChars" : 3,
|
||||
"minCharacterTypes" : 5,
|
||||
"minAlpha" : 5,
|
||||
"created" : "created",
|
||||
"useAccountAttributes" : false,
|
||||
"accountIdMinWordLength" : 4,
|
||||
"minLower" : 8,
|
||||
"useIdentityAttributes" : false,
|
||||
"defaultPolicy" : true,
|
||||
"requireStrongAuthOffNetwork" : true,
|
||||
"name" : "PasswordPolicy Example",
|
||||
"maxLength" : 25
|
||||
}"@
|
||||
|
||||
# Update Password Policy by ID
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
|
||||
Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
Reference in New Issue
Block a user