security.md

Security

51 operation(s). Part of the API index.

Call these as $client-><service>-><method>(...). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

---

accountRegisterMFAPasskeyBegin

GET /identity/v2/auth/account/2fa/register/passkey/begin

Begin MFA Passkey registration

Initiates the MFA Passkey registration flow for an Account.

Example

function callAccountRegisterMFAPasskeyBegin($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->accountRegisterMFAPasskeyBegin(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

object

---

accountRegisterMFAPasskeyFinish

POST /identity/v2/auth/account/2fa/register/passkey/finish

Complete MFA Passkey registration

Completes the MFA Passkey registration flow for an Account.

Example

function callAccountRegisterMFAPasskeyFinish($client) {
    $accountRegisterMFAPasskeyFinishRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\AccountRegisterMFAPasskeyFinishRequest(['passkeyCredential' => '<passkeyCredential>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->accountRegisterMFAPasskeyFinish($accountRegisterMFAPasskeyFinishRequest, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

object as application/json.

Returns

PasskeyCredentialObject

---

beginMFAPasskeyRegistration

GET /identity/v2/auth/login/2fa/register/passkey/begin

Begin Passkey Registration with MFA Token

Begins the MFA Passkey registration flow.

Example

function callBeginMFAPasskeyRegistration($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required

    try {
        $response = $client->security->beginMFAPasskeyRegistration(secondfactorauthenticationtoken: $secondfactorauthenticationtoken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token

Returns

object

---

beginPasskeyMFAVerification

GET /identity/v2/auth/login/2fa/passkey/begin

Begin Passkey Login with MFA Token

Begins the MFA Passkey verification flow.

Example

function callBeginPasskeyMFAVerification($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required

    try {
        $response = $client->security->beginPasskeyMFAVerification(secondfactorauthenticationtoken: $secondfactorauthenticationtoken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token

Returns

object

---

changePinByAccessToken

PUT /identity/v2/auth/pin/change

Update PIN with Access Token

Updates an existing PIN by providing the current PIN and a valid Access Token for authentication, allowing a User to change their PIN while logged in.

Example

function callChangePinByAccessToken($client) {
    $changePin = new \LoginRadius\Sdk\Internal\OpenApi\Model\ChangePin(['oldpin' => '<oldpin>', 'newpin' => '<newpin>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $xPreventWebhook = true; //Optional
    $preventWebhook = true; //Optional
    $gRecaptchaResponse = '<gRecaptchaResponse>'; //Optional
    $gRecaptchaResponse2 = '<gRecaptchaResponse2>'; //Optional
    $hCaptchaResponse = '<hCaptchaResponse>'; //Optional
    $qqCaptchaTicket = '<qqCaptchaTicket>'; //Optional
    $qqCaptchaRandstr = '<qqCaptchaRandstr>'; //Optional

    try {
        $response = $client->security->changePinByAccessToken($changePin, accessToken: $accessToken, xPreventWebhook: $xPreventWebhook, preventWebhook: $preventWebhook, gRecaptchaResponse: $gRecaptchaResponse, gRecaptchaResponse2: $gRecaptchaResponse2, hCaptchaResponse: $hCaptchaResponse, qqCaptchaTicket: $qqCaptchaTicket, qqCaptchaRandstr: $qqCaptchaRandstr);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
g-recaptcha-response	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
g_recaptcha_response	query	string	no	Google reCAPTCHA Response
h-captcha-response	query	string	no	hCaptcha Response
qq_captcha_ticket	query	string	no	QQ Captcha ticket (required if Bot Protection is enabled)
qq_captcha_randstr	query	string	no	QQ Captcha rand string (required if Bot Protection is enabled)

Request body

ChangePin as application/json.

Returns

IsPostedResponse

---

duoAuthenticationReAuthVerificationByAccessToken

PUT /identity/v2/auth/account/reauth/2fa/duo

Verify Duo

Verifies Duo authentication for a User using an Access Token, typically used when re-verification is required.

Example

function callDuoAuthenticationReAuthVerificationByAccessToken($client) {
    $duoVerifyRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\DuoVerifyRequest(['state' => '<state>', 'code' => '<code>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->duoAuthenticationReAuthVerificationByAccessToken($duoVerifyRequest, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
access_token	query	string	no	Access Token of the User

Request body

DuoVerifyRequest as application/json.

Returns

ReAuthResponse

---

duoAuthenticationVerificationByAccessToken

PUT /identity/v2/auth/account/2fa/duo

Verify Duo authentication

Verifies Duo authentication for a User using an Access Token, typically after initial authentication.

Example

function callDuoAuthenticationVerificationByAccessToken($client) {
    $duoVerifyRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\DuoVerifyRequest(['state' => '<state>', 'code' => '<code>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $accessToken = '<accessToken>'; //Optional
    $fields = '<fields>'; //Optional

    try {
        $response = $client->security->duoAuthenticationVerificationByAccessToken($duoVerifyRequest, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, accessToken: $accessToken, fields: $fields);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
access_token	query	string	no	Access Token of the User
fields	query	string	no	Comma-separated list of profile fields to include in the response.

Request body

DuoVerifyRequest as application/json.

Returns

Profile

---

duoAuthVerificationByMFASecondFactorToken

PUT /identity/v2/auth/login/2fa/duo

Verify Duo with MFA Token

Verifies Duo authentication for a User using a second factor token.

Example

function callDuoAuthVerificationByMFASecondFactorToken($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $duoVerifyRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\DuoVerifyRequest(['state' => '<state>', 'code' => '<code>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $fields = '<fields>'; //Optional
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbaoneclickemailtemplate = '<rbaoneclickemailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbaotpsmstemplate = '<rbaotpsmstemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->duoAuthVerificationByMFASecondFactorToken($duoVerifyRequest, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, fields: $fields, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbaoneclickemailtemplate: $rbaoneclickemailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbaotpsmstemplate: $rbaotpsmstemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
fields	query	string	no	Comma-separated list of profile fields to include in the response.
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbaoneclickemailtemplate	query	string	no	RBA one click Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA is enabled for the Tenant with one click sign in as a MFA option.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbaotpsmstemplate	query	string	no	RBA OTP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Request body

DuoVerifyRequest as application/json.

Returns

AuthResponse

---

emailOTPAuthVerificationByAccessToken

PUT /identity/v2/auth/account/2fa/email

Verify Email OTP

Verifies Email OTP authentication for a User using an Access Token.

Example

function callEmailOTPAuthVerificationByAccessToken($client) {
    $reAuthModelByEmailOtp = new \LoginRadius\Sdk\Internal\OpenApi\Model\ReAuthModelByEmailOtp(['emailid' => '<emailid>', 'otp' => '<otp>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $accessToken = '<accessToken>'; //Optional
    $fields = '<fields>'; //Optional

    try {
        $response = $client->security->emailOTPAuthVerificationByAccessToken($reAuthModelByEmailOtp, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, accessToken: $accessToken, fields: $fields);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
access_token	query	string	no	Access Token of the User
fields	query	string	no	Comma-separated list of profile fields to include in the response.

Request body

ReAuthModelByEmailOtp as application/json.

Returns

Profile

---

finishMFAPasskeyRegistration

POST /identity/v2/auth/login/2fa/register/passkey/finish

Complete Passkey registration

Completes the MFA Passkey registration process using the provided MFA token.

Example

function callFinishMFAPasskeyRegistration($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $finishMFAPasskeyRegistrationRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\FinishMFAPasskeyRegistrationRequest(['passkeyCredential' => '<passkeyCredential>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $fields = '<fields>'; //Optional
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbaoneclickemailtemplate = '<rbaoneclickemailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbaotpsmstemplate = '<rbaotpsmstemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->finishMFAPasskeyRegistration($finishMFAPasskeyRegistrationRequest, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, fields: $fields, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbaoneclickemailtemplate: $rbaoneclickemailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbaotpsmstemplate: $rbaotpsmstemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
fields	query	string	no	Comma-separated list of profile fields to include in the response.
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbaoneclickemailtemplate	query	string	no	RBA one click Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA is enabled for the Tenant with one click sign in as a MFA option.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbaotpsmstemplate	query	string	no	RBA OTP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Request body

object as application/json.

Returns

AuthResponse

---

finishPasskeyMFAVerification

POST /identity/v2/auth/login/2fa/passkey/finish

Complete Passkey Login with MFA Token

Completes the MFA Passkey verification flow.

Example

function callFinishPasskeyMFAVerification($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $finishPasskeyMFAVerificationRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\FinishPasskeyMFAVerificationRequest(['passkeyCredential' => '<passkeyCredential>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $fields = '<fields>'; //Optional
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbaoneclickemailtemplate = '<rbaoneclickemailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbaotpsmstemplate = '<rbaotpsmstemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->finishPasskeyMFAVerification($finishPasskeyMFAVerificationRequest, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, fields: $fields, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbaoneclickemailtemplate: $rbaoneclickemailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbaotpsmstemplate: $rbaotpsmstemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
fields	query	string	no	Comma-separated list of profile fields to include in the response.
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbaoneclickemailtemplate	query	string	no	RBA one click Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA is enabled for the Tenant with one click sign in as a MFA option.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbaotpsmstemplate	query	string	no	RBA OTP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Request body

object as application/json.

Returns

AuthResponse

---

forgotPinByEmail

POST /identity/v2/auth/pin/forgot/email

Send PIN Reset Email

Sends a PIN reset Email to the User's registered Email, enabling them to reset their PIN if forgotten.

Example

function callForgotPinByEmail($client) {
    $forgotPinByEmail = new \LoginRadius\Sdk\Internal\OpenApi\Model\ForgotPinByEmail(['email' => '<email>']); //Required
    $emailtemplate = '<emailtemplate>'; //Optional
    $resetpinurl = '<resetpinurl>'; //Optional

    try {
        $response = $client->security->forgotPinByEmail($forgotPinByEmail, emailtemplate: $emailtemplate, resetpinurl: $resetpinurl);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
emailtemplate	query	string	no	Name of the Email template to use for this notification.
resetpinurl	query	string	no	Reset PIN URL

Request body

ForgotPinByEmail as application/json.

Returns

IsPostedResponse

---

forgotPinByPhone

POST /identity/v2/auth/pin/forgot/otp

Send OTP for PIN Reset

Sends a One-Time Password (OTP) to the User's registered Phone number, enabling them to reset their PIN if forgotten.

Example

function callForgotPinByPhone($client) {
    $forgotPinByPhone = new \LoginRadius\Sdk\Internal\OpenApi\Model\ForgotPinByPhone(['phone' => '<phone>']); //Required
    $smstemplate = '<smstemplate>'; //Optional
    $isvoiceotp = true; //Optional

    try {
        $response = $client->security->forgotPinByPhone($forgotPinByPhone, smstemplate: $smstemplate, isvoiceotp: $isvoiceotp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
smstemplate	query	string	no	SMS Template
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Request body

ForgotPinByPhone as application/json.

Returns

SMSResponse

---

forgotPinByUsername

POST /identity/v2/auth/pin/forgot/username

Send PIN Reset Email by Username

Sends a PIN reset Email to the User IDentified by their Username, enabling them to reset their PIN if forgotten.

Example

function callForgotPinByUsername($client) {
    $forgotPinByUsername = new \LoginRadius\Sdk\Internal\OpenApi\Model\ForgotPinByUsername(['username' => '<username>']); //Required
    $emailtemplate = '<emailtemplate>'; //Optional
    $resetpinurl = '<resetpinurl>'; //Optional

    try {
        $response = $client->security->forgotPinByUsername($forgotPinByUsername, emailtemplate: $emailtemplate, resetpinurl: $resetpinurl);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
emailtemplate	query	string	no	Name of the Email template to use for this notification.
resetpinurl	query	string	no	Reset PIN URL

Request body

ForgotPinByUsername as application/json.

Returns

IsPostedResponse

---

getMfaPushDeviceStatus

GET /identity/v2/auth/account/2fa/push/ping

Check push device registration status

Checks whether a Push Notification device is registered on the User's profile for MFA, using an Access Token.

Example

function callGetMfaPushDeviceStatus($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->getMfaPushDeviceStatus(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

IsRegistered

---

getMFASettings

GET /identity/v2/auth/account/2fa

Retrieve MFA settings

Retrieves all MFA settings configured for the User, including the status of each authenticator type and available configuration details.

Example

function callGetMFASettings($client) {
    $duoredirecturi = '<duoredirecturi>'; //Optional
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->getMFASettings(duoredirecturi: $duoredirecturi, accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
duoredirecturi	query	string	no	Duo auth redirection url.
access_token	query	string	no	Access Token of the User

Returns

TwoFactorAuthenticationSettings

---

mfaGenerateBackupCodes

GET /identity/v2/auth/account/2fa/backupcode

Generate backup codes

Generates a set of backup codes for a User with MFA enabled. Returns an error if backup codes already exist.

Example

function callMfaGenerateBackupCodes($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->mfaGenerateBackupCodes(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

MFABackUpCodeResponse

---

mfaResendPushNotification

POST /identity/v2/auth/login/2fa/push

Resend Push Notification

Resends a Push Notification for Multi-Factor Authentication.

Example

function callMfaResendPushNotification($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required

    try {
        $response = $client->security->mfaResendPushNotification(secondfactorauthenticationtoken: $secondfactorauthenticationtoken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token

Returns

IsPostedResponse

---

mfaResetBackupCodes

GET /identity/v2/auth/account/2fa/backupcode/reset

Reset backup codes

Resets backup codes for a User with MFA enabled, allowing regeneration of backup codes.

Example

function callMfaResetBackupCodes($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->mfaResetBackupCodes(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

MFABackUpCodeResponse

---

mFAResetSMSAuthByToken

DELETE /identity/v2/auth/account/2fa/sms

Reset SMS Authenticator

Resets SMS Authenticator configurations for an Account using an Access Token.

Example

function callMFAResetSMSAuthByToken($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->mFAResetSMSAuthByToken(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

IsDeleted

---

mFAResetTotpByToken

DELETE /identity/v2/auth/account/2fa/totp

Reset TOTP

Resets TOTP Authenticator configurations for an Account using an Access Token.

Example

function callMFAResetTotpByToken($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->mFAResetTotpByToken(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

IsDeleted

---

mFAUpdatePhoneNumberByMfaToken

PUT /identity/v2/auth/login/2fa/sms/phone

Update Phone with MFA Token

Sends a verification OTP to the provided Phone number as part of the process to update the Phone number used for Multi-Factor Authentication.

Example

function callMFAUpdatePhoneNumberByMfaToken($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $mFAPhoneUpdateModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\MFAPhoneUpdateModel(['phoneno2fa' => '<phoneno2fa>']); //Required
    $smstemplate2fa = '<smstemplate2fa>'; //Optional
    $isvoiceotp = true; //Optional

    try {
        $response = $client->security->mFAUpdatePhoneNumberByMfaToken($mFAPhoneUpdateModel, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, smstemplate2fa: $smstemplate2fa, isvoiceotp: $isvoiceotp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
smstemplate2fa	query	string	no	SMS template name to be used for sending the 2FA code to the User.
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Request body

MFAPhoneUpdateModel as application/json.

Returns

SMSResponseData

---

mFAUpdatePhoneNumberByToken

PUT /identity/v2/auth/account/2fa/sms/phone

Update Phone by token

Sends a verification OTP to the provided Phone number as part of the process to update the Phone number used for MFA.

Example

function callMFAUpdatePhoneNumberByToken($client) {
    $mFAPhoneUpdateModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\MFAPhoneUpdateModel(['phoneno2fa' => '<phoneno2fa>']); //Required
    $smstemplate2fa = '<smstemplate2fa>'; //Optional
    $isvoiceotp = true; //Optional
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->mFAUpdatePhoneNumberByToken($mFAPhoneUpdateModel, smstemplate2fa: $smstemplate2fa, isvoiceotp: $isvoiceotp, accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
smstemplate2fa	query	string	no	SMS template name to be used for sending the 2FA code to the User.
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.
access_token	query	string	no	Access Token of the User

Request body

MFAPhoneUpdateModel as application/json.

Returns

SMSResponseData

---

mFAVerifyPhoneNumberByAccessToken

PUT /identity/v2/auth/account/2fa/sms

Verify Phone MFA

Updates Phone-based MFA settings after a successful login, managing or verifying Phone MFA configurations for secure operations.

Example

function callMFAVerifyPhoneNumberByAccessToken($client) {
    $mFAVerifyPhoneOtpModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\MFAVerifyPhoneOtpModel(['otp' => '<otp>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $fields = '<fields>'; //Optional

    try {
        $response = $client->security->mFAVerifyPhoneNumberByAccessToken($mFAVerifyPhoneOtpModel, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, fields: $fields);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
fields	query	string	no	Comma-separated list of profile fields to include in the response.

Request body

MFAVerifyPhoneOtpModel as application/json.

Returns

Profile

---

pingPushVerificationStatus

GET /identity/v2/auth/login/2fa/push/ping

Check Push Notification Verification Status

Checks the status of Push Notification verification and returns the login response when verified.

Example

function callPingPushVerificationStatus($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbaoneclickemailtemplate = '<rbaoneclickemailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbaotpsmstemplate = '<rbaotpsmstemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->pingPushVerificationStatus(secondfactorauthenticationtoken: $secondfactorauthenticationtoken, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbaoneclickemailtemplate: $rbaoneclickemailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbaotpsmstemplate: $rbaotpsmstemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbaoneclickemailtemplate	query	string	no	RBA one click Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA is enabled for the Tenant with one click sign in as a MFA option.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbaotpsmstemplate	query	string	no	RBA OTP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Returns

AuthResponse

---

pINLogin

POST /identity/v2/auth/login/pin

Login with PIN

Allows Users to log in using their previously set PIN along with a valid session token.

Example

function callPINLogin($client) {
    $sessionToken = '<sessionToken>'; //Required
    $pINLoginModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\PINLoginModel(['pin' => '<pin>']); //Required
    $xPreventWebhook = true; //Optional
    $preventWebhook = true; //Optional
    $gRecaptchaResponse = '<gRecaptchaResponse>'; //Optional
    $gRecaptchaResponse2 = '<gRecaptchaResponse2>'; //Optional
    $qqCaptchaTicket = '<qqCaptchaTicket>'; //Optional
    $qqCaptchaRandstr = '<qqCaptchaRandstr>'; //Optional
    $hCaptchaResponse = '<hCaptchaResponse>'; //Optional

    try {
        $response = $client->security->pINLogin($pINLoginModel, sessionToken: $sessionToken, xPreventWebhook: $xPreventWebhook, preventWebhook: $preventWebhook, gRecaptchaResponse: $gRecaptchaResponse, gRecaptchaResponse2: $gRecaptchaResponse2, qqCaptchaTicket: $qqCaptchaTicket, qqCaptchaRandstr: $qqCaptchaRandstr, hCaptchaResponse: $hCaptchaResponse);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
session_token	query	string	yes	Session Token for PIN Auth
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
g-recaptcha-response	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
g_recaptcha_response	query	string	no	Google reCAPTCHA Response
qq_captcha_ticket	query	string	no	QQ Captcha ticket (required if Bot Protection is enabled)
qq_captcha_randstr	query	string	no	QQ Captcha rand string (required if Bot Protection is enabled)
h-captcha-response	query	string	no	hCaptcha Response

Request body

PINLoginModel as application/json.

Returns

AuthResponse

---

reauthPassword

PUT /identity/v2/auth/account/reauth/password

Verify Password

Verifies the Password for a User using an Access Token, typically used when re-verification is required.

Example

function callReauthPassword($client) {
    $passwordReauthRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\PasswordReauthRequest(['gRecaptchaResponse' => '<gRecaptchaResponse>', 'qqCaptchaTicket' => '<qqCaptchaTicket>', 'qqCaptchaRandstr' => '<qqCaptchaRandstr>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $smstemplate = '<smstemplate>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $gRecaptchaResponse = '<gRecaptchaResponse>'; //Optional
    $gRecaptchaResponse2 = '<gRecaptchaResponse2>'; //Optional
    $qqCaptchaTicket = '<qqCaptchaTicket>'; //Optional
    $qqCaptchaRandstr = '<qqCaptchaRandstr>'; //Optional
    $hCaptchaResponse = '<hCaptchaResponse>'; //Optional

    try {
        $response = $client->security->reauthPassword($passwordReauthRequest, accessToken: $accessToken, smstemplate: $smstemplate, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, gRecaptchaResponse: $gRecaptchaResponse, gRecaptchaResponse2: $gRecaptchaResponse2, qqCaptchaTicket: $qqCaptchaTicket, qqCaptchaRandstr: $qqCaptchaRandstr, hCaptchaResponse: $hCaptchaResponse);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
smstemplate	query	string	no	SMS Template
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
g-recaptcha-response	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
g_recaptcha_response	query	string	no	Google reCAPTCHA Response
qq_captcha_ticket	query	string	no	QQ reCAPTCHA Response
qq_captcha_randstr	query	string	no	QQ reCAPTCHA Response
h-captcha-response	query	string	no	hCaptcha Response

Request body

PasswordReauthRequest as application/json.

Returns

ReAuthResponse

---

reauthPin

PUT /identity/v2/auth/account/reauth/pin

Verify PIN

Verifies the PIN for a User using an Access Token, typically used when re-verification is required.

Example

function callReauthPin($client) {
    $pinReauthRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\PinReauthRequest(['pin' => '<pin>']); //Required
    $smstemplate = '<smstemplate>'; //Optional
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->reauthPin($pinReauthRequest, smstemplate: $smstemplate, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
smstemplate	query	string	no	SMS Template
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

PinReauthRequest as application/json.

Returns

ReAuthResponse

---

reauthTrigger

GET /identity/v2/auth/account/reauth/2fa

Retrieve Step-Up Authentication settings

Triggers Step-Up Authentication for Multi-Factor Authentication (MFA) settings, allowing Users to verify their MFA methods.

Example

function callReauthTrigger($client) {
    $accessToken = '<accessToken>'; //Optional
    $smstemplate2fa = '<smstemplate2fa>'; //Optional
    $duoredirecturi = '<duoredirecturi>'; //Optional

    try {
        $response = $client->security->reauthTrigger(accessToken: $accessToken, smstemplate2fa: $smstemplate2fa, duoredirecturi: $duoredirecturi);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
smstemplate2fa	query	string	no	SMS template name to be used for sending the 2FA code to the User.
duoredirecturi	query	string	no	Duo auth redirection url.

Returns

TwoFactorAuthenticationSettings

---

resend2FAOTP

GET /identity/v2/auth/login/2fa/resend

Resend SMS OTP with MFA Token

Resends the Multi-Factor Authentication OTP via SMS for login.

Example

function callResend2FAOTP($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $isvoiceotp = true; //Optional

    try {
        $response = $client->security->resend2FAOTP(secondfactorauthenticationtoken: $secondfactorauthenticationtoken, isvoiceotp: $isvoiceotp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Returns

SMSResponseData

---

resend2faSMSOtp

GET /identity/v2/auth/login/2fa/sms/resend

Resend SMS OTP with MFA Token

Resends the Multi-Factor Authentication OTP via SMS for login.

Example

function callResend2faSMSOtp($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $isvoiceotp = true; //Optional

    try {
        $response = $client->security->resend2faSMSOtp(secondfactorauthenticationtoken: $secondfactorauthenticationtoken, isvoiceotp: $isvoiceotp);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.

Returns

SMSResponseData

---

resendEmailOTPMFAToken

POST /identity/v2/auth/login/2fa/email

Resend Email OTP with MFA Token

Sends the OTP to the Email if the Email OTP authenticator is enabled in the Tenant's MFA configuration.

Example

function callResendEmailOTPMFAToken($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $emailModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\EmailModel(['email' => '<email>']); //Required
    $isvoiceotp = true; //Optional
    $emailtemplate2fa = '<emailtemplate2fa>'; //Optional

    try {
        $response = $client->security->resendEmailOTPMFAToken($emailModel, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, isvoiceotp: $isvoiceotp, emailtemplate2fa: $emailtemplate2fa);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.
emailtemplate2fa	query	string	no	Name of the 2FA Email template to use for this notification.

Request body

EmailModel as application/json.

Returns

IsPostedResponse

---

resendTwoFactorEmailOtp

GET /identity/v2/auth/account/2fa/email

Resend Email OTP

Sends the OTP to the Email if the Email OTP Authenticator is enabled in the Tenant's MFA configuration.

Example

function callResendTwoFactorEmailOtp($client) {
    $emailid = '<emailid>'; //Optional
    $emailtemplate2fa = '<emailtemplate2fa>'; //Optional
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->resendTwoFactorEmailOtp(emailid: $emailid, emailtemplate2fa: $emailtemplate2fa, accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
emailid	query	string (email)	no	The Email address of User
emailtemplate2fa	query	string	no	Name of the 2FA Email template to use for this notification.
access_token	query	string	no	Access Token of the User

Returns

IsPostedResponse

---

resetDuoAuthViaAccessToken

DELETE /identity/v2/auth/account/2fa/duo

Reset Duo Authenticator

Resets the Duo Authenticator settings for a User with MFA enabled, allowing reconfiguration or recovery of Duo access.

Example

function callResetDuoAuthViaAccessToken($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->resetDuoAuthViaAccessToken(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

IsDeleted

---

resetMFAEmailAuthByAccessToken

DELETE /identity/v2/auth/account/2fa/email

Reset Email OTP Authenticator

Resets the Email OTP Authenticator settings for a User with MFA enabled, allowing reconfiguration.

Example

function callResetMFAEmailAuthByAccessToken($client) {
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->resetMFAEmailAuthByAccessToken(accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User

Returns

IsDeleted

---

resetMFAPasskeyByAccessToken

DELETE /identity/v2/auth/account/2fa/passkey

Reset Passkey Authenticator

Resets the Passkey Authenticator settings for the specified User.

Example

function callResetMFAPasskeyByAccessToken($client) {
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->resetMFAPasskeyByAccessToken(accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Returns

IsDeleted

---

resetMfaPushAuthSettings

DELETE /identity/v2/auth/account/2fa/push

Reset MFA Push Notification

Resets the MFA Push Authenticator settings for a User.

Example

function callResetMfaPushAuthSettings($client) {
    try {
        $response = $client->security->resetMfaPushAuthSettings();
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Returns

IsDeleted

---

resetPinByOTP

PUT /identity/v2/auth/pin/reset/otp/{type}

Reset PIN with OTP

Allows a User to reset their PIN by verifying a One-Time Password (OTP). The User must provide the OTP, a new PIN, and one identifier (Phone, Email, or Username), enabling secure PIN recovery when the User forgets their PIN.

Example

function callResetPinByOTP($client) {
    $type = '<type>'; //Required
    $resetPINByOTP = new \LoginRadius\Sdk\Internal\OpenApi\Model\ResetPINByOTP(['otp' => '<otp>', 'pin' => '<pin>']); //Required
    $xPreventWebhook = true; //Optional
    $preventWebhook = true; //Optional
    $gRecaptchaResponse = '<gRecaptchaResponse>'; //Optional
    $gRecaptchaResponse2 = '<gRecaptchaResponse2>'; //Optional
    $qqCaptchaTicket = '<qqCaptchaTicket>'; //Optional
    $qqCaptchaRandstr = '<qqCaptchaRandstr>'; //Optional
    $hCaptchaResponse = '<hCaptchaResponse>'; //Optional

    try {
        $response = $client->security->resetPinByOTP($resetPINByOTP, type: $type, xPreventWebhook: $xPreventWebhook, preventWebhook: $preventWebhook, gRecaptchaResponse: $gRecaptchaResponse, gRecaptchaResponse2: $gRecaptchaResponse2, qqCaptchaTicket: $qqCaptchaTicket, qqCaptchaRandstr: $qqCaptchaRandstr, hCaptchaResponse: $hCaptchaResponse);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
type	path	string	yes	The method of ReAuth MFA verification to use.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
g-recaptcha-response	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
g_recaptcha_response	query	string	no	Google reCAPTCHA Response
qq_captcha_ticket	query	string	no	QQ Captcha ticket (required if Bot Protection is enabled)
qq_captcha_randstr	query	string	no	QQ Captcha rand string (required if Bot Protection is enabled)
h-captcha-response	query	string	no	hCaptcha Response

Request body

ResetPINByOTP as application/json.

Returns

IsPostedResponse

---

resetPinByResetToken

PUT /identity/v2/auth/pin/reset/token

Reset PIN with Reset Token

Allows a User to reset their PIN by providing a reset token received via Email and a new PIN, enabling secure PIN recovery when the User forgets their PIN.

Example

function callResetPinByResetToken($client) {
    $resetPINByToken = new \LoginRadius\Sdk\Internal\OpenApi\Model\ResetPINByToken(['resettoken' => '<resettoken>', 'pin' => '<pin>']); //Required
    $xPreventWebhook = true; //Optional
    $preventWebhook = true; //Optional

    try {
        $response = $client->security->resetPinByResetToken($resetPINByToken, xPreventWebhook: $xPreventWebhook, preventWebhook: $preventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.

Request body

ResetPINByToken as application/json.

Returns

IsPostedResponse

---

sendEmailOtpForReauthMFA

GET /identity/v2/auth/account/reauth/2fa/email

Send Email OTP

Sends a One-Time Password (OTP) to the User's Email for re-authentication.

Example

function callSendEmailOtpForReauthMFA($client) {
    $emailid = '<emailid>'; //Optional
    $emailtemplate = '<emailtemplate>'; //Optional
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->sendEmailOtpForReauthMFA(emailid: $emailid, emailtemplate: $emailtemplate, accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
emailid	query	string (email)	no	The Email address of User
emailtemplate	query	string	no	Name of the Email template to use for this notification.
access_token	query	string	no	Access Token of the User

Returns

IsPostedResponse

---

sendReAuthEmailOtp

GET /identity/v2/auth/account/reauth/otp/email

Send Email OTP

Sends a One-Time Password (OTP) to the User's Email for re-authentication.

Example

function callSendReAuthEmailOtp($client) {
    $emailid = '<emailid>'; //Optional
    $emailtemplate = '<emailtemplate>'; //Optional
    $accessToken = '<accessToken>'; //Optional

    try {
        $response = $client->security->sendReAuthEmailOtp(emailid: $emailid, emailtemplate: $emailtemplate, accessToken: $accessToken);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
emailid	query	string (email)	no	The Email address of User
emailtemplate	query	string	no	Name of the Email template to use for this notification.
access_token	query	string	no	Access Token of the User

Returns

IsPostedResponse

---

setPinByPinAuthToken

POST /identity/v2/auth/pin/set/pinauthtoken

Set PIN with Authentication Token

Sets a PIN for Users logging in or registering for the first time. Requires a valid PIN authentication token and is typically part of the onboarding or initial setup process.

Example

function callSetPinByPinAuthToken($client) {
    $pinauthtoken = '<pinauthtoken>'; //Required
    $pINModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\PINModel(['pin' => '<pin>']); //Required
    $xPreventWebhook = true; //Optional
    $preventWebhook = true; //Optional

    try {
        $response = $client->security->setPinByPinAuthToken($pINModel, pinauthtoken: $pinauthtoken, xPreventWebhook: $xPreventWebhook, preventWebhook: $preventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
pinauthtoken	query	string	yes	Pin auth token to set the PIN on account
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.

Request body

PINModel as application/json.

Returns

AuthResponse

---

validateEmailOtpForReauth

PUT /identity/v2/auth/account/reauth/otp/email

Verify Email OTP

Validates the One-Time Password (OTP) sent to the User's Email during re-authentication.

Example

function callValidateEmailOtpForReauth($client) {
    $reAuthModelByEmailOtp = new \LoginRadius\Sdk\Internal\OpenApi\Model\ReAuthModelByEmailOtp(['emailid' => '<emailid>', 'otp' => '<otp>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->validateEmailOtpForReauth($reAuthModelByEmailOtp, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

ReAuthModelByEmailOtp as application/json.

Returns

ReAuthResponse

---

validateEmailOtpForReauthMFA

PUT /identity/v2/auth/account/reauth/2fa/otp/email/verify

Verify Email OTP

Verifies the User with Email OTP and Access Token, typically used when re-authentication via Email OTP is required.

Example

function callValidateEmailOtpForReauthMFA($client) {
    $reAuthModelByEmailOtp = new \LoginRadius\Sdk\Internal\OpenApi\Model\ReAuthModelByEmailOtp(['emailid' => '<emailid>', 'otp' => '<otp>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->validateEmailOtpForReauthMFA($reAuthModelByEmailOtp, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

ReAuthModelByEmailOtp as application/json.

Returns

ReAuthResponse

---

validateMfaOTPByEmail

PUT /identity/v2/auth/login/2fa/email

Verify Email OTP with MFA Token

Logs in to a User's account during the second MFA step with an OTP sent to the Email.

Example

function callValidateMfaOTPByEmail($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $reAuthModelByEmailOtp = new \LoginRadius\Sdk\Internal\OpenApi\Model\ReAuthModelByEmailOtp(['emailid' => '<emailid>', 'otp' => '<otp>']); //Required
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->validateMfaOTPByEmail($reAuthModelByEmailOtp, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Request body

ReAuthModelByEmailOtp as application/json.

Returns

AuthResponse

---

validateMfaOTPByPhone

PUT /identity/v2/auth/login/2fa/sms

Verify SMS OTP

Allows Users to log in with Multi-Factor Authentication using the OTP sent via SMS or Voice OTP.

Example

function callValidateMfaOTPByPhone($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $mFAVerifyPhoneOtpModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\MFAVerifyPhoneOtpModel(['otp' => '<otp>']); //Required
    $smstemplate2fa = '<smstemplate2fa>'; //Optional
    $fields = '<fields>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $isvoiceotp = true; //Optional
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbaotpsmstemplate = '<rbaotpsmstemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->validateMfaOTPByPhone($mFAVerifyPhoneOtpModel, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, smstemplate2fa: $smstemplate2fa, fields: $fields, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, isvoiceotp: $isvoiceotp, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbaotpsmstemplate: $rbaotpsmstemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
smstemplate2fa	query	string	no	SMS template name to be used for sending the 2FA code to the User.
fields	query	string	no	Comma-separated list of profile fields to include in the response.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
isvoiceotp	query	boolean	no	Boolean flag to enforce sending SMS content via Voice.
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbaotpsmstemplate	query	string	no	RBA OTP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Request body

MFAVerifyPhoneOtpModel as application/json.

Returns

AuthResponse

---

validateReauthMFA

PUT /identity/v2/auth/account/reauth/2fa/{type}

Verify backup code or OTP

Validates the triggered MFA authentication flow using a backup code, OTP, or authenticator code.

Example

function callValidateReauthMFA($client) {
    $type = '<type>'; //Required
    $reAuthTwoFAModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\ReAuthTwoFAModel(['gRecaptchaResponse' => '<gRecaptchaResponse>', 'qqCaptchaTicket' => '<qqCaptchaTicket>', 'qqCaptchaRandstr' => '<qqCaptchaRandstr>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $gRecaptchaResponse = '<gRecaptchaResponse>'; //Optional
    $gRecaptchaResponse2 = '<gRecaptchaResponse2>'; //Optional
    $qqCaptchaTicket = '<qqCaptchaTicket>'; //Optional
    $qqCaptchaRandstr = '<qqCaptchaRandstr>'; //Optional
    $hCaptchaResponse = '<hCaptchaResponse>'; //Optional

    try {
        $response = $client->security->validateReauthMFA($reAuthTwoFAModel, type: $type, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, gRecaptchaResponse: $gRecaptchaResponse, gRecaptchaResponse2: $gRecaptchaResponse2, qqCaptchaTicket: $qqCaptchaTicket, qqCaptchaRandstr: $qqCaptchaRandstr, hCaptchaResponse: $hCaptchaResponse);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
type	path	string	yes	The method of ReAuth MFA verification to use.
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
g-recaptcha-response	query	string	no	Google reCAPTCHA response parameter which will be sent to the server for verification.
g_recaptcha_response	query	string	no	Google reCAPTCHA Response
qq_captcha_ticket	query	string	no	QQ reCAPTCHA Response
qq_captcha_randstr	query	string	no	QQ reCAPTCHA Response
h-captcha-response	query	string	no	hCaptcha Response

Request body

ReAuthTwoFAModel as application/json.

Returns

ReAuthResponse

---

validateSecurityQuestionReauthMFA

POST /identity/v2/auth/account/reauth/2fa/securityquestionanswer/verify

Verify security question answer

Validates the triggered MFA authentication flow using a security question answer.

Example

function callValidateSecurityQuestionReauthMFA($client) {
    $twoFAAuthBySecQuesAuthModel = new \LoginRadius\Sdk\Internal\OpenApi\Model\TwoFAAuthBySecQuesAuthModel(['securityquestionanswer' => '<securityquestionanswer>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->validateSecurityQuestionReauthMFA($twoFAAuthBySecQuesAuthModel, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

TwoFAAuthBySecQuesAuthModel as application/json.

Returns

ReAuthResponse

---

verify2faTOTPAuth

PUT /identity/v2/auth/account/2fa/totp

Verify TOTP code

Validates an Authenticator Code as part of the MFA process.

Example

function callVerify2faTOTPAuth($client) {
    $authenticatorCodeRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\AuthenticatorCodeRequest(['googleauthenticatorcode' => '<googleauthenticatorcode>', 'authenticatorcode' => '<authenticatorcode>']); //Required
    $accessToken = '<accessToken>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->verify2faTOTPAuth($authenticatorCodeRequest, accessToken: $accessToken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
access_token	query	string	no	Access Token of the User
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

AuthenticatorCodeRequest as application/json.

Returns

IdentityResponseWithSocialWithoutLogins

---

verifyBackupCodeForMFALogin

PUT /identity/v2/auth/login/2fa/backupcode

Verify Backup Code with MFA Token

Verifies a User's MFA backup code as a second factor during the login process, typically used when the primary MFA method is unavailable.

Example

function callVerifyBackupCodeForMFALogin($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $twoFAAuthByBackupCode = new \LoginRadius\Sdk\Internal\OpenApi\Model\TwoFAAuthByBackupCode(['backupcode' => '<backupcode>']); //Required
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional

    try {
        $response = $client->security->verifyBackupCodeForMFALogin($twoFAAuthByBackupCode, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.

Request body

TwoFAAuthByBackupCode as application/json.

Returns

AuthResponse

---

verifyTotpByMfaToken

PUT /identity/v2/auth/login/2fa/totp

Verify TOTP Code with MFA Token

Validates the TOTP Authenticator code provided by the User as part of the Multi-Factor Authentication login process.

Example

function callVerifyTotpByMfaToken($client) {
    $secondfactorauthenticationtoken = '<secondfactorauthenticationtoken>'; //Required
    $authenticatorCodeRequest = new \LoginRadius\Sdk\Internal\OpenApi\Model\AuthenticatorCodeRequest(['googleauthenticatorcode' => '<googleauthenticatorcode>', 'authenticatorcode' => '<authenticatorcode>']); //Required
    $fields = '<fields>'; //Optional
    $rbabrowseremailtemplate = '<rbabrowseremailtemplate>'; //Optional
    $rbacityemailtemplate = '<rbacityemailtemplate>'; //Optional
    $rbacountryemailtemplate = '<rbacountryemailtemplate>'; //Optional
    $rbaipemailtemplate = '<rbaipemailtemplate>'; //Optional
    $rbadeviceemailtemplate = '<rbadeviceemailtemplate>'; //Optional
    $rbabrowsersmstemplate = '<rbabrowsersmstemplate>'; //Optional
    $rbacitysmstemplate = '<rbacitysmstemplate>'; //Optional
    $rbacountrysmstemplate = '<rbacountrysmstemplate>'; //Optional
    $rbaipsmstemplate = '<rbaipsmstemplate>'; //Optional
    $rbadevicesmstemplate = '<rbadevicesmstemplate>'; //Optional
    $preventWebhook = true; //Optional
    $xPreventWebhook = true; //Optional

    try {
        $response = $client->security->verifyTotpByMfaToken($authenticatorCodeRequest, secondfactorauthenticationtoken: $secondfactorauthenticationtoken, fields: $fields, rbabrowseremailtemplate: $rbabrowseremailtemplate, rbacityemailtemplate: $rbacityemailtemplate, rbacountryemailtemplate: $rbacountryemailtemplate, rbaipemailtemplate: $rbaipemailtemplate, rbadeviceemailtemplate: $rbadeviceemailtemplate, rbabrowsersmstemplate: $rbabrowsersmstemplate, rbacitysmstemplate: $rbacitysmstemplate, rbacountrysmstemplate: $rbacountrysmstemplate, rbaipsmstemplate: $rbaipsmstemplate, rbadevicesmstemplate: $rbadevicesmstemplate, preventWebhook: $preventWebhook, xPreventWebhook: $xPreventWebhook);
        echo $response;
    } catch (\LoginRadius\Sdk\Internal\OpenApi\ApiException $e) {
        $lr = \LoginRadius\Sdk\Client::toLoginRadiusException($e);
        echo $lr->description();
    }
}

Parameters

Name	In	Type	Required	Description
secondfactorauthenticationtoken	query	string	yes	Second factor token
fields	query	string	no	Comma-separated list of profile fields to include in the response.
rbabrowseremailtemplate	query	string	no	RBA browser Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with browser option is enabled for the Tenant.
rbacityemailtemplate	query	string	no	RBA city Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with city option is enabled for the Tenant.
rbacountryemailtemplate	query	string	no	RBA country Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with country option is enabled for the Tenant.
rbaipemailtemplate	query	string	no	RBA IP Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with IP option is enabled for the Tenant.
rbadeviceemailtemplate	query	string	no	RBA device Email template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when RBA with device option is enabled for the Tenant.
rbabrowsersmstemplate	query	string	no	RBA browser SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacitysmstemplate	query	string	no	RBA city SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbacountrysmstemplate	query	string	no	RBA country SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbaipsmstemplate	query	string	no	RBA IP SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
rbadevicesmstemplate	query	string	no	RBA device SMS template name which will be sent to the User when any risk is detected while logging in to the Tenant. It will only be used when a User has logged in via Phone.
prevent_webhook	query	boolean	no	When true, suppresses webhook events for this operation.
X-PreventWebhook	header	boolean	no	When true, suppresses webhook events for this operation.

Request body

AuthenticatorCodeRequest as application/json.

Returns

AuthResponse