| Service | Microsoft Docs article | Related commit history on GitHub | Change details |
|---|---|---|---|
| v1.0 | Invitation Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/invitation-post.md | Use this API to create a new [invitation](../resources/invitation.md). Invitatio When creating a new invitation you have several options available: 1. On invitation creation, Microsoft Graph can automatically send an invitation email directly to the invited user, or your app can use the *inviteRedeemUrl* returned in the creation response to craft your own invitation (through your communication mechanism of choice) to the invited user. If you decide to have Microsoft Graph send an invitation email automatically, you can control the content and language of the email using [*invitedUserMessageInfo*](../resources/invitedusermessageinfo.md).-2. When the user is invited, a user entity (of userType Guest) is created and can now be used to control access to resources. The invited user has to go through the redemption process to access any resources he has been invited to. +2. When the user is invited, a user entity (of userType Guest) is created and can now be used to control access to resources. The invited user has to go through the redemption process to access any resources they have been invited to. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
| v1.0 | Security Retentionevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionevent-delete.md | + + Title: "Delete retentionEvent" +description: "Deletes a retentionEvent object." ++ms.localizationpriority: medium +++# Delete retentionEvent +Namespace: microsoft.graph.security +++Delete a [retentionEvent](../resources/security-retentionevent.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/triggers/retentionEvents/{retentionEventId} +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "delete_retentionevent" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/triggers/retentionEvents/{retentionEventId} +``` +++### Response +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
| v1.0 | Security Retentionevent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionevent-get.md | + + Title: "Get retentionEvent" +description: "Read the properties and relationships of a retentionEvent object." ++ms.localizationpriority: medium +++# Get retentionEvent +Namespace: microsoft.graph.security +++Read the properties and relationships of a [retentionEvent](../resources/security-retentionevent.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/triggers/retentionEvents/{retentionEventId} +``` ++## Optional query parameters +This method supports the expand OData query parameters to help customize the response. For example, to retrieve the event type, use `$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "get_retentionevent" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/triggers/retentionEvents/{retentionEventId} +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionEvent" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.retentionEvent", + "id": "fcdbfb58-d0c6-85dd-d011-4e0ff9a6805d", + "displayName": "String", + "description": "String", + "eventQueries": [ + { + "@odata.type": "microsoft.graph.security.eventQueries" + } + ], + "eventTriggerDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "eventPropagationResults": [ + { + "@odata.type": "microsoft.graph.security.eventPropagationResult" + } + ], + "eventStatus": { + "@odata.type": "microsoft.graph.security.retentionEventStatus" + }, + "lastStatusUpdateDateTime": "String (timestamp)" + } +} +``` + |
| v1.0 | Security Retentionevent List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionevent-list.md | + + Title: "List retentionEvents" +description: "Get a list of the retentionEvent objects and their properties." ++ms.localizationpriority: medium +++# List retentionEvents +Namespace: microsoft.graph.security +++Get a list of the [retentionEvent](../resources/security-retentionevent.md) objects and their properties. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/triggers/retentionEvents +``` ++## Optional query parameters +This method supports the expand OData query parameters to help customize the response. For example, to get the event type, use `$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) objects in the response body. ++## Examples ++### Request ++<!-- { + "blockType": "request", + "name": "list_retentionevent" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/triggers/retentionEvents +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.retentionEvent)" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.retentionEvent", + "id": "fcdbfb58-d0c6-85dd-d011-4e0ff9a6805d", + "displayName": "String", + "description": "String", + "eventQueries": [ + { + "@odata.type": "microsoft.graph.security.eventQueries" + } + ], + "eventTriggerDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "eventPropagationResults": [ + { + "@odata.type": "microsoft.graph.security.eventPropagationResult" + } + ], + "eventStatus": { + "@odata.type": "microsoft.graph.security.retentionEventStatus" + }, + "lastStatusUpdateDateTime": "String (timestamp)" + } + ] +} +``` |
| v1.0 | Security Retentionevent Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionevent-post.md | + + Title: "Create retentionEvent" +description: "Create a new retentionEvent object." ++ms.localizationpriority: medium +++# Create retentionEvent +Namespace: microsoft.graph.security +++Create a new [retentionEvent](../resources/security-retentionevent.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/triggers/retentionEvents +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [retentionEvent](../resources/security-retentionevent.md) object. ++Specify the following properties when creating a **retentionEvent**. ++|Property|Type|Description| +|:|:|:| +|description|String|Optional information about the event.| +|displayName|String|Name of the event.| +|eventQueries|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| +|retentionEventType|String|Name of the event type associated with the event.| ++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "create_retentionevent_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/triggers/retentionEvents +Content-Type: application/json +Content-length: 616 ++{ + "@odata.type": "#microsoft.graph.security.retentionEvent", + "displayName": "String", + "description": "String", + "eventQueries": [ + { + "@odata.type": "microsoft.graph.security.eventQueries" + } + ], + "eventTriggerDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "eventPropagationResults": [ + { + "@odata.type": "microsoft.graph.security.eventPropagationResult" + } + ], + "eventStatus": { + "@odata.type": "microsoft.graph.security.retentionEventStatus" + }, + "lastStatusUpdateDateTime": "String (timestamp)" +} +``` +++### Response +The following is an example of the response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionEvent" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.retentionEvent", + "id": "fcdbfb58-d0c6-85dd-d011-4e0ff9a6805d", + "displayName": "String", + "description": "String", + "eventQueries": [ + { + "@odata.type": "microsoft.graph.security.eventQueries" + } + ], + "eventTriggerDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "eventPropagationResults": [ + { + "@odata.type": "microsoft.graph.security.eventPropagationResult" + } + ], + "eventStatus": { + "@odata.type": "microsoft.graph.security.retentionEventStatus" + }, + "lastStatusUpdateDateTime": "String (timestamp)" +} +``` + |
| v1.0 | Security Retentioneventtype Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentioneventtype-delete.md | + + Title: "Delete retentionEventType" +description: "Deletes a retentionEventType object." ++ms.localizationpriority: medium +++# Delete retentionEventType +Namespace: microsoft.graph.security +++Delete a [retentionEventType](../resources/security-retentioneventtype.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/retentionLabels/{retentionLabelId}/eventType/$ref +DELETE /security/triggerTypes/retentionEventTypes/{retentionEventTypeId}/$ref +DELETE /security/triggers/retentionEvents/{retentionEventId}/retentionEventType/$ref +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "delete_retentioneventtype" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes/{retentionEventTypeId} +``` +++### Response +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
| v1.0 | Security Retentioneventtype Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentioneventtype-get.md | + + Title: "Get retentionEventType" +description: "Read the properties and relationships of a retentionEventType object." ++ms.localizationpriority: medium +++# Get retentionEventType +Namespace: microsoft.graph.security +++Read the properties and relationships of a [retentionEventType](../resources/security-retentioneventtype.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/retentionLabels/{retentionLabelId}/eventType +GET /security/triggerTypes/retentionEventTypes/{retentionEventTypeId} +GET /security/triggers/retentionEvents/{retentionEventId}/retentionEventType +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "get_retentioneventtype" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes/{retentionEventTypeId} +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionEventType" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.retentionEventType", + "id": "dd689e79-9e79-dd68-799e-68dd799e68dd", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)" + } +} +``` + |
| v1.0 | Security Retentioneventtype List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentioneventtype-list.md | + + Title: "List retentionEventTypes" +description: "Get a list of the retentionEventType objects and their properties." ++ms.localizationpriority: medium +++# List retentionEventTypes +Namespace: microsoft.graph.security +++Get a list of the [retentionEventType](../resources/security-retentioneventtype.md) objects and their properties. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/triggerTypes/retentionEventTypes +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) objects in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "list_retentioneventtype" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.retentionEventType)" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.retentionEventType", + "id": "dd689e79-9e79-dd68-799e-68dd799e68dd", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)" + } + ] +} +``` |
| v1.0 | Security Retentioneventtype Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentioneventtype-post.md | + + Title: "Create retentionEventType" +description: "Create a new retentionEventType object." ++ms.localizationpriority: medium +++# Create retentionEventType +Namespace: microsoft.graph.security +++Create a new [retentionEventType](../resources/security-retentioneventtype.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/triggerTypes/retentionEventTypes +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [retentionEventType](../resources/security-retentioneventtype.md) object. ++Specify the following properties when creating a **retentionEventType**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Name of the event type.| +|description|String|Information about the event type. Optional.| +++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "create_retentioneventtype_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes +Content-Type: application/json +Content-length: 199 ++{ + "@odata.type": "#microsoft.graph.security.retentionEventType", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionEventType" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.retentionEventType", + "id": "dd689e79-9e79-dd68-799e-68dd799e68dd", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)" +} +``` + |
| v1.0 | Security Retentioneventtype Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentioneventtype-update.md | + + Title: "Update retentionEventType" +description: "Update the properties of a retentionEventType object." ++ms.localizationpriority: medium +++# Update retentionEventType +Namespace: microsoft.graph.security +++Update the properties of a [retentionEventType](../resources/security-retentioneventtype.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/labels/retentionLabels/{retentionLabelId}/eventType +PATCH /security/triggerTypes/retentionEventTypes/{retentionEventTypeId} +PATCH /security/triggers/retentionEvents/{retentionEventId}/retentionEventType +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body ++|Property|Type|Description| +|:|:|:| +|displayName|String|Name of the event type. Optional.| +|description|String|Information about the event type. Optional.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who created the retentionEventType. Optional.| +|createdDateTime|DateTimeOffset|The date time when the retentionEventType was created. Optional.| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionEventType.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionEventType was modified. Optional.| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) object in the response body. ++## Examples ++### Request ++<!-- { + "blockType": "request", + "name": "update_retentioneventtype" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/eventType +Content-Type: application/json +Content-length: 199 ++{ + "@odata.type": "#microsoft.graph.security.retentionEventType", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionEventType" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.retentionEventType", + "id": "dd689e79-9e79-dd68-799e-68dd799e68dd", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)" +} +``` |
| v1.0 | Security Retentionlabel Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionlabel-delete.md | + + Title: "Delete retentionLabel" +description: "Deletes a retentionLabel object." ++ms.localizationpriority: medium +++# Delete retentionLabel +Namespace: microsoft.graph.security +++Delete a [retentionLabel](../resources/security-retentionlabel.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/labels/retentionLabels/{retentionLabelId} ++``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "delete_retentionlabel" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +``` +++### Response +> +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
| v1.0 | Security Retentionlabel Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionlabel-get.md | + + Title: "Get retentionLabel" +description: "Read the properties and relationships of a retentionLabel object." ++ms.localizationpriority: medium +++# Get retentionLabel +Namespace: microsoft.graph.security +++Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/retentionLabels/{retentionLabelId} +GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId} +``` ++## Optional query parameters +This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "get_retentionlabel" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionLabel" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" + } +} +``` + |
| v1.0 | Security Retentionlabel List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionlabel-list.md | + + Title: "List retentionLabels" +description: "Get a list of the retentionLabel objects and their properties." ++ms.localizationpriority: medium +++# List retentionLabels +Namespace: microsoft.graph.security +++Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/labels/retentionLabels +``` ++## Optional query parameters +This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| ++## Request body +Do not supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) objects in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "list_retentionlabel" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/labels/retentionLabels +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.security.retentionLabel)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" + } + ] +} +``` ++ |
| v1.0 | Security Retentionlabel Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionlabel-post.md | + + Title: "Create retentionLabel" +description: "Create a new retentionLabel object." ++ms.localizationpriority: medium +++# Create retentionLabel +Namespace: microsoft.graph.security +++Create a new [retentionLabel](../resources/security-retentionlabel.md) object. ++To create a [disposition review stage](../resources/security-dispositionreviewstage.md), include the **actionAfterRetentionPeriod** property in the request body with one of the possible values specified. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/labels/retentionLabels +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply a JSON representation of the [retentionLabel](../resources/security-retentionlabel.md) object. ++Specify the following properties when you create a **retentionLabel**. ++|Property|Type|Description| +|:|:|:| +|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on a document with this label applied during the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`. | +|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`. | +|descriptionForAdmins|String|Provides label information for the admin. Optional. | +|descriptionForUsers|String|Provides the label information for the user. Optional. | +|displayName|String|Unique string that defines a label name. | +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained. | +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content. | +|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`. | +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`. | +|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | ++++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "create_retentionlabel_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/labels/retentionLabels +Content-Type: application/json +Content-length: 555 ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` +++### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionLabel" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` + |
| v1.0 | Security Retentionlabel Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/security-retentionlabel-update.md | + + Title: "Update retentionLabel" +description: "Update the properties of a retentionLabel object." ++ms.localizationpriority: medium +++# Update retentionLabel +Namespace: microsoft.graph.security +++Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object. ++To update a [disposition review stage](../resources/security-dispositionreviewstage.md), include the **actionAfterRetentionPeriod** property in the request body with one of the possible values specified. ++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/labels/retentionLabels/{retentionLabelId} ++``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| ++## Request body +++|Property|Type|Description| +|:|:|:| +|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to be applied on a document with this label after the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.| +|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.| +|descriptionForAdmins|String|This is an optional property that provides the label information for the admin.| +|descriptionForUsers|String|This is an optional property that provides the label information for the user.| +|displayName|String|Unique string that defines a label name.| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.| +|id|String|Unique ID of the retentionLabel. [entity](/graph/api/resources/entity).| +|isInUse|Boolean|Specifies whether the label is currently being used.| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionLabel.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionLabel was modified.| +|retentionDuration|[microsoft.graph.security.retentionduration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.| +|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`.| +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.| +|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | ++++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "update_retentionlabel" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +Content-Type: application/json +Content-length: 555 ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.security.retentionLabel" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` + |
| v1.0 | User List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-messages.md | GET https://graph.microsoft.com/beta/me/messages?$select=sender,subject #### Response-Here is an example of the response. To get the next page of messages, apply the URL returned in `@odata.nextLink` to a subsequent GET request. +The following is an example of the response. To get the next page of messages, apply the URL returned in `@odata.nextLink` to a subsequent GET request. <!-- { "blockType": "response", Content-type: application/json #### Request The next example filters all messages in the signed-in user's mailbox for those that mention the user. It also uses `$select` to return a subset of the properties of each message in the response. -The example also incorporates URL encoding for the space characters in the query parameter string. +The following example also incorporates URL encoding for the space characters in the query parameter string. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/beta/me/messages?$filter=MentionsPreview/IsMenti #### Response-Here is an example of the response. Note: The response object shown here might be shortened for readability. +The following is an example of the response. +> **Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, Prefer: outlook.body-content-type="text" #### Response-Here is an example of the response. +The following is an example of the response. <!-- Note: The response includes a `Preference-Applied: outlook.body-content-type` header to acknowledge the `Prefer: outlook.body-content-type` request header. |
| v1.0 | Callrecords Traceroutehop | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/callrecords-traceroutehop.md | Represents the network trace route hops collected for a [media stream](callrecor | Property | Type | Description | |:-|:|:|-|hopCount|Int32|The network path count of this hop that was used to compute the RTT.| +|hopCount|Int32|The network path count of this hop that was used to compute the round-trip time.| |ipAddress|String|IP address used for this hop in the network trace.| |roundTripTime|Duration|The time from when the trace route packet was sent from the client to this hop and back to the client, denoted in [ISO 8601][] format. For example, 1 second is denoted as `PT1S`, where P is the duration designator, T is the time designator, and S is the second designator.| |
| v1.0 | Complianceapioverview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/complianceapioverview.md | Use the Microsoft Graph compliance and privacy APIs to build applications that: - Automate common tasks in eDiscovery - Create and manage subject rights requests+- Automate tasks in records management ## eDiscovery Microsoft Priva Subject Rights Requests provides powerful capabilities to help y Explore the [subject rights request APIs](subjectrightsrequest-subjectrightsrequestapioverview.md). +## Records management (preview) ++Records management in Microsoft Purview provides the ability to manage regulatory, legal, and business-critical records across corporate data. It helps organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained. ++For more details, see [Microsoft Purview records management](/microsoft-365/compliance/records-management). ++The records management API is defined in the OData subnamespace, microsoft.graph.security. +Explore the [Microsoft Purview Records Management APIs](security-recordsManagement-overview.md). + <!-- ## Labels |
| v1.0 | Enums Security | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/enums-security.md | + + Title: "Security enum values" +description: "Microsoft Graph security namespace enumeration values." ++ms.localizationpriority: medium +++# Security enum values ++Namespace: microsoft.graph.security ++### actionAfterRetentionPeriod values ++++|Member| +|:| +|none| +|delete| +|startDispositionReview| +|unknownFutureValue| ++### behaviorDuringRetentionPeriod values ++++|Member| +|:| +|doNotRetain| +|retain| +|retainAsRecord| +|retainAsRegulatoryRecord| +|unknownFutureValue| +++### defaultRecordBehavior values ++++|Member| +|:| +|startLocked| +|startUnlocked| +|unknownFutureValue| +++### eventPropagationStatus values ++++|Member| +|:| +|none| +|inProcessing| +|failed| +|success| +|unknownFutureValue| ++### eventStatusType values ++++|Member| +|:| +|pending| +|error| +|success| +|notAvaliable| +|unknownFutureValue| ++### queryType values ++++|Member| +|:| +|files| +|messages| +|unknownFutureValue| ++++### retentionTrigger values ++++|Member| +|:| +|dateLabeled| +|dateCreated| +|dateModified| +|dateOfEvent| +|unknownFutureValue| +++<!-- +{ + "type": "#page.annotation", + "namespace": "microsoft.graph.security" +} +--> |
| v1.0 | Security Dispositionreviewstage | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-dispositionreviewstage.md | + + Title: "dispositionReviewStage resource type" +description: "Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item.." ++ms.localizationpriority: medium +++# dispositionReviewStage resource type ++Namespace: microsoft.graph.security +++Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item. +For details, see [Disposition of content](/microsoft-365/compliance/disposition). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Create retentionLabel](../api/security-retentionlabel-post.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object. | +|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the [retentionLabel](../resources/security-retentionlabel.md) object. | +++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Unique ID for each stage. | +|name|String|Name representing each stage within a collection. | +|reviewersEmailAddresses|String collection|A collection of reviewers at each stage. | +|stageNumber|Int32|The sequence number for each stage of the disposition review. | +++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.dispositionReviewStage", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.dispositionReviewStage", + "id": "String (identifier)", + "stageNumber": "Integer", + "name": "String", + "reviewersEmailAddresses": [ + "String" + ] +} +``` |
| v1.0 | Security Eventpropagationresult | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-eventpropagationresult.md | + + Title: "eventPropagationResult resource type" +description: "Represents the success status of a created event and additional information about the scoped locations." ++ms.localizationpriority: medium +++# eventPropagationResult resource type ++Namespace: microsoft.graph.security +++Represents the status of a retention event creation request and additional information about the scoped locations. ++## Properties +|Property|Type|Description| +|:|:|:| +|status|microsoft.graph.security.eventPropagationStatus|Indicates the status of the event creation request. The possible values are: `none`, `inProcessing`, `failed`, `success`.| +|statusInformation|String|Additional information about the status of the event creation request.| +|serviceName|String|The name of the workload associated with the event.| +|location|String|The name of the specific location in the workload associated with the event.| +++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.eventPropagationResult" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.eventPropagationResult", + "workload": "String", + "location": "String", + "status": "String", + "statusInformation": "String" +} +``` ++ |
| v1.0 | Security Eventqueries | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-eventqueries.md | + + Title: "eventQuery resource type" +description: "Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event." ++ms.localizationpriority: medium +++# eventQuery resource type ++Namespace: microsoft.graph.security +++Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event. ++## Properties +|Property|Type|Description| +|:|:|:| +|queryType|microsoft.graph.security.queryType|Represents the type of query associated with an event. 'files' for SPO and ODB and 'messages' for EXO.The possible values are: `files`, `messages`, `unknownFutureValue`.| +|query|String|Represents unique identification for the query. 'Asset ID' for SharePoint Online and OneDrive for Business, 'keywords' for Exchange Online.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.eventQueries" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.eventQuery", + "queryType": "String", + "query": "String" +} +``` ++ |
| v1.0 | Security Recordsmanagement Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-recordsmanagement-overview.md | + + Title: "Use the Microsoft Graph records management API" +description: "The Microsoft Purview Records Management APIs helps organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained." +ms.localizationpriority: medium ++++# Use the Microsoft Graph records management APIs +++The Microsoft Purview Records Management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained. ++The records mangement solution is a part of the Microsoft Purview compliance center. ++## Manage retention labels +Records management admins and developers need to maintain records management systems with labels that are created, updated, and deleted periodically. ++Developers and compliance admins can use the the records management APIs to perform operations on records management labels in order to maintain their systems. ++## Trigger events for an existing label +When an employee leaves a company, information is updated in the HR management system. From the leave date, confidential documents need to be retained for a period for 7 years. These documents have the label `Employee_departure` applied. ++Developers and compliance administrators can use records management APIs to read the label `Employee_departure` and look up the associated event type `Event-employee_departure`. ++Compliance admins can use records management APIs to create an event for the associated event type. The retention period for the confidential documents starts after the creation of this event. ++## Entities +The records management API includes the following key entities. ++| Name | Type | Use case | +|:-|:-|:-| +| Label | [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) | Contains retention settings and actions that can be applied to an item at the end of a period. | +| Retention event | [microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) | Represents a trigger for event-based retention, where a retention period starts after the event occurs. | +| Retention event type | [microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) | Represents a single group for the same type of retention events. | |
| v1.0 | Security Retentionduration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentionduration.md | + + Title: "retentionDuration resource type" +description: "Represents how long content will be retained before it can be deleted. " ++ms.localizationpriority: medium +++# retentionDuration resource type ++Namespace: microsoft.graph.security +++Represents how long an item will be retained before it can be deleted. This is an abstract type. +The **retentionDuration** resource is the base type for the +[retentionDurationForever](../resources/security-retentiondurationforever.md) and [retnetionDurationInDays](../resources/security-retentiondurationindays.md) resourceTypes. ++## Properties +None. ++## Relationships +None. ++## JSON representation for retentionDuration +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionDuration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDuration" +} +``` ++ |
| v1.0 | Security Retentiondurationforever | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentiondurationforever.md | + + Title: "retentionDurationForever resource type" +description: "Represents that content will be retained permanently and will not be deleted." ++ms.localizationpriority: medium +++# retentionDurationForever resource type ++Namespace: microsoft.graph.security +++Indicates that content will be retained permanently and will not be deleted. +++Inherits from [retentionDuration](../resources/security-retentionduration.md). ++## Properties +None. ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionDurationForever" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDurationForever" +} +``` |
| v1.0 | Security Retentiondurationindays | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentiondurationindays.md | + + Title: "retentionDurationInDays resource type" +description: "Represents the number of days an item will be retained before it can be deleted" ++ms.localizationpriority: medium +++# retentionDurationInDays resource type ++Namespace: microsoft.graph.security +++Represents the number of days an item will be retained before it can be deleted. +++Inherits from [retentionDuration](../resources/security-retentionduration.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|days|Int32|Specifies the time period in days for which an item with the applied retention label will be retained for.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionDurationInDays" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDurationInDays", + "days": "Integer" +} +``` |
| v1.0 | Security Retentionevent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentionevent.md | + + Title: "retentionEvent resource type" +description: "Represents a trigger for event-based retention labels where start of the retention period is based on when a specific type of event occurs." ++ms.localizationpriority: medium +++# retentionEvent resource type ++Namespace: microsoft.graph.security +++Represents a trigger for event-based retention labels where start of the retention period is based on when a specific type of event occurs. +To learn more about it, see [Start retention when an event occurs](/microsoft-365/compliance/event-driven-retention). +++## Methods +|Method|Return type|Description| +|:|:|:| +|[List retentionEvents](../api/security-retentionevent-list.md)|[microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md) collection|Get a list of the [retentionEvent](../resources/security-retentionevent.md) objects and their properties.| +|[Create retentionEvent](../api/security-retentionevent-post.md)|[microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md)|Create a new [retentionEvent](../resources/security-retentionevent.md) object.| +|[Get retentionEvent](../api/security-retentionevent-get.md)|[microsoft.graph.security.retentionEvent](../resources/security-retentionevent.md)|Read the properties and relationships of a [retentionEvent](../resources/security-retentionevent.md) object.| +|[Delete retentionEvent](../api/security-retentionevent-delete.md)|None|Delete a [retentionEvent](../resources/security-retentionevent.md) object.| +|[List retentionEventType](../api/security-retentioneventtype-list.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) collection|Get the retentionEventType resources from the exapnd eventType navigation property.| +|[Create retentionEventType](../api/security-retentioneventtype-post.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Add eventType by adding the relevant odata property when creating an event.| +++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who created the retentionEvent.| +|createdDateTime|DateTimeOffset|The date time when the retentionEvent was created.| +|description|String|Optional information about the event.| +|displayName|String|Name of the event.| +|eventPropagationResult|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md)|Represents the success status of a created event and additional information.| +|eventQueries|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|retentionEventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md) collection|Status of event propogation to the scoped locations after the event has been created.| +|eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| +|id|String|Represents the unique ID of the user who created the retentionEvent. [entity](/graph/api/resources/entity).| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionEvent.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionEvent was modified.| +|lastStatusUpdateDateTime|DateTimeOffset|Last time the status of the event was updated.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|retentionEventType|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Specifies the event that will start the retention period for labels that use this event type when an event is created.| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.retentionEvent", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionEvent", + "id": "String (identifier)", + "displayName": "String", + "description": "String", + "eventQueries": [ + { + "@odata.type": "microsoft.graph.security.eventQueries" + } + ], + "eventTriggerDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "eventPropagationResults": [ + { + "@odata.type": "microsoft.graph.security.eventPropagationResult" + } + ], + "eventStatus": { + "@odata.type": "microsoft.graph.security.retentionEventStatus" + }, + "lastStatusUpdateDateTime": "String (timestamp)" +} +``` |
| v1.0 | Security Retentioneventstatus | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentioneventstatus.md | + + Title: "retentionEventStatus resource type" +description: "For event-based retention, provides the status of the propagation of the event to the specified locations after the event has been created." ++ms.localizationpriority: medium +++# retentionEventStatus resource type ++Namespace: microsoft.graph.security +++For event-based retention, this attribute provides the status of event propogation to the targetted locations after the event has been created. ++## Properties +|Property|Type|Description| +|:|:|:| +|error|[microsoft.graph.publicError](../resources/publicerror.md)|The error if the status is not successful.| +|status|microsoft.graph.security.eventStatusType|The status of the distribution. The possible values are: `pending`, `error`, `success`, `notAvaliable`.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.retentionEventStatus" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionEventStatus", + "error": { + "@odata.type": "microsoft.graph.publicError" + }, + "status": "String" +} +``` + |
| v1.0 | Security Retentioneventtype | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentioneventtype.md | + + Title: "retentionEventType resource type" +description: "Represents a single group for the same type of retention events. An event type is a generic desription for similar events that can be used with any label with event-based retention." ++ms.localizationpriority: medium +++# retentionEventType resource type ++Namespace: microsoft.graph.security +++Represents a single group for the same type of retention events. ++When a [retention event](../resources/security-retentionevent.md) is created, it is associated with a specific event type which in turn is associated with a [retention label](../resources/security-retentionlabel.md). Only content with that retention label applied will be retained for the specified retention period. +For details, see [Start retention when an event occurs](/microsoft-365/compliance/event-driven-retention). +++## Methods +|Method|Return type|Description| +|:|:|:| +|[List retentionEventTypes](../api/security-retentioneventtype-list.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) collection|Get a list of the [retentionEventType](../resources/security-retentioneventtype.md) objects and their properties.| +|[Create retentionEventType](../api/security-retentioneventtype-post.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Create a new [retentionEventType](../resources/security-retentioneventtype.md) object.| +|[Get retentionEventType](../api/security-retentioneventtype-get.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Read the properties and relationships of a [retentionEventType](../resources/security-retentioneventtype.md) object.| +|[Update retentionEventType](../api/security-retentioneventtype-update.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Update the properties of a [retentionEventType](../resources/security-retentioneventtype.md) object.| +|[Delete retentionEventType](../api/security-retentioneventtype-delete.md)|None|Delete a [retentionEventType](../resources/security-retentioneventtype.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who created the retentionEventType.| +|createdDateTime|DateTimeOffset|The date time when the retentionEventType was created.| +|description|String|Optional information about the event type.| +|displayName|String|Name of the event type.| +|id|String|Represents the unique ID of the user who created the retentionEventType. [entity](/graph/api/resources/entity).| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionEventType.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionEventType was modified.| ++## Relationships +None. ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.retentionEventType", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionEventType", + "id": "String (identifier)", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)" +} +``` + |
| v1.0 | Security Retentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/security-retentionlabel.md | + + Title: "retentionLabel resource type" +description: "Represents how customers can manage their data, whether and for how long to retain or delete it." ++ms.localizationpriority: medium +++# retentionLabel resource type ++Namespace: microsoft.graph.security +++Represents how customers can manage their data, including whether and for how long to retain or delete it. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List retentionLabels](../api/security-retentionlabel-list.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.| +|[Create retentionLabel](../api/security-retentionlabel-post.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Get retentionLabel](../api/security-retentionlabel-get.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Delete retentionLabel](../api/security-retentionlabel-delete.md)|None|Delete a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[List retentionEventType](../api/security-retentioneventtype-list.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) collection|Get the retentionEventType resources from the exapnd eventType navigation property.| +|[Add retentionEventType](../api/security-retentioneventtype-post.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Add eventType by adding the relevant odata property when creating a label.| ++## Properties +|Property|Type|Description| +|:|:|:| +|actionAfterRetentionPeriod|microsoft.graph.security.actionAfterRetentionPeriod| Specifies the action to take on a document with this label applied during the retention period. The possible values are: `none`, `delete`, `startDispositionReview`, `unknownFutureValue`.| +|behaviorDuringRetentionPeriod|microsoft.graph.security.behaviorDuringRetentionPeriod|Specifies how the behavior of a document with this label should be during the retention period. The possible values are: `doNotRetain`, `retain`, `retainAsRecord`, `retainAsRegulatoryRecord`, `unknownFutureValue`.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.| +|descriptionForAdmins|String|Provides label information for the admin. Optional.| +|descriptionForUsers|String|Provides the label information for the user. Optional.| +|displayName|String|Unique string that defines a label name.| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.| +|id|String|Unique ID of the retentionLabel. [entity](/graph/api/resources/entity).| +|isInUse|Boolean|Specifies whether the label is currently being used.| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionLabel.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionLabel was modified.| +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.| +|retentionTrigger|microsoft.graph.security.retentionTrigger|Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: `dateLabeled`, `dateCreated`, `dateModified`, `dateOfEvent`, `unknownFutureValue`.| +|defaultRecordBehavior|microsoft.graph.security.defaultRecordBehavior|Specifies the locked or unlocked state of a record label when it is created.The possible values are: `startLocked`, `startUnlocked`, `unknownFutureValue`.| +|labelToBeApplied|String|Specifies the replacement label to be applied automatically after the retention period of the current label ends. | +++## Relationships +|Relationship|Type|Description| +|:|:|:| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.| +|eventType|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Represents the type associated with a retention event..| ++## JSON representation +The following is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.retentionLabel", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "String (identifier)", + "displayName": "String", + "behaviorDuringRetentionPeriod": "String", + "actionAfterRetentionPeriod": "String", + "retentionTrigger": "String", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "isInUse": "Boolean", + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` |
| v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/user.md | This resource supports: | lastPasswordChangeDateTime | DateTimeOffset | The time when this Azure AD user last changed their password or when their password was created, , whichever date the latest action was performed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. <br><br>Returned only on `$select`. | | legalAgeGroupClassification | [legalAgeGroupClassification](#legalagegroupclassification-values) | Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on **ageGroup** and **consentProvidedForMinor** properties. Allowed values: `null`, `MinorWithOutParentalConsent`, `MinorWithParentalConsent`, `MinorNoParentalConsentRequired`, `NotAdult` and `Adult`. Refer to the [legal age group property definitions](#legal-age-group-property-definitions) for further information. <br><br>Returned only on `$select`. | | licenseAssignmentStates | [licenseAssignmentState](licenseassignmentstate.md) collection | State of license assignments for this user. Read-only. <br><br>Returned only on `$select`. |-| mail | String | The SMTP address for the user, for example, `admin@contoso.com`. Changes to this property will also update the user's **proxyAddresses** collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, and `eq` on `null` values). | +| mail | String | The SMTP address for the user, for example, `admin@contoso.com`. Changes to this property will also update the user's **proxyAddresses** collection to include the value as an SMTP address. This property cannot contain accent characters. <br/> **NOTE:** We do not recommend updating this property for Azure AD B2C user profiles. Use the **otherMails** property instead. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, and `eq` on `null` values). | | mailboxSettings | [mailboxSettings](mailboxsettings.md) | Settings for the primary mailbox of the signed-in user. You can [get](../api/user-get-mailboxsettings.md) or [update](../api/user-update-mailboxsettings.md) settings for sending automatic replies to incoming messages, locale, and time zone. For more information, see [User preferences for languages and regional formats](#user-preferences-for-languages-and-regional-formats). <br><br>Returned only on `$select`. | | mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |
| v1.0 | Accesspackage Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accesspackage-update.md | Title: "Update accessPackage" description: "Update the properties of an accessPackage object." ms.localizationpriority: medium doc_type: apiPageType # Update accessPackage |
| v1.0 | Accessreviewhistorydefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accessreviewhistorydefinition-get.md | Title: "Get accessReviewHistoryDefinition" description: "Retrieve an accessReviewHistoryDefinition object." ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | Accessreviewset List Historydefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accessreviewset-list-historydefinitions.md | Title: "List historyDefinitions" description: "Get a list of the accessReviewHistoryDefinition objects."-+ ms.localizationpriority: medium ms.prod: "governance" doc_type: apiPageType |
| v1.0 | Accessreviewset Post Definitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/accessreviewset-post-definitions.md | Title: "Create definitions" description: "Create a new accessReviewScheduleDefinition object." ms.localizationpriority: medium-+ ms.prod: "governance" doc_type: apiPageType |
| v1.0 | Application Post Calls | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/application-post-calls.md | Title: "Create call" description: "Create a new call."-+ ms.localizationpriority: medium doc_type: apiPageType |
| v1.0 | B2xidentityuserflow Put Apiconnectorconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/b2xidentityuserflow-put-apiconnectorconfiguration.md | Title: "Update apiConnectorConfiguration" description: "Enable or disable an API connector to a specific step in a user flow by updating the apiConnectorConfiguration property."-+ ms.localizationpriority: medium ms.prod: "identity-and-sign-in" doc_type: apiPageType |
| v1.0 | Call Transfer | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/call-transfer.md | Title: "call: transfer" description: "Transfer an active peer-to-peer call or group call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType |
| v1.0 | Channel List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-list-messages.md | Title: "List channel messages" description: "Retrieve the list of messages (without the replies) in a channel of a team. To get the replies for a message, call the list message replies or the get message reply API. " ms.localizationpriority: high-+ ms.prod: "microsoft-teams" doc_type: apiPageType |
| v1.0 | Channel Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/channel-post-members.md | Title: "Add member to channel" description: "Add member to channel."-+ doc_type: apiPageType ms.localizationpriority: medium ms.prod: "microsoft-teams" |
| v1.0 | Chat List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chat-list-messages.md | Title: "List messages in a chat" description: "Retrieve the list of messages in a chat. " ms.localizationpriority: high-+ ms.prod: "microsoft-teams" doc_type: apiPageType |
| v1.0 | Chatmessage List Hostedcontents | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessage-list-hostedcontents.md | Title: "List hostedContents" description: "Retrieve the list of chatMessageHostedContent objects from a message." ms.localizationpriority: medium doc_type: "apiPageType" |
| v1.0 | Chatmessage Post Replies | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessage-post-replies.md | Title: "Send replies to a message in a channel" description: "Reply to existing message in a channel."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
| v1.0 | Chatmessagehostedcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/chatmessagehostedcontent-get.md | Title: "Get chatMessageHostedContent" description: "Retrieve the properties and relationships of chatMessageHostedContent object." ms.localizationpriority: medium-+ ms.prod: "microsoft-teams" doc_type: "apiPageType" |
| v1.0 | Device Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/device-get.md | Title: "Get device" description: "Get the properties and relationships of a device object."-+ ms.localizationpriority: medium ms.prod: "directory-management" doc_type: apiPageType |
| v1.0 | Device Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/device-update.md | Title: "Update device" description: "Update the properties of a registered device."-+ ms.localizationpriority: medium ms.prod: "directory-management" doc_type: apiPageType |
| v1.0 | Driveitem List Children | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/driveitem-list-children.md | |
| v1.0 | Educationsubmission Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/educationsubmission-get.md | Title: "Get educationSubmission" description: "Retrieve a particular submission. A submission object represents a student's work for an assignment. Resources associated with the submission represent this work. Only the student the submission is assigned to can see and modify the submission. A teacher or application with application permissions has full access to all submissions. "-+ ms.localizationpriority: medium ms.prod: "education" doc_type: apiPageType |
| v1.0 | Group List Transitivemembers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/group-list-transitivemembers.md | Title: "List group transitive members" description: "Get a list of the group's members. A group can have users, devices, organizational contacts, and other groups as members. This operation is transitive and returns a flat list of all nested members."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType |
| v1.0 | Invitation Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/invitation-post.md | Use this API to create a new [invitation](../resources/invitation.md). Invitatio When creating a new invitation you have several options available: 1. On invitation creation, Microsoft Graph can automatically send an invitation email directly to the invited user, or your app can use the *inviteRedeemUrl* returned in the creation response to craft your own invitation (through your communication mechanism of choice) to the invited user. If you decide to have Microsoft Graph send an invitation email automatically, you can control the content and language of the email using [*invitedUserMessageInfo*](../resources/invitedusermessageinfo.md).-2. When the user is invited, a user entity (of userType Guest) is created and can now be used to control access to resources. The invited user has to go through the redemption process to access any resources he has been invited to. +2. When the user is invited, a user entity (of userType Guest) is created and can now be used to control access to resources. The invited user has to go through the redemption process to access any resources they have been invited to. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
| v1.0 | User List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/api/user-list-messages.md | If successful, this method returns a `200 OK` response code and collection of [M ## Examples ### Example 1: List all messages #### Request-This example gets the default, top 10 messages in the signed-in user's mailbox. It uses `$select` to return a subset of the properties of each message in the response. +The following shows an example that gets the default, top 10 messages in the signed-in user's mailbox. It uses `$select` to return a subset of the properties of each message in the response. # [HTTP](#tab/http) <!-- { GET https://graph.microsoft.com/v1.0/me/messages?$select=sender,subject #### Response-Here is an example of the response. To get the next page of messages, apply the URL returned in `@odata.nextLink` to a subsequent GET request. +The following is an example of the response. To get the next page of messages, apply the URL returned in `@odata.nextLink` to a subsequent GET request. <!-- { "blockType": "response", |
| v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/v1.0/resources/user.md | This resource supports: |lastPasswordChangeDateTime| DateTimeOffset | The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. <br><br>Returned only on `$select`.| |legalAgeGroupClassification|[legalAgeGroupClassification](#legalagegroupclassification-values)| Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on **ageGroup** and **consentProvidedForMinor** properties. Allowed values: `null`, `MinorWithOutParentalConsent`, `MinorWithParentalConsent`, `MinorNoParentalConsentRequired`, `NotAdult` and `Adult`. Refer to the [legal age group property definitions](#legal-age-group-property-definitions) for further information. <br><br>Returned only on `$select`.| |licenseAssignmentStates|[licenseAssignmentState](licenseassignmentstate.md) collection|State of license assignments for this user. Read-only. <br><br>Returned only on `$select`.|-|mail|String|The SMTP address for the user, for example, `jeff@contoso.onmicrosoft.com`.<br>Changes to this property will also update the user's **proxyAddresses** collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, and `eq` on `null` values).| +|mail|String|The SMTP address for the user, for example, `jeff@contoso.onmicrosoft.com`. Changes to this property will also update the user's **proxyAddresses** collection to include the value as an SMTP address. This property cannot contain accent characters. <br/> **NOTE:** We do not recommend updating this property for Azure AD B2C user profiles. Use the **otherMails** property instead. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, and `eq` on `null` values).| |mailboxSettings|[mailboxSettings](mailboxsettings.md)|Settings for the primary mailbox of the signed-in user. You can [get](../api/user-get-mailboxsettings.md) or [update](../api/user-update-mailboxsettings.md) settings for sending automatic replies to incoming messages, locale and time zone. <br><br>Returned only on `$select`.| |mailNickname|String|The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |mobilePhone|String|The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | |