alfresco-ng2-components/docs/core/services/identity-group.service.md

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

• assignRoles(groupId: string, roles: IdentityRoleModel[]): Observable<any>
  Assigns roles to the group
  • groupId: string - The ID of the group
  • roles: IdentityRoleModel[] - Array of roles to assign
  • Returns Observable<any> -
• 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
• 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
• 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
• 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.
• deleteGroup(groupId: string): Observable<any>
  Deletes Group.
  • groupId: string - Id of the group.
  • Returns Observable<any> - Empty response when the group deleted.
• findGroupsByName(searchParams: IdentityGroupSearchParam): Observable<IdentityGroupModel[]>
  Finds groups filtered by name.
  • searchParams: IdentityGroupSearchParam - Object containing the name filter string
  • Returns Observable<IdentityGroupModel[]> - List of group information
• getAssignedRoles(groupId: string): Observable<IdentityRoleModel[]>
  Gets assigned roles
  • groupId: string - Id of the group.
  • Returns Observable<IdentityRoleModel[]> - Array of available roles
• getAvailableRoles(groupId: string): Observable<IdentityRoleModel[]>
  Gets available roles
  • groupId: string - Id of the group.
  • Returns Observable<IdentityRoleModel[]> - Array of available roles information objects
• 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
• 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
• getEffectiveRoles(groupId: string): Observable<IdentityRoleModel[]>
  Get effective roles
  • groupId: string - Id of the group
  • Returns Observable<IdentityRoleModel[]> - Array of effective roles
• getGroupRoles(groupId: string): Observable<IdentityRoleModel[]>
  Gets details for a specified group.
  • groupId: string - Id of the target group
  • Returns Observable<IdentityRoleModel[]> - Group details
• getGroups(): Observable<IdentityGroupModel[]>
  Gets all groups.
  • Returns Observable<IdentityGroupModel[]> - Array of group information objects
• getTotalGroupsCount(): Observable<IdentityGroupCountModel>
  Gets groups total count.
  • Returns Observable<IdentityGroupCountModel> - Number of groups count.
• queryGroups(requestQuery: IdentityGroupQueryCloudRequestModel): Observable<IdentityGroupQueryResponse>
  Queries groups.
  • requestQuery: IdentityGroupQueryCloudRequestModel -
  • Returns Observable<IdentityGroupQueryResponse> - Array of user information objects
• removeRoles(groupId: string, roles: IdentityRoleModel[]): Observable<any>
  Removes roles from the group
  • groupId: string - The ID of the group
  • roles: IdentityRoleModel[] - Array of roles to remove
  • Returns Observable<any> -
• 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.

See also

• Identity user service