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:
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: beta-password-management
|
||||
title: PasswordManagement
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/password-management
|
||||
tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'BetaPasswordManagement']
|
||||
---
|
||||
|
||||
|
||||
# PasswordManagement
|
||||
Use this API to implement password management functionality.
|
||||
With this functionality in place, users can manage their identity passwords for all their applications.
|
||||
@@ -47,9 +47,7 @@ Method | HTTP request | Description
|
||||
[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
|
||||
[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password
|
||||
|
||||
|
||||
## create-digit-token
|
||||
|
||||
This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create".
|
||||
|
||||
### Parameters
|
||||
@@ -58,7 +56,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | PasswordDigitTokenReset | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordDigitToken**](../models/password-digit-token)
|
||||
|
||||
### Responses
|
||||
@@ -72,7 +69,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
|
||||
|
||||
@@ -83,7 +79,9 @@ $PasswordDigitTokenReset = @"{
|
||||
"length" : 8,
|
||||
"userId" : "Abby.Smith"
|
||||
}"@
|
||||
|
||||
# Generate a digit token
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset
|
||||
New-BetaDigitToken-BetaPasswordDigitTokenReset $Result
|
||||
@@ -95,11 +93,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-identity-password-change-status
|
||||
|
||||
This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API.
|
||||
|
||||
### Parameters
|
||||
@@ -108,7 +103,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | Id | **String** | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordStatus**](../models/password-status)
|
||||
|
||||
### Responses
|
||||
@@ -122,14 +116,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 = "MyId" # String |
|
||||
|
||||
# Get Password Change Request Status
|
||||
|
||||
try {
|
||||
Get-BetaIdentityPasswordChangeStatus-BetaId $Id
|
||||
|
||||
@@ -140,11 +135,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## query-password-info
|
||||
|
||||
This API is used to query password related information.
|
||||
|
||||
A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)
|
||||
@@ -161,7 +153,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordInfo**](../models/password-info)
|
||||
|
||||
### Responses
|
||||
@@ -175,7 +166,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
|
||||
|
||||
@@ -185,7 +175,9 @@ $PasswordInfoQueryDTO = @"{
|
||||
"sourceName" : "My-AD",
|
||||
"userName" : "Abby.Smith"
|
||||
}"@
|
||||
|
||||
# Query Password Info
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
|
||||
Search-BetaPasswordInfo-BetaPasswordInfoQueryDTO $Result
|
||||
@@ -197,11 +189,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-identity-password
|
||||
|
||||
This API is used to set a password for an identity.
|
||||
|
||||
An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow).
|
||||
@@ -253,7 +242,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**PasswordChangeResponse**](../models/password-change-response)
|
||||
|
||||
### Responses
|
||||
@@ -267,7 +255,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
|
||||
|
||||
@@ -280,7 +267,9 @@ $PasswordChangeRequest = @"{
|
||||
"publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2",
|
||||
"encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="
|
||||
}"@
|
||||
|
||||
# Set Identity's Password
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
|
||||
Set-BetaIdentityPassword-BetaPasswordChangeRequest $Result
|
||||
@@ -292,7 +281,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user