Skip to main content

@webda/hawkReadme | API


Class: HawkServiceParameters

Extends

  • ServiceParameters

Constructors

new HawkServiceParameters(params)

new HawkServiceParameters(params): HawkServiceParameters

Parameters

params: any

Returns

HawkServiceParameters

Overrides

ServiceParameters.constructor

Inherit Doc

Source

hawk/src/hawk.ts:57

Properties

dynamicSessionKey?

dynamicSessionKey?: string

If specified will verify the signature match the key store in session

Source

hawk/src/hawk.ts:43


keysStore?

keysStore?: string

Key store name

Default

'apikeys'

Source

hawk/src/hawk.ts:39


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

ServiceParameters.openapi

Source

core/lib/services/service.d.ts:104


redirectUris?

redirectUris?: string[]

Allowed redirection with CSRF

Source

hawk/src/hawk.ts:52


redirectUrl?

redirectUrl?: string

redirect endpoint

Param

Source

hawk/src/hawk.ts:48


type

type: string

Type of the service

Inherited from

ServiceParameters.type

Source

core/lib/services/service.d.ts:95


url?

url?: string

URL on which to serve the content

Inherited from

ServiceParameters.url

Source

core/lib/services/service.d.ts:99