Function AuthApiFp

Returns {
    authCreateLogin(
        loginSerializerExRequest: LoginSerializerExRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Token>,
    >;
    authCreateLogout(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RestAuthDetail>,
    >;
    authCreatePasswordChange(
        passwordChangeRequest: PasswordChangeRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RestAuthDetail>,
    >;
    authCreatePasswordReset(
        passwordResetSerializerExRequest: PasswordResetSerializerExRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RestAuthDetail>,
    >;
    authCreatePasswordResetConfirm(
        passwordResetConfirmRequest: PasswordResetConfirmRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RestAuthDetail>,
    >;
    authCreateRegister(
        registerSerializerExRequest: RegisterSerializerExRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<RegisterSerializerEx>,
    >;
    authCreateSigning(
        signingRequest: SigningRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    authRetrieveRules(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• authCreateLogin:function

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

      Override http request option.

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

    Throws

• authCreateLogout:function

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

    Throws

• authCreatePasswordChange:function

  • authCreatePasswordChange(
        passwordChangeRequest: PasswordChangeRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• authCreatePasswordReset:function

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

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

    Parameters

    • passwordResetSerializerExRequest: PasswordResetSerializerExRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• authCreatePasswordResetConfirm:function

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

      Override http request option.

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

    Throws

• authCreateRegister:function

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

    Parameters

    • registerSerializerExRequest: RegisterSerializerExRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• authCreateSigning:function

  • authCreateSigning(
        signingRequest: SigningRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => 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
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

    Throws

• authRetrieveRules:function

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws