Function AuthApiAxiosParamCreator

AuthApi - axios parameter creator

  • Parameters

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

    • authCreateLogin: (
          loginSerializerExRequest: LoginSerializerExRequest,
          options?: RawAxiosRequestConfig,
      ) => 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.

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

      Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

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

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

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

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

    • authCreatePasswordResetConfirm: (
          passwordResetConfirmRequest: PasswordResetConfirmRequest,
          options?: RawAxiosRequestConfig,
      ) => 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.

    • authCreateRegister: (
          registerSerializerExRequest: RegisterSerializerExRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • authCreateSigning: (
          signingRequest: SigningRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

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

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