mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
1fa81962a0
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
98 lines
8.9 KiB
Markdown
98 lines
8.9 KiB
Markdown
---
|
|
Title: Identity Group service
|
|
Added: v3.4.0
|
|
Status: Active
|
|
Last reviewed: 2019-07-13
|
|
---
|
|
|
|
# [Identity Group service](lib/core/src/lib/services/identity-group.service.ts "Defined in identity-group.service.ts")
|
|
|
|
Performs CRUD operations on identity groups.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **assignRoles**(groupId: `string`, roles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Assigns roles to the group
|
|
- _groupId:_ `string` - The ID of the group
|
|
- _roles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - Array of roles to assign
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
|
|
- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
|
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`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
|
|
- **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
|
Checks if a group has a client app.
|
|
- _groupId:_ `string` - Id of the target group
|
|
- _clientId:_ `string` - Id of the client
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has the client app, false otherwise
|
|
- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
|
|
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`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
|
|
- **createGroup**(newGroup: [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Creates new group.
|
|
- _newGroup:_ [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts) - Object of containing the new group details.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the group created.
|
|
- **deleteGroup**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Deletes Group.
|
|
- _groupId:_ `string` - Id of the group.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the group deleted.
|
|
- **findGroupsByName**(searchParams: [`IdentityGroupSearchParam`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`<br/>
|
|
Finds groups filtered by name.
|
|
- _searchParams:_ [`IdentityGroupSearchParam`](lib/core/src/lib/models/identity-group.model.ts) - Object containing the name filter string
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - List of group information
|
|
- **getAssignedRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
|
Gets assigned roles
|
|
- _groupId:_ `string` - Id of the group.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles
|
|
- **getAvailableRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
|
Gets available roles
|
|
- _groupId:_ `string` - Id of the group.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of available roles information objects
|
|
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
|
|
Gets the client Id using the app name.
|
|
- _applicationName:_ `string` - Name of the app
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client Id string
|
|
- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
|
Gets client roles.
|
|
- _groupId:_ `string` - Id of the target group
|
|
- _clientId:_ `string` - Id of the client
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - List of roles
|
|
- **getEffectiveRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
|
Get effective roles
|
|
- _groupId:_ `string` - Id of the group
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Array of effective roles
|
|
- **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>`<br/>
|
|
Gets details for a specified group.
|
|
- _groupId:_ `string` - Id of the target group
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityRoleModel`](../../../lib/core/models/identity-role.model.ts)`[]>` - Group details
|
|
- **getGroups**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>`<br/>
|
|
Gets all groups.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` - Array of group information objects
|
|
- **getTotalGroupsCount**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupCountModel`](../../../lib/core/models/identity-group.model.ts)`>`<br/>
|
|
Gets groups total count.
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupCountModel`](../../../lib/core/models/identity-group.model.ts)`>` - Number of groups count.
|
|
- **queryGroups**(requestQuery: [`IdentityGroupQueryCloudRequestModel`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>`<br/>
|
|
Queries groups.
|
|
- _requestQuery:_ [`IdentityGroupQueryCloudRequestModel`](lib/core/src/lib/models/identity-group.model.ts) -
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`IdentityGroupQueryResponse`](../../../lib/core/models/identity-group.model.ts)`>` - Array of user information objects
|
|
- **removeRoles**(groupId: `string`, roles: [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Removes roles from the group
|
|
- _groupId:_ `string` - The ID of the group
|
|
- _roles:_ [`IdentityRoleModel`](lib/core/src/lib/models/identity-role.model.ts)`[]` - Array of roles to remove
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
|
|
- **updateGroup**(groupId: `string`, updatedGroup: [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
|
|
Updates group details.
|
|
- _groupId:_ `string` - Id of the targeted group.
|
|
- _updatedGroup:_ [`IdentityGroupModel`](lib/core/src/lib/models/identity-group.model.ts) - Object of containing the group details
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the group updated.
|
|
|
|
## See also
|
|
|
|
- [Identity user service](../../core/userInfo/services/identity-user.service.md)
|