mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
eb2811fdd0
* [ADF-4738] [Process -Cloud] Move GroupCloudService to adf-core lib. * * Changed GroupModel to IdentityGroupModel * Updated unit tests the recent changes. * * Added documentation to the identityGroupService * Updated GroupInitial and GroupCoudcomponent doc. * * Created groupCount model. * Updated unit test to the recent changes * * After rebase updated doc * * Fixed comments.
6.6 KiB
6.6 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Identity Group service | v3.4.0 | Active | 2019-07-13 |
Identity Group service
Performs CRUD operations on identity groups.
Class members
Methods
- checkGroupHasAnyClientAppRole(groupId:
string, clientId:string, roleNames:string[]):Observable<boolean>
Check if a group has any of the client app roles in the supplied list.- groupId:
string- Id of the target group - clientId:
string- Id of the client - roleNames:
string[]- Array of role names to check - Returns
Observable<boolean>- True if the group has one or more of the roles, false otherwise
- groupId:
- checkGroupHasClientApp(groupId:
string, clientId:string):Observable<boolean>
Checks if a group has a client app.- groupId:
string- Id of the target group - clientId:
string- Id of the client - Returns
Observable<boolean>- True if the group has the client app, false otherwise
- groupId:
- checkGroupHasRole(groupId:
string, roleNames:string[]):Observable<boolean>
Check that a group has one or more roles from the supplied list.- groupId:
string- Id of the target group - roleNames:
string[]- Array of role names - Returns
Observable<boolean>- True if the group has one or more of the roles, false otherwise
- groupId:
- createGroup(newGroup:
IdentityGroupModel):Observable<any>
Creates new group.- newGroup:
IdentityGroupModel- Object of containing the new group details. - Returns
Observable<any>- Empty response when the group created.
- newGroup:
- deleteGroup(groupId:
string):Observable<any>
Deletes Group.- groupId:
string- Id of the group. - Returns
Observable<any>- Empty response when the group deleted.
- groupId:
- findGroupsByName(searchParams:
IdentityGroupSearchParam):Observable<any>
Finds groups filtered by name.- searchParams:
IdentityGroupSearchParam- Object containing the name filter string - Returns
Observable<any>- List of group information
- searchParams:
- getClientIdByApplicationName(applicationName:
string):Observable<string>
Gets the client ID using the app name.- applicationName:
string- Name of the app - Returns
Observable<string>- client ID string
- applicationName:
- getClientRoles(groupId:
string, clientId:string):Observable<IdentityRoleModel[]>
Gets client roles.- groupId:
string- ID of the target group - clientId:
string- ID of the client - Returns
Observable<IdentityRoleModel[]>- List of roles
- groupId:
- getGroupRoles(groupId:
string):Observable<IdentityRoleModel[]>
Gets details for a specified group.- groupId:
string- ID of the target group - Returns
Observable<IdentityRoleModel[]>- Group details
- groupId:
- getGroups():
Observable<IdentityGroupModel[]>
Gets all groups.- Returns
Observable<IdentityGroupModel[]>- Array of group information objects
- Returns
- getTotalGroupsCount():
Observable<IdentityGroupCountModel>
Gets groups total count.- Returns
Observable<IdentityGroupCountModel>- Number of groups count.
- Returns
- queryGroups(requestQuery:
IdentityGroupQueryCloudRequestModel):Observable<IdentityGroupQueryResponse>
Queries groups.- requestQuery:
IdentityGroupQueryCloudRequestModel- - Returns
Observable<IdentityGroupQueryResponse>- Array of user information objects
- requestQuery:
- updateGroup(groupId:
string, updatedGroup:IdentityGroupModel):Observable<any>
Updates group details.- groupId:
string- Id of the targeted group. - updatedGroup:
IdentityGroupModel- Object of containing the group details - Returns
Observable<any>- Empty response when the group updated.
- groupId: