Version: 1.0

KeycloakCrudService

This custom CRUD Service shows another potential way to add auth

This is actually quite nice and clean but it does not allow for field level auth. It's still a possibility that we could go with though!

Type parameters#

Type

Hierarchy#

  • GraphbackProxyService‹Type›

    KeycloakCrudService

Implements#

  • GraphbackCRUDService‹Type›

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

+ new KeycloakCrudService(model: ModelDefinition, __namedParameters: object): KeycloakCrudService

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:38

Parameters:

model: ModelDefinition

__namedParameters: object

NameType
authConfigCrudServiceAuthConfig
serviceGraphbackCRUDService‹any, any›

Returns: KeycloakCrudService

Properties#

Private authConfig#

authConfig: CrudServiceAuthConfig

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:37


Private model#

model: ModelDefinition

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:38


Protected proxiedService#

proxiedService: GraphbackCRUDService

Inherited from KeycloakCrudService.proxiedService

Defined in packages/graphback-core/types/runtime/GraphbackProxyService.d.ts:12

Methods#

batchLoadData#

batchLoadData(relationField: string, id: string | number, filter: QueryFilter, context: GraphbackContext, info?: GraphQLResolveInfo): any

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:160

Parameters:

NameType
relationFieldstring
idstring | number
filterQueryFilter
contextGraphbackContext
info?GraphQLResolveInfo

Returns: any


create#

create(data: Type, context?: GraphbackKeycloakContext, info?: GraphQLResolveInfo): Promise‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:46

Parameters:

NameType
dataType
context?GraphbackKeycloakContext
info?GraphQLResolveInfo

Returns: Promise‹Type›


delete#

delete(data: Type, context?: GraphbackKeycloakContext, info?: GraphQLResolveInfo): Promise‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:72

Parameters:

NameType
dataType
context?GraphbackKeycloakContext
info?GraphQLResolveInfo

Returns: Promise‹Type›


findBy#

findBy(args: FindByArgs, context?: GraphbackKeycloakContext | any, info?: GraphQLResolveInfo, path?: string): Promise‹ResultList‹Type››

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:101

Parameters:

NameType
argsFindByArgs
context?GraphbackKeycloakContext | any
info?GraphQLResolveInfo
path?string

Returns: Promise‹ResultList‹Type››


findOne#

findOne(args: any, context: GraphbackKeycloakContext, info?: GraphQLResolveInfo): Promise‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:83

Parameters:

NameType
argsany
contextGraphbackKeycloakContext
info?GraphQLResolveInfo

Returns: Promise‹Type›


subscribeToCreate#

subscribeToCreate(filter?: QueryFilter, context?: GraphbackKeycloakContext): AsyncIterator‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:127

Parameters:

NameType
filter?QueryFilter
context?GraphbackKeycloakContext

Returns: AsyncIterator‹Type›


subscribeToDelete#

subscribeToDelete(filter?: QueryFilter, context?: GraphbackContext): AsyncIterator‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:149

Parameters:

NameType
filter?QueryFilter
context?GraphbackContext

Returns: AsyncIterator‹Type›


subscribeToUpdate#

subscribeToUpdate(filter?: QueryFilter, context?: GraphbackContext): AsyncIterator‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:138

Parameters:

NameType
filter?QueryFilter
context?GraphbackContext

Returns: AsyncIterator‹Type›


update#

update(data: Type, context?: GraphbackKeycloakContext, info?: GraphQLResolveInfo): Promise‹Type›

Overrides void

Defined in packages/graphback-keycloak-authz/src/KeycloakCrudService.ts:59

Parameters:

NameType
dataType
context?GraphbackKeycloakContext
info?GraphQLResolveInfo

Returns: Promise‹Type›