## Uses of Interface
com.ibm.openpages.api.security.ISecurityPrincipal

- Packages that use ISecurityPrincipal
  Package | Description
  --- | ---
  com.ibm.openpages.api.resource | Provides interfaces to work with the OpenPages content data: folders, GRC objects and document attachments.
  com.ibm.openpages.api.security | Provides interfaces to work with the OpenPages security data: users, groups, and role-based security.
  com.ibm.openpages.api.service | Provides the main interfaces to work with the API services.

- - ### Uses of ISecurityPrincipal in com.ibm.openpages.api.resource

    Methods in com.ibm.openpages.api.resource that return ISecurityPrincipal
    Modifier and Type | Method and Description
    --- | ---
    `ISecurityPrincipal` | IResourcePermission.`getSecurityPrincipal()` The Resource Permission belong to a User or a Group.

  - ### Uses of ISecurityPrincipal in com.ibm.openpages.api.security

    Subinterfaces of ISecurityPrincipal in com.ibm.openpages.api.security
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `IGroup` Interface for security group information.
    `interface` | `IUser` Interface for user-level security information.

    Methods in com.ibm.openpages.api.security that return ISecurityPrincipal
    Modifier and Type | Method and Description
    --- | ---
    `ISecurityPrincipal` | IAdminPermission.`getAdministrator()` Returns `ISecurityPrincipal` of the administrator to whom this administrative permission applies.
    `ISecurityPrincipal` | IRoleAssignment.`getSecurityPrincipal()` Returns the user or group that is assigned the object permissions specified by the role template.

    Methods in com.ibm.openpages.api.security that return types with arguments of type ISecurityPrincipal
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<ISecurityPrincipal>` | IGroup.`getAllMembers()` Returns all members of a security group.
    `java.util.Iterator<ISecurityPrincipal>` | IGroup.`getMembers(boolean includesEntityGroups)` Returns all members of a security group.

    Methods in com.ibm.openpages.api.security with parameters of type ISecurityPrincipal
    Modifier and Type | Method and Description
    --- | ---
    `void` | IGroup.`addMember(ISecurityPrincipal groupOrUser)` Adds a group member.
    `boolean` | IGroup.`hasMember(ISecurityPrincipal groupOrUser)` Verifies group membership.
    `void` | IGroup.`remove(ISecurityPrincipal securityPrincipal)` Remove Security Principal from this group.

  - ### Uses of ISecurityPrincipal in com.ibm.openpages.api.service

    Methods in com.ibm.openpages.api.service with parameters of type ISecurityPrincipal
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<IRoleAssignment>` | ISecurityService.`getRoleAssignments(ISecurityPrincipal userOrGroup, IRoleTemplate roleTemplate, IFolder folder)` Returns an iterator over all role assignments effective in the user or group

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2022. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.