Relativity.Identity.V1.Services.IPermissionManager

public interface IPermissionManager : IDisposable

Permission Manager.

Documentation

Task AddRemoveItemGroupsAsync(int workspaceArtifactID, int itemArtifactID, 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<List<PermissionDetail>> GetAdminOperationPermissionSelectedListAsync(int workspaceArtifactID, List<int> permissionIDs)

Indicates if a given admin permission is selected.

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

Get a list of tabs for the group and the tab visibility state.

Task<GroupPermissions> GetItemGroupPermissionsAsync(int workspaceArtifactID, int artifactID, int groupID)

Get Item Group Permissions.

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

Get Item GroupSelector.

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

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, int groupID)

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

Task<List<PermissionValue>> GetPermissionSelectedForGroupAsync(int workspaceArtifactID, List<PermissionRef> permissions, int groupID, 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, int groupID)

Get Workspace Group Permissions.

Task<GroupSelector> GetWorkspaceGroupSelectorAsync(int workspaceArtifactID)

Get Workspace GroupSelector.

Task<List<UserRef>> GetWorkspaceGroupUsersAsync(int workspaceArtifactID, int groupID)

Get Workspace Group Users.

Task<bool> HasAccessToWorkspaceAsync(int workspaceArtifactID)

Determines if the current user has access to workspace.

Task<bool> IsUserInWorkspaceGroupAsync(int workspaceArtifactID, int userID, int groupID)

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

Task<PermissionQueryResults> QueryAsync(int workspaceArtifactID, Query query, int length = 0)

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

Task<PermissionQueryResults> QueryAsync(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 SetGroupTabVisibilityAsync(int workspaceArtifactID, int groupArtifactID, GroupTabVisibility tabVisibility)

Update the tab visibility state for a group.

Task SetItemGroupPermissionsAsync(int workspaceArtifactID, int groupID, int artifactID, GroupPermissions groupPermissions)

Set Item Group Permissions.

Task SetItemLevelSecurityAsync(int workspaceArtifactID, int artifactID, ItemLevelSecurity itemLevelSecurity)

Set Item Level Security settings for a given ArtifactID.

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

Set the Selected value for a given group permission.

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

Set the Selected value for a given group permission.

Task SetWorkspaceGroupPermissionsAsync(int workspaceArtifactID, int groupID, GroupPermissions groupPermissions)

Set Workspace Group Permissions.

Task UpdateSingleAsync(int workspaceArtifactID, Permission permissionDTO)

Asynchronously updates a Permission.