Function AuthApiAxiosParamCreator

Returns {
    authCreateLogin: ((loginSerializerExRequest, options?) => Promise<RequestArgs>);
    authCreateLogout: ((options?) => Promise<RequestArgs>);
    authCreatePasswordChange: ((passwordChangeRequest, options?) => Promise<RequestArgs>);
    authCreatePasswordReset: ((passwordResetSerializerExRequest, options?) => Promise<RequestArgs>);
    authCreatePasswordResetConfirm: ((passwordResetConfirmRequest, options?) => Promise<RequestArgs>);
    authCreateRegister: ((registerSerializerExRequest, options?) => Promise<RequestArgs>);
    authCreateSigning: ((signingRequest, options?) => Promise<RequestArgs>);
    authRetrieveRules: ((options?) => Promise<RequestArgs>);
}

• authCreateLogin: ((loginSerializerExRequest, options?) => Promise<RequestArgs>)

  • • (loginSerializerExRequest, options?): Promise<RequestArgs>

    • 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

      • loginSerializerExRequest: LoginSerializerExRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Throws

• authCreateLogout: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • 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 Promise<RequestArgs>

      Throws

• authCreatePasswordChange: ((passwordChangeRequest, options?) => Promise<RequestArgs>)

  • • (passwordChangeRequest, options?): Promise<RequestArgs>

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

      Parameters

      • passwordChangeRequest: PasswordChangeRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Throws

• authCreatePasswordReset: ((passwordResetSerializerExRequest, options?) => Promise<RequestArgs>)

  • • (passwordResetSerializerExRequest, options?): Promise<RequestArgs>

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

      Parameters

      • passwordResetSerializerExRequest: PasswordResetSerializerExRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Throws

• authCreatePasswordResetConfirm: ((passwordResetConfirmRequest, options?) => Promise<RequestArgs>)

  • • (passwordResetConfirmRequest, options?): Promise<RequestArgs>

    • 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

      • passwordResetConfirmRequest: PasswordResetConfirmRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Throws

• authCreateRegister: ((registerSerializerExRequest, options?) => Promise<RequestArgs>)

  • • (registerSerializerExRequest, options?): Promise<RequestArgs>

    • Parameters

      • registerSerializerExRequest: RegisterSerializerExRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Throws

• authCreateSigning: ((signingRequest, options?) => Promise<RequestArgs>)

  • • (signingRequest, options?): Promise<RequestArgs>

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

      Parameters

      • signingRequest: SigningRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      This method signs URL for access to the server

      Throws

• authRetrieveRules: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Throws