Class GroupService<T, S>

Type Parameters

T extends default<S>
S extends ProviderGroupDetails = KeycloakGroupRepresentation

Hierarchy (View Summary)

GenericEntityService<T>
- GroupService

Index

Constructors

Properties

basePath keycloak?

Methods

add createAllFromProvider delete deleteGroupClassPermission deleteGroupClassPermissions deleteGroupInstancePermission deleteGroupInstancePermissions deleteRoleClassPermission deleteRoleClassPermissions deleteRoleInstancePermission deleteRoleInstancePermissions deleteUserClassPermission deleteUserClassPermissions deleteUserInstancePermission deleteUserInstancePermissions findAll findAllNoPaging findOne getBasePath getGroupClassPermission getGroupClassPermissions getGroupInstancePermission getGroupInstancePermissions getPageUrl getRoleClassPermission getRoleClassPermissions getRoleInstancePermission getRoleInstancePermissions getUserClassPermission getUserClassPermissions getUserInstancePermission getUserInstancePermissions isPublic revokePublic setGroupClassPermission setGroupInstancePermission setPublic setRoleClassPermission setRoleInstancePermission setUserClassPermission setUserInstancePermission update updatePartial

Constructors

constructor

new GroupService<
    T extends default<S>,
    S extends ProviderGroupDetails = KeycloakGroupRepresentation,
>(
    opts?: GenericServiceOpts,
): GroupService<T, S>
Type Parameters
- T extends default<S>
- S extends ProviderGroupDetails = KeycloakGroupRepresentation
Parameters
- opts: GenericServiceOpts = ...
Returns GroupService<T, S>
Overrides GenericEntityService.constructor
- Defined in service/GroupService/index.ts:8

Properties

`Protected` `Readonly`basePath

basePath: string

`Protected` `Optional` `Readonly`keycloak

keycloak?: Keycloak

Methods

add

add(t: T, fetchOpts?: RequestInit): Promise<T>
Parameters
- t: T
- OptionalfetchOpts: RequestInit
Returns Promise<T>
Inherited from GenericEntityService.add
- Defined in service/GenericEntityService/index.ts:90

createAllFromProvider

createAllFromProvider(fetchOpts?: RequestInit): Promise<void>
Parameters
- OptionalfetchOpts: RequestInit
Returns Promise<void>
- Defined in service/GroupService/index.ts:14

delete

delete(id: string | number, fetchOpts?: RequestInit): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.delete
- Defined in service/GenericEntityService/index.ts:161

deleteGroupClassPermission

deleteGroupClassPermission(
    id: string | number,
    groupId: string | number,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- groupId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteGroupClassPermission
- Defined in service/PermissionService/index.ts:490

deleteGroupClassPermissions

deleteGroupClassPermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteGroupClassPermissions
- Defined in service/PermissionService/index.ts:606

deleteGroupInstancePermission

deleteGroupInstancePermission(
    id: string | number,
    groupId: string | number,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- groupId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteGroupInstancePermission
- Defined in service/PermissionService/index.ts:430

deleteGroupInstancePermissions

deleteGroupInstancePermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteGroupInstancePermissions
- Defined in service/PermissionService/index.ts:549

deleteRoleClassPermission

deleteRoleClassPermission(
    id: string | number,
    roleId: string | number,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- roleId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteRoleClassPermission
- Defined in service/PermissionService/index.ts:510

deleteRoleClassPermissions

deleteRoleClassPermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteRoleClassPermissions
- Defined in service/PermissionService/index.ts:625

deleteRoleInstancePermission

deleteRoleInstancePermission(
    id: string | number,
    roleId: string | number,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- roleId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteRoleInstancePermission
- Defined in service/PermissionService/index.ts:450

deleteRoleInstancePermissions

deleteRoleInstancePermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteRoleInstancePermissions
- Defined in service/PermissionService/index.ts:568

deleteUserClassPermission

deleteUserClassPermission(
    id: string | number,
    userId: string | number,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- userId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteUserClassPermission
- Defined in service/PermissionService/index.ts:470

deleteUserClassPermissions

deleteUserClassPermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteUserClassPermissions
- Defined in service/PermissionService/index.ts:587

deleteUserInstancePermission

deleteUserInstancePermission(
    id: string | number,
    userId: string | number,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- userId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteUserInstancePermission
- Defined in service/PermissionService/index.ts:410

deleteUserInstancePermissions

deleteUserInstancePermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.deleteUserInstancePermissions
- Defined in service/PermissionService/index.ts:530

findAll

findAll(pageOpts?: PageOpts, fetchOpts?: RequestInit): Promise<Page<T>>
Parameters
- OptionalpageOpts: PageOpts
- OptionalfetchOpts: RequestInit
Returns Promise<Page<T>>
Inherited from GenericEntityService.findAll
- Defined in service/GenericEntityService/index.ts:50

findAllNoPaging

findAllNoPaging(fetchOpts?: RequestInit): Promise<T[]>
Parameters
- OptionalfetchOpts: RequestInit
Returns Promise<T[]>
Inherited from GenericEntityService.findAllNoPaging
- Defined in service/GenericEntityService/index.ts:16

findOne

findOne(id: string | number, fetchOpts?: RequestInit): Promise<T>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<T>
Inherited from GenericEntityService.findOne
- Defined in service/GenericEntityService/index.ts:70

getBasePath

getBasePath(): string
Returns string
Inherited from GenericEntityService.getBasePath
- Defined in service/GenericEntityService/index.ts:179

getGroupClassPermission

getGroupClassPermission(
    id: string | number,
    groupId: string | number,
    fetchOpts?: RequestInit,
): Promise<UserClassPermission>
Parameters
- id: string | number
- groupId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<UserClassPermission>
Inherited from GenericEntityService.getGroupClassPermission
- Defined in service/PermissionService/index.ts:224

getGroupClassPermissions

getGroupClassPermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<GroupClassPermission[]>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<GroupClassPermission[]>
Inherited from GenericEntityService.getGroupClassPermissions
- Defined in service/PermissionService/index.ts:100

getGroupInstancePermission

getGroupInstancePermission(
    id: string | number,
    groupId: string | number,
    fetchOpts?: RequestInit,
): Promise<UserInstancePermission>
Parameters
- id: string | number
- groupId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<UserInstancePermission>
Inherited from GenericEntityService.getGroupInstancePermission
- Defined in service/PermissionService/index.ts:161

getGroupInstancePermissions

getGroupInstancePermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<GroupInstancePermission[]>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<GroupInstancePermission[]>
Inherited from GenericEntityService.getGroupInstancePermissions
- Defined in service/PermissionService/index.ts:40

`Protected`getPageUrl

getPageUrl(pageOpts?: PageOpts): string
Parameters
- OptionalpageOpts: PageOpts
Returns string
Inherited from GenericEntityService.getPageUrl
- Defined in service/GenericService/index.ts:31

getRoleClassPermission

getRoleClassPermission(
    id: string | number,
    roleId: string | number,
    fetchOpts?: RequestInit,
): Promise<RoleClassPermission>
Parameters
- id: string | number
- roleId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<RoleClassPermission>
Inherited from GenericEntityService.getRoleClassPermission
- Defined in service/PermissionService/index.ts:245

getRoleClassPermissions

getRoleClassPermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<RoleClassPermission[]>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<RoleClassPermission[]>
Inherited from GenericEntityService.getRoleClassPermissions
- Defined in service/PermissionService/index.ts:120

getRoleInstancePermission

getRoleInstancePermission(
    id: string | number,
    roleId: string | number,
    fetchOpts?: RequestInit,
): Promise<RoleInstancePermission>
Parameters
- id: string | number
- roleId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<RoleInstancePermission>
Inherited from GenericEntityService.getRoleInstancePermission
- Defined in service/PermissionService/index.ts:182

getRoleInstancePermissions

getRoleInstancePermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<RoleInstancePermission[]>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<RoleInstancePermission[]>
Inherited from GenericEntityService.getRoleInstancePermissions
- Defined in service/PermissionService/index.ts:60

getUserClassPermission

getUserClassPermission(
    id: string | number,
    userId: string | number,
    fetchOpts?: RequestInit,
): Promise<UserClassPermission>
Parameters
- id: string | number
- userId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<UserClassPermission>
Inherited from GenericEntityService.getUserClassPermission
- Defined in service/PermissionService/index.ts:203

getUserClassPermissions

getUserClassPermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<UserClassPermission[]>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<UserClassPermission[]>
Inherited from GenericEntityService.getUserClassPermissions
- Defined in service/PermissionService/index.ts:80

getUserInstancePermission

getUserInstancePermission(
    id: string | number,
    userId: string | number,
    fetchOpts?: RequestInit,
): Promise<UserInstancePermission>
Parameters
- id: string | number
- userId: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<UserInstancePermission>
Inherited from GenericEntityService.getUserInstancePermission
- Defined in service/PermissionService/index.ts:140

getUserInstancePermissions

getUserInstancePermissions(
id: string | number,
fetchOpts?: RequestInit,
): Promise<UserInstancePermission[]>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<UserInstancePermission[]>
Inherited from GenericEntityService.getUserInstancePermissions
- Defined in service/PermissionService/index.ts:20

isPublic

isPublic(id: string | number, fetchOpts?: RequestInit): Promise<boolean>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<boolean>
Inherited from GenericEntityService.isPublic
- Defined in service/PermissionService/index.ts:644

revokePublic

revokePublic(id: string | number, fetchOpts?: RequestInit): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.revokePublic
- Defined in service/PermissionService/index.ts:678

setGroupClassPermission

setGroupClassPermission(
    id: string | number,
    groupId: string | number,
    permissionType: PermissionCollectionType,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- groupId: string | number
- permissionType: PermissionCollectionType
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setGroupClassPermission
- Defined in service/PermissionService/index.ts:362

setGroupInstancePermission

setGroupInstancePermission(
    id: string | number,
    groupId: string | number,
    permissionType: PermissionCollectionType,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- groupId: string | number
- permissionType: PermissionCollectionType
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setGroupInstancePermission
- Defined in service/PermissionService/index.ts:290

setPublic

setPublic(id: string | number, fetchOpts?: RequestInit): Promise<void>
Parameters
- id: string | number
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setPublic
- Defined in service/PermissionService/index.ts:660

setRoleClassPermission

setRoleClassPermission(
    id: string | number,
    roleId: string | number,
    permissionType: PermissionCollectionType,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- roleId: string | number
- permissionType: PermissionCollectionType
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setRoleClassPermission
- Defined in service/PermissionService/index.ts:386

setRoleInstancePermission

setRoleInstancePermission(
    id: string | number,
    roleId: string | number,
    permissionType: PermissionCollectionType,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- roleId: string | number
- permissionType: PermissionCollectionType
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setRoleInstancePermission
- Defined in service/PermissionService/index.ts:314

setUserClassPermission

setUserClassPermission(
    id: string | number,
    userId: string | number,
    permissionType: PermissionCollectionType,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- userId: string | number
- permissionType: PermissionCollectionType
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setUserClassPermission
- Defined in service/PermissionService/index.ts:338

setUserInstancePermission

setUserInstancePermission(
    id: string | number,
    userId: string | number,
    permissionType: PermissionCollectionType,
    fetchOpts?: RequestInit,
): Promise<void>
Parameters
- id: string | number
- userId: string | number
- permissionType: PermissionCollectionType
- OptionalfetchOpts: RequestInit
Returns Promise<void>
Inherited from GenericEntityService.setUserInstancePermission
- Defined in service/PermissionService/index.ts:266

update

update(t: T, fetchOpts?: RequestInit): Promise<T>
Parameters
- t: T
- OptionalfetchOpts: RequestInit
Returns Promise<T>
Inherited from GenericEntityService.update
- Defined in service/GenericEntityService/index.ts:115

updatePartial

updatePartial(t: Partial<T>, fetchOpts?: RequestInit): Promise<T>
Parameters
- t: Partial<T>
- OptionalfetchOpts: RequestInit
Returns Promise<T>
Inherited from GenericEntityService.updatePartial
- Defined in service/GenericEntityService/index.ts:138