Class CAS

constructor

• new CAS(lemonldap: string): CAS

  Parameters

  • lemonldap: string

    An authenticated session cookie.

  Returns CAS

Readonlylemonldap

Static ReadonlyCOOKIE

Static ReadonlyHOST

authorize

• authorize(client: OAuth2, challenge?: boolean, state?: string): Promise<URL>

  Authorize an user through /oauth2 route.

  Parameters

  • client: OAuth2
  • challenge: boolean = false
  • state: string = ""

  Returns Promise<URL>

  callback URL with authentication details

service

• service(service: Services): Promise<URL>

  Authenticates to a given service using the CAS as SSO. Most of the time it'll generate a ticket URL.

  Parameters

  • service: Services

    service to authenticate to through CAS

  Returns Promise<URL>

  an authenticated url to said service

tokenize

• tokenize(callback: URL, client: OAuth2, challenge?: boolean): Promise<Tokens>

  Retrieves CAS tokens using the authorized OAuth2.0 callback URL.

  Parameters

  • callback: URL

    url created with authorize method

  • client: OAuth2

    oauth2 linked to the url

  • challenge: boolean = false

  Returns Promise<Tokens>

userinfo

• userinfo(tokens: Tokens): Promise<User>

  Retrieves user information from the CAS.

  Parameters

  • tokens: Tokens

    oauth2 tokens received in tokenize

  Returns Promise<User>

  user details from CAS

Staticinitialize

• initialize(username: string, password: string): Promise<CAS>

  Authenticates through the CAS with the given username and password.

  Parameters

  • username: string
  • password: string

  Returns Promise<CAS>