Function AuthApiFp

Returns {
    authCreateLogin(loginSerializerExRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<Token>)>;
    authCreateLogout(options?) => Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>;
    authCreatePasswordChange(passwordChangeRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>;
    authCreatePasswordReset(passwordResetSerializerExRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>;
    authCreatePasswordResetConfirm(passwordResetConfirmRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>;
    authCreateRegister(registerSerializerExRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<RegisterSerializerEx>)>;
    authCreateSigning(signingRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<string>)>;
    authRetrieveRules(options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• authCreateLogin:function

  • authCreateLogin(loginSerializerExRequest, options?): Promise<((axios?, basePath?) => 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

    • loginSerializerExRequest: LoginSerializerExRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Token>)>

    Throws

• authCreateLogout:function

  • authCreateLogout(options?): Promise<((axios?, basePath?) => 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 Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>

    Throws

• authCreatePasswordChange:function

  • authCreatePasswordChange(passwordChangeRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>

  • 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<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>

    Throws

• authCreatePasswordReset:function

  • authCreatePasswordReset(passwordResetSerializerExRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>

  • 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<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>

    Throws

• authCreatePasswordResetConfirm:function

  • authCreatePasswordResetConfirm(passwordResetConfirmRequest, options?): Promise<((axios?, basePath?) => 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

    • passwordResetConfirmRequest: PasswordResetConfirmRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RestAuthDetail>)>

    Throws

• authCreateRegister:function

  • authCreateRegister(registerSerializerExRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<RegisterSerializerEx>)>

  • Parameters

    • registerSerializerExRequest: RegisterSerializerExRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RegisterSerializerEx>)>

    Throws

• authCreateSigning:function

  • authCreateSigning(signingRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<string>)>

  • 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<((axios?, basePath?) => AxiosPromise<string>)>

    Summary

    This method signs URL for access to the server

    Throws

• authRetrieveRules:function

  • authRetrieveRules(options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Throws