kaven-utils - v5.5.1
    Preparing search index...

    Class KavenAuthenticationAbstract

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    Name Password Realm Records ResponseHeaderName UserName

    Accessors

    RequestHeaderName StatusCode

    Methods

    AddRecord Authenticate CanAuthenticate GetResponse Update

    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.

    Records: undefined | KavenAuthorizationRecords

    4.3.6

    2022-09-20

    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

      • key: string
      • success: boolean

      Returns void

    • Parameters

      • key: string

      Returns boolean

    • Parameters

      • message: string = "Authentication is required."
      • OptionalstatusCode: HttpStatusCode

      Returns HttpResponseMessage

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods