Class AuthApi

AuthApi - object-oriented interface

AuthApi

Hierarchy

  • BaseAPI
    • AuthApi

Constructors

  • Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns AuthApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

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

    AuthApi

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

    AuthApi

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

    AuthApi

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    AuthApi