mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: beta-mfa-controller
|
||||
title: MFAController
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/mfa-controller
|
||||
tags: ['SDK', 'Software Development Kit', 'MFAController', 'BetaMFAController']
|
||||
---
|
||||
|
||||
|
||||
# MFAController
|
||||
This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method
|
||||
|
||||
@@ -25,9 +25,7 @@ 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.
|
||||
|
||||
### Parameters
|
||||
@@ -36,7 +34,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | SendTokenRequest | [**SendTokenRequest**](../models/send-token-request) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SendTokenResponse**](../models/send-token-response)
|
||||
|
||||
### Responses
|
||||
@@ -50,7 +47,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
|
||||
|
||||
@@ -60,7 +56,9 @@ $SendTokenRequest = @"{
|
||||
"userAlias" : "will.albin",
|
||||
"deliveryType" : "EMAIL_WORK"
|
||||
}"@
|
||||
|
||||
# Create and send user token
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest
|
||||
New-BetaSendToken-BetaSendTokenRequest $Result
|
||||
@@ -72,11 +70,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## ping-verification-status
|
||||
|
||||
This API poll the VerificationPollRequest for the specified MFA method.
|
||||
|
||||
### Parameters
|
||||
@@ -86,7 +81,6 @@ Path | Method | **String** | True | The name of the MFA method. The currently
|
||||
Body | VerificationPollRequest | [**VerificationPollRequest**](../models/verification-poll-request) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**VerificationResponse**](../models/verification-response)
|
||||
|
||||
### Responses
|
||||
@@ -100,7 +94,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
|
||||
|
||||
@@ -110,7 +103,9 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
|
||||
$VerificationPollRequest = @"{
|
||||
"requestId" : "089899f13a8f4da7824996191587bab9"
|
||||
}"@
|
||||
|
||||
# Polling MFA method by VerificationPollRequest
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
|
||||
Ping-BetaVerificationStatus-BetaMethod $Method -BetaVerificationPollRequest $Result
|
||||
@@ -122,11 +117,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## send-duo-verify-request
|
||||
|
||||
This API Authenticates the user via Duo-Web MFA method.
|
||||
|
||||
### Parameters
|
||||
@@ -135,7 +127,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | DuoVerificationRequest | [**DuoVerificationRequest**](../models/duo-verification-request) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**VerificationResponse**](../models/verification-response)
|
||||
|
||||
### Responses
|
||||
@@ -149,7 +140,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
|
||||
|
||||
@@ -159,7 +149,9 @@ $DuoVerificationRequest = @"{
|
||||
"signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2",
|
||||
"userId" : "2c9180947f0ef465017f215cbcfd004b"
|
||||
}"@
|
||||
|
||||
# Verifying authentication via Duo method
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
|
||||
Send-BetaDuoVerifyRequest-BetaDuoVerificationRequest $Result
|
||||
@@ -171,11 +163,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## send-kba-answers
|
||||
|
||||
This API Authenticate user in KBA MFA method.
|
||||
|
||||
### Parameters
|
||||
@@ -184,7 +173,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**KbaAuthResponse**](../models/kba-auth-response)
|
||||
|
||||
### Responses
|
||||
@@ -198,19 +186,19 @@ 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
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
# KbaAnswerRequestItem[] |
|
||||
$KbaAnswerRequestItem = @"{
|
||||
"answer" : "Your answer",
|
||||
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
|
||||
}"@
|
||||
}"@ # KbaAnswerRequestItem[] |
|
||||
|
||||
|
||||
# Authenticate KBA provided MFA method
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
|
||||
Send-BetaKbaAnswers-BetaKbaAnswerRequestItem $Result
|
||||
@@ -222,11 +210,8 @@ try {
|
||||
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.
|
||||
|
||||
### Parameters
|
||||
@@ -235,7 +220,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | OktaVerificationRequest | [**OktaVerificationRequest**](../models/okta-verification-request) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**VerificationResponse**](../models/verification-response)
|
||||
|
||||
### Responses
|
||||
@@ -249,7 +233,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
|
||||
|
||||
@@ -258,7 +241,9 @@ Code | Description | Data Type
|
||||
$OktaVerificationRequest = @"{
|
||||
"userId" : "example@mail.com"
|
||||
}"@
|
||||
|
||||
# Verifying authentication via Okta method
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
|
||||
Send-BetaOktaVerifyRequest-BetaOktaVerificationRequest $Result
|
||||
@@ -270,11 +255,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## send-token-auth-request
|
||||
|
||||
This API Authenticate user in Token MFA method.
|
||||
|
||||
### Parameters
|
||||
@@ -283,7 +265,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | TokenAuthRequest | [**TokenAuthRequest**](../models/token-auth-request) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TokenAuthResponse**](../models/token-auth-response)
|
||||
|
||||
### Responses
|
||||
@@ -297,7 +278,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
|
||||
|
||||
@@ -308,7 +288,9 @@ $TokenAuthRequest = @"{
|
||||
"deliveryType" : "EMAIL_WORK",
|
||||
"token" : "12345"
|
||||
}"@
|
||||
|
||||
# Authenticate Token provided MFA method
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest
|
||||
Send-BetaTokenAuthRequest-BetaTokenAuthRequest $Result
|
||||
@@ -320,7 +302,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user