second-factor-configuration.md

Second Factor Configuration

6 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.

---

getDuoAuthenticatorConfiguration

GET /v2/manage/2fa/duo-authenticator-settings

Retrieve Duo configuration

Retrieves the Duo Authentication configuration for a specific Tenant.

Example

async function callGetDuoAuthenticatorConfiguration(client: LoginRadius) {
  try {
    const res = await client.<service>.getDuoAuthenticatorConfiguration();
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Returns

DuoSecurityAuthenticator

---

getSecondFactorConfiguration

GET /v2/manage/2fa/config

Retrieve second factor configuration

Retrieves the second factor authentication configuration for the Tenant.

Example

async function callGetSecondFactorConfiguration(client: LoginRadius) {
  try {
    const res = await client.<service>.getSecondFactorConfiguration();
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Returns

MFASettings

---

getTOTPConfiguration

GET /v2/manage/2fa/totp-authenticator-settings

Retrieve TOTP configuration

Retrieves the Time-based One Time Password (TOTP) configuration for a specific Tenant.

Example

async function callGetTOTPConfiguration(client: LoginRadius) {
  try {
    const res = await client.<service>.getTOTPConfiguration();
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Returns

GoogleAuthenticator

---

updateDuoAuthenticatorConfiguration

PUT /v2/manage/2fa/duo-authenticator-settings

Update Duo configuration

Updates the Duo Authentication configuration for a specific Tenant.

Example

async function callUpdateDuoAuthenticatorConfiguration(client: LoginRadius) {
  const duoSecurityAuthenticator = {  }; //Required

  try {
    const res = await client.<service>.updateDuoAuthenticatorConfiguration({ duoSecurityAuthenticator });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Request body

DuoSecurityAuthenticator as application/json.

Returns

DuoSecurityAuthenticator

---

updateSecondFactorConfiguration

PUT /v2/manage/2fa/config

Update second factor configuration

Updates the second factor authentication configuration for the Tenant.

Example

async function callUpdateSecondFactorConfiguration(client: LoginRadius) {
  const mFASettings = {  }; //Required

  try {
    const res = await client.<service>.updateSecondFactorConfiguration({ mFASettings });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Request body

MFASettings as application/json.

Returns

MFASettings

---

updateTOTPConfiguration

PUT /v2/manage/2fa/totp-authenticator-settings

Update TOTP configuration

Updates the Time-based One Time Password (TOTP) configuration for a specific Tenant.

Example

async function callUpdateTOTPConfiguration(client: LoginRadius) {
  const googleAuthenticator = {  }; //Required

  try {
    const res = await client.<service>.updateTOTPConfiguration({ googleAuthenticator });
    console.log(res.data);
  } catch (err) {
    if (err instanceof LoginRadiusError) {
      console.error(err.description);
    } else {
      throw err;
    }
  }
}

Request body

GoogleAuthenticator as application/json.

Returns

GoogleAuthenticator