Interface ISecurityStrategy

interface ISecurityStrategy {
    schemeTypes: string[];
    inject(ctx: SecurityInjectionContext): boolean;
    supportsAuthType(authType?: DynamicProviderAuthType): boolean;
}

Implemented by

Index

Properties

Methods

inject supportsAuthType

Properties

`Readonly`schemeTypes

schemeTypes: string[]

securityScheme "type" values this strategy handles, e.g. ['apiKey'] or ['oauth2', 'openIdConnect'].

Methods

inject

inject(ctx: SecurityInjectionContext): boolean
Attempts injection; returns true iff it wrote to headers/queryParams.
Parameters
- ctx: SecurityInjectionContext
Returns boolean
- Defined in services/security/security-strategy.interface.ts:18

supportsAuthType

supportsAuthType(authType?: DynamicProviderAuthType): boolean
Gate mirroring the authType compatibility check for this scheme/sub-scheme.
Parameters
- OptionalauthType: DynamicProviderAuthType
Returns boolean
- Defined in services/security/security-strategy.interface.ts:16