Function AuthApiFactory

  • AuthApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        authCreateLogin(requestParameters, options?) => AxiosPromise<Token>;
        authCreateLogout(options?) => AxiosPromise<RestAuthDetail>;
        authCreatePasswordChange(requestParameters, options?) => AxiosPromise<RestAuthDetail>;
        authCreatePasswordReset(requestParameters, options?) => AxiosPromise<RestAuthDetail>;
        authCreatePasswordResetConfirm(requestParameters, options?) => AxiosPromise<RestAuthDetail>;
        authCreateRegister(requestParameters, options?) => AxiosPromise<RegisterSerializerEx>;
        authCreateSigning(requestParameters, options?) => AxiosPromise<string>;
        authRetrieveRules(options?) => AxiosPromise<void>;
    }

    • authCreateLogin:function
      • authCreateLogin(requestParameters, options?): AxiosPromise<Token>

      • Check the credentials and return the REST Token if the credentials are valid and authenticated. If email verification is enabled and the user has the unverified email, an email with a confirmation link will be sent. Calls Django Auth login method to register User ID in Django session framework. Accept the following POST parameters: username, email, password Return the REST Framework Token Object's key.

        Parameters

        Returns AxiosPromise<Token>

        Throws

    • authCreateLogout:function
      • authCreateLogout(options?): AxiosPromise<RestAuthDetail>

      • Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

        Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<RestAuthDetail>

        Throws

    • authCreatePasswordChange:function
      • authCreatePasswordChange(requestParameters, options?): AxiosPromise<RestAuthDetail>

      • Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

        Parameters

        Returns AxiosPromise<RestAuthDetail>

        Throws

    • authCreatePasswordReset:function
    • authCreatePasswordResetConfirm:function
      • authCreatePasswordResetConfirm(requestParameters, options?): AxiosPromise<RestAuthDetail>

      • Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

        Parameters

        Returns AxiosPromise<RestAuthDetail>

        Throws

    • authCreateRegister:function
    • authCreateSigning:function
      • authCreateSigning(requestParameters, options?): AxiosPromise<string>

      • Signed URL contains a token which authenticates a user on the server.Signed URL is valid during 30 seconds since signing.

        Parameters

        Returns AxiosPromise<string>

        Summary

        This method signs URL for access to the server

        Throws

    • authRetrieveRules:function
      • authRetrieveRules(options?): AxiosPromise<void>

      • Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc