Thrift module: sharing_cpi

ModuleServicesData typesConstants
sharing_cpiSharingRegistryService

Services

Service: SharingRegistryService

Function: SharingRegistryService.createDomain

string createDomain(sharing_models.Domain domain)
    throws sharing_models.SharingRegistryException

API method to create a new domain


Function: SharingRegistryService.updateDomain

bool updateDomain(sharing_models.Domain domain)
    throws sharing_models.SharingRegistryException

API method to update a domain


Function: SharingRegistryService.deleteDomain

bool deleteDomain(string domainId)
    throws sharing_models.SharingRegistryException

API method to delete domain


Function: SharingRegistryService.getDomain

sharing_models.Domain getDomain(string domainId)
    throws sharing_models.SharingRegistryException

API method to retrieve a domain


Function: SharingRegistryService.getDomains

list<sharing_models.Domain> getDomains(i32 offset,
                                       i32 limit)
    throws sharing_models.SharingRegistryException

API method to get all domain.


Function: SharingRegistryService.createUser

string createUser(sharing_models.User user)
    throws sharing_models.SharingRegistryException

API method to register a user in the system


Function: SharingRegistryService.updatedUser

bool updatedUser(sharing_models.User user)
    throws sharing_models.SharingRegistryException

API method to update existing user


Function: SharingRegistryService.deleteUser

bool deleteUser(string domainId,
                string userId)
    throws sharing_models.SharingRegistryException

API method to delete user


Function: SharingRegistryService.getUser

sharing_models.User getUser(string domainId,
                            string userId)
    throws sharing_models.SharingRegistryException

API method to get a user


Function: SharingRegistryService.getUsers

list<sharing_models.User> getUsers(string domainId,
                                   i32 offset,
                                   i32 limit)
    throws sharing_models.SharingRegistryException

API method to get a list of users in a specific domain.

  • domainId : Domain id
  • offset : Starting result number
  • limit : Number of max results to be sent

  • Function: SharingRegistryService.createGroup

    string createGroup(sharing_models.UserGroup group)
        throws sharing_models.SharingRegistryException
    

    API method to create a new group


    Function: SharingRegistryService.updateGroup

    bool updateGroup(sharing_models.UserGroup group)
        throws sharing_models.SharingRegistryException
    

    API method to update a group


    Function: SharingRegistryService.deleteGroup

    bool deleteGroup(string domainId,
                     string groupId)
        throws sharing_models.SharingRegistryException
    

    API method to delete a group


    Function: SharingRegistryService.getGroup

    sharing_models.UserGroup getGroup(string domainId,
                                      string groupId)
        throws sharing_models.SharingRegistryException
    

    API method to get a group


    Function: SharingRegistryService.getGroups

    list<sharing_models.UserGroup> getGroups(string domainId,
                                             i32 offset,
                                             i32 limit)
    

    API method to get groups in a domainId.


    Function: SharingRegistryService.addUsersToGroup

    bool addUsersToGroup(string domainId,
                         list<string> userIds,
                         string groupId)
        throws sharing_models.SharingRegistryException
    

    API method to add list of users to a group


    Function: SharingRegistryService.removeUsersFromGroup

    bool removeUsersFromGroup(string domainId,
                              list<string> userIds,
                              string groupId)
        throws sharing_models.SharingRegistryException
    

    API method to remove users from a group


    Function: SharingRegistryService.getGroupMembersOfTypeUser

    list<sharing_models.User> getGroupMembersOfTypeUser(string domainId,
                                                        string groupId,
                                                        i32 offset,
                                                        i32 limit)
        throws sharing_models.SharingRegistryException
    

    API method to get list of child users in a group. Only the direct members will be returned.


    Function: SharingRegistryService.getGroupMembersOfTypeGroup

    list<sharing_models.UserGroup> getGroupMembersOfTypeGroup(string domainId,
                                                              string groupId,
                                                              i32 offset,
                                                              i32 limit)
        throws sharing_models.SharingRegistryException
    

    API method to get list of child groups in a group. Only the direct members will be returned.


    Function: SharingRegistryService.addChildGroupsToParentGroup

    bool addChildGroupsToParentGroup(string domainId,
                                     list<string> childIds,
                                     string groupId)
        throws sharing_models.SharingRegistryException
    

    API method to add a child group to a parent group.


    Function: SharingRegistryService.removeChildGroupFromParentGroup

    bool removeChildGroupFromParentGroup(string domainId,
                                         string childId,
                                         string groupId)
        throws sharing_models.SharingRegistryException
    

    API method to remove a child group from parent group.


    Function: SharingRegistryService.createEntityType

    string createEntityType(sharing_models.EntityType entityType)
        throws sharing_models.SharingRegistryException
    

    API method to create a new entity type


    Function: SharingRegistryService.updateEntityType

    bool updateEntityType(sharing_models.EntityType entityType)
        throws sharing_models.SharingRegistryException
    

    API method to update entity type


    Function: SharingRegistryService.deleteEntityType

    bool deleteEntityType(string domainId,
                          string entityTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to delete entity type


    Function: SharingRegistryService.getEntityType

    sharing_models.EntityType getEntityType(string domainId,
                                            string entityTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to get an entity type


    Function: SharingRegistryService.getEntityTypes

    list<sharing_models.EntityType> getEntityTypes(string domainId,
                                                   i32 offset,
                                                   i32 limit)
        throws sharing_models.SharingRegistryException
    

    API method to get entity types in a domainId.


    Function: SharingRegistryService.createEntity

    string createEntity(sharing_models.Entity entity)
        throws sharing_models.SharingRegistryException
    

    API method to register new entity


    Function: SharingRegistryService.updateEntity

    bool updateEntity(sharing_models.Entity entity)
        throws sharing_models.SharingRegistryException
    

    API method to update entity


    Function: SharingRegistryService.deleteEntity

    bool deleteEntity(string domainId,
                      string entityId)
        throws sharing_models.SharingRegistryException
    

    API method to delete entity


    Function: SharingRegistryService.getEntity

    sharing_models.Entity getEntity(string domainId,
                                    string entityId)
        throws sharing_models.SharingRegistryException
    

    API method to get entity


    Function: SharingRegistryService.searchEntities

    list<sharing_models.Entity> searchEntities(string domainId,
                                               string userId,
                                               list<sharing_models.SearchCriteria> filters,
                                               i32 offset,
                                               i32 limit)
        throws sharing_models.SharingRegistryException
    

    API method to search entities


    Function: SharingRegistryService.getListOfSharedUsers

    list<sharing_models.User> getListOfSharedUsers(string domainId,
                                                   string entityId,
                                                   string permissionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to get a list of shared users given the entity id


    Function: SharingRegistryService.getListOfSharedGroups

    list<sharing_models.UserGroup> getListOfSharedGroups(string domainId,
                                                         string entityId,
                                                         string permissionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to get a list of shared groups given the entity id


    Function: SharingRegistryService.createPermissionType

    string createPermissionType(sharing_models.PermissionType permissionType)
        throws sharing_models.SharingRegistryException
    

    API method to create permission type


    Function: SharingRegistryService.updatePermissionType

    bool updatePermissionType(sharing_models.PermissionType permissionType)
        throws sharing_models.SharingRegistryException
    

    API method to update permission type


    Function: SharingRegistryService.deletePermissionType

    bool deletePermissionType(string domainId,
                              string permissionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to delete permission type


    Function: SharingRegistryService.getPermissionType

    sharing_models.PermissionType getPermissionType(string domainId,
                                                    string permissionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to get permission type


    Function: SharingRegistryService.getPermissionTypes

    list<sharing_models.PermissionType> getPermissionTypes(string domainId,
                                                           i32 offset,
                                                           i32 limit)
        throws sharing_models.SharingRegistryException
    

    API method to get list of permission types in a given domainId.


    Function: SharingRegistryService.shareEntityWithUsers

    bool shareEntityWithUsers(string domainId,
                              string entityId,
                              list<string> userList,
                              string perssionTypeId,
                              bool cascadePermission)
        throws sharing_models.SharingRegistryException
    

    API method to share an entity with users


    Function: SharingRegistryService.revokeEntitySharingFromUsers

    bool revokeEntitySharingFromUsers(string domainId,
                                      string entityId,
                                      list<string> userList,
                                      string perssionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to revoke sharing from a list of users


    Function: SharingRegistryService.shareEntityWithGroups

    bool shareEntityWithGroups(string domainId,
                               string entityId,
                               list<string> groupList,
                               string perssionTypeId,
                               bool cascadePermission)
        throws sharing_models.SharingRegistryException
    

    API method to share an entity with list of groups


    Function: SharingRegistryService.revokeEntitySharingFromGroups

    bool revokeEntitySharingFromGroups(string domainId,
                                       string entityId,
                                       list<string> groupList,
                                       string perssionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to revoke sharing from list of users


    Function: SharingRegistryService.userHasAccess

    bool userHasAccess(string domainId,
                       string userId,
                       string entityId,
                       string permissionTypeId)
        throws sharing_models.SharingRegistryException
    

    API method to check whether a user has access to a specific entity