diff --git a/CHANGELOG.md b/CHANGELOG.md index 3bddf99b..4cd39223 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Change Log +## [v2.12.0](https://github.com/auth0/react-native-auth0/tree/v2.12.0) (2022-01-07) + +[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.11.0...v2.12.0) + +**Added** + +- Feature: Implemented MFA APIs [\#442](https://github.com/auth0/react-native-auth0/pull/442) ([poovamraj](https://github.com/poovamraj)) + +**Fixed** + +- Fix: Warning on RN65 while linking from agent.js [\#441](https://github.com/auth0/react-native-auth0/pull/441) ([poovamraj](https://github.com/poovamraj)) + ## [v2.11.0](https://github.com/auth0/react-native-auth0/tree/v2.11.0) (2021-11-30) [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.10.0...v2.11.0) diff --git a/docs/Auth.html b/docs/Auth.html index a2b976a8..ecc9bf91 100644 --- a/docs/Auth.html +++ b/docs/Auth.html @@ -69,6 +69,26 @@ >loginWithEmail +
  • + FloginWithOOB +
    • +
  • + FloginWithOTP +
    • +
  • + FloginWithRecoveryCode +
  • FlogoutUrl
    • +
  • + FmultifactorChallenge +
  • F @@ -977,6 +1005,388 @@
    Returns:
    +
    +

    + (static) loginWithOOB(parameters) → {Promise} +

    + +
    +

    + Log in a user using an Out Of Band authentication code after + they have received the 'mfa_required' error. The MFA token tells + the server the username or email, password, and realm values + sent on the first request. +

    +

    + Requires your client to have the MFA OOB Grant + Type enabled. See + Client Grant Types + to learn how to enable it. +

    +
    + +
    +
    Source:
    +
    + +
    +
    + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    parameters + Object + +

    login with Recovery Code parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    mfaToken + String + +

    + the token received in the previous login response +

    +
    oobCode + String + +

    + the out of band code received in the challenge + response. +

    +
    bindingCode + String + +

    + [Optional] the code used to bind the side channel + (used to deliver the challenge) with the main + channel you are using to authenticate. This is + usually an OTP-like code delivered as part of the + challenge message. +

    +
    +
    + +
    +
    Returns:
    + +
    +
    + Type: +
    +
    + Promise +
    +
    +
    +
    + +
    +

    + (static) loginWithOTP(parameters) → {Promise} +

    + +
    +

    + Log in a user using the One Time Password code after they have + received the 'mfa_required' error. The MFA token tells the + server the username or email, password, and realm values sent on + the first request. +

    +

    + Requires your client to have the MFA OTP Grant + Type enabled. See + Client Grant Types + to learn how to enable it. +

    +
    + +
    +
    Source:
    +
    + +
    +
    + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    parameters + Object + +

    login with OTP parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    mfaToken + String + +

    + the token received in the previous login response +

    +
    otp + String + +

    + the one time password code provided by the + resource owner, typically obtained from an MFA + application such as Google Authenticator or + Guardian. +

    +
    +
    + +
    +
    Returns:
    + +
    +
    + Type: +
    +
    + Promise +
    +
    +
    +
    + +
    +

    + (static) loginWithRecoveryCode(parameters) → {Promise} +

    + +
    +

    + Log in a user using a multi-factor authentication Recovery Code + after they have received the 'mfa_required' error. The MFA token + tells the server the username or email, password, and realm + values sent on the first request. +

    +

    + Requires your client to have the MFA Grant Type + enabled. See + Client Grant Types + to learn how to enable it. +

    +
    + +
    +
    Source:
    +
    + +
    +
    + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    parameters + Object + +

    login with Recovery Code parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    mfaToken + String + +

    + the token received in the previous login response +

    +
    recoveryCode + String + +

    the recovery code provided by the end-user.

    +
    +
    + +
    +
    Returns:
    + +
    +
    + Type: +
    +
    + Promise +
    +
    +
    +
    +

    (static) loginWithSMSReturns:

    +
    +

    + (static) multifactorChallenge(parameters) → {Promise} +

    + +
    +

    + Request a challenge for multi-factor authentication (MFA) based + on the challenge types supported by the application and user. + The challenge type is how the user will get the challenge and + prove possession. Supported challenge types include: + "otp" and "oob". +

    +
    + +
    +
    Source:
    +
    + +
    +
    + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    parameters + Object + +

    challenge request parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    mfaToken + String + +

    + the token received in the previous login response +

    +
    challengeType + String + +

    + A whitespace-separated list of the challenges + types accepted by your application. Accepted + challenge types are oob or otp. Excluding this + parameter means that your client application + accepts all supported challenge types. +

    +
    authenticatorId + String + +

    The ID of the authenticator to challenge.

    +
    +
    + +
    +
    Returns:
    + +
    +
    + Type: +
    +
    + Promise +
    +
    +
    +
    +

    (static) @@ -1895,7 +2434,7 @@

    @@ -1987,7 +2526,7 @@

    @@ -2068,8 +2607,8 @@

    Returns:
    Generated by JSDoc 3.6.4 on - Tue Nov 30 2021 12:41:50 GMT-0300 (Argentina Standard Time) using the - Minami theme. + Fri Jan 07 2022 16:42:51 GMT+0100 (Central European Standard Time) using + the Minami theme.