Запреты накладываются на данные на неопределенный срок в целях соблюдения юридических обязательств или обязательств по обеспечению сохранности данных. Обычно они налагаются на одного или нескольких пользователей, чтобы гарантировать невозможность удаления данных, потенциально относящихся к делу, до тех пор, пока дело не перестанет быть активным.
Если пользователь, на которого наложен запрет, удаляет защищённые данные, эти данные исчезают из поля зрения пользователя, но сохраняются в Хранилище. Пока действует запрет, администратор Хранилища может выполнять поиск и экспортировать эти данные.
Удержания состоят из следующих компонентов:
- Служба — приложение, ответственное за хранение данных. В качестве службы можно выбрать Почту, Диск или Группы.
- Область действия — объекты, на которые распространяется удержание. Область действия может быть установлена на одну или несколько учетных записей пользователей или на организационное подразделение (OU).
- Дополнительные параметры (необязательно) — конкретные данные (поисковые запросы или параметры конфигурации), используемые для сужения данных, которые должны храниться в заданной области. Возможны следующие варианты:
- почта, Группы: поисковый запрос для сужения удержания
- Диск: включить общие диски в удержание
Для работы с ресурсами Vault у учётной записи должны быть необходимые привилегии Vault и доступ к делу. Для доступа к делу у учётной записи должна быть возможность создать дело, предоставить доступ к делу или иметь право « Просмотр всех дел» .
Создайте удержание почты для определенных учетных записей пользователей с помощью поискового запроса
В следующем примере показано, как создается удержание с названием «Удержание моих первых почтовых аккаунтов» для:
- Служба: почта
- Сущность: учетные записи пользователей «user1» и «user2»
- Дополнительные возможности: поисковый запрос «to:ceo@company.com»
Извлекайте идентификаторы учётных записей пользователей из API каталога . Обратите внимание, что HeldAccount может принимать идентификатор учётной записи или адрес электронной почты. Если указаны оба, используется адрес электронной почты, а идентификатор учётной записи игнорируется.
Ява
HeldMailQuery mailQuery = new HeldMailQuery().setTerms("to:ceo@company.com"); Listaccounts = Lists.newArrayList(); accounts.add(new HeldAccount().setAccountId(user1accountId)); accounts.add(new HeldAccount().setEmail(user2Email)); Hold hold = new Hold() .setName("My First mail Accounts Hold") .setCorpus("MAIL"); .setQuery(new CorpusQuery().setMailQuery(mailQuery)) .setAccounts(accounts); Hold createdHold = client.matters().holds().create(matterId, hold).execute();
Питон
def create_hold_mail_accounts(service, matter_id, account_id): mail_query = {'terms': 'to:ceo@company.com'} accounts = [ {'accountId': user1_account_id}, {'email': user2_email} ] wanted_hold = { 'name': 'My First mail Accounts Hold', 'corpus': 'MAIL', 'query': { 'mailQuery': mail_query }, 'accounts': accounts } return service.matters().holds().create( matterId=matter_id, body=wanted_hold).execute()
Создайте удержание для Диска в организационном подразделении и включите содержимое общего диска
В следующем примере показано, как создается удержание с именем «My First Drive OU Hold» для:
- Услуга: Drive
- Сущность: подразделение организации «Финансы» (идентификатор подразделения зафиксирован в orgUnitId)
- Дополнительные параметры: включить общие диски, участниками которых являются пользователи этого организационного подразделения
Извлечь идентификаторы OU из API каталога .
Ява
HeldOrgUnit orgUnit = new HeldOrgUnit().setOrgUnitId(orgUnitId); // Include shared drives content. HeldDriveQuery driveQuery = new HeldDriveQuery().setIncludeSharedDriveFiles(true); // Create the hold. Hold hold = new Hold() .setName("My First Drive OU Hold") .setCorpus("DRIVE") .setQuery(new CorpusQuery().setDriveQuery(driveQuery)) .setOrgUnit(orgUnit); Hold createdHold = client.matters().holds().create(matterId, hold).execute(); return createdHold;
Питон
def create_hold_drive_org(service, matter_id, org_unit_id): drive_query = {'includeSharedDriveFiles': True} org_unit = {'orgUnitId': org_unit_id} wanted_hold = { 'name': 'My First Drive OU Hold', 'corpus': 'DRIVE', 'orgUnit': org_unit, 'query': { 'driveQuery': drive_query } } return service.matters().holds().create( matterId=matter_id, body=wanted_hold).execute()
Создайте удержание для групп по определенным групповым аккаунтам с диапазоном дат
В следующем примере показано, как создается удержание с именем «Мое первое групповое удержание» для:
- Обслуживание: Группы
- Сущность: групповые счета «group1» и «group2»
- Дополнительные параметры: хранить только сообщения с датами отправки между «startTime» и «endTime»
Извлечь идентификаторы групповых учетных записей из API каталога .
Ява
String APRIL_2_2017_GMT = "2017-04-02T00:00:00Z"; // See below for format*. Listaccounts = Lists.newArrayList(); accounts.add(new HeldAccount().setAccountId(accountId)); accounts.add(new HeldAccount().setAccountId(accountId2)); HeldGroupsQuery groupQuery = new HeldGroupsQuery(); // Restrict by sent date. groupQuery.setStartTime(APRIL_2_2017_GMT); groupQuery.setEndTime(APRIL_2_2017_GMT); // create the hold Hold hold = new Hold() .setName("My First Group Hold") .setCorpus("GROUPS") .setQuery(new CorpusQuery().setGroupsQuery(groupQuery)); hold.setAccounts(accounts); Hold createdHold = client.matters().holds().create(matterId, hold).execute();
Питон
def create_hold_groups_date_range(service, matter_id, group_account_id): groups_query = { 'startTime': '2017-04-02T00:00:00Z', # See below for format* 'endTime': '2017-04-02T00:00:00Z' } accounts = [{'accountId': group_account_id}] wanted_hold = { 'name': 'My First Group Hold', 'corpus': 'GROUPS', 'query': { 'groupsQuery': groups_query }, 'accounts': accounts } return service.matters().holds().create( matterId=matter_id, body=wanted_hold).execute()
- Формат временной метки . Кроме того, начальное и конечное время преобразуются в время по Гринвичу (GMT) и округляются до начала заданной даты.
Запрос и изменение существующих удержаний
В следующем примере показано, как составить список всех счетов, включенных в существующее удержание:
Ява
client.matters().holds().accounts().list(matterId, holdId).execute().getAccounts();
Питон
# If no accounts are on hold, ['accounts'] will raise an error. def list_held_accounts(service, matter_id, hold_id): return service.matters().holds().accounts().list( matterId=matter_id, holdId=hold_id).execute()['accounts']
В следующем примере показано, как добавить учетную запись в существующее удержание и удалить учетную запись из существующего удержания:
Ява
// Add an account by id. client .matters() .holds() .accounts() .create(matterId, holdId, new HeldAccount().setAccountId(accountId)) .execute(); // Remove an account by id. client.matters().holds().accounts().delete(matterId, holdId, accountId).execute(); String email = "email@email.com"; // Add an account by email. client .matters() .holds() .accounts() .create(matterId, holdId, new HeldAccount().setEmail(email)) .execute();
Питон
def add_held_account(service, matter_id, hold_id, account_id): held_account = {'accountId': account_id} return service.matters().holds().accounts().create( matterId=matter_id, holdId=hold_id, body=held_account).execute() def remove_held_account(service, matter_id, hold_id, account_id): return service.matters().holds().accounts().delete( matterId=matter_id, holdId=hold_id, accountId=account_id).execute() def add_held_account(service, matter_id, hold_id, email): held_account = {'email': email} return service.matters().holds().accounts().create( matterId=matter_id, holdId=hold_id, body=held_account).execute()
В следующем примере показано, как изменить OU в существующем удержании OU:
Ява
Hold hold = client.matters().holds().get(matterId, holdId).execute(); hold.getOrgUnit().setOrgUnitId(newOrgUnitId); Hold modifiedHold = client.matters().holds().update(matterId, holdId, hold).execute(); return modifiedHold;
Питон
def update_hold_ou(service, matter_id, hold_id, org_unit_id): current_hold = get_hold(matter_id, hold_id) current_hold['orgUnit'] = {'orgUnitId': org_unit_id} return service.matters().holds().update( matterId=matter_id, holdId=hold_id, body=current_hold).execute()
В следующем примере показано, как составить список всех удержаний по делу:
Ява
String matterId = "Matter Id";// List all holds. List
holdsList = client.matters().holds().list(matterId).execute().getHolds(); // Paginate on holds. ListHoldsResponse response = client .matters() .holds() .list(matterId) .setPageSize(10) .execute();
String nextPageToken = response.getNextPageToken(); if (nextPageToken != null) { client .matters() .holds() .list(matterId) .setPageSize(10) .setPageToken(nextPageToken) .execute(); }
Питон
# This can paginate in the same manner as with matters. def list_holds(service, matter_id): return service.matters().holds().list(matterId=matter_id).execute()