Skip to content

Latest commit

 

History

History
381 lines (253 loc) · 8.48 KB

account-security.md

File metadata and controls

381 lines (253 loc) · 8.48 KB

Account Security

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


mfaGenerateBackupCodesByUid

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

Generate Backup Codes

Generates a set of backup codes for the specified User.

Example

public static void callMfaGenerateBackupCodesByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.mfaGenerateBackupCodesByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

MFABackUpCodeResponse


mfaResetBackupCodesByUid

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

Reset Backup Codes

Resets and generates a new set of backup codes for the specified User.

Example

public static void callMfaResetBackupCodesByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.mfaResetBackupCodesByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

MFABackUpCodeResponse


mFAResetSMSAuthByUid

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

Reset SMS Authenticator

Resets MFA settings for the specified User.

Example

public static void callMFAResetSMSAuthByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.mFAResetSMSAuthByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

IsDeleted


mFAResetTotpByUid

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

Reset TOTP

Resets MFA settings for the specified User.

Example

public static void callMFAResetTotpByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.mFAResetTotpByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

IsDeleted


resetDuoAuthByUid

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

Reset Duo

Resets the Duo Authenticator for the specified User.

Example

public static void callResetDuoAuthByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.resetDuoAuthByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

IsDeleted


resetEmailAuthenticatorByUid

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

Reset Email OTP

Resets the Email OTP Authenticator for the specified User.

Example

public static void callResetEmailAuthenticatorByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.resetEmailAuthenticatorByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

IsDeleted


resetMfaPasskeyByUid

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

Reset MFA Passkey

Resets the MFA Passkey for the specified User.

Example

public static void callResetMfaPasskeyByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.resetMfaPasskeyByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

IsDeleted


resetMfaPushByUid

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

Reset MFA Push Notification

Resets the Push Notification Authenticator for the specified User.

Example

public static void callResetMfaPushByUid(LoginRadiusClient client) {
  String uid = "<uid>"; //Required

  try {
    var response = client.accountSecurity.resetMfaPushByUid(uid);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid query string yes The UID associated with the User

Returns

IsDeleted


validateSecondFactorTokenForPassword

POST /identity/v2/manage/account/{uid}/reauth/password

Verify Password MFA Token

Validates and verifies the 'SecondFactorValidationToken' generated by the Step-Up Authenticate By Password API.

Example

public static void callValidateSecondFactorTokenForPassword(LoginRadiusClient client) {
  String uid = "<uid>"; //Required
  EventBasedSecondFactorToken eventBasedSecondFactorToken = new EventBasedSecondFactorToken().secondfactorvalidationtoken("<secondfactorvalidationtoken>"); //Required

  try {
    var response = client.accountSecurity.validateSecondFactorTokenForPassword(uid, eventBasedSecondFactorToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid path string yes The UID associated with the User

Request body

EventBasedSecondFactorToken as application/json.

Returns

IsValid


validateSecondFactorTokenForPin

POST /identity/v2/manage/account/{uid}/reauth/pin

Verify PIN MFA Token

Validates and verifies the 'SecondFactorValidationToken' generated by the Step-Up Authenticate By PIN API.

Example

public static void callValidateSecondFactorTokenForPin(LoginRadiusClient client) {
  String uid = "<uid>"; //Required
  EventBasedSecondFactorToken eventBasedSecondFactorToken = new EventBasedSecondFactorToken().secondfactorvalidationtoken("<secondfactorvalidationtoken>"); //Required

  try {
    var response = client.accountSecurity.validateSecondFactorTokenForPin(uid, eventBasedSecondFactorToken);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
uid path string yes The UID associated with the User

Request body

EventBasedSecondFactorToken as application/json.

Returns

IsValid