Relativity.Services.Permission.IPermissionManager

public interface IPermissionManager : IDisposable

Permission Manager.

Documentation

Task AddRemoveAdminGroupsAsync(GroupSelector groupSelector)

Add and/or remove Admin groups.

Task AddRemoveItemGroupsAsync(int workspaceArtifactID, int artifactID, GroupSelector groupSelector)

Add and/or remove item groups.

Task AddRemoveWorkspaceGroupsAsync(int workspaceArtifactID, GroupSelector groupSelector)

Add and/or remove workspace groups.

Task<int> CreateSingleAsync(int workspaceArtifactID, Permission permissionDTO)

Asynchronously create a new permission.

Task DeleteSingleAsync(int workspaceArtifactID, int permissionID)

Asynchronously delets a Permission.

Task<GroupPermissions> GetAdminGroupPermissionsAsync(GroupRef group)

Get Admin Group Permissions.

Task<GroupSelector> GetAdminGroupSelectorAsync()

Get Admin GroupSelector.

Task<GroupTabVisibility> GetAdminGroupTabVisibilityAsync(int groupArtifactID)

Returns the tabs visibility state for an admin group.

Task<List<UserRef>> GetAdminGroupUsersAsync(GroupRef group)

Get Admin Group Users.

Task<List<PermissionDetail>> GetAdminOperationPermissionSelectedListAsync(int workspaceArtifactID, List<int> permissionIds)

Indicates if a given admin permission is selected.

Task<GroupPermissions> GetItemGroupPermissionsAsync(int workspaceArtifactID, int artifactID, GroupRef group)

Get Item Group Permissions.

Task<GroupSelector> GetItemGroupSelectorAsync(int workspaceArtifactID, int artifactID)

Get Item GroupSelector.

Task<List<UserRef>> GetItemGroupUsersAsync(int workspaceArtifactID, int artifactID, GroupRef group)

Get Item Group Users.

Task<ItemLevelSecurity> GetItemLevelSecurityAsync(int workspaceArtifactID, int artifactID)

Get Item Level Security settings for a given ArtifactID.

Task<Dictionary<int, ItemLevelSecurity>> GetItemLevelSecurityListAsync(int workspaceArtifactID, IEnumerable<int> artifactIDs)

Returns a dictionary of item-level security settings objects for the specified Relativity artifacts. Inputs include the workspace ArtifactID and a collection of ArtifactIDs. For admin artifacts, specify -1 as the workspace ArtifactID.

Task<List<PermissionValue>> GetPermissionSelectedAsync(int workspaceArtifactID, List<PermissionRef> permissions)

Indicates a given permission is selected. (ArtifactTypeID)

Task<List<PermissionValue>> GetPermissionSelectedAsync(int workspaceArtifactID, List<PermissionRef> permissions, int artifactID)

Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID)

Task<List<PermissionValue>> GetPermissionSelectedForGroupAsync(int workspaceArtifactID, List<PermissionRef> permissions, GroupRef group)

Indicates a given permission is selected. (ArtifactTypeID for a given Group)

Task<List<PermissionValue>> GetPermissionSelectedForGroupAsync(int workspaceArtifactID, List<PermissionRef> permissions, GroupRef group, int artifactID)

Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID for a given Group)

Task<Dictionary<int, List<PermissionValue>>> GetPermissionSelectedListAsync(int workspaceArtifactID, List<PermissionRef> permissions, IEnumerable<int> artifactIDs)

Returns the current user’s permission to the specified relativity artifacts as a dictionary that maps the ArtifactID to the permissions values. Inputs include the workspace ArtifactID, a collection of PermissionRef objects, and a collection of ArtifactIDs. To return admin-level artifact permissions, specify -1 as the workspace ArtifactID.

Task<GroupSelector> GetWorkspaceAndWorkspaceAdminGroupSelectorAsync(int workspaceArtifactID)

Get Workspace and Workspace Admin GroupSelector.

Task<GroupPermissions> GetWorkspaceGroupPermissionsAsync(int workspaceArtifactID, GroupRef group)

Get Workspace Group Permissions.

Task<GroupSelector> GetWorkspaceGroupSelectorAsync(int workspaceArtifactID)

Get Workspace GroupSelector.

Task<GroupTabVisibility> GetWorkspaceGroupTabVisibilityAsync(int workspaceArtifactID, int groupArtifactID)

Returns the tabs visibility state for a group in a workspace.

Task<List<UserRef>> GetWorkspaceGroupUsersAsync(int workspaceArtifactID, GroupRef group)

Get Workspace Group Users.

Task<List<UserRef>> GetWorkspaceGroupUsersByWorkspaceGroupAsync(int workspaceArtifactID, GroupRef workspaceGroup)

Get Workspace Group Users.

Task<bool> IsUserInWorkspaceGroupAsync(int workspaceArtifactID, UserRef user, GroupRef group)

Determines if the given user is a member of the given workspace group

Task<PermissionQueryResultSet> QueryAsync(int workspaceArtifactID, Query query)

Asynchronously queries for Permission.

Task<PermissionQueryResultSet> QueryAsync(int workspaceArtifactID, Query query, int length)

Asynchronously queries for Permission.

Task<PermissionQueryResultSet> QuerySubsetAsync(int workspaceArtifactID, string queryToken, int start, int length)

Asynchronously queries for a subset of a collection of Permission instances.

Task<Permission> ReadSingleAsync(int workspaceArtifactID, int permissionID)

Asynchronously read a single Permission instance.

Task SetAdminGroupPermissionsAsync(GroupPermissions groupPermissions)

Set Admin Group Permissions.

Task SetAdminGroupTabVisibilityAsync(GroupTabVisibility tabVisibility)

Set the tabs visibility state for an admin group.

Task SetItemGroupPermissionsAsync(int workspaceArtifactID, GroupPermissions groupPermissions)

Set Item Group Permissions.

Task SetItemLevelSecurityAsync(int workspaceArtifactID, ItemLevelSecurity itemLevelSecurity)

Set Item Level Security settings for a given ArtifactID.

Task SetPermissionSelectedForGroupAsync(int workspaceArtifactID, List<PermissionValue> permissionValues, GroupRef group)

Set the Selected value for a given group permission.

Task SetPermissionSelectedForGroupAsync(int workspaceArtifactID, List<PermissionValue> permissionValues, GroupRef group, int artifactID)

Set the Selected value for a given group permission.

Task SetWorkspaceGroupPermissionsAsync(int workspaceArtifactID, GroupPermissions groupPermissions)

Set Workspace Group Permissions.

Task SetWorkspaceGroupTabVisibilityAsync(int workspaceArtifactID, GroupTabVisibility tabVisibility)

Set the tabs visibility state for a group in a workspace.

Task UpdateSingleAsync(int workspaceArtifactID, Permission permissionDTO)

Asynchronously updates a Permission.