Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KavenAuthentication Abstract

Hierarchy

Index

Constructors

  • Parameters

    • userName: string
    • password: string

    Returns KavenAuthentication

Properties

Name: string
Password: string
Realm: string = "Kaven Authentication"

A string to be displayed to users so they know which username and password to use.

This string should contain at least the name of the host performing the authentication and might additionally indicate the collection of users who might have access.

ResponseHeaderName: string = HttpStandardResponseHeader_WwwAuthenticate

WWW-Authenticate or Proxy-Authenticate

UserName: string

Accessors

  • get RequestHeaderName(): "Proxy-Authorization" | "Authorization"
  • Returns "Proxy-Authorization" | "Authorization"

  • get StatusCode(): Unauthorized | ProxyAuthenticationRequired
  • Returns Unauthorized | ProxyAuthenticationRequired

Methods

  • Parameters

    Returns Promise<boolean>

  • Parameters

    • message: string = "Authentication is required."
    • Optional statusCode: HttpStatusCode

    Returns HttpResponseMessage

Generated using TypeDoc