LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md
View File

@@ -46,9 +46,12 @@ 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".
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-digit-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -83,19 +86,22 @@ $PasswordDigitTokenReset = @"{
try {
$Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset
New-BetaDigitToken -BetaPasswordDigitTokenReset $Result
New-BetaDigitToken -BetaPasswordDigitTokenReset $Result
# Below is a request that includes all optional parameters
# New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset
# New-BetaDigitToken -BetaPasswordDigitTokenReset $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken"
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.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -125,16 +131,17 @@ $Id = "MyId" # String |
# Get Password Change Request Status
try {
Get-BetaIdentityPasswordChangeStatus -BetaId $Id
Get-BetaIdentityPasswordChangeStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-BetaIdentityPasswordChangeStatus -BetaId $Id
# Get-BetaIdentityPasswordChangeStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## query-password-info
This API is used to query password related information.
@@ -146,6 +153,8 @@ grant type will **NOT** work on this endpoint, and a `403 Forbidden` response
will be returned.
[API Spec](https://developer.sailpoint.com/docs/api/beta/query-password-info)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -179,16 +188,17 @@ $PasswordInfoQueryDTO = @"{
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result
Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO
# Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-identity-password
This API is used to set a password for an identity.
@@ -235,6 +245,8 @@ In this example, `toEncrypt` refers to the plain text password you are setting a
You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-identity-password)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -271,10 +283,10 @@ $PasswordChangeRequest = @"{
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result
Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest
# Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword"
Write-Host $_.ErrorDetails