Access Control Procedures

Prev Next

Procedure Name

Description

AddToTeamRole

Assigns user or group to folder team role. User or Group SID should be provided along with Role Id and Folder Id

AddToTeamRoleByName

Assigns user to folder team role. User Id should be provided along with Role Name and Folder Id

GetRoleByName

Gets role by role internal name

GetTeamRoleAssignments

Gets the list of team role assignments for a specified folder. Returns list of RoleAssignment objects for the specified Folder Id

GetTeamRoles

Gets the list of team roles for a specified case type. Returns list of Role objects for the specified Case Type Id

GrantAttachmentPermission

Grants attachment permissions to the list of users. If attachment is inheriting permissions then the permission inheritance will be stopped and attachment will get unique permissions. File GUID, Permissions combination and list of user security identifiers should be passed to apply the unique permissions on attachment

GrantFolderPermission

Grants explicit unique folder permissions on the folder for the user or group. Folder Id, Permissions combination and list of user or group security identifiers should be passed to grant explicitly permissions on folder

HasAttachmentPermission

Checks if user has specific permission on a attachment. File GUID, User Id and Permission combination should be passed to check if user has the provided permission on the attachment. If permission exists then returns true, otherwise false

HasFolderPermission

Checks if user has specific permission on a folder. Folder Id, User Id and Permission combination should be passed to check if user has the provided permission on the folder. If permission exists then returns true, otherwise false

InheritAttachmentPermissions

Removes unique permissions on the attachment and inherits the folder security. File GUID should be provided to resume inheritance

InheritCaseTypePermissions

Resume inheritance of permissions on the folder and optionally removes all explicitly assigned folder permissions based on deleteExplicitPermissions parameter. When deleteExplicitPermissions is true, explicit permissions are removed while enabling inheriting case type permissions on the folder

RemoveFromTeamRole

Removes a user or group from folder team roles. User or Group SID should be provided along with Folder Id and list or Role Ids

RevokeAttachmentPermission

Revokes all attachment permissions for the list of users when attachment has unique permissions. File GUID and list of User or Group SIDs should be passed to revoke attachment permissions

RevokeFolderPermission

Revokes explicit permissions for the list of users when folder has explicit permissions. Folder Id and list of User or Group SIDs should be passed to revoke explicit folder permissions

StopInheritingCaseTypePermissions

Enables unique permission on folder and assigns the specified permission as explicit permissions. Folder Id and Dictionary of SIDs and Case Permissions combination should be passed to grant explicit permissions. Dictionary key is SID and value will be a long with combination of CasePermissions constants

SyncTeamRolesFromWorkflow

Synchronizes folder scope roles matching with workflow roles for a specified workflow process Id. Updates folder scope role assignments from workflow roles assignment for matching role names