Skip to main content

Class: GroupAuthPlugin

Hierarchy​

  • AbstractAuthPlugin

    ↳ GroupAuthPlugin

Constructors​

constructor​

• new GroupAuthPlugin(config): GroupAuthPlugin

Parameters​

NameType
configGroupAuthConfig

Returns​

GroupAuthPlugin

Overrides​

AbstractAuthPlugin.constructor

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:39

Properties​

_internalConfig​

• Protected Readonly _internalConfig: AuthPluginInternalConfig

Overrides​

AbstractAuthPlugin._internalConfig

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:25


decorateRequestDefaults​

• decorateRequestDefaults: DecorateResponse

Overrides​

AbstractAuthPlugin.decorateRequestDefaults

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:104


decorateUserStatus​

• decorateUserStatus: DecorateUserStatus<GroupAuthUserStatus>

Overrides​

AbstractAuthPlugin.decorateUserStatus

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:114


groupAuthConfig​

• Protected Readonly groupAuthConfig: GroupAuthConfig

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:29


logger​

• Protected logger: undefined | Logger

Inherited from​

AbstractAuthPlugin.logger

Defined in​

server/dist/auth-plugins/abstract-auth-plugin.d.ts:22


DEBUG_ANY_APP​

▪ Static DEBUG_ANY_APP: string = "<ANY-APP>"

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:37


DEBUG_ANY_ORG​

▪ Static DEBUG_ANY_ORG: string = "<ANY-ORG>"

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:35


DEBUG_MATCHING_ORG​

▪ Static DEBUG_MATCHING_ORG: string = "<MATCHING-ORG>"

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:36

Accessors​

internalConfig​

• get internalConfig(): AuthPluginInternalConfig

Returns​

AuthPluginInternalConfig

Inherited from​

AbstractAuthPlugin.internalConfig

Defined in​

server/dist/auth-plugins/abstract-auth-plugin.d.ts:30

Methods​

exposedEndpoints​

▸ exposedEndpoints(): Object

Returns​

Object

NameType
check() => void

Overrides​

AbstractAuthPlugin.exposedEndpoints

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:636


groupAuth​

▸ groupAuth(): void

Returns​

void

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:640


groupCheck​

▸ groupCheck(): void

Returns​

void

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:644


isAuthorized​

▸ isAuthorized(connectorRequest): Promise<boolean>

Parameters​

NameType
connectorRequestConnectorRequest

Returns​

Promise<boolean>

Overrides​

AbstractAuthPlugin.isAuthorized

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:182


onPluginRegister​

▸ onPluginRegister(onRegisterConfig): Promise<undefined>

Parameters​

NameType
onRegisterConfigAuthPluginOnRegisterConfig

Returns​

Promise<undefined>

Overrides​

AbstractAuthPlugin.onPluginRegister

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:65


onRegister​

▸ onRegister(onRegisterConfig): Promise<undefined>

Do not override

Parameters​

NameType
onRegisterConfigAuthPluginOnRegisterConfig

Returns​

Promise<undefined>

Inherited from​

AbstractAuthPlugin.onRegister

Defined in​

server/dist/auth-plugins/abstract-auth-plugin.d.ts:28


groupAuthDebugToPrintable​

▸ groupAuthDebugToPrintable(groupAuthDebug): GroupAuthDebugPrintable

Parameters​

NameType
groupAuthDebugGroupAuthDebug

Returns​

GroupAuthDebugPrintable

Defined in​

group-auth-plugin/src/group-auth-plugin.ts:648