Class Strategy

Hierarchy

Strategy
- Strategy
  - MultiSamlStrategy

Implements

Strategy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Strategy(verify: VerifyCallback | VerifyCallbackWithRequest): Strategy
new Strategy(options: SAMLOptions, verify: VerifyCallback | VerifyCallbackWithRequest): Strategy

- Defined in src/passport-saml/strategy.ts:17
Parameters
- verify: VerifyCallback | VerifyCallbackWithRequest
Returns Strategy
- Defined in src/passport-saml/strategy.ts:19
Parameters
- options: SAMLOptions
- verify: VerifyCallback | VerifyCallbackWithRequest
Returns Strategy

Properties

_authnRequestBinding

_authnRequestBinding: string

_passReqToCallback

_passReqToCallback: boolean

_saml

_saml: SAML

_verify

_verify: VerifyCallback | VerifyCallbackWithRequest

error

error: (err: Error) => void

Type declaration

- (err: Error): void
- Parameters
  - err: Error
  Returns void

fail

fail: (info?: any) => void

Type declaration

- (info?: any): void
- Parameters
  - Optional info: any
  Returns void

name

name: string

pass

pass: () => void

Type declaration

- (): void
- Returns void

redirect

redirect: (url: string) => void

Type declaration

- (url: string): void
- Parameters
  - url: string
  Returns void

success

success: (user: saml.Profile, info: any) => void

Type declaration

- (user: saml.Profile, info: any): void
- Parameters
  - user: saml.Profile
  - info: any
  Returns void

Methods

authenticate

authenticate(req: express.Request, options: AuthenticateOptions): void

Overrides Strategy.authenticate
- Defined in src/passport-saml/strategy.ts:57
Parameters
- req: express.Request
- options: AuthenticateOptions
Returns void

generateServiceProviderMetadata

generateServiceProviderMetadata(decryptionCert: string | null, signingCert: string, options: { _saml: SAML }): string

- Defined in src/passport-saml/strategy.ts:52
Parameters
- decryptionCert: string | null
- signingCert: string
- options: { _saml: SAML }
  - _saml: SAML
Returns string

logout

logout(req: RequestWithUser, callback: (err: Error | null) => null, options: { _saml: SAML }): void

- Defined in src/passport-saml/strategy.ts:47
Parameters
- req: RequestWithUser
- callback: (err: Error | null) => null
  - - (err: Error | null): null
    - Parameters
      - err: Error | null
      Returns null
- options: { _saml: SAML }
  - _saml: SAML
Returns void

Generated using TypeDoc