--- canonical_url: "https://docs.composio.dev/toolkits/microsoft_purview" markdown_url: "https://docs.composio.dev/toolkits/microsoft_purview.md" product: "platform" version: null last_updated: null --- # Microsoft Purview Manage Microsoft Purview eDiscovery, records management, information protection, sensitivity labels, and subject rights requests through Microsoft Graph. - **Category:** security & identity tools - **Auth:** OAUTH2, S2S_OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 213 - **Triggers:** 0 - **Slug:** `MICROSOFT_PURVIEW` - **Version:** 00000000_00 ## Tools ### Activate Ediscovery Case Custodian **Slug:** `MICROSOFT_PURVIEW_ACTIVATE_EDISCOVERY_CASE_CUSTODIAN` Reactivate a released custodian so they become part of the eDiscovery case again. Microsoft Graph accepts this asynchronous workflow with 202 Accepted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: activate route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: activate route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Ediscovery Case Members **Slug:** `MICROSOFT_PURVIEW_ADD_EDISCOVERY_CASE_MEMBERS` Add an eDiscovery case member in Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Member ID. If omitted, provide display_name for a role group or smtp_address for a user. | | `display_name` | string | No | Role-group display name. If omitted for a role group, provide id. | | `smtp_address` | string | No | User SMTP address. If omitted for a user, provide id. | | `recipient_type` | string ("user" | "roleGroup") | Yes | Recipient type: user or roleGroup. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Add ediscoveryCaseMember route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Ediscovery Case Search Additional Sources **Slug:** `MICROSOFT_PURVIEW_ADD_EDISCOVERY_CASE_SEARCH_ADDITIONAL_SOURCES` Add one mailbox or site as an additional source for an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `site` | string | No | SharePoint site URL. Required when email is omitted; do not combine with email. | | `email` | string | No | Mailbox SMTP address. Required when site is omitted; do not combine with site. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Ediscovery Case Search Custodian Sources **Slug:** `MICROSOFT_PURVIEW_ADD_EDISCOVERY_CASE_SEARCH_CUSTODIAN_SOURCES` Deprecated: use ADD_EDISCOVERY_CASE_SEARCH_SOURCE with source_type='custodial'. Associate a custodial data source with an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_url` | string | Yes | Required Microsoft Graph URL of the custodial object to associate. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Ediscovery Case Search Noncustodial Sources **Slug:** `MICROSOFT_PURVIEW_ADD_EDISCOVERY_CASE_SEARCH_NONCUSTODIAL_SOURCES` Deprecated: use ADD_EDISCOVERY_CASE_SEARCH_SOURCE with source_type='noncustodial'. Associate a noncustodial data source with an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_url` | string | Yes | Required Microsoft Graph URL of the noncustodial object to associate. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Ediscovery Case Search Source **Slug:** `MICROSOFT_PURVIEW_ADD_EDISCOVERY_CASE_SEARCH_SOURCE` Associate one custodial or noncustodial data source with an eDiscovery search. Verify the source URL before changing this compliance relationship. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_url` | string | Yes | Microsoft Graph URL of the custodial or noncustodial object to associate. | | `source_type` | string ("custodial" | "noncustodial") | Yes | Type of search source relationship to add. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Search Results To Ediscovery Review Set **Slug:** `MICROSOFT_PURVIEW_ADD_SEARCH_RESULTS_TO_EDISCOVERY_REVIEW_SET` Start the long-running process that adds an eDiscovery search collection to a review set. Microsoft Graph returns only acceptance; monitor case operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search` | object | No | eDiscovery search reference to add to the review set. | | `document_version` | string ("latest" | "recent10" | "recent100" | "all") | No | Document versions to collect. | | `items_to_include` | string | No | Comma-separated item flags: searchHits or partiallyIndexed. | | `e_discovery_case_id` | string | Yes | ID of the eDiscovery case that contains the review set. | | `additional_data_options` | string | No | Comma-separated additional-data flags: allVersions, linkedFiles, advancedIndexing, listAttachments, htmlTranscripts, messageConversationExpansion, locationsWithoutHits, or allItemsInFolder. | | `cloud_attachment_version` | string ("latest" | "recent10" | "recent100" | "all") | No | Cloud attachment versions to collect. | | `e_discovery_review_set_id` | string | Yes | ID of the review set to add search results to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply Ediscovery Case Custodian Hold **Slug:** `MICROSOFT_PURVIEW_APPLY_EDISCOVERY_CASE_CUSTODIAN_HOLD` Apply a hold to one custodian through the stable v1.0 endpoint and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of custodians to apply hold. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: applyHold route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: applyHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply Ediscovery Case Custodians Hold **Slug:** `MICROSOFT_PURVIEW_APPLY_EDISCOVERY_CASE_CUSTODIANS_HOLD` Apply holds to selected custodians in an eDiscovery case and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of custodians to apply hold. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: applyHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply Ediscovery Case Noncustodial Data Source Hold **Slug:** `MICROSOFT_PURVIEW_APPLY_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCE_HOLD` Apply a hold to one noncustodial data source through the stable v1.0 endpoint and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of non-custodial data sources to apply hold. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: applyHold route. | | `ediscovery_noncustodial_data_source_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: applyHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply Ediscovery Case Noncustodial Data Sources Hold **Slug:** `MICROSOFT_PURVIEW_APPLY_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCES_HOLD` Apply holds to selected noncustodial data sources in an eDiscovery case and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of non-custodial data sources to apply hold. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: applyHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Apply Ediscovery Case Review Set Query Tags **Slug:** `MICROSOFT_PURVIEW_APPLY_EDISCOVERY_CASE_REVIEW_SET_QUERY_TAGS` Start the asynchronous process of adding, removing, or simultaneously adding and removing tags on files selected by a review set query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query_id` | string | Yes | ID of the query selecting files to tag. | | `tags_to_add` | array | No | Review tags to add. At least one non-empty tags_to_add or tags_to_remove list is required; both may be combined. | | `tags_to_remove` | array | No | Review tags to remove. At least one non-empty tags_to_add or tags_to_remove list is required; both may be combined. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Close Ediscovery Case **Slug:** `MICROSOFT_PURVIEW_CLOSE_EDISCOVERY_CASE` Close an eDiscovery case. This changes workflow state and can be difficult to reverse; confirm the target first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented Close eDiscoveryCase route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Compute Current User Governance Protection Scopes **Slug:** `MICROSOFT_PURVIEW_COMPUTE_CURRENT_USER_GOVERNANCE_PROTECTION_SCOPES` Compute data-protection policies and actions for the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pivot_on` | string ("activity" | "location" | "none") | No | Property by which Microsoft Graph aggregates results. | | `locations` | array | No | Application, domain, or URL locations to evaluate. | | `activities` | array | No | Distinct activity flags to evaluate. Use none by itself, or select uploadText, uploadFile, downloadText, and downloadFile as needed. | | `device_metadata` | object | No | Device context used for policy evaluation. | | `integrated_app_metadata` | object | No | Application integrating with Microsoft Purview. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Compute Tenant Governance Protection Scopes **Slug:** `MICROSOFT_PURVIEW_COMPUTE_TENANT_GOVERNANCE_PROTECTION_SCOPES` Compute tenant-wide data-protection policies, actions, and bindings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `pivot_on` | string ("activity" | "location" | "none") | No | Property by which Microsoft Graph aggregates results. | | `locations` | array | No | Application, domain, or URL locations to evaluate. | | `activities` | array | No | Distinct activity flags to evaluate. Use none by itself, or select uploadText, uploadFile, downloadText, and downloadFile as needed. | | `device_metadata` | object | No | Device context used for policy evaluation. | | `integrated_app_metadata` | object | No | Application integrating with Microsoft Purview. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Compute Tenant Governance Sensitivity Labels Inheritance **Slug:** `MICROSOFT_PURVIEW_COMPUTE_TENANT_GOVERNANCE_SENSITIVITY_LABELS_INHERITANCE` Compute the inherited tenant sensitivity label for selected labels and content formats. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | Locale for localizable label fields. | | `label_ids` | array | No | Sensitivity label GUIDs considered for inheritance. | | `content_formats` | array | No | Content formats to evaluate, such as File or Email. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Compute Tenant Governance Sensitivity Labels Rights And Inheritance **Slug:** `MICROSOFT_PURVIEW_COMPUTE_TENANT_GOVERNANCE_SENSITIVITY_LABELS_RIGHTS_AND_INHERITANCE` Compute usage rights and inherited labels for protected tenant content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `locale` | string | No | Localization code, such as en-US. | | `protected_contents` | array | No | Protected content items whose rights are computed. | | `delegated_user_email` | string | No | UPN of the user whose rights are computed. | | `supported_content_formats` | array | No | Supported formats, such as email and file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Compute User Governance Protection Scopes **Slug:** `MICROSOFT_PURVIEW_COMPUTE_USER_GOVERNANCE_PROTECTION_SCOPES` Compute data-protection policies and actions for a specific user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID of the user whose scopes are computed. | | `pivot_on` | string ("activity" | "location" | "none") | No | Property by which Microsoft Graph aggregates results. | | `locations` | array | No | Application, domain, or URL locations to evaluate. | | `activities` | array | No | Distinct activity flags to evaluate. Use none by itself, or select uploadText, uploadFile, downloadText, and downloadFile as needed. | | `device_metadata` | object | No | Device context used for policy evaluation. | | `integrated_app_metadata` | object | No | Application integrating with Microsoft Purview. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Authority **Slug:** `MICROSOFT_PURVIEW_CREATE_AUTHORITY` Create an authority template in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | Yes | Unique authority name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Category **Slug:** `MICROSOFT_PURVIEW_CREATE_CATEGORY` Create a category template in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | Yes | Unique category name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Category Subcategory **Slug:** `MICROSOFT_PURVIEW_CREATE_CATEGORY_SUBCATEGORY` Create a subcategory template under a category in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | No | Unique subcategory name. | | `category_template_id` | string | Yes | Parent category template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Citation **Slug:** `MICROSOFT_PURVIEW_CREATE_CITATION` Create a citation template in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `citation_url` | string | No | URL of the published citation. | | `display_name` | string | Yes | Unique citation name. | | `citation_jurisdiction` | string | No | Jurisdiction or agency that published the citation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Current User Governance Content Activity **Slug:** `MICROSOFT_PURVIEW_CREATE_CURRENT_USER_GOVERNANCE_CONTENT_ACTIVITY` Write a persistent Microsoft Purview compliance activity for the signed-in user. This stores metadata permanently, and Microsoft Graph provides no delete endpoint; confirm the metadata before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_to_process` | object | Yes | Required metadata for the persistent compliance activity. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Department **Slug:** `MICROSOFT_PURVIEW_CREATE_DEPARTMENT` Create a department template in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | Yes | Unique department name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE` Create a named eDiscovery case for an investigation, with an optional description and customer reference number. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | The case description. Optional. | | `external_id` | string | No | The external case number for customer reference. Optional. | | `display_name` | string | Yes | The name of the eDiscovery case. Required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Custodian **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_CUSTODIAN` Create one custodian in a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Custodian's primary SMTP address. Required. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create custodians route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Custodian Site Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_CUSTODIAN_SITE_SOURCE` Deprecated compatibility action. New callers should use CREATE_EDISCOVERY_CASE_CUSTODIAN_SOURCE with source_type=site. Create a site source for an eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `site` | string | Yes | URL of the site; for example, https://contoso.sharepoint.com/sites/HumanResources. | | `custodian_id` | string | Yes | Identifier used in the documented Create custodian siteSource route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create custodian siteSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Custodian Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_CUSTODIAN_SOURCE` Create one site, user, or unified-group source for an eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | No | User SMTP address. Required only when source_type is user. | | `group_id` | string | No | Microsoft Graph group ID or absolute v1.0 group resource URL. For unified_group, provide exactly one of group_email or group_id. | | `site_url` | string | No | SharePoint site URL. Required only when source_type is site. | | `group_email` | string | No | Group SMTP address. For unified_group, provide exactly one of group_email or group_id. | | `source_type` | string ("site" | "user" | "unified_group") | Yes | Source type to create: site, user, or unified_group. | | `custodian_id` | string | Yes | ID of the custodian that will own the source. | | `included_sources` | array | No | Distinct source types to include: mailbox and/or site. Allowed only for user and unified_group sources. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case that contains the custodian. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Custodian Unified Group Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_CUSTODIAN_UNIFIED_GROUP_SOURCE` Deprecated compatibility action. New callers should use CREATE_EDISCOVERY_CASE_CUSTODIAN_SOURCE with source_type=unified_group. Create a unified-group source for an eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group` | string | No | Group email address. Required when group_id is omitted; do not combine with group_id. | | `group_id` | string | No | Microsoft Graph group UUID or absolute v1.0 group resource URL. Required when group is omitted; do not combine with group. | | `custodian_id` | string | Yes | Identifier used in the documented Create custodian unifiedGroupSource route. | | `included_sources` | string | No | Comma-separated source flags: mailbox or site. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create custodian unifiedGroupSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Custodian User Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_CUSTODIAN_USER_SOURCE` Deprecated compatibility action. New callers should use CREATE_EDISCOVERY_CASE_CUSTODIAN_SOURCE with source_type=user. Create a user source for an eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | SMTP address of the user. | | `custodian_id` | string | Yes | Identifier used in the documented Create custodian userSource route. | | `included_sources` | string | No | Comma-separated source flags: mailbox or site. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create custodian userSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Legal Hold **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_LEGAL_HOLD` Create an eDiscovery hold policy. Graph can return 404 after committing this asynchronous operation; list the case's holds for the unique name before retrying. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | The description of the legal hold policy. Optional. | | `display_name` | string | Yes | The display name of the legal hold policy. Required. | | `content_query` | string | No | KQL query that specifies content to be held in the specified locations. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create ediscoveryHoldPolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Legal Hold Site Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_LEGAL_HOLD_SITE_SOURCE` Deprecated compatibility action for creating a site source on an eDiscovery legal hold. New callers should use CREATE_EDISCOVERY_CASE_LEGAL_HOLD_SOURCE with source_type='site'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `site` | string | Yes | URL of the site; for example, https://contoso.sharepoint.com/sites/HumanResources. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create siteSource route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Create siteSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Legal Hold Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_LEGAL_HOLD_SOURCE` Create one site or user source on a Microsoft Purview eDiscovery legal-hold policy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | No | Mailbox SMTP address. Required only when source_type is user. | | `site_url` | string | No | SharePoint site URL. Required only when source_type is site. | | `source_type` | string ("site" | "user") | Yes | Type of legal-hold source to create: site or user. | | `included_sources` | string | No | Set to mailbox to include the user's mailbox in the legal hold. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case containing the legal hold. | | `ediscovery_hold_policy_id` | string | Yes | Identifier of the legal hold policy receiving the source. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Legal Hold User Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_LEGAL_HOLD_USER_SOURCE` Deprecated compatibility action for creating a user source on an eDiscovery legal hold. New callers should use CREATE_EDISCOVERY_CASE_LEGAL_HOLD_SOURCE with source_type='user'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | SMTP address of the user. | | `included_sources` | string | No | Sources included in this group. Only mailbox is applicable for legal-hold user sources. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create userSource route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Create userSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Noncustodial Data Source **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCE` Create one noncustodial data source in a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | No | Mailbox SMTP address. Required only when source_type is user. | | `site_id` | string | No | Microsoft Graph site ID or resource URL. For a site source, this and site_url are mutually exclusive and one is required. | | `site_url` | string | No | SharePoint site URL. For a site source, this and site_id are mutually exclusive and one is required. | | `source_type` | string ("user" | "site") | Yes | Type of noncustodial source to create: user for a mailbox or site for a SharePoint site. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create nonCustodialDataSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Review Set **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_REVIEW_SET` Create a review set in an eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Description of the review set. | | `display_name` | string | Yes | Name of the review set. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Review Set Query **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_REVIEW_SET_QUERY` Create a KQL query in an eDiscovery review set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | Yes | Name of the query. | | `content_query` | string | No | KQL query used to cull review set content. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Search **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_SEARCH` Create a search in a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Optional description of the search. | | `display_name` | string | Yes | Display name of the search. | | `content_query` | string | No | Optional KQL query string. | | `data_source_scopes` | string | No | Optional comma-separated tenant or case data-source scope flags. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Ediscovery Case Tag **Slug:** `MICROSOFT_PURVIEW_CREATE_EDISCOVERY_CASE_TAG` Create a review tag for a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Description of the tag. Optional. | | `display_name` | string | Yes | Display name of the tag. Required. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Create tags route. | | `child_selectability` | string ("One" | "Many") | Yes | Whether child tags are single-select (One) or multi-select (Many). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create File Plan Reference **Slug:** `MICROSOFT_PURVIEW_CREATE_FILE_PLAN_REFERENCE` Create a file plan reference template in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | Yes | Unique file plan reference name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Retention Event **Slug:** `MICROSOFT_PURVIEW_CREATE_RETENTION_EVENT` Create a retention event in Microsoft Purview records management. This starts a compliance retention workflow for matching content; verify the event type, trigger time, and workload queries before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Optional information about the event. | | `event_query` | array | Yes | Workload and identification queries associated with the event. | | `display_name` | string | Yes | Name of the event. | | `retention_event_type` | string | Yes | Identifier of the retention event type associated with the event. | | `event_trigger_date_time` | string | No | Optional ISO 8601 date and time when the event should be triggered. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Retention Event Type **Slug:** `MICROSOFT_PURVIEW_CREATE_RETENTION_EVENT_TYPE` Create a retention event type in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Information about the event type. Optional. | | `display_name` | string | Yes | Name of the event type. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Retention Label **Slug:** `MICROSOFT_PURVIEW_CREATE_RETENTION_LABEL` Create a retention label in Microsoft Purview records management. The label can configure content retention or deletion, disposition review, treatment as a regulatory record, and automatic application of a replacement label after the retention period, according to the supplied settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `display_name` | string | Yes | Unique label name. | | `retention_trigger` | string ("dateLabeled" | "dateCreated" | "dateModified" | "dateOfEvent" | "unknownFutureValue") | No | Optional retention trigger: dateLabeled, dateCreated, dateModified, dateOfEvent, or unknownFutureValue. | | `retention_duration` | string | No | Optional duration for which content is retained, measured in days or forever. | | `label_to_be_applied` | string | No | Optional replacement label applied automatically after retention ends. | | `description_for_users` | string | No | Label information for users. | | `description_for_admins` | string | No | Label information for administrators. | | `default_record_behavior` | string ("startLocked" | "startUnlocked" | "unknownFutureValue") | No | Optional initial record lock state: startLocked, startUnlocked, or unknownFutureValue. | | `disposition_review_stages` | array | No | Review stages used when action_after_retention_period is startDispositionReview. | | `action_after_retention_period` | string ("none" | "delete" | "startDispositionReview" | "unknownFutureValue") | No | Optional action after retention: none, delete, startDispositionReview, or unknownFutureValue. Use startDispositionReview with disposition_review_stages. | | `behavior_during_retention_period` | string ("doNotRetain" | "retain" | "retainAsRecord" | "retainAsRegulatoryRecord" | "unknownFutureValue") | No | Optional retention behavior: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, or unknownFutureValue. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Subject Rights Request **Slug:** `MICROSOFT_PURVIEW_CREATE_SUBJECT_RIGHTS_REQUEST` Create a regulated subject rights request in Microsoft Purview. Confirm the subject and request type because delete requests can lead to data removal. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("export" | "access" | "delete" | "tagForAction") | Yes | Type of subject rights request. | | `approvers` | array | No | Users who can approve a delete request. | | `description` | string | No | Description for the request. | | `external_id` | string | No | Immutable identifier used by an external tracking system. | | `regulations` | array | No | Regulations the request must fulfill. | | `data_subject` | object | Yes | Information about the data subject. | | `display_name` | string | Yes | Name of the request. | | `collaborators` | array | No | Users who can collaborate on the request. | | `content_query` | string | No | KQL content query used for the search. | | `site_locations` | object | No | SharePoint and OneDrive sites to search. | | `data_subject_type` | string ("customer" | "currentEmployee" | "formerEmployee" | "prospectiveEmployee" | "student" | "teacher" | "faculty" | "other") | Yes | Type of data subject. | | `mailbox_locations` | object | No | Mailboxes to search. | | `include_all_versions` | boolean | No | Whether to include historical document versions. | | `pause_after_estimate` | boolean | No | Whether processing pauses after the estimate finishes. | | `internal_due_date_time` | string | No | Internal due date in ISO 8601 format. | | `include_authored_content` | boolean | No | Whether to include content authored by the data subject. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Subject Rights Request Note **Slug:** `MICROSOFT_PURVIEW_CREATE_SUBJECT_RIGHTS_REQUEST_NOTE` Create an authored note on a Microsoft Purview subject rights request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content` | object | Yes | Required note text and content format. | | `subject_rights_request_id` | string | Yes | Unique identifier of the subject rights request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create User Governance Content Activity **Slug:** `MICROSOFT_PURVIEW_CREATE_USER_GOVERNANCE_CONTENT_ACTIVITY` Write a persistent Microsoft Purview compliance activity for a specified user. This stores metadata permanently, and Microsoft Graph provides no delete endpoint; confirm the user and metadata before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID or user principal name of the activity's user. | | `content_to_process` | object | Yes | Required metadata for the persistent compliance activity. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Authority **Slug:** `MICROSOFT_PURVIEW_DELETE_AUTHORITY` Permanently delete an authority template. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `authority_template_id` | string | Yes | Authority template identifier to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Category **Slug:** `MICROSOFT_PURVIEW_DELETE_CATEGORY` Permanently delete a category template. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `category_template_id` | string | Yes | Category template identifier to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Category Subcategory **Slug:** `MICROSOFT_PURVIEW_DELETE_CATEGORY_SUBCATEGORY` Permanently delete a subcategory template from its parent category. Verify both identifiers before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `category_template_id` | string | Yes | Parent category template identifier. | | `subcategory_template_id` | string | Yes | Subcategory template identifier to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Citation **Slug:** `MICROSOFT_PURVIEW_DELETE_CITATION` Permanently delete a citation template. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `citation_template_id` | string | Yes | Citation template identifier to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Department **Slug:** `MICROSOFT_PURVIEW_DELETE_DEPARTMENT` Permanently delete a department template. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `department_template_id` | string | Yes | Department template identifier to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE` Delete an eDiscovery case. This permanently removes compliance state; verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete ediscoveryCase route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Case Member **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_CASE_MEMBER` Remove an eDiscovery case member. Verify the case and member identifiers before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented Remove ediscoveryCaseMember route. | | `e_discovery_case_member_id` | string | Yes | Case-member identifier in the documented remove route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Custodian Site Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_CUSTODIAN_SITE_SOURCE` Deprecated compatibility action. New callers should use DELETE_EDISCOVERY_CASE_CUSTODIAN_SOURCE with source_type=site. Delete one site-source association from an eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `site_source_id` | string | Yes | Identifier used in the documented Delete siteSource route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete siteSource route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented Delete siteSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Custodian Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_CUSTODIAN_SOURCE` Remove one site, unified-group, or user source association from an eDiscovery custodian. This does not delete the underlying site, group, mailbox, or content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_id` | string | Yes | ID of the site, unified-group, or user source to remove. | | `source_type` | string ("site" | "unified_group" | "user") | Yes | Custodian source type to delete: site, unified_group, or user. | | `custodian_id` | string | Yes | ID of the custodian that owns the source. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case that contains the custodian. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Custodian Unified Group Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_CUSTODIAN_UNIFIED_GROUP_SOURCE` Deprecated compatibility action. New callers should use DELETE_EDISCOVERY_CASE_CUSTODIAN_SOURCE with source_type=unified_group. Delete one unified-group-source association from an eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete unifiedGroupSource route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented Delete unifiedGroupSource route. | | `unified_group_source_id` | string | Yes | Identifier used in the documented Delete unifiedGroupSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Custodian User Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_CUSTODIAN_USER_SOURCE` Deprecated compatibility action. New callers should use DELETE_EDISCOVERY_CASE_CUSTODIAN_SOURCE with source_type=user. Remove one user-source association without deleting the mailbox or content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_source_id` | string | Yes | Identifier used in the documented Delete userSource route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete userSource route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented Delete userSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Legal Hold **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_LEGAL_HOLD` Permanently delete an eDiscovery hold policy, remove all associated holds, and release its sites and mailboxes. This can permanently delete content that was preserved only by this hold; verify every identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete ediscoveryHoldPolicy route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Delete ediscoveryHoldPolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Legal Hold Site Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_LEGAL_HOLD_SITE_SOURCE` Deprecated compatibility action for deleting a site source from an eDiscovery legal hold. New callers should use DELETE_EDISCOVERY_CASE_LEGAL_HOLD_SOURCE with source_type='site'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `site_source_id` | string | Yes | Identifier used in the documented Delete siteSource route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete siteSource route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Delete siteSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Legal Hold Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_LEGAL_HOLD_SOURCE` Remove one site or user source association from an eDiscovery legal-hold policy. This does not delete the underlying SharePoint site, mailbox, or content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_id` | string | Yes | Identifier of the site or user source to remove from the legal hold. | | `source_type` | string ("site" | "user") | Yes | Type of legal-hold source to delete: site or user. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case containing the legal hold. | | `ediscovery_hold_policy_id` | string | Yes | Identifier of the legal hold policy containing the source. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Legal Hold User Source **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_LEGAL_HOLD_USER_SOURCE` Deprecated compatibility action for deleting a user source from an eDiscovery legal hold. New callers should use DELETE_EDISCOVERY_CASE_LEGAL_HOLD_SOURCE with source_type='user'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_source_id` | string | Yes | Identifier used in the documented Delete userSource route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Delete userSource route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Delete userSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Review Set Query **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_REVIEW_SET_QUERY` Permanently delete a query from an eDiscovery review set. Verify the case, review set, and query identifiers before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `e_discovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set containing the query. | | `e_discovery_review_set_query_id` | string | Yes | ID of the review set query to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Search **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_SEARCH` Permanently delete an eDiscovery search. Destructive: verify the case and search identifiers before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the search to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Ediscovery Case Tag **Slug:** `MICROSOFT_PURVIEW_DELETE_EDISCOVERY_CASE_TAG` Remove an eDiscovery review tag. Verify the case and tag identifiers before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_id` | string | Yes | Review-tag identifier in the documented remove route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Remove ediscoveryReviewTag route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete File Plan Reference **Slug:** `MICROSOFT_PURVIEW_DELETE_FILE_PLAN_REFERENCE` Permanently delete a file plan reference template through the Microsoft Graph v1.0 endpoint. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_plan_reference_template_id` | string | Yes | File plan reference template identifier to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Retention Event **Slug:** `MICROSOFT_PURVIEW_DELETE_RETENTION_EVENT` Delete a retention event from Microsoft Purview records management. This permanently removes compliance state; verify the retention event identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_event_id` | string | Yes | Identifier of the retention event to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Retention Event Type **Slug:** `MICROSOFT_PURVIEW_DELETE_RETENTION_EVENT_TYPE` Permanently delete a retention event type. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_event_type_id` | string | Yes | Identifier used in the documented Delete retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Retention Label **Slug:** `MICROSOFT_PURVIEW_DELETE_RETENTION_LABEL` Permanently delete a retention label. Verify the identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Retention Label Descriptors File Plan Reference Template **Slug:** `MICROSOFT_PURVIEW_DELETE_RETENTION_LABEL_DESCRIPTORS_FILE_PLAN_REFERENCE_TEMPLATE` Compatibility action that unlinks the file plan reference descriptor from a retention label. New callers should use MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR with descriptor_type='file_plan_reference'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier whose file plan reference descriptor is deleted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disable Ediscovery Case Legal Hold Policy **Slug:** `MICROSOFT_PURVIEW_DISABLE_EDISCOVERY_CASE_LEGAL_HOLD_POLICY` Disable an eDiscovery legal-hold policy and start asynchronous removal from its configured sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryHoldPolicy: disablePolicy route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented ediscoveryHoldPolicy: disablePolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enable Ediscovery Case Legal Hold Policy **Slug:** `MICROSOFT_PURVIEW_ENABLE_EDISCOVERY_CASE_LEGAL_HOLD_POLICY` Enable an eDiscovery legal-hold policy and start asynchronous distribution to its configured sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryHoldPolicy: enablePolicy route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented ediscoveryHoldPolicy: enablePolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Estimate Ediscovery Case Search Statistics **Slug:** `MICROSOFT_PURVIEW_ESTIMATE_EDISCOVERY_CASE_SEARCH_STATISTICS` Start a potentially long-running estimate job for an eDiscovery search. Monitor completion using the returned operation location or operation-read tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `statistics_options` | string | No | Comma-separated statistics flags: includeRefiners, includeQueryStats, includeUnindexedStats, advancedIndexing, or locationsWithoutHits. advancedIndexing and locationsWithoutHits require includeUnindexedStats. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Current User Sensitivity Labels Application **Slug:** `MICROSOFT_PURVIEW_EVALUATE_CURRENT_USER_SENSITIVITY_LABELS_APPLICATION` Evaluate which sensitivity-label actions apply for the signed-in user and desired content state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Existing content format, state, and MIP metadata. | | `labeling_options` | object | No | Desired label state and assignment details. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Current User Sensitivity Labels Classification Results **Slug:** `MICROSOFT_PURVIEW_EVALUATE_CURRENT_USER_SENSITIVITY_LABELS_CLASSIFICATION_RESULTS` Evaluate classification results against sensitivity-label policy for the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Existing content format, state, and MIP metadata. | | `classification_results` | array | No | Data-classification results used to select a label. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Current User Sensitivity Labels Removal **Slug:** `MICROSOFT_PURVIEW_EVALUATE_CURRENT_USER_SENSITIVITY_LABELS_REMOVAL` Evaluate removal of a sensitivity label for the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Existing content format, state, and MIP metadata. | | `downgrade_justification` | object | No | User or application justification for label removal. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Tenant Information Protection Sensitivity Labels Application **Slug:** `MICROSOFT_PURVIEW_EVALUATE_TENANT_INFORMATION_PROTECTION_SENSITIVITY_LABELS_APPLICATION` Evaluate sensitivity-label application against tenant information-protection policy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Existing content information. | | `labeling_options` | object | No | Desired label state. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate User Sensitivity Labels Application **Slug:** `MICROSOFT_PURVIEW_EVALUATE_USER_SENSITIVITY_LABELS_APPLICATION` Evaluate sensitivity-label application for a specific user's policy context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID or UPN of the target user. | | `content_info` | object | No | Existing content information. | | `labeling_options` | object | No | Desired label state. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate User Sensitivity Labels Classification Results **Slug:** `MICROSOFT_PURVIEW_EVALUATE_USER_SENSITIVITY_LABELS_CLASSIFICATION_RESULTS` Evaluate classification results for a specific user's information-protection policy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID or UPN of the target user. | | `content_info` | object | No | Existing content information. | | `classification_results` | array | No | Classification results used to select policy actions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate User Sensitivity Labels Removal **Slug:** `MICROSOFT_PURVIEW_EVALUATE_USER_SENSITIVITY_LABELS_REMOVAL` Evaluate sensitivity-label removal for a specific user's policy context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID or UPN of the target user. | | `content_info` | object | No | Existing content information. | | `downgrade_justification` | object | No | Justification for label removal. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Users Sensitivity Labels Classification Results **Slug:** `MICROSOFT_PURVIEW_EVALUATE_USERS_SENSITIVITY_LABELS_CLASSIFICATION_RESULTS` Evaluate classification results in the tenant-wide users information-protection context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Existing content information. | | `classification_results` | array | No | Classification results used to select policy actions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Evaluate Users Sensitivity Labels Removal **Slug:** `MICROSOFT_PURVIEW_EVALUATE_USERS_SENSITIVITY_LABELS_REMOVAL` Evaluate label removal in the tenant-wide users information-protection context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Existing content information. | | `downgrade_justification` | object | No | Justification for label removal. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Ediscovery Case Review Set **Slug:** `MICROSOFT_PURVIEW_EXPORT_EDISCOVERY_CASE_REVIEW_SET` Start a long-running review set export. The credential-bearing export location is deliberately not returned; monitor case operations for status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Description of the export job. | | `output_name` | string | Yes | Name of the export. | | `export_options` | string | No | Comma-separated export content and format flags. | | `export_structure` | string ("none" | "directory" | "pst" | "msg") | No | Export packaging structure. Prefer pst or msg; directory is deprecated. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set to export. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Ediscovery Case Review Set Query **Slug:** `MICROSOFT_PURVIEW_EXPORT_EDISCOVERY_CASE_REVIEW_SET_QUERY` Start a long-running export of files matching a review set query. No export location or credential-bearing URL is returned; monitor case operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query_id` | string | Yes | ID of the query whose matching files to export. | | `description` | string | No | Description of the export job. | | `output_name` | string | Yes | Name of the export. | | `export_options` | string | No | Comma-separated export content and format flags. | | `export_structure` | string ("none" | "directory" | "pst" | "msg") | No | Export packaging structure. Prefer pst or msg; directory is deprecated. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Ediscovery Case Search Report **Slug:** `MICROSOFT_PURVIEW_EXPORT_EDISCOVERY_CASE_SEARCH_REPORT` Start a potentially long-running eDiscovery search report export. This can trigger substantial compliance processing; monitor the returned operation location until completion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Optional export report description. | | `display_name` | string | No | Optional export report display name. | | `export_criteria` | string | Yes | Comma-separated criteria: searchHits and/or partiallyIndexed. | | `export_location` | string | No | Comma-separated location flags for partially indexed items: responsiveLocations and/or nonresponsiveLocations. | | `document_version` | string ("latest" | "recent10" | "recent100" | "all") | No | SharePoint document versions to include. | | `additional_options` | string | Yes | Comma-separated report options, or none. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | | `cloud_attachment_version` | string ("latest" | "recent10" | "recent100" | "all") | No | Cloud attachment versions to include. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Export Ediscovery Case Search Result **Slug:** `MICROSOFT_PURVIEW_EXPORT_EDISCOVERY_CASE_SEARCH_RESULT` Start a potentially long-running eDiscovery search-result export. This can trigger substantial compliance processing; monitor the returned operation location until completion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Optional export result description. | | `display_name` | string | No | Optional export result display name. | | `export_format` | string ("pst" | "msg" | "eml") | Yes | Email export format; eml is deprecated, so prefer pst or msg. | | `export_criteria` | string | Yes | Comma-separated criteria: searchHits and/or partiallyIndexed. | | `export_location` | string | No | Comma-separated location flags for partially indexed items: responsiveLocations and/or nonresponsiveLocations. | | `document_version` | string ("latest" | "recent10" | "recent100" | "all") | No | SharePoint document versions to include. | | `additional_options` | string | Yes | Comma-separated result options, or none. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | | `cloud_attachment_version` | string ("latest" | "recent10" | "recent100" | "all") | No | Cloud attachment versions to include. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Extract Current User Sensitivity Labels Content Label **Slug:** `MICROSOFT_PURVIEW_EXTRACT_CURRENT_USER_SENSITIVITY_LABELS_CONTENT_LABEL` Extract sensitivity-label information from content metadata for the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Content information whose embedded label should be extracted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Extract User Sensitivity Labels Content Label **Slug:** `MICROSOFT_PURVIEW_EXTRACT_USER_SENSITIVITY_LABELS_CONTENT_LABEL` Extract a sensitivity label from existing content metadata for a specified user using application authentication. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID or UPN of the specified user for application authentication. | | `content_info` | object | No | Content information containing label metadata. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Extract Users Sensitivity Labels Content Label **Slug:** `MICROSOFT_PURVIEW_EXTRACT_USERS_SENSITIVITY_LABELS_CONTENT_LABEL` Extract a content label in the tenant-wide users information-protection context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_info` | object | No | Content information containing label metadata. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Authority **Slug:** `MICROSOFT_PURVIEW_GET_AUTHORITY` Get an authority template from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `authority_template_id` | string | Yes | Authority template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Category **Slug:** `MICROSOFT_PURVIEW_GET_CATEGORY` Get a category template from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `category_template_id` | string | Yes | Category template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Category Subcategory **Slug:** `MICROSOFT_PURVIEW_GET_CATEGORY_SUBCATEGORY` Get a subcategory template from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `category_template_id` | string | Yes | Parent category template identifier. | | `subcategory_template_id` | string | Yes | Subcategory template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Citation **Slug:** `MICROSOFT_PURVIEW_GET_CITATION` Get a citation template from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `citation_template_id` | string | Yes | Citation template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User Label Policy Settings **Slug:** `MICROSOFT_PURVIEW_GET_CURRENT_USER_LABEL_POLICY_SETTINGS` Get information-protection label policy settings for the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User Sensitivity Label **Slug:** `MICROSOFT_PURVIEW_GET_CURRENT_USER_SENSITIVITY_LABEL` Get one sensitivity label available to the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | | `sensitivity_label_id` | string | Yes | Identifier of the sensitivity label to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Department **Slug:** `MICROSOFT_PURVIEW_GET_DEPARTMENT` Get a department template from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `department_template_id` | string | Yes | Department template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE` Get one eDiscovery case from Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get ediscoveryCase route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Custodian **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_CUSTODIAN` Get ediscovery custodian in Microsoft Purview ediscovery custodians and sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get ediscoveryCustodian route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented Get ediscoveryCustodian route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Legal Hold **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_LEGAL_HOLD` Get ediscovery hold policy in Microsoft Purview ediscovery holds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get ediscoveryHoldPolicy route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Get ediscoveryHoldPolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Noncustodial Data Source **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCE` Get ediscovery noncustodial data source in Microsoft Purview ediscovery custodians and sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get ediscoveryNoncustodialDataSource route. | | `ediscovery_noncustodial_data_source_id` | string | Yes | Identifier used in the documented Get ediscoveryNoncustodialDataSource route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Operation **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_OPERATION` Get case-operation status and safe metadata without exposing export download URLs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `case_operation_id` | string | Yes | Identifier used in the documented Get caseOperation route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get caseOperation route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Review Set **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_REVIEW_SET` Get one review set from an eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter supported by the method. | | `select` | string | No | Comma-separated properties to return. | | `review_set_id` | string | Yes | ID of the review set. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Review Set File **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_REVIEW_SET_FILE` Get metadata for one review set file through the beta-only route. File content and extracted text are never returned. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter supported by the method. | | `select` | string | No | Comma-separated properties to return. Do not request content or extractedTextContent. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_file_id` | string | Yes | ID of the review set file. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Review Set File Tag **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_REVIEW_SET_FILE_TAG` Get a tag by ID from the tags expanded on a beta eDiscovery review set file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_file_id` | string | Yes | ID of the review set file. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | | `ediscovery_review_tag_id` | string | Yes | ID of the review tag to locate in the file's expanded tags. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Review Set File Tag Child Tag **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_REVIEW_SET_FILE_TAG_CHILD_TAG` Get an applied child tag by its ID and parent tag ID from a beta eDiscovery review set file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `child_tag_id` | string | Yes | ID of the child review tag to locate under the requested parent. | | `parent_tag_id` | string | Yes | ID of the parent review tag for the requested child tag. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_file_id` | string | Yes | ID of the review set file. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Review Set File Tag Parent **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_REVIEW_SET_FILE_TAG_PARENT` Get the expanded parent of a tag associated with a beta eDiscovery review set file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_file_id` | string | Yes | ID of the review set file. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | | `ediscovery_review_tag_id` | string | Yes | ID of the review tag whose expanded parent to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Review Set Query **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_REVIEW_SET_QUERY` Get one query from an eDiscovery review set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter supported by the method. | | `select` | string | No | Comma-separated properties to return. | | `query_id` | string | Yes | ID of the review set query. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Search **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_SEARCH` Get one Microsoft Purview eDiscovery search by case and search identifier. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter supported by this operation. | | `select` | string | No | OData properties to return. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Search Last Estimate Statistics Operation **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_SEARCH_LAST_ESTIMATE_STATISTICS_OPERATION` Get the latest estimate-statistics operation for an eDiscovery search to monitor long-running processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter supported by this operation. | | `select` | string | No | OData properties to return. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Settings **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_SETTINGS` Get settings for a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get ediscoveryCaseSettings route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Tag **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_TAG` Get one review tag from a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Get ediscoveryReviewTag route. | | `ediscovery_review_tag_id` | string | Yes | Review-tag identifier in the documented get route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Ediscovery Case Tags As Hierarchy **Slug:** `MICROSOFT_PURVIEW_GET_EDISCOVERY_CASE_TAGS_AS_HIERARCHY` Return the review-tag hierarchy for a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented tags-as-hierarchy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get File Plan Reference **Slug:** `MICROSOFT_PURVIEW_GET_FILE_PLAN_REFERENCE` Get a file plan reference template from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `file_plan_reference_template_id` | string | Yes | File plan reference template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Event **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_EVENT` Get one retention event from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `retention_event_id` | string | Yes | Identifier of the retention event to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Event Label **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_EVENT_LABEL` Get a retention label associated with a Microsoft Purview retention event. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `retention_event_id` | string | Yes | Identifier of the retention event associated with the label. | | `retention_label_id` | string | Yes | Identifier of the retention label to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Event Retention Event Type **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_EVENT_RETENTION_EVENT_TYPE` Get the retention event type associated with a retention event. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Filter expression supported by the Microsoft Graph method. | | `select` | string | No | Properties to return, as supported by Microsoft Graph. | | `retention_event_id` | string | Yes | Identifier used in the documented Get retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Event Type **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_EVENT_TYPE` Get a retention event type from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Filter expression supported by the Microsoft Graph method. | | `select` | string | No | Properties to return, as supported by Microsoft Graph. | | `retention_event_type_id` | string | Yes | Identifier used in the documented Get retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL` Get a retention label from Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Descriptor **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTOR` Get one authority, category, citation, department, or file plan reference descriptor associated with a retention label. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by the selected descriptor method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `descriptor_type` | string ("authority" | "category" | "citation" | "department" | "file_plan_reference") | Yes | Descriptor relationship to retrieve. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Descriptors Authority Template **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTORS_AUTHORITY_TEMPLATE` Compatibility-specific authority descriptor getter. New callers should use MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTOR with descriptor_type='authority'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Descriptors Category Template **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTORS_CATEGORY_TEMPLATE` Compatibility-specific category descriptor getter. New callers should use MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTOR with descriptor_type='category'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Descriptors Citation Template **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTORS_CITATION_TEMPLATE` Compatibility-specific citation descriptor getter. New callers should use MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTOR with descriptor_type='citation'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Descriptors Department Template **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTORS_DEPARTMENT_TEMPLATE` Compatibility-specific department descriptor getter. New callers should use MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTOR with descriptor_type='department'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Descriptors File Plan Reference Template **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTORS_FILE_PLAN_REFERENCE_TEMPLATE` Compatibility-specific file plan reference descriptor getter. New callers should use MICROSOFT_PURVIEW_GET_RETENTION_LABEL_DESCRIPTOR with descriptor_type='file_plan_reference'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Retention label identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Retention Label Event Type **Slug:** `MICROSOFT_PURVIEW_GET_RETENTION_LABEL_EVENT_TYPE` Get the retention event type associated with a retention label. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Filter expression supported by the Microsoft Graph method. | | `select` | string | No | Properties to return, as supported by Microsoft Graph. | | `retention_label_id` | string | Yes | Identifier used in the documented Get retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Subject Rights Request **Slug:** `MICROSOFT_PURVIEW_GET_SUBJECT_RIGHTS_REQUEST` Get one subject rights request from Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `subject_rights_request_id` | string | Yes | Unique identifier of the subject rights request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Subject Rights Request Final Attachment **Slug:** `MICROSOFT_PURVIEW_GET_SUBJECT_RIGHTS_REQUEST_FINAL_ATTACHMENT` Download the completed subject rights request attachment as a framework-managed file without exposing the provider's redirect credentials. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `subject_rights_request_id` | string | Yes | Unique identifier of the subject rights request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Subject Rights Request Final Report **Slug:** `MICROSOFT_PURVIEW_GET_SUBJECT_RIGHTS_REQUEST_FINAL_REPORT` Download the completed subject rights request report as a framework-managed file without exposing provider redirect credentials. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `subject_rights_request_id` | string | Yes | Unique identifier of the subject rights request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tenant Governance Sensitivity Label **Slug:** `MICROSOFT_PURVIEW_GET_TENANT_GOVERNANCE_SENSITIVITY_LABEL` Get one tenant sensitivity label through the data-security and governance API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | | `label_id` | string | Yes | Identifier of the tenant sensitivity label. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tenant Governance Sensitivity Label Rights **Slug:** `MICROSOFT_PURVIEW_GET_TENANT_GOVERNANCE_SENSITIVITY_LABEL_RIGHTS` Get the calling user's usage rights for a tenant sensitivity label. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label_id` | string | Yes | Identifier of the tenant sensitivity label. | | `owner_email` | string | No | Email address of the label rights owner. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tenant Information Protection Label Policy Settings **Slug:** `MICROSOFT_PURVIEW_GET_TENANT_INFORMATION_PROTECTION_LABEL_POLICY_SETTINGS` Get tenant information-protection label policy settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tenant Information Protection Sensitivity Label **Slug:** `MICROSOFT_PURVIEW_GET_TENANT_INFORMATION_PROTECTION_SENSITIVITY_LABEL` Get one tenant sensitivity label through the beta information-protection API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | | `sensitivity_label_id` | string | Yes | Identifier of the tenant sensitivity label. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Label Policy Settings **Slug:** `MICROSOFT_PURVIEW_GET_USER_LABEL_POLICY_SETTINGS` Get information-protection label policy settings for a specific user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | | `user_id` | string | Yes | Object ID or user principal name of the target user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Sensitivity Label **Slug:** `MICROSOFT_PURVIEW_GET_USER_SENSITIVITY_LABEL` Get one sensitivity label available to a specific user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | | `user_id` | string | Yes | Object ID or user principal name of the target user. | | `sensitivity_label_id` | string | Yes | Identifier of the sensitivity label. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Authorities **Slug:** `MICROSOFT_PURVIEW_LIST_AUTHORITIES` List authority templates in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Categories **Slug:** `MICROSOFT_PURVIEW_LIST_CATEGORIES` List category templates in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Category Subcategories **Slug:** `MICROSOFT_PURVIEW_LIST_CATEGORY_SUBCATEGORIES` List subcategory templates for a category in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | | `category_template_id` | string | Yes | Parent category template identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Citations **Slug:** `MICROSOFT_PURVIEW_LIST_CITATIONS` List citation templates in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Current User Sensitivity Labels **Slug:** `MICROSOFT_PURVIEW_LIST_CURRENT_USER_SENSITIVITY_LABELS` List sensitivity labels available to the signed-in user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Departments **Slug:** `MICROSOFT_PURVIEW_LIST_DEPARTMENTS` List department templates in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Custodian Last Index Operation **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_CUSTODIAN_LAST_INDEX_OPERATION` Get the most recent indexing operation for one custodian in an eDiscovery case. Use it to monitor the progress and outcome of that custodian's index update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List lastIndexOperation route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented List lastIndexOperation route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Custodians **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_CUSTODIANS` List ediscovery custodian in Microsoft Purview ediscovery custodians and sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List ediscoveryCustodian route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Custodian Site Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_CUSTODIAN_SITE_SOURCES` Deprecated compatibility action. New callers should use LIST_EDISCOVERY_CASE_CUSTODIAN_SOURCES with source_type=site. List site sources for one eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `custodian_id` | string | Yes | Identifier used in the documented List siteSources route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List siteSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Custodian Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_CUSTODIAN_SOURCES` List site, unified-group, or user sources that belong to one custodian in an eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Maximum number of sources to return on this page. | | `skip` | integer | No | Number of sources to skip before returning this page. | | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `filter` | string | No | OData expression used to filter the sources. | | `order_by` | string | No | Comma-separated properties and directions used to sort sources. | | `source_type` | string ("site" | "unified_group" | "user") | Yes | Custodian source type to list: site, unified_group, or user. | | `custodian_id` | string | Yes | ID of the custodian whose sources are listed. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case that contains the custodian. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Custodian Unified Group Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_CUSTODIAN_UNIFIED_GROUP_SOURCES` Deprecated compatibility action. New callers should use LIST_EDISCOVERY_CASE_CUSTODIAN_SOURCES with source_type=unified_group. List unified-group sources for one eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `custodian_id` | string | Yes | Identifier used in the documented List custodian's unifiedGroupSources route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List custodian's unifiedGroupSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Custodian User Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_CUSTODIAN_USER_SOURCES` Deprecated compatibility action. New callers should use LIST_EDISCOVERY_CASE_CUSTODIAN_SOURCES with source_type=user. List user sources for one eDiscovery custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `custodian_id` | string | Yes | Identifier used in the documented List userSources route. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List userSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Legal Holds **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_LEGAL_HOLDS` List ediscovery hold policies in Microsoft Purview ediscovery holds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List ediscoveryHoldPolicies route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Legal Hold Site Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_LEGAL_HOLD_SITE_SOURCES` Deprecated compatibility action for listing site sources attached directly to an eDiscovery legal hold. New callers should use LIST_EDISCOVERY_CASE_LEGAL_HOLD_SOURCES with source_type='site'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List siteSources route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented List siteSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Legal Hold Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_LEGAL_HOLD_SOURCES` List one page of site or user sources attached directly to an eDiscovery legal-hold policy, excluding sources owned by a custodian. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `top` | integer | No | Maximum number of sources to return on this page. | | `skip` | integer | No | Number of sources to skip before returning this page. | | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `filter` | string | No | OData expression used to filter the returned sources. | | `order_by` | string | No | Comma-separated properties and directions used to sort sources. | | `source_type` | string ("site" | "user") | Yes | Type of legal-hold sources to list: site or user. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case containing the legal hold. | | `ediscovery_hold_policy_id` | string | Yes | Identifier of the legal hold policy whose sources are listed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Legal Hold User Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_LEGAL_HOLD_USER_SOURCES` Deprecated compatibility action for listing user sources attached directly to an eDiscovery legal hold. New callers should use LIST_EDISCOVERY_CASE_LEGAL_HOLD_SOURCES with source_type='user'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List userSources route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented List userSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Members **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_MEMBERS` List member objects for an eDiscovery case in Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented case-member list route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Noncustodial Data Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCES` List ediscovery noncustodial data sources in Microsoft Purview ediscovery custodians and sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. Omit for the first page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List ediscoveryNoncustodialDataSources route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Noncustodial Source Last Index Operation **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_NONCUSTODIAL_SOURCE_LAST_INDEX_OPERATION` Get the most recent indexing operation for one noncustodial data source in an eDiscovery case. Use it to monitor the progress and outcome of that source's index update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | string | No | Supported where stated by the method page. | | `select` | string | No | Supported where stated by the method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List lastIndexOperation route. | | `ediscovery_noncustodial_data_source_id` | string | Yes | Identifier used in the documented List lastIndexOperation route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Operations **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_OPERATIONS` List case operations for a Microsoft Purview eDiscovery case without exposing export download URLs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented case-operations list route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Review Set Files **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_REVIEW_SET_FILES` Return one page of file metadata from a review set using the beta-only Graph route. File content and extracted text are excluded. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Graph nextLink from a prior page. | | `filter` | string | No | OData expression for filtering files. | | `select` | string | No | Comma-separated properties to return. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set whose files to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Review Set Queries **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_REVIEW_SET_QUERIES` Return one page of queries associated with an eDiscovery review set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Graph nextLink from a prior page. | | `filter` | string | No | OData expression for filtering queries. | | `select` | string | No | Comma-separated properties to return. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set whose queries to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Review Sets **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_REVIEW_SETS` Return one page of review sets in an eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Graph nextLink from a prior page. | | `filter` | string | No | OData expression for filtering review sets. | | `select` | string | No | Comma-separated properties to return. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case whose review sets to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Cases **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASES` List eDiscovery cases in Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Search Additional Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_SEARCH_ADDITIONAL_SOURCES` Deprecated: use LIST_EDISCOVERY_CASE_SEARCH_SOURCES with source_type='additional'. List one page of additional sources associated with an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. | | `filter` | string | No | OData filter supported by this operation. | | `select` | string | No | OData properties to return. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Search Custodian Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_SEARCH_CUSTODIAN_SOURCES` Deprecated: use LIST_EDISCOVERY_CASE_SEARCH_SOURCES with source_type='custodial'. List one page of custodial data sources associated with an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. | | `filter` | string | No | OData filter supported by this operation. | | `select` | string | No | OData properties to return. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Searches **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_SEARCHES` List one page of searches in a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. | | `filter` | string | No | OData filter supported by this operation. | | `select` | string | No | OData properties to return. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Search Noncustodial Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_SEARCH_NONCUSTODIAL_SOURCES` Deprecated: use LIST_EDISCOVERY_CASE_SEARCH_SOURCES with source_type='noncustodial'. List one page of noncustodial data sources associated with an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. | | `filter` | string | No | OData filter supported by this operation. | | `select` | string | No | OData properties to return. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Search Sources **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_SEARCH_SOURCES` List one page of additional, custodial, or noncustodial data sources associated with an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation URL returned by a previous call. | | `filter` | string | No | OData filter supported by the selected operation. | | `select` | string | No | OData properties to return. | | `source_type` | string ("additional" | "custodial" | "noncustodial") | Yes | Type of search source relationship to list. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Ediscovery Case Tags **Slug:** `MICROSOFT_PURVIEW_LIST_EDISCOVERY_CASE_TAGS` List review tags for a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented List tags route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List File Plan References **Slug:** `MICROSOFT_PURVIEW_LIST_FILE_PLAN_REFERENCES` List file plan reference templates in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Retention Events **Slug:** `MICROSOFT_PURVIEW_LIST_RETENTION_EVENTS` List retention events in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Supported where stated by the Microsoft Graph method page. | | `select` | string | No | Supported where stated by the Microsoft Graph method page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Retention Event Types **Slug:** `MICROSOFT_PURVIEW_LIST_RETENTION_EVENT_TYPES` List retention event types in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Filter expression supported by the Microsoft Graph method. | | `select` | string | No | Properties to return, as supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Retention Labels **Slug:** `MICROSOFT_PURVIEW_LIST_RETENTION_LABELS` List retention labels in Microsoft Purview records management without an unsupported page-size query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | OData filter expression supported by this method. | | `select` | string | No | OData properties to return, where supported by Microsoft Graph. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subject Rights Request Notes **Slug:** `MICROSOFT_PURVIEW_LIST_SUBJECT_RIGHTS_REQUEST_NOTES` List authored notes associated with a Microsoft Purview subject rights request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Microsoft Graph $filter expression for the notes. | | `select` | string | No | Properties to return, as a Microsoft Graph $select expression. | | `subject_rights_request_id` | string | Yes | Unique identifier of the subject rights request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subject Rights Requests **Slug:** `MICROSOFT_PURVIEW_LIST_SUBJECT_RIGHTS_REQUESTS` List subject rights requests in Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Microsoft Graph $filter expression for the requests. | | `select` | string | No | Properties to return, as a Microsoft Graph $select expression. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tenant Governance Sensitivity Labels **Slug:** `MICROSOFT_PURVIEW_LIST_TENANT_GOVERNANCE_SENSITIVITY_LABELS` List tenant sensitivity labels through the data-security and governance API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Microsoft Graph next-page URL returned by a previous call. | | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tenant Information Protection Sensitivity Labels **Slug:** `MICROSOFT_PURVIEW_LIST_TENANT_INFORMATION_PROTECTION_SENSITIVITY_LABELS` List tenant sensitivity labels through the beta information-protection API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Graph next-page URL. | | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List User Sensitivity Labels **Slug:** `MICROSOFT_PURVIEW_LIST_USER_SENSITIVITY_LABELS` List sensitivity labels available to a specific user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Complete Graph next-page URL. | | `filter` | string | No | Microsoft Graph OData filter expression. | | `select` | string | No | Properties to return, as a comma-separated list. | | `user_id` | string | Yes | Object ID or user principal name of the target user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Process Current User Governance Content **Slug:** `MICROSOFT_PURVIEW_PROCESS_CURRENT_USER_GOVERNANCE_CONTENT` Process content against data protection policies in the signed-in user's context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `if_none_match` | string | No | ETag from protectionScopes compute used to detect policy-state changes. | | `content_to_process` | object | Yes | Content and policy-evaluation context for the signed-in user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Process Tenant Governance Content **Slug:** `MICROSOFT_PURVIEW_PROCESS_TENANT_GOVERNANCE_CONTENT` Evaluate content against tenant data-security and governance policies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content_to_process` | object | Yes | Content and complete policy-evaluation context. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Process Tenant Governance Content Async **Slug:** `MICROSOFT_PURVIEW_PROCESS_TENANT_GOVERNANCE_CONTENT_ASYNC` Submit a batch of content for tenant data-security and governance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `process_content_requests` | array | Yes | Batch items; total content entries across the batch cannot exceed 64. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Process User Governance Content **Slug:** `MICROSOFT_PURVIEW_PROCESS_USER_GOVERNANCE_CONTENT` Process content against data protection policies in a specified user's context. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Object ID or user principal name of the user whose context is evaluated. | | `if_none_match` | string | No | ETag from protectionScopes compute used to detect policy-state changes. | | `content_to_process` | object | Yes | Content and policy-evaluation context for the specified user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Purge Ediscovery Case Search Data **Slug:** `MICROSOFT_PURVIEW_PURGE_EDISCOVERY_CASE_SEARCH_DATA` Start an eDiscovery data purge. teamsMessages are permanently deleted even with recoverable; permanentlyDelete is irreversible for all selected areas. Verify the case, search, required purge areas, and required purge type before calling, then monitor the returned operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `purge_type` | string ("recoverable" | "permanentlyDelete") | Yes | Required purge type. recoverable retains recoverable mailbox items, but teamsMessages are still permanently deleted. permanentlyDelete is irreversible for all selected areas. | | `purge_areas` | string | Yes | Required comma-separated locations to purge: mailboxes and/or teamsMessages. teamsMessages are permanently deleted even when purge_type is recoverable. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case containing data to purge. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search whose matching data will be purged. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Release Ediscovery Case Custodian **Slug:** `MICROSOFT_PURVIEW_RELEASE_EDISCOVERY_CASE_CUSTODIAN` Release one custodian from an eDiscovery case and start asynchronous cleanup of its case data and holds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: release route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: release route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Release Ediscovery Case Noncustodial Data Source **Slug:** `MICROSOFT_PURVIEW_RELEASE_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCE` Release one noncustodial data source from an eDiscovery case and start asynchronous cleanup of its case data and holds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: release route. | | `ediscovery_noncustodial_data_source_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: release route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Custodian Hold **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_CUSTODIAN_HOLD` Remove the hold from one custodian through the stable v1.0 endpoint and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: removeHold route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: removeHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Custodians Hold **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_CUSTODIANS_HOLD` Remove holds from selected custodians in an eDiscovery case and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of custodians from which to remove holds. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: removeHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Noncustodial Data Source Hold **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCE_HOLD` Remove the hold from one noncustodial data source through the stable v1.0 endpoint and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: removeHold route. | | `ediscovery_noncustodial_data_source_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: removeHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Noncustodial Data Sources Hold **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCES_HOLD` Remove holds from selected noncustodial data sources in an eDiscovery case and start asynchronous compliance processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of non-custodial data sources to remove hold. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: removeHold route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Search Custodian Source **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_SEARCH_CUSTODIAN_SOURCE` Deprecated: use REMOVE_EDISCOVERY_CASE_SEARCH_SOURCE with source_type='custodial'. Remove a custodial data-source association from an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `custodian_source_id` | string | Yes | Identifier of the custodial data source relationship to remove. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Search Noncustodial Source **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_SEARCH_NONCUSTODIAL_SOURCE` Deprecated: use REMOVE_EDISCOVERY_CASE_SEARCH_SOURCE with source_type='noncustodial'. Remove a noncustodial data-source association from an eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | | `noncustodial_source_id` | string | Yes | Identifier of the noncustodial data source relationship to remove. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Ediscovery Case Search Source **Slug:** `MICROSOFT_PURVIEW_REMOVE_EDISCOVERY_CASE_SEARCH_SOURCE` Remove one custodial or noncustodial data-source association from an eDiscovery search. Verify every identifier before this destructive relationship change. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_id` | string | Yes | Identifier of the custodial or noncustodial source relationship to remove. | | `source_type` | string ("custodial" | "noncustodial") | Yes | Type of search source relationship to remove. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Event Retention Event Type **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_EVENT_RETENTION_EVENT_TYPE` Remove a retention event's event-type association. Verify the retention event identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_event_id` | string | Yes | Identifier used in the documented Delete retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Descriptor **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR` Unlink one authority, category, citation, department, or file plan reference descriptor from a retention label. Verify the label identifier and descriptor type before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `descriptor_type` | string ("authority" | "category" | "citation" | "department" | "file_plan_reference") | Yes | Descriptor relationship to unlink. | | `retention_label_id` | string | Yes | Retention label identifier whose descriptor association is removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Descriptors Authority Template **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTORS_AUTHORITY_TEMPLATE` Compatibility-specific authority descriptor unlink action. New callers should use MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR with descriptor_type='authority'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier whose authority descriptor is removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Descriptors Category Template **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTORS_CATEGORY_TEMPLATE` Compatibility-specific category descriptor unlink action. New callers should use MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR with descriptor_type='category'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier whose category descriptor is removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Descriptors Citation Template **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTORS_CITATION_TEMPLATE` Compatibility-specific citation descriptor unlink action. New callers should use MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR with descriptor_type='citation'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier whose citation descriptor is removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Descriptors Department Template **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTORS_DEPARTMENT_TEMPLATE` Compatibility-specific department descriptor unlink action. New callers should use MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR with descriptor_type='department'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier whose department descriptor is removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Descriptors File Plan Reference Template **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTORS_FILE_PLAN_REFERENCE_TEMPLATE` Compatibility-specific file plan reference descriptor unlink action. New callers should use MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_DESCRIPTOR with descriptor_type='file_plan_reference'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Retention label identifier whose file plan reference descriptor association is removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Retention Label Event Type **Slug:** `MICROSOFT_PURVIEW_REMOVE_RETENTION_LABEL_EVENT_TYPE` Remove a retention label's event-type association. Verify the retention label identifier before calling. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_label_id` | string | Yes | Identifier used in the documented Delete retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reopen Ediscovery Case **Slug:** `MICROSOFT_PURVIEW_REOPEN_EDISCOVERY_CASE` Reopen an eDiscovery case in Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented Reopen eDiscoveryCase route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Ediscovery Case Settings To Default **Slug:** `MICROSOFT_PURVIEW_RESET_EDISCOVERY_CASE_SETTINGS_TO_DEFAULT` Reset Microsoft Purview eDiscovery case settings to their defaults. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented reset-to-default route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retry Ediscovery Case Legal Hold Policy **Slug:** `MICROSOFT_PURVIEW_RETRY_EDISCOVERY_CASE_LEGAL_HOLD_POLICY` Retry distribution of an eDiscovery legal-hold policy after a failed deployment, then monitor the asynchronous case operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryHoldPolicy: retryPolicy route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented ediscoveryHoldPolicy: retryPolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run Ediscovery Case Review Set Query **Slug:** `MICROSOFT_PURVIEW_RUN_EDISCOVERY_CASE_REVIEW_SET_QUERY` Run a review set query through the beta-only route and return matching file metadata. File content and extracted text are excluded. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query_id` | string | Yes | ID of the review set query to run. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE` Update an eDiscovery case in Microsoft Purview. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | The case description. | | `external_id` | string | No | The external case number for customer reference. | | `display_name` | string | No | The case name. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Update ediscoveryCase route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Custodian Index **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_CUSTODIAN_INDEX` Update the index for one custodian through the stable v1.0 endpoint. This operation returns only after Graph accepts the update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: updateIndex route. | | `ediscovery_custodian_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: updateIndex route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Custodians Index **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_CUSTODIANS_INDEX` Start asynchronous index updates for selected custodians in an eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | No | The IDs of custodians to index. Optional. Maximum number of IDs that can be provided is 1000. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryCustodian: updateIndex route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Legal Hold **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_LEGAL_HOLD` Update the KQL content query or description of an eDiscovery legal-hold policy. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | The description of the legal hold policy. Optional. | | `content_query` | string | No | KQL query that specifies content to be held in the specified locations. To hold all content, omit this field. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Update ediscoveryHoldPolicy route. | | `ediscovery_hold_policy_id` | string | Yes | Identifier used in the documented Update ediscoveryHoldPolicy route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Noncustodial Data Source Index **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_NONCUSTODIAL_DATA_SOURCE_INDEX` Start an asynchronous index update for one noncustodial data source in an eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ediscovery_case_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: updateIndex route. | | `ediscovery_noncustodial_data_source_id` | string | Yes | Identifier used in the documented ediscoveryNoncustodialDataSource: updateIndex route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Review Set **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_REVIEW_SET` Update the description or display name of an eDiscovery review set. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | New review set description. | | `display_name` | string | No | New unique review set name, up to 64 characters. | | `review_set_id` | string | Yes | ID of the review set to update. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case, using the documented route casing. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Review Set Query **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_REVIEW_SET_QUERY` Update the name and optionally the KQL of an eDiscovery review set query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query_id` | string | Yes | ID of the query to update. | | `display_name` | string | Yes | New query name. | | `content_query` | string | No | New KQL content query. | | `ediscovery_case_id` | string | Yes | ID of the eDiscovery case. | | `ediscovery_review_set_id` | string | Yes | ID of the review set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Search **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_SEARCH` Update a Microsoft Purview eDiscovery search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Optional replacement description. | | `display_name` | string | No | Optional replacement display name. | | `content_query` | string | No | Optional replacement KQL query. | | `data_source_scopes` | string | No | Optional replacement comma-separated tenant or case data-source scope flags. | | `ediscovery_case_id` | string | Yes | Identifier of the eDiscovery case. | | `ediscovery_search_id` | string | Yes | Identifier of the eDiscovery search. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Settings **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_SETTINGS` Update one or more settings for a Microsoft Purview eDiscovery case. Provide at least one setting to change. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ocr` | object | No | Optical character recognition settings. Optional. | | `case_type` | string ("standard" | "premium" | "unknownFutureValue") | No | Case type: standard, premium, or unknownFutureValue. | | `topic_modeling` | object | No | Topic-modeling settings. Optional. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Update ediscoveryCaseSettings route. | | `review_set_settings` | string ("none" | "disableGrouping" | "unknownFutureValue") | No | Review-set setting: none, disableGrouping, or unknownFutureValue. | | `redundancy_detection` | object | No | Email threading and near-duplicate detection settings. Optional. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Ediscovery Case Tag **Slug:** `MICROSOFT_PURVIEW_UPDATE_EDISCOVERY_CASE_TAG` Update a review tag in a Microsoft Purview eDiscovery case. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | No | Description of the tag. Optional. | | `display_name` | string | Yes | Display name of the tag. Required. | | `ediscovery_case_id` | string | Yes | Identifier used in the documented Update ediscoveryReviewTag route. | | `child_selectability` | string ("One" | "Many") | Yes | Whether child tags are single-select (One) or multi-select (Many). | | `ediscovery_review_tag_id` | string | Yes | Review-tag identifier in the documented update route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Retention Event Retention Event Type **Slug:** `MICROSOFT_PURVIEW_UPDATE_RETENTION_EVENT_RETENTION_EVENT_TYPE` Update the description of the shared retention event type associated with a retention event. Other events or labels using that type are affected. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | Yes | New description for the associated shared retention event type. | | `retention_event_id` | string | Yes | Identifier used in the documented Update retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Retention Event Type **Slug:** `MICROSOFT_PURVIEW_UPDATE_RETENTION_EVENT_TYPE` Update a retention event type in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | Yes | New information for the event type. Microsoft Graph does not allow changing its display name. | | `retention_event_type_id` | string | Yes | Identifier used in the documented Update retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Retention Label **Slug:** `MICROSOFT_PURVIEW_UPDATE_RETENTION_LABEL` Update supported properties of a retention label in Microsoft Purview records management. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `retention_duration` | string | No | Duration for which content is retained, either a number of days or forever. | | `retention_label_id` | string | Yes | Retention label identifier to update. | | `label_to_be_applied` | string | No | Replacement label applied automatically after retention ends. | | `description_for_users` | string | No | Label information for users. | | `description_for_admins` | string | No | Label information for administrators. | | `default_record_behavior` | string ("startLocked" | "startUnlocked" | "unknownFutureValue") | No | Initial record lock state: startLocked, startUnlocked, or unknownFutureValue. | | `disposition_review_stages` | array | No | Review stages used to decide whether content is deleted or retained. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Retention Label Event Type **Slug:** `MICROSOFT_PURVIEW_UPDATE_RETENTION_LABEL_EVENT_TYPE` Update the description of the shared retention event type associated with a retention label. Other labels or events using that type are affected. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `description` | string | Yes | New description for the associated shared retention event type. | | `retention_label_id` | string | Yes | Identifier used in the documented Update retentionEventType route. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Subject Rights Request **Slug:** `MICROSOFT_PURVIEW_UPDATE_SUBJECT_RIGHTS_REQUEST` Update supported properties of a Microsoft Purview subject rights request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `assigned_to` | object | No | Identity of the user to assign the request to. | | `description` | string | No | Updated request description. | | `display_name` | string | No | Updated request name. | | `internal_due_date_time` | string | No | Updated internal due date in ISO 8601 format. | | `subject_rights_request_id` | string | Yes | Unique identifier of the subject rights request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |