Class AuthApi

AuthApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • AuthApi

Constructors

constructor

Properties

axios basePath configuration

Methods

authCreateLogin authCreateLogout authCreatePasswordChange authCreatePasswordReset authCreatePasswordResetConfirm authCreateRegister authCreateSigning authRetrieveRules

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns AuthApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

authCreateLogin

  • 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 Promise<AxiosResponse<Token, any>>

    Throws

    Memberof

    AuthApi

authCreateLogout

  • 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<AxiosResponse<RestAuthDetail, any>>

    Throws

    Memberof

    AuthApi

authCreatePasswordChange

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

    Parameters

    Returns Promise<AxiosResponse<RestAuthDetail, any>>

    Throws

    Memberof

    AuthApi

authCreatePasswordReset

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

    Parameters

    Returns Promise<AxiosResponse<RestAuthDetail, any>>

    Throws

    Memberof

    AuthApi

authCreatePasswordResetConfirm

  • 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 Promise<AxiosResponse<RestAuthDetail, any>>

    Throws

    Memberof

    AuthApi

authCreateRegister

authCreateSigning

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

    Parameters

    Returns Promise<AxiosResponse<string, any>>

    Summary

    This method signs URL for access to the server

    Throws

    Memberof

    AuthApi

authRetrieveRules

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    Memberof

    AuthApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc