G Suite Vault API: matters. Archiving and eDiscovery for G Suite. See: https://developers.google.com/vaultapi/reference/rest/v1/matters
G Suite Vault API: matters. Archiving and eDiscovery for G Suite. See: https://developers.google.com/vaultapi/reference/rest/v1/matters
(addPermissions$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/addPermissions
Required parameters: matterId
Optional parameters: none
Body:
{:sendEmails boolean, :matterPermission {:role string, :accountId string}, :ccMe boolean}
Adds an account as a matter collaborator.
https://developers.google.com/vaultapi/reference/rest/v1/matters/addPermissions Required parameters: matterId Optional parameters: none Body: {:sendEmails boolean, :matterPermission {:role string, :accountId string}, :ccMe boolean} Adds an account as a matter collaborator.
(close$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/close
Required parameters: matterId
Optional parameters: none
Body:
{}
Closes the specified matter. Returns matter with updated state.
https://developers.google.com/vaultapi/reference/rest/v1/matters/close Required parameters: matterId Optional parameters: none Body: {} Closes the specified matter. Returns matter with updated state.
(create$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/create
Required parameters: none
Optional parameters: none
Body:
{:matterId string, :state string, :name string, :matterPermissions [{:role string, :accountId string}], :description string}
Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
https://developers.google.com/vaultapi/reference/rest/v1/matters/create Required parameters: none Optional parameters: none Body: {:matterId string, :state string, :name string, :matterPermissions [{:role string, :accountId string}], :description string} Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
(delete$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/delete
Required parameters: matterId
Optional parameters: none
Deletes the specified matter. Returns matter with updated state.
https://developers.google.com/vaultapi/reference/rest/v1/matters/delete Required parameters: matterId Optional parameters: none Deletes the specified matter. Returns matter with updated state.
(exports-create$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/create
Required parameters: matterId
Optional parameters: none
Body:
{:name string, :createTime string, :requester {:email string, :displayName string}, :status string, :id string, :matterId string, :cloudStorageSink {:files [CloudStorageFile]}, :query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}, :stats {:totalArtifactCount string, :sizeInBytes string, :exportedArtifactCount string}, :exportOptions {:groupsOptions GroupsExportOptions, :driveOptions DriveExportOptions, :mailOptions MailExportOptions, :region string, :hangoutsChatOptions HangoutsChatExportOptions}}
Creates an Export.
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/create Required parameters: matterId Optional parameters: none Body: {:name string, :createTime string, :requester {:email string, :displayName string}, :status string, :id string, :matterId string, :cloudStorageSink {:files [CloudStorageFile]}, :query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}, :stats {:totalArtifactCount string, :sizeInBytes string, :exportedArtifactCount string}, :exportOptions {:groupsOptions GroupsExportOptions, :driveOptions DriveExportOptions, :mailOptions MailExportOptions, :region string, :hangoutsChatOptions HangoutsChatExportOptions}} Creates an Export.
(exports-delete$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/delete
Required parameters: matterId, exportId
Optional parameters: none
Deletes an Export.
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/delete Required parameters: matterId, exportId Optional parameters: none Deletes an Export.
(exports-get$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/get
Required parameters: matterId, exportId
Optional parameters: none
Gets an Export.
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/get Required parameters: matterId, exportId Optional parameters: none Gets an Export.
(exports-list$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/list
Required parameters: matterId
Optional parameters: pageToken, pageSize
Lists Exports.
https://developers.google.com/vaultapi/reference/rest/v1/matters/exports/list Required parameters: matterId Optional parameters: pageToken, pageSize Lists Exports.
(get$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/get
Required parameters: matterId
Optional parameters: view
Gets the specified matter.
https://developers.google.com/vaultapi/reference/rest/v1/matters/get Required parameters: matterId Optional parameters: view Gets the specified matter.
(holds-accounts-create$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/create
Required parameters: matterId, holdId
Optional parameters: none
Body:
{:lastName string, :email string, :accountId string, :firstName string, :holdTime string}
Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/create Required parameters: matterId, holdId Optional parameters: none Body: {:lastName string, :email string, :accountId string, :firstName string, :holdTime string} Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.
(holds-accounts-delete$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/delete
Required parameters: holdId, accountId, matterId
Optional parameters: none
Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/delete Required parameters: holdId, accountId, matterId Optional parameters: none Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
(holds-accounts-list$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/list
Required parameters: matterId, holdId
Optional parameters: none
Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use <a href="https://developers.google.com/admin-sdk/">Admin SDK</a> to enumerate its members.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/accounts/list Required parameters: matterId, holdId Optional parameters: none Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use <a href="https://developers.google.com/admin-sdk/">Admin SDK</a> to enumerate its members.
(holds-addHeldAccounts$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/addHeldAccounts
Required parameters: holdId, matterId
Optional parameters: none
Body:
{:emails [string], :accountIds [string]}
Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/addHeldAccounts Required parameters: holdId, matterId Optional parameters: none Body: {:emails [string], :accountIds [string]} Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.
(holds-create$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/create
Required parameters: matterId
Optional parameters: none
Body:
{:accounts [{:lastName string, :email string, :accountId string, :firstName string, :holdTime string}], :query {:mailQuery HeldMailQuery, :groupsQuery HeldGroupsQuery, :hangoutsChatQuery HeldHangoutsChatQuery, :driveQuery HeldDriveQuery}, :orgUnit {:holdTime string, :orgUnitId string}, :corpus string, :updateTime string, :name string, :holdId string}
Creates a hold in the given matter.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/create Required parameters: matterId Optional parameters: none Body: {:accounts [{:lastName string, :email string, :accountId string, :firstName string, :holdTime string}], :query {:mailQuery HeldMailQuery, :groupsQuery HeldGroupsQuery, :hangoutsChatQuery HeldHangoutsChatQuery, :driveQuery HeldDriveQuery}, :orgUnit {:holdTime string, :orgUnitId string}, :corpus string, :updateTime string, :name string, :holdId string} Creates a hold in the given matter.
(holds-delete$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/delete
Required parameters: holdId, matterId
Optional parameters: none
Removes a hold by ID. This will release any HeldAccounts on this Hold.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/delete Required parameters: holdId, matterId Optional parameters: none Removes a hold by ID. This will release any HeldAccounts on this Hold.
(holds-get$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/get
Required parameters: holdId, matterId
Optional parameters: view
Gets a hold by ID.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/get Required parameters: holdId, matterId Optional parameters: view Gets a hold by ID.
(holds-list$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/list
Required parameters: matterId
Optional parameters: view, pageToken, pageSize
Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/list Required parameters: matterId Optional parameters: view, pageToken, pageSize Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
(holds-removeHeldAccounts$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/removeHeldAccounts
Required parameters: matterId, holdId
Optional parameters: none
Body:
{:accountIds [string]}
Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/removeHeldAccounts Required parameters: matterId, holdId Optional parameters: none Body: {:accountIds [string]} Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.
(holds-update$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/update
Required parameters: matterId, holdId
Optional parameters: none
Body:
{:accounts [{:lastName string, :email string, :accountId string, :firstName string, :holdTime string}], :query {:mailQuery HeldMailQuery, :groupsQuery HeldGroupsQuery, :hangoutsChatQuery HeldHangoutsChatQuery, :driveQuery HeldDriveQuery}, :orgUnit {:holdTime string, :orgUnitId string}, :corpus string, :updateTime string, :name string, :holdId string}
Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.
https://developers.google.com/vaultapi/reference/rest/v1/matters/holds/update Required parameters: matterId, holdId Optional parameters: none Body: {:accounts [{:lastName string, :email string, :accountId string, :firstName string, :holdTime string}], :query {:mailQuery HeldMailQuery, :groupsQuery HeldGroupsQuery, :hangoutsChatQuery HeldHangoutsChatQuery, :driveQuery HeldDriveQuery}, :orgUnit {:holdTime string, :orgUnitId string}, :corpus string, :updateTime string, :name string, :holdId string} Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.
(list$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/list
Required parameters: none
Optional parameters: state, pageToken, pageSize, view
Lists matters the user has access to.
https://developers.google.com/vaultapi/reference/rest/v1/matters/list Required parameters: none Optional parameters: state, pageToken, pageSize, view Lists matters the user has access to.
(removePermissions$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/removePermissions
Required parameters: matterId
Optional parameters: none
Body:
{:accountId string}
Removes an account as a matter collaborator.
https://developers.google.com/vaultapi/reference/rest/v1/matters/removePermissions Required parameters: matterId Optional parameters: none Body: {:accountId string} Removes an account as a matter collaborator.
(reopen$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/reopen
Required parameters: matterId
Optional parameters: none
Body:
{}
Reopens the specified matter. Returns matter with updated state.
https://developers.google.com/vaultapi/reference/rest/v1/matters/reopen Required parameters: matterId Optional parameters: none Body: {} Reopens the specified matter. Returns matter with updated state.
(savedQueries-create$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/create
Required parameters: matterId
Optional parameters: none
Body:
{:query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}, :matterId string, :createTime string, :savedQueryId string, :displayName string}
Creates a saved query.
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/create Required parameters: matterId Optional parameters: none Body: {:query {:hangoutsChatOptions HangoutsChatOptions, :orgUnitInfo OrgUnitInfo, :timeZone string, :hangoutsChatInfo HangoutsChatInfo, :startTime string, :terms string, :searchMethod string, :method string, :endTime string, :sharedDriveInfo SharedDriveInfo, :accountInfo AccountInfo, :corpus string, :teamDriveInfo TeamDriveInfo, :mailOptions MailOptions, :driveOptions DriveOptions, :dataScope string}, :matterId string, :createTime string, :savedQueryId string, :displayName string} Creates a saved query.
(savedQueries-delete$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/delete
Required parameters: matterId, savedQueryId
Optional parameters: none
Deletes a saved query by Id.
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/delete Required parameters: matterId, savedQueryId Optional parameters: none Deletes a saved query by Id.
(savedQueries-get$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/get
Required parameters: matterId, savedQueryId
Optional parameters: none
Retrieves a saved query by Id.
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/get Required parameters: matterId, savedQueryId Optional parameters: none Retrieves a saved query by Id.
(savedQueries-list$ auth parameters)
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/list
Required parameters: matterId
Optional parameters: pageToken, pageSize
Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.
https://developers.google.com/vaultapi/reference/rest/v1/matters/savedQueries/list Required parameters: matterId Optional parameters: pageToken, pageSize Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.
(undelete$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/undelete
Required parameters: matterId
Optional parameters: none
Body:
{}
Undeletes the specified matter. Returns matter with updated state.
https://developers.google.com/vaultapi/reference/rest/v1/matters/undelete Required parameters: matterId Optional parameters: none Body: {} Undeletes the specified matter. Returns matter with updated state.
(update$ auth parameters body)
https://developers.google.com/vaultapi/reference/rest/v1/matters/update
Required parameters: matterId
Optional parameters: none
Body:
{:matterId string, :state string, :name string, :matterPermissions [{:role string, :accountId string}], :description string}
Updates the specified matter. This updates only the name and description of the matter, identified by matter id. Changes to any other fields are ignored. Returns the default view of the matter.
https://developers.google.com/vaultapi/reference/rest/v1/matters/update Required parameters: matterId Optional parameters: none Body: {:matterId string, :state string, :name string, :matterPermissions [{:role string, :accountId string}], :description string} Updates the specified matter. This updates only the name and description of the matter, identified by matter id. Changes to any other fields are ignored. Returns the default view of the matter.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close