Skip to content

Latest commit

 

History

History
408 lines (256 loc) · 10.9 KB

MFAConfigurationApi.md

File metadata and controls

408 lines (256 loc) · 10.9 KB

\MFAConfigurationApi

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method HTTP request Description
DeleteMFAConfig Delete /mfa/{method}/delete Delete MFA method configuration
GetMFADuoConfig Get /mfa/duo-web/config Configuration of Duo MFA method
GetMFAOktaConfig Get /mfa/okta-verify/config Configuration of Okta MFA method
SetMFADuoConfig Put /mfa/duo-web/config Set Duo MFA configuration
SetMFAOktaConfig Put /mfa/okta-verify/config Set Okta MFA configuration
TestMFAConfig Get /mfa/{method}/test MFA method's test configuration

DeleteMFAConfig

MfaOktaConfig DeleteMFAConfig(ctx, method).Execute()

Delete MFA method configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    method := "okta-verify" // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MFAConfigurationApi.DeleteMFAConfig(context.Background(), method).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationApi.DeleteMFAConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteMFAConfig`: MfaOktaConfig
    fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationApi.DeleteMFAConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
method string The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteMFAConfigRequest struct via the builder pattern

Name Type Description Notes

Return type

MfaOktaConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMFADuoConfig

MfaDuoConfig GetMFADuoConfig(ctx).Execute()

Configuration of Duo MFA method

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MFAConfigurationApi.GetMFADuoConfig(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationApi.GetMFADuoConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMFADuoConfig`: MfaDuoConfig
    fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationApi.GetMFADuoConfig`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMFADuoConfigRequest struct via the builder pattern

Return type

MfaDuoConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMFAOktaConfig

MfaOktaConfig GetMFAOktaConfig(ctx).Execute()

Configuration of Okta MFA method

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MFAConfigurationApi.GetMFAOktaConfig(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationApi.GetMFAOktaConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetMFAOktaConfig`: MfaOktaConfig
    fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationApi.GetMFAOktaConfig`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetMFAOktaConfigRequest struct via the builder pattern

Return type

MfaOktaConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetMFADuoConfig

MfaDuoConfig SetMFADuoConfig(ctx).MfaDuoConfig(mfaDuoConfig).Execute()

Set Duo MFA configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    mfaDuoConfig := *openapiclient.NewMfaDuoConfig() // MfaDuoConfig | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MFAConfigurationApi.SetMFADuoConfig(context.Background()).MfaDuoConfig(mfaDuoConfig).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationApi.SetMFADuoConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SetMFADuoConfig`: MfaDuoConfig
    fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationApi.SetMFADuoConfig`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSetMFADuoConfigRequest struct via the builder pattern

Name Type Description Notes
mfaDuoConfig MfaDuoConfig

Return type

MfaDuoConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetMFAOktaConfig

MfaOktaConfig SetMFAOktaConfig(ctx).MfaOktaConfig(mfaOktaConfig).Execute()

Set Okta MFA configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    mfaOktaConfig := *openapiclient.NewMfaOktaConfig() // MfaOktaConfig | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MFAConfigurationApi.SetMFAOktaConfig(context.Background()).MfaOktaConfig(mfaOktaConfig).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationApi.SetMFAOktaConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SetMFAOktaConfig`: MfaOktaConfig
    fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationApi.SetMFAOktaConfig`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSetMFAOktaConfigRequest struct via the builder pattern

Name Type Description Notes
mfaOktaConfig MfaOktaConfig

Return type

MfaOktaConfig

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestMFAConfig

MfaConfigTestResponse TestMFAConfig(ctx, method).Execute()

MFA method's test configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    method := "okta-verify" // string | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MFAConfigurationApi.TestMFAConfig(context.Background(), method).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MFAConfigurationApi.TestMFAConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TestMFAConfig`: MfaConfigTestResponse
    fmt.Fprintf(os.Stdout, "Response from `MFAConfigurationApi.TestMFAConfig`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
method string The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.

Other Parameters

Other parameters are passed through a pointer to a apiTestMFAConfigRequest struct via the builder pattern

Name Type Description Notes

Return type

MfaConfigTestResponse

Authorization

UserContextAuth, UserContextAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]