Skip to content

Latest commit

 

History

History
80 lines (72 loc) · 8.81 KB

security-controls.service.md

File metadata and controls

80 lines (72 loc) · 8.81 KB
Raw
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

  • createSecurityGroup(input: SecurityGroupBody): Observable<SecurityGroupEntry>
    Create security group

    • input: SecurityGroupBody - securityGroupBody.
    • Returns Observable<SecurityGroupEntry> - Observable<SecurityGroupEntry>

  • createSecurityMarks(securityGroupId: string, input: SecurityMarkBody[]): Promise<SecurityMarkPaging|SecurityMarkEntry>
    Create security marks

    • securityGroupId: string - The key for the security group id.
    • input: SecurityMarkBody[] - securityMarkBody[].
    • Returns Promise<SecurityMarkPaging|SecurityMarkEntry> - Promise<SecurityMarkPaging | SecurityMarkEntry>

  • deleteSecurityGroup(securityGroupId: string): Observable<SecurityGroupEntry>
    Delete security group

    • securityGroupId: string - The key for the security group id.
    • Returns Observable<SecurityGroupEntry> - 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> - Promise<SecurityMarkEntry>

  • getClearancesForAuthority(authorityName: string, skipCount: number = DEFAULT_SKIP_COUNT, maxItems: number = this.userPreferencesService.paginationSize): 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. Can be left blank in which case it will fetch it for all users with pagination
    • 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. Default is specified by UserPreferencesService.
    • Returns Observable<AuthorityClearanceGroupPaging> - Observable<AuthorityClearanceGroupPaging>

  • getSecurityGroup(skipCount: number = DEFAULT_SKIP_COUNT, maxItems: number = this.userPreferencesService.paginationSize, include: string = DEFAULT_INCLUDE): Promise<SecurityControlsGroupResponse>
    Get All 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. Default is specified by UserPreferencesService.
    • include: string - Additional information about the security group
    • Returns Promise<SecurityControlsGroupResponse> - Promise<SecurityControlsGroupResponse>

  • getSecurityMark(securityGroupId: string, skipCount: number = DEFAULT_SKIP_COUNT, include: string = DEFAULT_INCLUDE): Promise<SecurityControlsMarkResponse>
    Get security mark value Gets the value for a selected securityGroupId.

    • 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> - Promise<SecurityControlsMarkResponse>

  • reloadSecurityGroups()

  • 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[] - NodeSecurityMarkBody[]
    • Returns Observable<SecurityMarkEntry|SecurityMarkPaging> - Observable<SecurityMarkEntry | SecurityMarkPaging>

  • 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 - SecurityGroupBody
    • opts: any - (Optional) additional information about the security group
    • Returns Promise<SecurityGroupEntry> - 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 - securityMarkBody.
    • Returns Promise<SecurityMarkEntry> - Promise<SecurityMarkEntry>

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.