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

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md
View File

@@ -24,9 +24,12 @@ Method | HTTP request | Description
[**Send-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
## create-send-token
This API send token request.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-send-token)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -60,19 +63,22 @@ $SendTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest
New-BetaSendToken -BetaSendTokenRequest $Result
New-BetaSendToken -BetaSendTokenRequest $Result
# Below is a request that includes all optional parameters
# New-BetaSendToken -BetaSendTokenRequest $SendTokenRequest
# New-BetaSendToken -BetaSendTokenRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## ping-verification-status
This API poll the VerificationPollRequest for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-verification-status)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -107,19 +113,22 @@ $VerificationPollRequest = @"{
try {
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $Result
Ping-BetaVerificationStatus -Method $Method -BetaVerificationPollRequest $Result
# Below is a request that includes all optional parameters
# Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $VerificationPollRequest
# Ping-BetaVerificationStatus -Method $Method -BetaVerificationPollRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-duo-verify-request
This API Authenticates the user via Duo-Web MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-duo-verify-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -153,19 +162,22 @@ $DuoVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result
Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $DuoVerificationRequest
# Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-kba-answers
This API Authenticate user in KBA MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-kba-answers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -200,19 +212,22 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result
Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $KbaAnswerRequestItem
# Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-okta-verify-request
This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-okta-verify-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -245,19 +260,22 @@ $OktaVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result
Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $OktaVerificationRequest
# Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-token-auth-request
This API Authenticate user in Token MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/send-token-auth-request)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -292,10 +310,10 @@ $TokenAuthRequest = @"{
try {
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest
Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result
Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result
# Below is a request that includes all optional parameters
# Send-BetaTokenAuthRequest -BetaTokenAuthRequest $TokenAuthRequest
# Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest"
Write-Host $_.ErrorDetails