Preparing search index...
The search index is not available
@terrestris/shogun-util
@terrestris/shogun-util
service/GroupService
GroupService
Class GroupService<T, S>
Type Parameters
T
extends
default
<
S
>
S
extends
ProviderGroupDetails
=
KeycloakGroupRepresentation
Hierarchy (
View Summary
)
GenericEntityService
<
T
>
GroupService
Index
Constructors
constructor
Properties
base
Path
keycloak?
Methods
add
create
All
From
Provider
delete
delete
Group
Class
Permission
delete
Group
Class
Permissions
delete
Group
Instance
Permission
delete
Group
Instance
Permissions
delete
Role
Class
Permission
delete
Role
Class
Permissions
delete
Role
Instance
Permission
delete
Role
Instance
Permissions
delete
User
Class
Permission
delete
User
Class
Permissions
delete
User
Instance
Permission
delete
User
Instance
Permissions
find
All
find
All
No
Paging
find
One
get
Base
Path
get
Group
Class
Permission
get
Group
Class
Permissions
get
Group
Instance
Permission
get
Group
Instance
Permissions
get
Page
Url
get
Role
Class
Permission
get
Role
Class
Permissions
get
Role
Instance
Permission
get
Role
Instance
Permissions
get
User
Class
Permission
get
User
Class
Permissions
get
User
Instance
Permission
get
User
Instance
Permissions
is
Public
revoke
Public
set
Group
Class
Permission
set
Group
Instance
Permission
set
Public
set
Role
Class
Permission
set
Role
Instance
Permission
set
User
Class
Permission
set
User
Instance
Permission
update
update
Partial
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
>
Properties
Protected
Readonly
base
Path
basePath
:
string
Protected
Optional
Readonly
keycloak
keycloak
?:
Keycloak
Methods
add
add
(
t
:
T
,
fetchOpts
?:
RequestInit
)
:
Promise
<
T
>
Parameters
t
:
T
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
T
>
create
All
From
Provider
createAllFromProvider
(
fetchOpts
?:
RequestInit
)
:
Promise
<
void
>
Parameters
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
delete
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Group
Class
Permission
deleteGroupClassPermission
(
id
:
string
|
number
,
groupId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
groupId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Group
Class
Permissions
deleteGroupClassPermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Group
Instance
Permission
deleteGroupInstancePermission
(
id
:
string
|
number
,
groupId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
groupId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Group
Instance
Permissions
deleteGroupInstancePermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Role
Class
Permission
deleteRoleClassPermission
(
id
:
string
|
number
,
roleId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
roleId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Role
Class
Permissions
deleteRoleClassPermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Role
Instance
Permission
deleteRoleInstancePermission
(
id
:
string
|
number
,
roleId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
roleId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
Role
Instance
Permissions
deleteRoleInstancePermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
User
Class
Permission
deleteUserClassPermission
(
id
:
string
|
number
,
userId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
userId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
User
Class
Permissions
deleteUserClassPermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
User
Instance
Permission
deleteUserInstancePermission
(
id
:
string
|
number
,
userId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
userId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
delete
User
Instance
Permissions
deleteUserInstancePermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
find
All
findAll
(
pageOpts
?:
PageOpts
,
fetchOpts
?:
RequestInit
)
:
Promise
<
Page
<
T
>
>
Parameters
Optional
pageOpts
:
PageOpts
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
Page
<
T
>
>
find
All
No
Paging
findAllNoPaging
(
fetchOpts
?:
RequestInit
)
:
Promise
<
T
[]
>
Parameters
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
T
[]
>
find
One
findOne
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
)
:
Promise
<
T
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
T
>
get
Base
Path
getBasePath
()
:
string
Returns
string
get
Group
Class
Permission
getGroupClassPermission
(
id
:
string
|
number
,
groupId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
UserClassPermission
>
Parameters
id
:
string
|
number
groupId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
UserClassPermission
>
get
Group
Class
Permissions
getGroupClassPermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
GroupClassPermission
[]
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
GroupClassPermission
[]
>
get
Group
Instance
Permission
getGroupInstancePermission
(
id
:
string
|
number
,
groupId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
UserInstancePermission
>
Parameters
id
:
string
|
number
groupId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
UserInstancePermission
>
get
Group
Instance
Permissions
getGroupInstancePermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
GroupInstancePermission
[]
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
GroupInstancePermission
[]
>
Protected
get
Page
Url
getPageUrl
(
pageOpts
?:
PageOpts
)
:
string
Parameters
Optional
pageOpts
:
PageOpts
Returns
string
get
Role
Class
Permission
getRoleClassPermission
(
id
:
string
|
number
,
roleId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
RoleClassPermission
>
Parameters
id
:
string
|
number
roleId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
RoleClassPermission
>
get
Role
Class
Permissions
getRoleClassPermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
RoleClassPermission
[]
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
RoleClassPermission
[]
>
get
Role
Instance
Permission
getRoleInstancePermission
(
id
:
string
|
number
,
roleId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
RoleInstancePermission
>
Parameters
id
:
string
|
number
roleId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
RoleInstancePermission
>
get
Role
Instance
Permissions
getRoleInstancePermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
RoleInstancePermission
[]
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
RoleInstancePermission
[]
>
get
User
Class
Permission
getUserClassPermission
(
id
:
string
|
number
,
userId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
UserClassPermission
>
Parameters
id
:
string
|
number
userId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
UserClassPermission
>
get
User
Class
Permissions
getUserClassPermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
UserClassPermission
[]
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
UserClassPermission
[]
>
get
User
Instance
Permission
getUserInstancePermission
(
id
:
string
|
number
,
userId
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
UserInstancePermission
>
Parameters
id
:
string
|
number
userId
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
UserInstancePermission
>
get
User
Instance
Permissions
getUserInstancePermissions
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
UserInstancePermission
[]
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
UserInstancePermission
[]
>
is
Public
isPublic
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
)
:
Promise
<
boolean
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
boolean
>
revoke
Public
revokePublic
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
Group
Class
Permission
setGroupClassPermission
(
id
:
string
|
number
,
groupId
:
string
|
number
,
permissionType
:
PermissionCollectionType
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
groupId
:
string
|
number
permissionType
:
PermissionCollectionType
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
Group
Instance
Permission
setGroupInstancePermission
(
id
:
string
|
number
,
groupId
:
string
|
number
,
permissionType
:
PermissionCollectionType
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
groupId
:
string
|
number
permissionType
:
PermissionCollectionType
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
Public
setPublic
(
id
:
string
|
number
,
fetchOpts
?:
RequestInit
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
Role
Class
Permission
setRoleClassPermission
(
id
:
string
|
number
,
roleId
:
string
|
number
,
permissionType
:
PermissionCollectionType
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
roleId
:
string
|
number
permissionType
:
PermissionCollectionType
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
Role
Instance
Permission
setRoleInstancePermission
(
id
:
string
|
number
,
roleId
:
string
|
number
,
permissionType
:
PermissionCollectionType
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
roleId
:
string
|
number
permissionType
:
PermissionCollectionType
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
User
Class
Permission
setUserClassPermission
(
id
:
string
|
number
,
userId
:
string
|
number
,
permissionType
:
PermissionCollectionType
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
userId
:
string
|
number
permissionType
:
PermissionCollectionType
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
set
User
Instance
Permission
setUserInstancePermission
(
id
:
string
|
number
,
userId
:
string
|
number
,
permissionType
:
PermissionCollectionType
,
fetchOpts
?:
RequestInit
,
)
:
Promise
<
void
>
Parameters
id
:
string
|
number
userId
:
string
|
number
permissionType
:
PermissionCollectionType
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
void
>
update
update
(
t
:
T
,
fetchOpts
?:
RequestInit
)
:
Promise
<
T
>
Parameters
t
:
T
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
T
>
update
Partial
updatePartial
(
t
:
Partial
<
T
>
,
fetchOpts
?:
RequestInit
)
:
Promise
<
T
>
Parameters
t
:
Partial
<
T
>
Optional
fetchOpts
:
RequestInit
Returns
Promise
<
T
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
base
Path
keycloak
Methods
add
create
All
From
Provider
delete
delete
Group
Class
Permission
delete
Group
Class
Permissions
delete
Group
Instance
Permission
delete
Group
Instance
Permissions
delete
Role
Class
Permission
delete
Role
Class
Permissions
delete
Role
Instance
Permission
delete
Role
Instance
Permissions
delete
User
Class
Permission
delete
User
Class
Permissions
delete
User
Instance
Permission
delete
User
Instance
Permissions
find
All
find
All
No
Paging
find
One
get
Base
Path
get
Group
Class
Permission
get
Group
Class
Permissions
get
Group
Instance
Permission
get
Group
Instance
Permissions
get
Page
Url
get
Role
Class
Permission
get
Role
Class
Permissions
get
Role
Instance
Permission
get
Role
Instance
Permissions
get
User
Class
Permission
get
User
Class
Permissions
get
User
Instance
Permission
get
User
Instance
Permissions
is
Public
revoke
Public
set
Group
Class
Permission
set
Group
Instance
Permission
set
Public
set
Role
Class
Permission
set
Role
Instance
Permission
set
User
Class
Permission
set
User
Instance
Permission
update
update
Partial
@terrestris/shogun-util
Loading...