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,178 @@
|
||||
---
|
||||
id: v2025-password-configuration
|
||||
title: PasswordConfiguration
|
||||
pagination_label: PasswordConfiguration
|
||||
sidebar_label: PasswordConfiguration
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordConfiguration', 'V2025PasswordConfiguration']
|
||||
slug: /tools/sdk/powershell/v2025/methods/password-configuration
|
||||
tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'V2025PasswordConfiguration']
|
||||
---
|
||||
|
||||
# PasswordConfiguration
|
||||
Use this API to implement organization password configuration functionality.
|
||||
With this functionality in place, organization administrators can create organization-specific password configurations.
|
||||
|
||||
These configurations include details like custom password instructions, as well as digit token length and duration.
|
||||
|
||||
Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality.
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-V2025PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config
|
||||
[**Get-V2025PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
|
||||
[**Send-V2025PasswordOrgConfig**](#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/v2025/create-password-org-config)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True |
|
||||
|
||||
### Return type
|
||||
[**PasswordOrgConfig**](../models/password-org-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Reference to the password org config. | PasswordOrgConfig
|
||||
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**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$PasswordOrgConfig = @"{
|
||||
"digitTokenLength" : 9,
|
||||
"digitTokenEnabled" : true,
|
||||
"digitTokenDurationMinutes" : 10,
|
||||
"customInstructionsEnabled" : true
|
||||
}"@
|
||||
|
||||
# Create Password Org Config
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
|
||||
New-V2025PasswordOrgConfig -PasswordOrgConfig $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2025PasswordOrgConfig -PasswordOrgConfig $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordOrgConfig"
|
||||
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/v2025/get-password-org-config)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
|
||||
### Return type
|
||||
[**PasswordOrgConfig**](../models/password-org-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Reference to the password org config. | PasswordOrgConfig
|
||||
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
|
||||
|
||||
# Get Password Org Config
|
||||
|
||||
try {
|
||||
Get-V2025PasswordOrgConfig
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2025PasswordOrgConfig
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordOrgConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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/v2025/put-password-org-config)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True |
|
||||
|
||||
### Return type
|
||||
[**PasswordOrgConfig**](../models/password-org-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Reference to the password org config. | PasswordOrgConfig
|
||||
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**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$PasswordOrgConfig = @"{
|
||||
"digitTokenLength" : 9,
|
||||
"digitTokenEnabled" : true,
|
||||
"digitTokenDurationMinutes" : 10,
|
||||
"customInstructionsEnabled" : true
|
||||
}"@
|
||||
|
||||
# Update Password Org Config
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
|
||||
Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Send-V2025PasswordOrgConfig -PasswordOrgConfig $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PasswordOrgConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
Reference in New Issue
Block a user