Skip to content

second-factor-configuration.md

Latest commit

 

History

History
197 lines (130 loc) · 4.67 KB

second-factor-configuration.md

File metadata and controls

197 lines (130 loc) · 4.67 KB
Raw

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

public static void callGetDuoAuthenticatorConfiguration(LoginRadiusClient client) {
  try {
    var response = client.secondFactorConfiguration.getDuoAuthenticatorConfiguration();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

DuoSecurityAuthenticator

getSecondFactorConfiguration

GET /v2/manage/2fa/config

Retrieve second factor configuration

Retrieves the second factor authentication configuration for the Tenant.

Example

public static void callGetSecondFactorConfiguration(LoginRadiusClient client) {
  try {
    var response = client.secondFactorConfiguration.getSecondFactorConfiguration();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

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

public static void callGetTOTPConfiguration(LoginRadiusClient client) {
  try {
    var response = client.secondFactorConfiguration.getTOTPConfiguration();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

GoogleAuthenticator

updateDuoAuthenticatorConfiguration

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

Update Duo configuration

Updates the Duo Authentication configuration for a specific Tenant.

Example

public static void callUpdateDuoAuthenticatorConfiguration(LoginRadiusClient client) {
  DuoSecurityAuthenticator duoSecurityAuthenticator = new DuoSecurityAuthenticator().isEnabled(true).clientId("<clientId>").clientSecret("<clientSecret>"); //Required

  try {
    var response = client.secondFactorConfiguration.updateDuoAuthenticatorConfiguration(duoSecurityAuthenticator);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

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

public static void callUpdateSecondFactorConfiguration(LoginRadiusClient client) {
  MFASettings mfASettings = new MFASettings().isSecondFactorAuthenticatorEnabled(true).isRequired(true).isAuthenticatorEnabled(true); //Required

  try {
    var response = client.secondFactorConfiguration.updateSecondFactorConfiguration(mfASettings);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

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

public static void callUpdateTOTPConfiguration(LoginRadiusClient client) {
  GoogleAuthenticator googleAuthenticator = new GoogleAuthenticator().issuerId("<issuerId>"); //Required

  try {
    var response = client.secondFactorConfiguration.updateTOTPConfiguration(googleAuthenticator);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Request body

GoogleAuthenticator as application/json.

Returns

GoogleAuthenticator