OpenVeo server API for plugins

API Docs for: 7.0.0
Show:

CAS1

Extends CAS
Module: passport

Summary

Defines a cas client interfacing with cas protocol 1.0.

Constructor

CAS1

Syntax

CAS1

()

Summary

Methods

analyzeValidateTicketResponse

Syntax

analyzeValidateTicketResponse

(
  • response
  • callback
)
async

Summary

Analyzes the validate ticket response from cas server.

Parameters:

  • response String

    Validate ticket response from cas server

  • callback Function

    Function to call when analyzed with :

    • Error An error if authentication failed or something went wrong, null otherwise
    • String Success response content

getLoginUri

Syntax

getLoginUri

() String

Summary

Gets login uri.

Returns:

String:

The login uri

getLogoutUri

Syntax

getLogoutUri

() String

Summary

Gets logout uri.

Returns:

String:

The logout uri

getUrl

Syntax

getUrl

() String

Summary

Gets cas server url.

Returns:

String:

Cas server url

getValidateUri

Inherited from CAS but overwritten in lib/passport/strategies/cas/CAS1.js:18

Syntax

getValidateUri

() String

Summary

Gets validate uri.

Returns:

String:

The validate uri

validateTicket

Syntax

validateTicket

(
  • service
  • ticket
)
Promise async

Summary

Validates a ticket using cas.

Parameters:

  • service String

    Cas registered service

  • ticket String

    Ticket to validate

Returns:

Promise:

Promise resolving with cas user information (name and attributes)

Properties

certificate

Syntax

certificate

String final

Summary

Cas server certificate's public key.

host

Syntax

host

String final

Summary

CAS server host.

httpClient

Syntax

httpClient

Object final

Summary

Either the http or https client of NodeJS.

loginUri

Syntax

loginUri

String final

Summary

CAS server login uri.

path

Syntax

path

String final

Summary

CAS server uri (usally /cas).

port

Syntax

port

Number final

Summary

CAS server port.

protocol

Syntax

protocol

String final

Summary

CAS server protocol, either http or https.

url

Syntax

url

String final

Summary

CAS server url.

validateUri

Syntax

validateUri

String final

Summary

CAS server validate uri.