OpenVeo server API for plugins

API Docs for: 7.0.0
Show:

CasStrategy

Extends Strategy
Defined in: lib/passport/strategies/cas/CasStrategy.js:14
Module: passport

Summary

Defines a passport cas strategy to authenticate requests using a cas server.

Constructor

CasStrategy

Defined in lib/passport/strategies/cas/CasStrategy.js:14

Syntax

CasStrategy

(
  • options
  • verify
)

Summary

Parameters:

  • options Object

    The list of cas strategy options

    • service String

      The service to use to authenticate to the CAS server

    • version String

      The version of the CAS server

    • url String

      The url of the CAS server

    • certificate String

      The absolute path to the CAS server certificate

  • verify Function

    Function to call to validate user as returnd by CAS

Example:

e.g. Configuration example
// {
//   "service": "https://my-application-service-host", // Application service
//   "url": "https://my-cas-server-host:8443/cas", // CAS server url
//   "version": "3", // CAS protocol version (could be 1, 2, 3)
//   "certificate": "/home/test/cas.crt" // CAS full chain certificate
// }

Item Index

Methods

Properties

Methods

authenticate

Defined in lib/passport/strategies/cas/CasStrategy.js:128

Syntax

authenticate

(
  • request
  • options
)
async

Summary

Authenticates a request using cas.

Parameters:

  • request Object

    The express authenticate request

  • options Object

    Passport authenticate options such as redirects

logout

Defined in lib/passport/strategies/cas/CasStrategy.js:194

Syntax

logout

(
  • request
  • request
)

Summary

Logouts from cas.

Parameters:

  • request Object

    The express logout request

  • request Object

    The express response

Properties

cas

Defined in lib/passport/strategies/cas/CasStrategy.js:57

Syntax

cas

String final

Summary

Passport cas strategy name.

Default: "cas"

cas

Defined in lib/passport/strategies/cas/CasStrategy.js:91

Syntax

cas

CAS final

Summary

CAS client implementation.

logoutUri

Defined in lib/passport/strategies/cas/CasStrategy.js:113

Syntax

logoutUri

Function final

Summary

URI to return to after logging out.

service

Defined in lib/passport/strategies/cas/CasStrategy.js:69

Syntax

service

String final

Summary

Application service registered in CAS.

verify

Defined in lib/passport/strategies/cas/CasStrategy.js:102

Syntax

verify

Function final

Summary

Passport verify function to call to validate user returned by CAS.

version

Defined in lib/passport/strategies/cas/CasStrategy.js:80

Syntax

version

String final

Summary

CAS protocol version.