mfa

Documentation

Overview

Multifactor authentication should be enabled on the admin console before utilizing these APIs. Please note that the access tokens used for this section are different from the access tokens obtained from standard login and is obtained from calling the validate Backup Code/OTP/Google Auth Code API; this token is often referred to as secondfactorauthenticationtoken

Index

• type Loginradius
  • func (lr Loginradius) DeleteMFAResetGoogleAuthenticatorByToken() (*httprutils.Response, error)
  • func (lr Loginradius) DeleteMFAResetGoogleAuthenticatorByUid(queries interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) DeleteMFAResetSMSAuthenticatorByToken() (*httprutils.Response, error)
  • func (lr Loginradius) DeleteMFAResetSMSAuthenticatorByUid(queries interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) GetMFABackUpCodeByAccessToken() (*httprutils.Response, error)
  • func (lr Loginradius) GetMFABackUpCodeByUID(queries interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) GetMFAReAuthenticate(queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) GetMFAResetBackUpCodeByAccessToken() (*httprutils.Response, error)
  • func (lr Loginradius) GetMFAResetBackUpCodeByUID(queries interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) GetMFAValidateAccessToken(queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PostMFAEmailLogin(body interface{}, queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PostMFAPhoneLogin(body interface{}, queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PostMFAUsernameLogin(body interface{}, queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAReauthenticateByBackupCode(body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAReauthenticateByGoogleAuthenticator(body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAReauthenticateByOTP(body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAReauthenticateByPassword(body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAUpdateByToken(body interface{}, queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAUpdatePhoneNumber(queries, body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAUpdatePhoneNumberByToken(body interface{}, queries ...interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAUpdateSettings(body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAValidateBackupCode(queries interface{}, body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAValidateGoogleAuthCode(queries, body interface{}) (*httprutils.Response, error)
  • func (lr Loginradius) PutMFAValidateOTP(queries, body interface{}) (*httprutils.Response, error)

Types

type Loginradius

type Loginradius struct {
	Client *lr.Loginradius
}

Embed Loginradius struct

func (Loginradius) DeleteMFAResetGoogleAuthenticatorByToken

func (lr Loginradius) DeleteMFAResetGoogleAuthenticatorByToken() (*httprutils.Response, error)

Required body parameter: googleauthenticator - pass true as value

func (Loginradius) DeleteMFAResetGoogleAuthenticatorByUid

func (lr Loginradius) DeleteMFAResetGoogleAuthenticatorByUid(queries interface{}) (*httprutils.Response, error)

Required body parameter: googleauthenticator - pass true as value

func (Loginradius) DeleteMFAResetSMSAuthenticatorByToken

func (lr Loginradius) DeleteMFAResetSMSAuthenticatorByToken() (*httprutils.Response, error)

Required body parameter: otpauthenticator - pass true as value

func (Loginradius) DeleteMFAResetSMSAuthenticatorByUid

func (lr Loginradius) DeleteMFAResetSMSAuthenticatorByUid(queries interface{}) (*httprutils.Response, error)

Required body parameter: otpauthenticator - pass true as value

func (Loginradius) GetMFABackUpCodeByAccessToken

func (lr Loginradius) GetMFABackUpCodeByAccessToken() (*httprutils.Response, error)

Required query parameter: apikey

func (Loginradius) GetMFABackUpCodeByUID

func (lr Loginradius) GetMFABackUpCodeByUID(queries interface{}) (*httprutils.Response, error)

Required query parameter: apikey, apisecret, uid

func (Loginradius) GetMFAReAuthenticate

func (lr Loginradius) GetMFAReAuthenticate(queries ...interface{}) (*httprutils.Response, error)

Optional query parameter: smstemplate2fa

func (Loginradius) GetMFAResetBackUpCodeByAccessToken

func (lr Loginradius) GetMFAResetBackUpCodeByAccessToken() (*httprutils.Response, error)

Required query parameter: apikey

func (Loginradius) GetMFAResetBackUpCodeByUID

func (lr Loginradius) GetMFAResetBackUpCodeByUID(queries interface{}) (*httprutils.Response, error)

Required query parameter: apikey, apisecret, uid

func (Loginradius) GetMFAValidateAccessToken

func (lr Loginradius) GetMFAValidateAccessToken(queries ...interface{}) (*httprutils.Response, error)

Needs Authorization Bearer token header

func (Loginradius) PostMFAEmailLogin

func (lr Loginradius) PostMFAEmailLogin(body interface{}, queries ...interface{}) (*httprutils.Response, error)

Required post parameters: email - string; password - string;

func (Loginradius) PostMFAPhoneLogin

func (lr Loginradius) PostMFAPhoneLogin(body interface{}, queries ...interface{}) (*httprutils.Response, error)

Required post parameters: phone - string; password - string;

func (Loginradius) PostMFAUsernameLogin

func (lr Loginradius) PostMFAUsernameLogin(body interface{}, queries ...interface{}) (*httprutils.Response, error)

Required post parameters: username - string; password - string;

func (Loginradius) PutMFAReauthenticateByBackupCode

func (lr Loginradius) PutMFAReauthenticateByBackupCode(body interface{}) (*httprutils.Response, error)

PutMFAReauthenticateByBackupCode is used to re-authenticate via Multi-factor-authentication by passing the backup code. Documentation: https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/re-authentication/validate-mfa-by-backup-code Required query parameter: apikey Required body parameters: backupcode

func (Loginradius) PutMFAReauthenticateByGoogleAuthenticator

func (lr Loginradius) PutMFAReauthenticateByGoogleAuthenticator(body interface{}) (*httprutils.Response, error)

Required body parameters: googleauthenticatorcode

func (Loginradius) PutMFAReauthenticateByOTP

func (lr Loginradius) PutMFAReauthenticateByOTP(body interface{}) (*httprutils.Response, error)

Optional bodys parameters: securityanswer, qq_captcha_ticket, qq_captcha_Randstr, g-recaptcha-response

func (Loginradius) PutMFAReauthenticateByPassword

func (lr Loginradius) PutMFAReauthenticateByPassword(body interface{}) (*httprutils.Response, error)

Optional body parameters: securityanswer - object, qq_captcha_ticket, qq_captcha_Randstr, g-recaptcha-response

func (Loginradius) PutMFAUpdateByToken

func (lr Loginradius) PutMFAUpdateByToken(body interface{}, queries ...interface{}) (*httprutils.Response, error)

Rerquired post parameters: googleauthenticatorcode - string

func (Loginradius) PutMFAUpdatePhoneNumber

func (lr Loginradius) PutMFAUpdatePhoneNumber(queries, body interface{}) (*httprutils.Response, error)

Required post parameter: phoneno2fa - string

func (Loginradius) PutMFAUpdatePhoneNumberByToken

func (lr Loginradius) PutMFAUpdatePhoneNumberByToken(body interface{}, queries ...interface{}) (*httprutils.Response, error)

Required post parameter: phoneno2fa - string

func (Loginradius) PutMFAUpdateSettings

func (lr Loginradius) PutMFAUpdateSettings(body interface{}) (*httprutils.Response, error)

optional body parameters: securityanswer - object; g-recaptcha-response - string; qq_captcha_ticket - string; qq-captcha-randstr - string

func (Loginradius) PutMFAValidateBackupCode

func (lr Loginradius) PutMFAValidateBackupCode(queries interface{}, body interface{}) (*httprutils.Response, error)

Required body parameter: backupcode

func (Loginradius) PutMFAValidateGoogleAuthCode

func (lr Loginradius) PutMFAValidateGoogleAuthCode(queries, body interface{}) (*httprutils.Response, error)

Required post parameter: googleauthenticatorcode: string

func (Loginradius) PutMFAValidateOTP

func (lr Loginradius) PutMFAValidateOTP(queries, body interface{}) (*httprutils.Response, error)

Optional query parameters: securityanswer, g-recaptcha-response, qq_captcha_ticket, qq_captcha_randstr