LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 20:37:46 +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

45
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md
View File

@@ -25,9 +25,12 @@ Method | HTTP request | Description
[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
## get-mfa-duo-config
This API returns the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -55,7 +58,7 @@ Code | Description | Data Type
# Configuration of Duo MFA method
try {
Get-V2024MFADuoConfig
Get-V2024MFADuoConfig
# Below is a request that includes all optional parameters
# Get-V2024MFADuoConfig
@@ -65,9 +68,12 @@ try {
}
```
[[Back to top]](#)
## get-mfa-kba-config
This API returns the KBA configuration for MFA.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-kba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -97,19 +103,22 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be
# Configuration of KBA MFA method
try {
Get-V2024MFAKbaConfig
Get-V2024MFAKbaConfig
# Below is a request that includes all optional parameters
# Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages
# Get-V2024MFAKbaConfig -AllLanguages $AllLanguages
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mfa-okta-config
This API returns the configuration of an Okta MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -137,7 +146,7 @@ Code | Description | Data Type
# Configuration of Okta MFA method
try {
Get-V2024MFAOktaConfig
Get-V2024MFAOktaConfig
# Below is a request that includes all optional parameters
# Get-V2024MFAOktaConfig
@@ -147,9 +156,12 @@ try {
}
```
[[Back to top]](#)
## set-mfa-duo-config
This API sets the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-duo-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -190,19 +202,22 @@ $MfaDuoConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig
# Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-mfakba-config
This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfakba-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -237,19 +252,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem
# Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## set-mfa-okta-config
This API sets the configuration of an Okta MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-okta-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -286,19 +304,22 @@ $MfaOktaConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig
# Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## test-mfa-config
This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-mfa-config)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -328,10 +349,10 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
# MFA method's test configuration
try {
Test-V2024MFAConfig -V2024Method $Method
Test-V2024MFAConfig -Method $Method
# Below is a request that includes all optional parameters
# Test-V2024MFAConfig -V2024Method $Method
# Test-V2024MFAConfig -Method $Method
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig"
Write-Host $_.ErrorDetails