alfresco-ng2-components/docs/content-services/services/security-controls.service.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Security Controls service	v2.0.0	Active	2023-02-21

Security Controls service

Manages security groups & marks in Content Services.

Class members

Methods

• getSecurityGroup(skipCount?: number, maxItems?: number, include?: string): Promise<SecurityControlsGroupResponse>
  Get security groups.
  • skipCount: number - The number of entities that exist in the collection before those included in this list.
  • maxItems: number - The maximum number of items to return in the list.
  • include: string - Additional information about the security group.
  • Returns Promise<SecurityControlsGroupResponse>
• createSecurityGroup(input: SecurityGroupBody): Observable<SecurityGroupEntry>
  Creates a security group.
  • input: SecurityGroupBody - Security group.
  • Returns Observable<SecurityGroupEntry>
• createSecurityMarks(securityGroupId: string, input: SecurityMarkBody[]): Promise<SecurityMarkPaging | SecurityMarkEntry>
  Create security marks.
  • securityGroupId: string - The key for the security group id.
  • SecurityMarkBody: SecurityMarkBody[] - Node security marks list.
  • Returns Promise<SecurityMarkPaging | SecurityMarkEntry>
• getSecurityMark(securityGroupId: string, skipCount?: number, include?: string): Promise<SecurityControlsMarkResponse>
  Get security mark value.
  • securityGroupId: string - The key for the security group id.
  • skipCount: number - The number of entities that exist in the collection before those included in this list.
  • include: string - The key for the security mark is in use or not.
  • Returns Promise<SecurityControlsMarkResponse>
• updateSecurityGroup(securityGroupId: string, input: SecurityGroupBody, opts?: any): Promise<SecurityGroupEntry>
  Update a security groups information.
  • securityGroupId: string - The key of security group id for which info is required.
  • input: SecurityGroupBody - Security group.
  • opts: any - (Optional) Extra options supported by JS-API.
  • Returns Promise<SecurityGroupEntry>
• updateSecurityMark(securityGroupId: string, securityMarkId: string, input: SecurityMarkBody): Promise<SecurityMarkEntry>
  Updates Security Mark value.
  • securityGroupId: string - The key for the security group id.
  • securityMarkId: string - The key for the security mark is in use or not.
  • input: SecurityMarkBody - Security mark.
  • Returns Promise<SecurityMarkEntry>
• deleteSecurityGroup(securityGroupId: string): Observable<SecurityGroupEntry>
  Delete security group.
  • securityGroupId: string - The key for the security group id.
  • Returns Observable<SecurityGroupEntry>
• deleteSecurityMark(securityGroupId: string, securityMarkId: string): Promise<SecurityMarkEntry>
  Delete security mark.
  • securityGroupId: string - The key for the security group id.
  • securityMarkId: string - The key for the security mark id.
  • Returns Promise<SecurityMarkEntry>
• getClearancesForAuthority(authorityName: string, skipCount?: number, maxItems?: number): Observable<AuthorityClearanceGroupPaging>
  Get the authority clearances for a single user/group.
  • authorityName: string - The name for the authority for which the clearance is to be fetched.
  • skipCount: number - The number of entities that exist in the collection before those included in this list.
  • maxItems: number - The maximum number of items to return in the list.
  • Returns Observable<AuthorityClearanceGroupPaging>
• updateClearancesForAuthority(authorityName: string, securityMarksList: NodeSecurityMarkBody[]): Observable<SecurityMarkEntry | SecurityMarkPaging>
  Updates the authority clearance.
  • authorityName: string - The name for the authority for which the clearance is to be updated.
  • securityMarksList: NodeSecurityMarkBody[] - Node security marks list.
  • Returns Observable<SecurityMarkEntry | SecurityMarkPaging>

Properties

Name	Type	Description
groupsPaginated$	Observable<SecurityControlsGroupResponse>	Current paginated groups.
marksPaginated$	Observable<SecurityControlsMarkResponse>	Current paginated marks.
reloadSecurityControls$	Observable<void>
reloadAuthorityClearance$	Observable<void>
loading$	Observable<boolean>	Current loading state.