Function AuthApiFactory

Returns {
    authCreateLogin(
        requestParameters: AuthApiAuthCreateLoginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<Token>;
    authCreateLogout(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RestAuthDetail>;
    authCreatePasswordChange(
        requestParameters: AuthApiAuthCreatePasswordChangeRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RestAuthDetail>;
    authCreatePasswordReset(
        requestParameters: AuthApiAuthCreatePasswordResetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RestAuthDetail>;
    authCreatePasswordResetConfirm(
        requestParameters: AuthApiAuthCreatePasswordResetConfirmRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RestAuthDetail>;
    authCreateRegister(
        requestParameters: AuthApiAuthCreateRegisterRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RegisterSerializerEx>;
    authCreateSigning(
        requestParameters: AuthApiAuthCreateSigningRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<string>;
    authRetrieveRules(options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• authCreateLogin:function

  • authCreateLogin(
        requestParameters: AuthApiAuthCreateLoginRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: AuthApiAuthCreateLoginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Token>

    Throws

• authCreateLogout:function

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

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RestAuthDetail>

    Throws

• authCreatePasswordChange:function

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

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

    Parameters

    • requestParameters: AuthApiAuthCreatePasswordChangeRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RestAuthDetail>

    Throws

• authCreatePasswordReset:function

  • authCreatePasswordReset(
        requestParameters: AuthApiAuthCreatePasswordResetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RestAuthDetail>

    Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

    Parameters

    • requestParameters: AuthApiAuthCreatePasswordResetRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RestAuthDetail>

    Throws

• authCreatePasswordResetConfirm:function

  • authCreatePasswordResetConfirm(
        requestParameters: AuthApiAuthCreatePasswordResetConfirmRequest,
        options?: RawAxiosRequestConfig,
    ): 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

    • requestParameters: AuthApiAuthCreatePasswordResetConfirmRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RestAuthDetail>

    Throws

• authCreateRegister:function

  • authCreateRegister(
        requestParameters: AuthApiAuthCreateRegisterRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RegisterSerializerEx>

    Parameters

    • requestParameters: AuthApiAuthCreateRegisterRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RegisterSerializerEx>

    Throws

• authCreateSigning:function

  • authCreateSigning(
        requestParameters: AuthApiAuthCreateSigningRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<string>

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

    Parameters

    • requestParameters: AuthApiAuthCreateSigningRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<string>

    Throws

• authRetrieveRules:function

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws