LogoRobo.js
Packages@robojs/mock

ApiKeyAuthProvider

Class: ApiKeyAuthProvider

API key-based auth provider stub To be implemented for hosted deployment

Implements

Constructors

new ApiKeyAuthProvider()

new ApiKeyAuthProvider(options?): ApiKeyAuthProvider

Parameters

ParameterType
options?{ apiKeyHeader: string; }
options.apiKeyHeader?string

Returns

ApiKeyAuthProvider

Methods

onSessionCreated()

onSessionCreated(_session, _auth): Promise<void>

Parameters

ParameterType
_sessionISession
_authAuthResult

Returns

Promise<void>

Implementation of

AuthProvider.onSessionCreated


onSessionEnded()

onSessionEnded(_session, _auth): Promise<void>

Parameters

ParameterType
_sessionISession
_authAuthResult

Returns

Promise<void>

Implementation of

AuthProvider.onSessionEnded


validateRequest()

validateRequest(req): Promise<AuthResult>

Parameters

ParameterType
reqRequest

Returns

Promise<AuthResult>

Implementation of

AuthProvider.validateRequest

On this page