Updates from: 09/22/2023 02:17:47
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Accesspackageassignmentrequest Cancel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackageassignmentrequest-cancel.md
Title: "accessPackageAssignmentRequest: cancel"
-description: "Cancel accessPackageAssignmentRequest objects that are in a cancellable state."
+description: "Cancel accessPackageAssignmentRequest objects that are in a cancelable state."
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-In [Azure AD Entitlement Management](../resources/entitlementmanagement-overview.md), cancel [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) objects that are in a cancellable state: `accepted`, `pendingApproval`, `pendingNotBefore`, `pendingApprovalEscalated`.
+In [Azure AD Entitlement Management](../resources/entitlementmanagement-overview.md), cancel [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) objects that are in a cancelable state: `accepted`, `pendingApproval`, `pendingNotBefore`, `pendingApprovalEscalated`.
## 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).
For a non-administrator user to cancel their own request, the request must conta
## Response
-If successful, this method returns a `200 OK` response code. It does not return anything in the response body.
+If successful, this method returns a `200 OK` response code. It doesn't return anything in the response body.
## Examples
POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/a
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Accessreview Addreviewer https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accessreview-addreviewer.md
Title: "Add accessReview reviewer (deprecated)"
-description: "In the Azure AD access reviews feature, update an existing accessReview object to add another user as a reviewer. This operation is only permitted for an access review that is not yet completed, and only for an access review where the reviewers are explicitly specified. This operation is not permitted for an access review in which users review their own access, and not intended for an access review in which the group owners are assigned as the reviewers. "
+description: "In the Azure AD access reviews feature, update an existing accessReview object to add another user as a reviewer. This operation is only permitted for an access review that isn't yet completed, and only for an access review where the reviewers are explicitly specified. This operation isn't permitted for an access review in which users review their own access, and not intended for an access review in which the group owners are assigned as the reviewers. "
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [accessreviews-disclaimer](../../includes/accessreviews-disclaimer.md)]
-In the Azure AD [access reviews](../resources/accessreviews-root.md) feature, update an existing [accessReview](../resources/accessreview.md) object to add another user as a reviewer. This operation is only permitted for an access review that is not yet completed, and only for an access review where the reviewers are explicitly specified. This operation is not permitted for an access review in which users review their own access, and not intended for an access review in which the group owners are assigned as the reviewers.
+In the Azure AD [access reviews](../resources/accessreviews-root.md) feature, update an existing [accessReview](../resources/accessreview.md) object to add another user as a reviewer. This operation is only permitted for an access review that isn't yet completed, and only for an access review where the reviewers are explicitly specified. This operation isn't permitted for an access review in which users review their own access, and not intended for an access review in which the group owners are assigned as the reviewers.
## Permissions
The following table shows the properties that can be supplied when you update an
## Response
-If successful, this method returns a `201 Created` response code .
+If successful, this method returns a `201 Created` response code.
## Example
-This is an example of updating a one-time (not reoccurring) access review with an additional reviewer.
+This is an example of updating a one-time (not reoccurring) access review with another reviewer.
##### Request In the request body, supply a JSON representation of the id of the user object.
v1.0 Administrativeunit Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-delete.md
DELETE /administrativeUnits/{id}
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body.
## Example ### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
DELETE https://graph.microsoft.com/beta/administrativeUnits/{id}
### Response
-Here is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Application Addkey https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-addkey.md
Add a key credential to an [application](../resources/application.md). This meth
As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.
-Applications that donΓÇÖt have any existing valid certificates (no certificates have been added yet, or all certificates have expired), wonΓÇÖt be able to use this service action. You can use the [Update application](../api/application-update.md) operation to perform an update instead.
+Applications that don't have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won't be able to use this service action. You can use the [Update application](../api/application-update.md) operation to perform an update instead.
## Permissions
Applications that donΓÇÖt have any existing valid certificates (no certificates
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/addKey
POST /applications(appId='{appId}')/addKey
In the request body, provide the following required properties.
-| Property | Type |Description|
+| Property | Type |Description|
|:|:--|:-| | keyCredential | [keyCredential](../resources/keycredential.md) | The new application key credential to add. The __type__, __usage__ and __key__ are required properties for this usage. Supported key types are:<br><ul><li>`AsymmetricX509Cert`: The usage must be `Verify`.</li><li>`X509CertAndPassword`: The usage must be `Sign`</li></ul>| | passwordCredential | [passwordCredential](../resources/passwordcredential.md) | Only __secretText__ is required to be set which should contain the password for the key. This property is required only for keys of type `X509CertAndPassword`. Set it to `null` otherwise.|
v1.0 Application Addpassword https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-addpassword.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/addPassword
v1.0 Application Delete Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-delete-owners.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http DELETE /applications/{id}/owners/{id}/$ref
v1.0 Application Delete Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-delete-tokenlifetimepolicies.md
One of the following sets of permissions is required to call this API. To learn
Token lifetime policies can be assigned to both applications and service principals.
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Application Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-delete.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal. Replace `{applicationObjectId}` with the **id** for the application object.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center. Replace `{applicationObjectId}` with the **id** for the application object.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Application Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-get.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal. Replace `{applicationObjectId}` with the **id** for the application object.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center. Replace `{applicationObjectId}` with the **id** for the application object.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Application List Federatedidentitycredentials https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-federatedidentitycredentials.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http GET /applications/{id}/federatedIdentityCredentials
v1.0 Application List Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-owners.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http GET /applications/{id}/owners
v1.0 Application List Tokenissuancepolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-tokenissuancepolicies.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http GET /applications/{id}/tokenIssuancePolicies
v1.0 Application List Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-tokenlifetimepolicies.md
One of the following permissions is required to call this API. To learn more, in
Token lifetime policies can be assigned to both applications and service principals.
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Application Post Federatedidentitycredentials https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-federatedidentitycredentials.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/federatedIdentityCredentials
v1.0 Application Post Onlinemeetings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-onlinemeetings.md
POST /users/{userId}/onlineMeetings
``` > [!NOTE]
->- `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
+>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
## Request headers
v1.0 Application Post Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-owners.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/owners/$ref
v1.0 Application Post Tokenissuancepolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-tokenissuancepolicies.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/tokenIssuancePolicies/$ref
v1.0 Application Post Tokenlifetimepolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-tokenlifetimepolicies.md
One of the following permissions is required to call this API. To learn more, in
Token lifetime policies can be assigned to both applications and service principals.
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Application Removekey https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-removekey.md
As part of the request validation for this method, a proof of possession of an e
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/removeKey
v1.0 Application Removepassword https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-removepassword.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/removePassword
v1.0 Application Setverifiedpublisher https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-setverifiedpublisher.md
Set the the [verifiedPublisher](../resources/verifiedPublisher.md) on an [applic
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/setVerifiedPublisher
v1.0 Application Unsetverifiedpublisher https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-unsetverifiedpublisher.md
Unset the the [verifiedPublisher](../resources/verifiedPublisher.md) previously
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /applications/{id}/unsetVerifiedPublisher
v1.0 Application Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-update.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal. Replace `{applicationObjectId}` with the **id** for the application object.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center. Replace `{applicationObjectId}` with the **id** for the application object.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Appmanagementpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appmanagementpolicy-get.md
Content-type: application/json
}, { "restrictionType": "passwordLifetime",
- "maxLifetime": "P4DT12H30M5S",
+ "maxLifetime": "P90D",
"restrictForAppsCreatedAfterDateTime": "2017-10-19T10:37:00Z" }, {
Content-type: application/json
}, { "restrictionType": "symmetricKeyLifetime",
- "maxLifetime": "P4D",
+ "maxLifetime": "P30D",
"restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z" } ],
v1.0 Appmanagementpolicy List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appmanagementpolicy-list.md
Content-type: application/json
}, { "restrictionType": "passwordLifetime",
- "maxLifetime": "P4DT12H30M5S",
+ "maxLifetime": "P90D",
"restrictForAppsCreatedAfterDateTime": "2017-10-19T10:37:00Z" }, {
Content-type: application/json
}, { "restrictionType": "symmetricKeyLifetime",
- "maxLifetime": "P4D",
+ "maxLifetime": "P30D",
"restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z" } ],
v1.0 Appmanagementpolicy Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appmanagementpolicy-post.md
POST https://graph.microsoft.com/beta/policies/appManagementPolicies
"description": "Cred policy sample", "isEnabled": true, "restrictions": {
- "passwordCredentials": [
- {
- "restrictionType": "passwordAddition",
- "maxLifetime": null,
- "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
- },
- {
- "restrictionType": "passwordLifetime",
- "maxLifetime": "P4DT12H30M5S",
- "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
- },
- {
- "restrictionType": "symmetricKeyAddition",
- "maxLifetime": null,
- "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
- },
- {
- "restrictionType": "symmetricKeyLifetime",
- "maxLifetime": "P4D",
- "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
- }
- ],
- "keyCredentials": [
- {
- "restrictionType": "asymmetricKeyLifetime",
- "maxLifetime": "P90D",
- "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
- }
- ]
- }
+ "passwordCredentials": [
+ {
+ "restrictionType": "passwordAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "passwordLifetime",
+ "maxLifetime": "P90D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyAddition",
+ "maxLifetime": null,
+ "restrictForAppsCreatedAfterDateTime": "2019-10-19T10:37:00Z"
+ },
+ {
+ "restrictionType": "symmetricKeyLifetime",
+ "maxLifetime": "P30D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ],
+ "keyCredentials": [
+ {
+ "restrictionType": "asymmetricKeyLifetime",
+ "maxLifetime": "P90D",
+ "restrictForAppsCreatedAfterDateTime": "2014-10-19T10:37:00Z"
+ }
+ ]
+ }
} ```
Content-type: application/json
}, { "restrictionType": "passwordLifetime",
- "maxLifetime": "P4DT12H30M5S",
+ "maxLifetime": "P90D",
"restrictForAppsCreatedAfterDateTime": "2018-10-19T10:37:00Z" } ]
v1.0 Attendancerecord List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attendancerecord-list.md
To get attendance records of a virtual event session's attendance report:
GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}/attendanceRecords ```
->- `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
+>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
>- `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. >- `reportId` is the **id** of an [meetingAttendanceReport](../resources/meetingAttendanceReport.md) object. >- `webinarId` is the **id** of an [virtualEventWebinar](../resources/virtualEventWebinar.md) object.
v1.0 Authenticationconditionapplication Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationconditionapplication-delete.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Remove or unlink [an application](../resources/authenticationconditionapplication.md) from an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. This disables the authentication experience that's defined by the user flow for the application.
+Remove or unlink [an application](../resources/authenticationconditionapplication.md) from an external identities self-service sign-up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. This disables the authentication experience that's defined by the user flow for the application.
## 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).
DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditi
|Content-Type|application/json. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error will be returned with specific details.
+If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details.
## Examples #### Request
-The following is an example of a request. `63856651-13d9-4784-9abf-20758d509e19` representes the **appId** of the application, also known as the client ID, not the object ID.
+Here's an example of a request. `63856651-13d9-4784-9abf-20758d509e19` represents the **appId** of the application, also known as the client ID, not the object ID.
# [HTTP](#tab/http) <!-- { "blockType": "request",
DELETE https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313c
#### Response
-The following is an example of the response
+Here's an example of the response
<!-- { "blockType": "response", "truncated": true
v1.0 Authorizationpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authorizationpolicy-get.md
If successful, this method returns a `200 OK` response code and the single [auth
The following is an example of the request.
+<!-- {
+ "blockType": "request",
+ "name": "get_authorizationpolicy"
+}-->
+ ```msgraph-interactive GET https://graph.microsoft.com/beta/policies/authorizationPolicy ```- ### Response
HTTP/1.1 200 OK
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authorizationPolicy/$entity",
- "id": "authorizationPolicy",
- "displayName": "Authorization Policy",
- "description": "Used to manage authorization related settings across the company.",
- "enabledPreviewFeatures": [],
- "guestUserRoleId": "10dae51f-b6af-4016-8d66-8c2a99b929b3",
- "allowUserConsentForRiskyApps": false,
- "blockMsolPowerShell": ""
- "defaultUserRolePermissions": {
- "allowedToCreateApps": true,
- "allowedToCreateSecurityGroups": false,
- "allowedToReadOtherUsers": true
- }
- "allowedToSignUpEmailBasedSubscriptions": false,
- "allowedToUseSSPR": true,
- "allowEmailVerifiedUsersToJoinOrganization": true,
- "permissionGrantPolicyIdsAssignedToDefaultUserRole": [
- "managePermissionGrantsForSelf.microsoft-user-default-low"
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authorizationPolicy",
+ "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET policies/authorizationPolicy?$select=allowedToSignUpEmailBasedSubscriptions,allowedToUseSSPR",
+ "value": [
+ {
+ "id": "authorizationPolicy",
+ "allowInvitesFrom": "everyone",
+ "allowedToSignUpEmailBasedSubscriptions": true,
+ "allowedToUseSSPR": true,
+ "allowEmailVerifiedUsersToJoinOrganization": false,
+ "allowUserConsentForRiskyApps": null,
+ "blockMsolPowerShell": false,
+ "description": "Used to manage authorization related settings across the company.",
+ "displayName": "Authorization Policy",
+ "enabledPreviewFeatures": [],
+ "guestUserRoleId": "10dae51f-b6af-4016-8d66-8c2a99b929b3",
+ "permissionGrantPolicyIdsAssignedToDefaultUserRole": [
+ "ManagePermissionGrantsForSelf.microsoft-user-default-legacy"
+ ],
+ "defaultUserRolePermissions": {
+ "allowedToCreateApps": false,
+ "allowedToCreateSecurityGroups": true,
+ "allowedToCreateTenants": true,
+ "allowedToReadBitlockerKeysForOwnedDevice": true,
+ "allowedToReadOtherUsers": true
+ }
+ }
] } ```
v1.0 Authorizationpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authorizationpolicy-update.md
PATCH /policies/authorizationPolicy/authorizationPolicy
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property | Type | Description | |:-|:|:|
In the request body, supply the values for relevant fields that should be update
|allowUserConsentForRiskyApps|Boolean| Indicates whether [user consent for risky apps](/azure/active-directory/manage-apps/configure-risk-based-step-up-consent) is allowed. Default value is `false`. We recommend that you keep the value set to `false`.| |allowedToSignUpEmailBasedSubscriptions|Boolean| Indicates whether users can sign up for email-based subscriptions. | |allowedToUseSSPR|Boolean| Indicates whether users can use the Self-Serve Password Reset feature on the tenant. |
-|blockMsolPowerShell|Boolean| To disable the use of MSOL PowerShell, set this property to `true`. This also disables user-based access to the legacy service endpoint used by MSOL PowerShell. This does not affect Azure Active Directory Connect or Microsoft Graph. |
+|blockMsolPowerShell|Boolean| To disable the use of MSOL PowerShell, set this property to `true`. This also disables user-based access to the legacy service endpoint used by MSOL PowerShell. This doesn't affect Azure Active Directory Connect or Microsoft Graph. |
|defaultUserRolePermissions|[defaultUserRolePermissions](../resources/defaultUserRolePermissions.md)| Specifies certain customizable permissions for default user role. | |description|String| Description of this policy. | |displayName|String| Display name for this policy. |
In the request body, supply the values for relevant fields that should be update
## Response
-If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.
+If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
## Examples
If successful, this method returns a `204 No Content` response code. It does not
#### Request
-The following is an example of the request. In this example, guest access level is modified to Restricted Guest User.
+Here's an example of the request. In this example, guest access level is modified to Restricted Guest User.
-
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_guestUserLevel"
+ "name": "update_authorizationpolicy_guestuserrole"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
HTTP/1.1 204 No Content
#### Request
-The following is an example of the request.
-
+Here's an example of the request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_preview"
+ "name": "update_authorizationpolicy_enabledpreviewfeatures"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
HTTP/1.1 204 No Content
#### Request
-The following is an example of the request.
+Here's an example of the request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_blockMSOLPowerShell"
+ "name": "update_authorizationpolicy_blockmsolpowershell"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
HTTP/1.1 204 No Content
#### Request
-The following is an example of the request.
-
+Here's an example of the request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_applications"
+ "name": "update_authorizationpolicy_defaultuserrolepermissions"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
HTTP/1.1 204 No Content
#### Request
-The following is an example of the request.
+Here's an example of the request.
-
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_SSPR"
+ "name": "update_authorizationpolicy_allowedtousesspr"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
HTTP/1.1 204 No Content
#### Request
-The following is an example of the request.
+Here's an example of the request.
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_disableUserConsent"
+ "name": "update_authorizationpolicy_disableusercontent"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
HTTP/1.1 204 No Content
#### Request
-The following is an example of the request that allows user consent to apps, subject to the built-in [app consent policy](/azure/active-directory/manage-apps/manage-app-consent-policies) `microsoft-user-default-low`, which allows delegated permissions classified "low", for client apps from verified publishers or registered in the same tenant.
+Here's an example of the request that allows user consent to apps, subject to the built-in [app consent policy](/azure/active-directory/manage-apps/manage-app-consent-policies) `microsoft-user-default-low`, which allows delegated permissions classified "low", for client apps from verified publishers or registered in the same tenant.
-
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "update_authZPolicy_enableUserConsentLow"
+ "name": "update_authorizationpolicy_permissiongrantpolicyidsassignedtodefaultuserrole"
}--> ```http
PATCH https://graph.microsoft.com/beta/policies/authorizationPolicy/authorizatio
} ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
--- #### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response"
v1.0 B2xidentityuserflow Delete Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete-identityproviders.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] [!INCLUDE [identityprovider-deprecate](../../includes/identityprovider-deprecate.md)]
-Delete an identity provider from a [b2xIdentityUserFlow](../resources/b2xidentityuserflow.md) object. For self-service sign up user flows, the values can be `Google-OAUTH` or `Facebook-OAUTH`.
+Delete an identity provider from a [b2xIdentityUserFlow](../resources/b2xidentityuserflow.md) object. For self-service sign-up user flows, the values can be `Google-OAUTH` or `Facebook-OAUTH`.
## Permissions
DELETE /identity/b2xUserFlows/{id}/identityProviders/{id}/$ref
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error will be returned with specific details.
+If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details.
## Example ### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
DELETE https://graph.microsoft.com/beta/identity/b2xUserFlows/B2X_1_PartnerSignU
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 B2xidentityuserflow Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete.md
DELETE /identity/b2xUserFlows/{id}
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns `204 No Content` response code.
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
DELETE https://graph.microsoft.com/beta/identity/b2xUserFlows/{id}
### Response
-The following is an example of the response.
+Here's an example of the response.
**Note:** The response object shown here might be shortened for readability.
v1.0 B2xidentityuserflow Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-get.md
GET /identity/b2xUserFlows/{id}
## Optional query parameters
-You can use `$expand` to expand specific user flow properties that are not expanded by default.
+You can use `$expand` to expand specific user flow properties that aren't expanded by default.
For more information, see [OData query parameters](/graph/query-parameters).
For more information, see [OData query parameters](/graph/query-parameters).
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a [b2xIdentityUs
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/identity/b2xUserFlows/{id}
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 B2xidentityuserflow List Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-identityproviders.md
GET /identity/b2xUserFlows/{id}/identityProviders
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a collection of
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/identity/b2xUserFlows/{id}/identityProvider
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Bookingservice Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-update.md
The following are some examples you can customize for a service:
- Price - Typical length of an appointment - Reminders-- Any time buffer to set up before or finish up after the service
+- Any, time buffer to set up before or finish up after the service
- [Scheduling policy](../resources/bookingschedulingpolicy.md) parameters such as minimum notice to book or cancel, and whether customers can select specific staff members for an appointment. ## Permissions
PATCH /bookingBusinesses/{id}/services/{id}
| Authorization | Bearer {code}. Required.| ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
|displayName|String|A service name.| |id|String| Read-only.| |isAnonymousJoinEnabled|Boolean|`True` if the URL to join the appointment anonymously (**anonymousJoinWebUrl**) will be generated for the appointment booked for this service.|
-|isHiddenFromCustomers|Boolean|True means this service is not available to customers for booking.|
+|isHiddenFromCustomers|Boolean|True means this service isn't available to customers for booking.|
|isLocationOnline|Boolean|True indicates that the appointments for the service will be held online. Default value is false.| |languageTag|String|The language of the self-service booking page.| |notes|String|Additional information about this service.|
In the request body, supply the values for relevant fields that should be update
|maximumAttendeesCount|Int32|The maximum number of customers allowed in a service. | ## Response
-If successful, this method returns a `204 No content` response code. It does not return anything in the response body.
+If successful, this method returns a `204 No content` response code. It doesn't return anything in the response body.
## Example ### Request The following example updates the duration of the specified service.
Content-type: application/json
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response", "truncated": true
v1.0 Bookingstaffmember Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-delete.md
DELETE /bookingBusinesses/{id}/staffMembers/{id}
| Authorization | Bearer {code}| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns `204, No Content` response code. It does not return anything in the response body.
+If successful, this method returns `204, No Content` response code. It doesn't return anything in the response body.
## Example ##### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
DELETE https://graph.microsoft.com/beta/bookingBusinesses/contosolunchdelivery@c
##### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response", "truncated": true
v1.0 Bundle Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bundle-delete.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Delete a [bundle][] of driveItems by using its **id**.
-Note that deleting a bundle using this method permanently deletes the bundle and does not move it to the Recycle Bin.
-It does not, however, remove the items that were referenced by the bundle.
-They will remain in their parent folders.
+Deleting a bundle using this method permanently deletes the bundle and doesn't move it to the Recycle Bin.
+It doesn't, however, remove the items that were referenced by the bundle.
+They'll remain in their parent folders.
## Permissions
DELETE /drive/items/{bundle-id}
| Name | Description | |:- |: | | Authorization | Bearer {token}. Required. |
-| if-match | eTag. Optional. If this request header is included and the eTag (or cTag) provided does not match the current tag on the bundle, a `412 Precondition Failed` response is returned and the bundle will not be deleted.|
+| if-match | eTag. Optional. If this request header is included and the eTag (or cTag) provided doesn't match the current tag on the bundle, a `412 Precondition Failed` response is returned and the bundle won't be deleted.|
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.
+If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
For information about error responses, see [Microsoft Graph error responses and resource types][error-response].
For information about error responses, see [Microsoft Graph error responses and
### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete-bundle" } -->
DELETE https://graph.microsoft.com/beta/drive/items/{bundle-id}
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } -->
v1.0 Calendargroup Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calendargroup-update.md
PATCH /users/{id | userPrincipalName}/calendarGroups/{id}
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type | Description | | :- | :-- | :-- |
If successful, this method returns a `200 OK` response code and updated [calenda
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
v1.0 Certificatebasedauthconfiguration List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-list.md
The following is an example of the request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "get_certificatebasedauthconfigurations"
+ "name": "list_certificatebasedauthconfigurations"
}--> ```msgraph-interactive
v1.0 Channel Delete Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-delete-tabs.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | TeamsTab.ReadWriteSelfForTeam , TeamsTab.ReadWriteForTeam, TeamsTab.ReadWrite.All, Group.ReadWrite.All**, Directory.ReadWrite.All** |
+|Delegated (work or school account) | TeamsTab.ReadWriteSelfForTeam, TeamsTab.ReadWriteForTeam, TeamsTab.ReadWrite.All, Group.ReadWrite.All**, Directory.ReadWrite.All** |
|Delegated (personal Microsoft account) | Not supported. | |Application | TeamsTab.Delete.Group*, TeamsTab.ReadWrite.Group*, TeamsTab.ReadWriteSelfForTeam.All, TeamsTab.ReadWriteForTeam.All, TeamsTab.ReadWrite.All, Group.ReadWrite.All**, Directory.ReadWrite.All** |
DELETE /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body.
## Example ### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored", "name": "get_team"
DELETE https://graph.microsoft.com/beta/teams/{id}/channels/{id}/tabs/{id}
``` ### Response
-The following is an example of the response.
+Here's an example of the response.
```http HTTP/1.1 204 No Content ```
v1.0 Chart List Series https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chart-list-series.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookChartSeries](../resources/workbookchartseries.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chart Setposition https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chart-setposition.md
In the request body, provide a JSON object with the following parameters.
| Parameter | Type |Description| |:|:--|:-|
-|startCell|string|The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.|
+|startCell|string|The start cell. This is where the chart is moved to. The start cell is the top-left or top-right cell, depending on the user's right-to-left display settings.|
|endCell|string|Optional. The end cell. If specified, the chart's width and height will be set to fully cover up this cell/range.| ## Response
-If successful, this method returns `200 OK` response code. It does not return anything in the response body.
+If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
## Example
-Here is an example of how to call this API.
+Here's an example of how to call this API.
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } -->
v1.0 Chartfill Setsolidcolor https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartfill-setsolidcolor.md
In the request body, provide a JSON object with the following parameters.
| Parameter | Type |Description| |:|:--|:-|
-|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|
+|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange").|
## Response
-If successful, this method returns `200 OK` response code. It does not return anything in the response body.
+If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
## Example
-Here is an example of how to call this API.
+Here's an example of how to call this API.
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } -->
v1.0 Chartfont Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartfont-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/a
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-| |bold|boolean|Represents the bold status of font.|
-|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|
+|color|string|HTML color code representation of the text color. for example, #FF0000 represents Red.|
|italic|boolean|Represents the italic status of the font.|
-|name|string|Font name (e.g. "Calibri")|
-|size|double|Size of the font (e.g. 11)|
+|name|string|Font name (for example "Calibri")|
+|size|double|Size of the font (for example, 11)|
|underline|string|Type of underline applied to the font. Possible values are: `None`, `Single`.| ## Response
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [workbookChartFont](../resources/workbookchartfont.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartgridlines Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartgridlines-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookChartGridlines](../resources/workbookchartgridlines.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartgridlines Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartgridlines-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/a
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [workbookChartGridlines](../resources/workbookchartgridlines.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartlegend Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartlegend-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookChartLegend](../resources/workbookchartlegend.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartlegend Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartlegend-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/l
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-| |overlay|boolean|Boolean value for whether the chart legend should overlap with the main body of the chart.| |position|string|Represents the position of the legend on the chart. Possible values are: `Top`, `Bottom`, `Left`, `Right`, `Corner`, `Custom`.|
-|visible|boolean|A boolean value the represents the visibility of a ChartLegend object.|
+|visible|boolean|A boolean value that represents the visibility of a ChartLegend object.|
## Response If successful, this method returns a `200 OK` response code and updated [workbookChartLegend](../resources/workbookchartlegend.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartpoint Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartpoint-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Name |Description| |:-|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookChartPoint](../resources/workbookchartpoint.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartpoint List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartpoint-list.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookChartPoint](../resources/workbookchartpoint.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartseries Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartseries-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookChartSeries](../resources/workbookchartseries.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartseries List Points https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartseries-list-points.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookChartPoint](../resources/workbookchartpoint.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartseries List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartseries-list.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookChartSeries](../resources/workbookchartseries.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Chartseries Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chartseries-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/s
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [workbookChartSeries](../resources/workbookchartseries.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Charttitle Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/charttitle-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookChartTitle](../resources/workbookcharttitle.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Charttitle Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/charttitle-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/charts/{name}/t
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|overlay|boolean|Boolean value representing if the chart title will overlay the chart or not.|
+|overlay|boolean|Boolean value representing if the chart title overlays the chart or not.|
|text|string|Represents the title text of a chart.|
-|visible|boolean|A boolean value the represents the visibility of a chart title object.|
+|visible|boolean|A boolean value that represents the visibility of a chart title object.|
## Response If successful, this method returns a `200 OK` response code and updated [workbookChartTitle](../resources/workbookcharttitle.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Cloudpc Bulkresize https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-bulkresize.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Perform a bulk resize action to resize a group of [cloudPCs](../resources/cloudpc.md) that have successfully passed [validation](cloudpc-validatebulkresize.md). If any devices cannot be resized, those devices will indicate "resize failed". The remaining devices will be `provisioned` for the resize process.
+Perform a bulk resize action to resize a group of [cloudPCs](../resources/cloudpc.md) that have successfully passed [validation](cloudpc-validatebulkresize.md). If any devices can't be resized, those devices indicate "resize failed". The remaining devices are `provisioned` for the resize process.
## Permissions
Content-Type: application/json
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Cloudpc Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-get.md
This method supports the `$select` OData query parameter to help customize the r
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a [cloudPC](../r
#### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/9
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
Content-Type: application/json
#### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/4
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
Content-Type: application/json
#### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac1
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Cloudpc Getcloudpcconnectivityhistory https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-getcloudpcconnectivityhistory.md
GET /deviceManagement/virtualEndpoint/cloudPCs/{id}/getCloudPcConnectivityHistor
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a [cloudPcConnec
### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/{
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Cloudpc Poweroff https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-poweroff.md
Namespace: microsoft.graph
Power off a [Windows 365 Frontline](https://www.microsoft.com/en/windows-365/frontline) Cloud PC. This action supports Microsoft Endpoint Manager (MEM) admin scenarios.
-After a [Windows 365 Frontline](https://www.microsoft.com/en/windows-365/frontline) Cloud PC is powered off, it is de-allocated, and licenses are revoked immediately. Only IT admin users can perform this action.
+After a [Windows 365 Frontline](https://www.microsoft.com/en/windows-365/frontline) Cloud PC is powered off, it's deallocated, and licenses are revoked immediately. Only IT admin users can perform this action.
## Permissions
POST /deviceManagement/virtualEndpoint/cloudPCs/{cloudPCId}/poweroff
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
v1.0 Cloudpc Retrypartneragentinstallation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-retrypartneragentinstallation.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retry installation for the partner agents which failed to install on the Cloud PC. Service side will check which agent installation failed firstly and retry.
+Retry installation for the partner agents that failed to install on the Cloud PC. Service side checks which agent installation failed firstly and retry.
## Permissions
POST /deviceManagement/virtualEndpoint/cloudPCs/{id}/retryPartnerAgentInstallati
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `204 No Content` response code.
#### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
v1.0 Cloudpc Start https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-start.md
POST /me/cloudPCs/{cloudPCId}/start
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `204 No Content` response code.
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Cloudpc Stop https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-stop.md
POST /me/cloudPCs/{cloudPCId}/stop
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `204 No Content` response code.
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Connectorgroup Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/connectorgroup-update.md
PATCH /onPremisesPublishingProfiles/applicationProxy/connectorGroups/{id}
| Authorization | Bearer. Required| ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|connectorGroupType|string| Indicates the type of hybrid agent. This pre-set by the system. |
+|connectorGroupType|string| Indicates the type of hybrid agent and is preset by the system. |
|id|string| Unique identifier for this connectorGroup. Read-only. |
-|isDefault|boolean| Indicates if the connectorGroup is the default connectorGroup. Only a single connector group can be the default connectorGroup and this is pre-set by the system. |
+|isDefault|boolean| Indicates if the connectorGroup is the default connectorGroup. Only a single connector group can be the default connectorGroup and this is preset by the system. |
|name|string| The name associated with the connectorGroup. |
-|region|string| The region the connectorGroup is assigned to and will optimize traffic for. This region can only be set if **no** connectors or applications are assigned to the connectorGroup. The regions available include: North America, Europe, Australia, Asia, and India. Possible values are: `nam`, `eur`, `aus`, `asia`, `ind`.|
+|region|string| The region the connectorGroup is assigned to and for which it optimizes traffic. This region can only be set if **no** connectors or applications are assigned to the connectorGroup. The regions available include: North America, Europe, Australia, Asia, and India. Possible values are: `nam`, `eur`, `aus`, `asia`, `ind`.|
## Response If successful, this method returns a `200 OK` response code and updated [connectorGroup](../resources/connectorgroup.md) object in the response body. ## Example ##### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-The following is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Contactfolder Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contactfolder-update.md
PATCH /users/{id | userPrincipalName}/contactFolders/{id}
| Content-Type | application/json. Required. | ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [contactFolder](../resources/contactfolder.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Conversationthread Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conversationthread-update.md
PATCH /groups/{group id}/conversations/{conversation id}/threads/{thread id}
| Content-Type | application/json. Required. | ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and an empty object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response", "truncated": true,
v1.0 Directoryaudit Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryaudit-get.md
GET /auditLogs/directoryAudits/{id}
## Optional query parameters
-This method does not support any OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method doesn't support any OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
## Request headers
This method does not support any OData query parameters to help customize the re
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and [directoryAudit]
### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/auditLogs/directoryAudits/{id}
### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Directoryrole Delete Member https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-delete-member.md
Namespace: microsoft.graph
Remove a member from a directoryRole.
-You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Azure portal. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
+You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
## Permissions
v1.0 Directoryrole Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-get.md
Namespace: microsoft.graph
Retrieve the properties of a directoryRole object.
-You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Azure portal. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
+You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
## 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 Directoryrole List Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list-members.md
Namespace: microsoft.graph
Retrieve a list of the users that are assigned to the directory role. Only users can be assigned to a directory role.
-You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Azure portal. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
+You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
## 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 Directoryrole List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list.md
List the directory roles that are activated in the tenant.
This operation only returns roles that have been activated. A role becomes activated when an admin activates the role using the [Activate directoryRole](directoryrole-post-directoryroles.md) API. Not all built-in roles are initially activated.
-When assigning a role using the Azure portal, the role activation step is implicitly done on the admin's behalf. To get the full list of roles that are available in Azure AD, use [List directoryRoleTemplates](directoryroletemplate-list.md).
+When assigning a role using the Microsoft Entra admin center, the role activation step is implicitly done on the admin's behalf. To get the full list of roles that are available in Azure AD, use [List directoryRoleTemplates](directoryroletemplate-list.md).
## 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 Directoryrole Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-post-members.md
Namespace: microsoft.graph
Create a new directory role member.
-You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Azure portal. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
+You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids).
## 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 Drive Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/drive-get.md
One of the following permissions is required to call this API. To learn more, in
The signed in user's drive (when using delegated authentication) can be accessed from the `me` singleton.
-If a user's OneDrive is not provisioned but the user has a license to use OneDrive, this request will automatically provision the user's drive, when using delegated authentication.
+If a user's OneDrive isn't provisioned but the user has a license to use OneDrive, this request will automatically provision the user's drive, when using delegated authentication.
<!-- { "blockType": "ignored" } -->
GET /me/drive
To access a user's OneDrive or OneDrive for Business, your app must request the **drive** relationship on the User resource.
-If a user's OneDrive is not provisioned but the user has a license to use OneDrive, this request will automatically provision the user's drive, when using delegated authentication.
+If a user's OneDrive isn't provisioned but the user has a license to use OneDrive, this request will automatically provision the user's drive, when using delegated authentication.
<!-- { "blockType": "ignored" } -->
GET /groups/{groupId}/drive
| Parameter name | Value | Description | |:|:-|:--|
-| _groupId_ | string | Required. The identifier for the group which owns the document library. |
+| _groupId_ | string | Required. The identifier for the group that owns the document library. |
### Get the document library for a site
GET /drives/{driveId}
## Optional query parameters
-These method support the [$select query parameter][odata-query-parameters] to shape the response.
+These methods support the [$select query parameter][odata-query-parameters] to shape the response.
## Response
Each of these methods returns a [Drive resource][drive-resource] for the matchin
### Error response codes
-If the drive does not exist and cannot be provisioned automatically (when using delegated authentication) an `HTTP 404` response will be returned.
+If the drive doesn't exist and can't be provisioned automatically (when using delegated authentication) an `HTTP 404` response is returned.
## Examples
v1.0 Drive Recent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/drive-recent.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] List a set of items that have been recently used by the signed in user.
-This collection includes items that are in the user's drive as well as items they have access to from other drives.
+This collection includes items that are in the user's drive and items they have access to from other drives.
## Permissions
GET /me/drive/recent
## Response
-This method returns a collection of [DriveItem](../resources/driveitem.md) resources for items which the owner of the drive has recently accessed.
+This method returns a collection of [DriveItem](../resources/driveitem.md) resources for items that the owner of the drive has recently accessed.
## Examples
Content-Type: application/json
## Remarks
-Some driveItems returned from the **recent** action will include the **remoteItem** facet which indicates they are items from another drive.
-To access the original driveItem object, you will need to make a request using the information provided in **remoteItem** in the following format:
+
+Some driveItems returned from the **recent** action will include the **remoteItem** facet that indicates the items are from another drive.
+To access the original driveItem object, you need to make a request using the information provided in **remoteItem** in the following format:
<!-- { "blockType": "ignored", "name": "drives-get-remoteitem" } -->
v1.0 Driveitem Assignsensitivitylabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-assignsensitivitylabel.md
Namespace: microsoft.graph
Asynchronously assign a sensitivity label to a [driveItem][item-resource].
-This API is part of Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions and is considered a protected API. Protected APIs require you to have additional validation, beyond permission and consent, before you can use them. Before you call this API, you must [request access](https://aka.ms/PreviewSPOPremiumAPI).
+This API is part of Microsoft SharePoint and OneDrive APIs that perform advanced premium administrative functions and is considered a protected API. Protected APIs require you to have more validation, beyond permission and consent, before you can use them. Before you call this API, you must [request access](https://aka.ms/PreviewSPOPremiumAPI).
For more information about sensitivity labels from an administrator's perspective, see [Enable sensitivity labels for Office files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files?view=o365-worldwide&preserve-view=true).
In the request body, provide the ID for the sensitivity label that is to be assi
|:--|:--|:| | sensitivityLabelId | String | Required. ID of the sensitivity label to be assigned, or empty string to remove the sensitivity label. | | assignmentMethod | [sensitivityLabelAssignmentMethod](/graph/api/resources/sensitivitylabelassignment?view=graph-rest-beta&preserve-view=true#sensitivitylabelassignmentmethod-values) | Optional. The assignment method of the label on the document. Indicates whether the assignment of the label was done automatically, standard, or as a privileged operation (the equivalent of an administrator operation). |
-| justificationText | String | Optional. Justification text for audit purposes. Required when downgrading/removing a label. |
+| justificationText | String | Optional. Justification text for audit purposes. Required when downgrading or removing a label. |
## Response If successful, the API returns a `202 Accepted` HTTP response code with an empty response body. The `Location` header provides the URL to get operation details.
-For more details about how to monitor the progress of an assign sensitivity label operation, see [monitoring long-running operations](/graph/long-running-actions-overview).
+For more information about how to monitor the progress of an assign sensitivity label operation, see [monitoring long-running operations](/graph/long-running-actions-overview).
In addition to general errors that apply to Microsoft Graph, this API returns the `423 Locked` response code, which indicates that the file being accessed is locked. In such cases, the **code** property of the response object indicates the error type that blocks the operation.
-Also, Few Irm Protected sensitivity labels cannot be updated by Application and need delegated user access to validate if the user has proper rights, For these scenario the API will throw `Not Supported` response code.
+Also, Few Irm Protected sensitivity labels can't be updated by Application and need delegated user access to validate if the user has proper rights. For these scenarios, the API throws `Not Supported` response code.
The following table lists the possible values for the error types. | Value | Description | |:-|:--|
-| fileDoubleKeyEncrypted | Indicates that the file is protected via double key encryption; therefore, it cannot be opened. |
-| fileDecryptionNotSupported | Indicates that the encrypted file has specific properties that do not allow these files to be opened by SharePoint.|
-| fileDecryptionDeferred | Indicates that the file is being processed for decryption; therefore, it cannot be opened. |
-| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
+| fileDoubleKeyEncrypted | Indicates that the file is protected via double key encryption; therefore, it can't be opened. |
+| fileDecryptionNotSupported | Indicates that the encrypted file has specific properties that don't allow these files to be opened by SharePoint.|
+| fileDecryptionDeferred | Indicates that the file is being processed for decryption; therefore, it can't be opened. |
+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http)
Content-Type: application/json
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } --> ```http
The value of the `Location` header provides a URL for a service that will return
You can use this information to [determine when the assign sensitivity label operation has finished](/graph/long-running-actions-overview). ### Remarks
-The response from the API only indicates that the assign sensitivity label operation was accepted or rejected. The operation might be rejected, for example, if the file type is not supported, or the file is double encrypted.
+The response from the API only indicates that the assign sensitivity label operation was accepted or rejected. The operation might be rejected, for example, if the file type isn't supported, or the file is double encrypted.
[item-resource]: ../resources/driveitem.md
v1.0 Driveitem Get Content https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-get-content.md
GET /users/{userId}/drive/items/{item-id}/content
## Example
-Here is an example to download a complete file.
+Here's an example to download a complete file.
### Request
GET /me/drive/items/{item-id}/content
### Response
-Returns a `302 Found` response redirecting to a pre-authenticated download URL for the file.
+Returns a `302 Found` response redirecting to a preauthenticated download URL for the file.
This is the same URL available through the `@microsoft.graph.downloadUrl` property on the DriveItem.
-To download the contents of the file your application will need to follow the `Location` header in the response.
-Many HTTP client libraries will automatically follow the 302 redirection and start downloading the file immedately.
+To download the contents of the file your application needs to follow the `Location` header in the response.
+Many HTTP client libraries follow the 302 redirection and start downloading the file immediately.
-Pre-authenticated download URLs are only valid for a short period of time (a few minutes) and do not require an `Authorization` header to download.
+Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header to download.
<!-- { "blockType": "response" } -->
Location: https://b0mpua-by3301.files.1drv.com/y23vmagahszhxzlcvhasdhasghasodfi
``` ## Downloading files in JavaScript apps
-To download files in a JavaScript app, you cannot use the `/content` API, because this responds with a `302` redirect.
+To download files in a JavaScript app, you can't use the `/content` API, because this responds with a `302` redirect.
A `302` redirect is explicitly prohibited when a [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) _preflight_ is required, such as when providing the **Authorization** header. Instead, your app needs to select the `@microsoft.graph.downloadUrl` property, which returns the same URL that `/content` directs to. This URL can then be requested directly using XMLHttpRequest.
-Because these URLs are pre-authenticated, they can be retrieved without a CORS preflight request.
+Because these URLs are preauthenticated, they can be retrieved without a CORS preflight request.
### Example
To retrieve the download URL for a file, first make a request that includes the
GET /drive/items/{item-ID}?select=id,@microsoft.graph.downloadUrl ```
-This returns the ID and download URL for a file:
+The call returns the ID and download URL for a file:
```http HTTP/1.1 200 OK
You can then make an XMLHttpRequest for the URL provided in `@microsoft.graph.do
## Partial range downloads To download a partial range of bytes from the file, your app can use the `Range` header as specified in [RFC 2616](https://www.ietf.org/rfc/rfc2616.txt).
-Note that you must append the `Range` header to the actual `@microsoft.graph.downloadUrl` URL and not to the request for `/content`.
+You must append the `Range` header to the actual `@microsoft.graph.downloadUrl` URL and not to the request for `/content`.
<!-- { "blockType": "request", "name": "download-item-partial", "scopes": "files.read" } -->
GET https://b0mpua-by3301.files.1drv.com/y23vmag
Range: bytes=0-1023 ```
-This will return an `HTTP 206 Partial Content` response with the request range of bytes from the file.
-If the range cannot be generated the Range header may be ignored and an `HTTP 200` response would be returned with the full contents of the file.
+The call returns an `HTTP 206 Partial Content` response with the request range of bytes from the file.
+If the range can't be generated, then the Range header may be ignored and an `HTTP 200` response would be returned with the full contents of the file.
<!-- { "blockType": "response", "name": "download-item-partial", "@odata.type": "stream" } -->
v1.0 Driveitem Getretentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-getretentionlabel.md
+
+ Title: "driveItem: getRetentionLabel"
+description: "Get metadata information for a retention label applied on a driveItem."
+
+ms.localizationpriority: medium
++
+# driveItem: getRetentionLabel
+
+Namespace: microsoft.graph
++
+Get metadata information for a retention label applied on a [driveItem](../resources/driveitem.md).
+
+For information about retention labels from an administrator's perspective, see [Use retention labels to manage the lifecycle of documents stored in SharePoint](/microsoft-365/compliance/auto-apply-retention-labels-scenario).
+
+## 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).
+
+| Type | Permissions (from least to most privileged) |
+|:|:-|
+| Delegated (work or school account) | Files.Read.All, Sites.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Files.Read.All, Sites.Read.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+```http
+GET /driveitem/retentionLabel
+GET /drives/{drive-id}/items/{id}/retentionLabel
+GET /drives/{drive-id}/items/{id}?$expand=retentionLabel
+```
+
+## Optional query parameters
+
+This method supports the `$expand` [OData query parameter](/graph/query-parameters) to help customize the response.
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an [itemRetentionLabel](../resources/itemretentionlabel.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following shows an example of the request.
+
+<!-- {
+ "blockType": "request",
+ "name": "driveItem_getRetentionLabel",
+ "sampleKeys": ["22e064df-3562-4a3c-98c3-74721ca06aa0", "44d372fc-2eb6-4c85-8538-f3a0386a568f"]
+}
+-->
+```http
+GET https://graph.microsoft.com/beta/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/lists/documents/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/driveitem/retentionLabel
+```
+
+### Response
+
+The following shows an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.itemRetentionLabel"
+}
+-->
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "name": "Retention label for Contracts",
+ "retentionSettings": {
+ "behaviorDuringRetentionPeriod": "retain",
+ "isDeleteAllowed": false,
+ "isRecordLocked": false,
+ "isMetadataUpdateAllowed": false,
+ "isContentUpdateAllowed": false,
+ "isLabelUpdateAllowed": false
+ },
+ "isLabelAppliedExplicitly": false,
+ "labelAppliedDateTime": "2022-12-22T10:18:23.6580555+00:00",
+ "labelAppliedBy": {
+ "user": {
+ "id": "56d171c8-a92e-4359-9c4a-38b88ac7eabd",
+ "displayName": "Contoso Admin"
+ }
+ }
+}
+```
v1.0 Driveitem Lockorunlockrecord https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-lockorunlockrecord.md
+
+ Title: "driveItem: lockOrUnlockRecord"
+description: "Lock or unlock a retention label on a driveItem that classifies content as records."
+
+ms.localizationpriority: medium
++
+# driveItem: lockOrUnlockRecord
+
+Namespace: microsoft.graph
++
+Lock or unlock a retention label on a [driveItem](../resources/driveitem.md) that classifies content as records.
+
+For information about retention labels from an administrator's perspective, see [Use retention labels to manage the lifecycle of documents stored in SharePoint](/microsoft-365/compliance/auto-apply-retention-labels-scenario).
+
+For information about how you can lock and unlock retention labels, see [Use record versioning to update records stored in SharePoint or OneDrive](/microsoft-365/compliance/record-versioning).
+
+## 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).
+
+| Type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Files.ReadWrite.All, Sites.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Files.ReadWrite.All, Sites.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+```http
+PATCH /driveitem/retentionLabel
+PATCH /drives/{drive-id}/items/{id}/retentionLabel
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, provide a JSON object with the following parameter.
+
+|Property|Type|Description|
+|:|:|:|
+|retentionSettings|[retentionLabelSettings](../resources/retentionlabelsettings.md) | The retention settings enforced on the item. |
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [itemRetentionLabel](../resources/itemretentionlabel.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following shows an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "driveItem_lockOrUnlockRecord",
+ "sampleKeys": ["22e064df-3562-4a3c-98c3-74721ca06aa0", "44d372fc-2eb6-4c85-8538-f3a0386a568f"]
+}
+-->
+
+```http
+PATCH https://graph.microsoft.com/beta/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/retentionLabel
+Content-Type: application/json
+
+{
+ "retentionSettings": {
+ "isRecordLocked": true
+ }
+}
+```
+
+### Response
+
+The following shows an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.itemRetentionLabel"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "name": "Retention label for Contracts",
+ "retentionSettings": {
+ "behaviorDuringRetentionPeriod": "retain",
+ "isDeleteAllowed": false,
+ "isRecordLocked": true,
+ "isMetadataUpdateAllowed": false,
+ "isContentUpdateAllowed": false,
+ "isLabelUpdateAllowed": false
+ },
+ "isLabelAppliedExplicitly": false,
+ "labelAppliedDateTime": "2022-12-22T10:18:23.6580555+00:00",
+ "labelAppliedBy": {
+ "user": {
+ "id": "56d171c8-a92e-4359-9c4a-38b88ac7eabd",
+ "displayName": "Contoso Admin"
+ }
+ }
+}
+```
v1.0 Driveitem Removeretentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-removeretentionlabel.md
+
+ Title: "driveItem: removeRetentionLabel"
+description: "Remove a retention label from a driveItem."
+
+ms.localizationpriority: medium
++
+# driveItem: removeRetentionLabel
+
+Namespace: microsoft.graph
++
+Remove a retention label from a [driveItem](../resources/driveitem.md).
+
+For information about retention labels from an administrator's perspective, see [Use retention labels to manage the lifecycle of documents stored in SharePoint](/microsoft-365/compliance/auto-apply-retention-labels-scenario).
+
+## 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).
+
+| Type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All, Sites.FullControl.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
+
+>**Note:** `Sites.FullControl.All` is the least privileged permission required to remove retention labels that classify the content as records.
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+```http
+DELETE /driveitem/retentionLabel
+DELETE /drives/{drive-id}/items/{id}/retentionLabel
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
+
+## Examples
+
+### Request
+
+The following shows an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "driveItem_removeRetentionLabel",
+ "sampleKeys": ["22e064df-3562-4a3c-98c3-74721ca06aa0", "44d372fc-2eb6-4c85-8538-f3a0386a568f"]
+}
+-->
+
+```http
+DELETE https://graph.microsoft.com/beta/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/retentionLabel
+```
+
+### Response
+
+The following shows an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
v1.0 Driveitem Setretentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-setretentionlabel.md
+
+ Title: "driveItem: setRetentionLabel"
+description: "Apply a retention label on a driveItem asynchronously."
+
+ms.localizationpriority: medium
++
+# driveItem: setRetentionLabel
+
+Namespace: microsoft.graph
++
+Apply (set) a retention label on a [driveItem](../resources/driveitem.md) (files and folders). Retention labels don't need to be published in a retention label policy to be applied using this method.
+
+When a retention label is applied to a folder, all the items in the folder are tagged with the same retention label. Conflict resolution is based on the following principle: _explicit wins over implicit_. For example, if a file in the folder has already been explicitly tagged with a label, that file doesn't inherit the label of the parent. For information about retention labels from an administrator's perspective, see [Use retention labels to manage the lifecycle of documents stored in SharePoint](/microsoft-365/compliance/auto-apply-retention-labels-scenario).
+
+## 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).
+
+| Type | Permissions (from least to most privileged) |
+|:|:--|
+| Delegated (work or school account) | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All |
+
+>**Note:** `Sites.FullControl.All` is the least privileged permission required to change retention labels that classify the content as records.
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /driveitem/retentionLabel
+PATCH /drives/{drive-id}/items/{id}/retentionLabel
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, provide a JSON object with the following parameter.
+
+| Property | Type | Description |
+|:|:-|:-|
+| name | String | Specifies the name of the retention label. |
+
+## Response
+
+When a file is applied with a retention label for the first time, this method returns a `201 Created` response code and an updated [itemRetentionLabel](../resources/itemretentionlabel.md) object in the response body. Subsequent updates to **retentionLabel** return a `200 OK` response code.
+
+## Examples
+
+### Request
+
+The following shows an example of a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "driveItem_setRetentionLabel",
+ "sampleKeys": ["22e064df-3562-4a3c-98c3-74721ca06aa0", "44d372fc-2eb6-4c85-8538-f3a0386a568f"]
+}
+-->
+
+```http
+PATCH https://graph.microsoft.com/beta/drives/22e064df-3562-4a3c-98c3-74721ca06aa0/items/44d372fc-2eb6-4c85-8538-f3a0386a568f/retentionLabel
+Content-Type: application/json
+
+{
+ "name": "Retention label for Contracts"
+}
+```
+
+### Response
+
+The following shows an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.itemRetentionLabel"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "name": "Retention label for Contracts",
+ "retentionSettings": {
+ "behaviorDuringRetentionPeriod": "retain",
+ "isDeleteAllowed": false,
+ "isRecordLocked": false,
+ "isMetadataUpdateAllowed": false,
+ "isContentUpdateAllowed": false,
+ "isLabelUpdateAllowed": false
+ },
+ "isLabelAppliedExplicitly": false,
+ "labelAppliedDateTime": "2022-12-22T10:18:23.6580555+00:00",
+ "labelAppliedBy": {
+ "user": {
+ "id": "56d171c8-a92e-4359-9c4a-38b88ac7eabd",
+ "displayName": "Contoso Admin"
+ }
+ }
+}
+```
v1.0 Driveitemversion Get Contents https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitemversion-get-contents.md
GET /users/{user-id}/drive/items/{item-id}/versions/{version-id}/content
## Response
-Returns a `302 Found` response redirecting to a pre-authenticated download URL for the bytes of the file.
+Returns a `302 Found` response redirecting to a preauthenticated download URL for the bytes of the file.
-To download the contents of the file your application will need to follow the `Location` header in the response.
-Many HTTP client libraries will automatically follow the 302 redirection and start downloading the file immedately.
+To download the contents of the file your application needs to follow the `Location` header in the response.
+Many HTTP client libraries will automatically follow the 302 redirection and start downloading the file immediately.
-Pre-authenticated download URLs are only valid for a short period of time (a few minutes) and do not require an `Authorization` header to download.
+Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header to download.
## Example
GET /me/drive/items/{item-id}/versions/{version-id}/content
### Response
-This returns a redirect to where the contents of the version can be downloaded.
+Returns a redirect to where the contents of the version can be downloaded.
<!-- { "blockType": "response", "isEmpty": true } -->
Location: https://onedrive.com/34FF49D6...
## Remarks
-OneDrive does not preserve the complete metadata for previous versions of a file.
+OneDrive doesn't preserve the complete metadata for previous versions of a file.
When your app retrieves the list of available versions for a file, a [driveItemVersion](../resources/driveitemversion.md) resource is returned that provides the available information about the specific version.
v1.0 Dynamics Unitsofmeasure Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/dynamics-unitsofmeasure-delete.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Deletes a units of measure object from Dynamics 365 Business Central.
+Deletes a unit of measure object from Dynamics 365 Business Central.
## 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).
This method supports the [OData Query Parameters](/graph/query-parameters) to he
|Header|Value| ||--| |Authorization |Bearer {token}. Required. |
-|If-Match |Required. When this request header is included and the eTag provided does not match the current tag on the **unitsOfMeasure**, the **unitsOfMeasure** will not be updated. |
+|If-Match |Required. When this request header is included and the eTag provided doesn't match the current tag on the **unitsOfMeasure**, the **unitsOfMeasure** won't be updated. |
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns ```204 No Content``` response code. It does not return anything in the response body.
+If successful, this method returns ```204 No Content``` response code. It doesn't return anything in the response body.
## Example **Request**
-Here is an example of the request.
+Here's an example of the request.
```http DELETE https://graph.microsoft.com/beta/financials/companies/{id}/unitsOfMeasure/{id}
DELETE https://graph.microsoft.com/beta/financials/companies/{id}/unitsOfMeasure
**Response**
-Here is an example of the response.
+Here's an example of the response.
```http HTTP/1.1 204 No Content
v1.0 Dynamics Unitsofmeasure Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/dynamics-unitsofmeasure-update.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Update the properties of a units of measure object for Dynamics 365 Business Central.
+Update the properties of a unit of measure object for Dynamics 365 Business Central.
## 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).
This method supports the [OData Query Parameters](/graph/query-parameters) to he
||--| |Authorization |Bearer. Required.| |Content-Type |application/json|
-|If-Match |Required. When this request header is included and the eTag provided does not match the current tag on the **unitsOfMeasure**, the **unitsOfMeasure** will not be updated. |
+|If-Match |Required. When this request header is included and the eTag provided doesn't match the current tag on the **unitsOfMeasure**, the **unitsOfMeasure** won't be updated. |
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
## Response If successful, this method returns a `200 OK` response code and an updated **unitsOfMeasure** object in the response body.
If successful, this method returns a `200 OK` response code and an updated **uni
**Request**
-Here is an example of the request.
+Here's an example of the request.
```http PATCH https://graph.microsoft.com/beta/financials/companies/{id}/unitsOfMeasure/{id} Content-type: application/json
Content-type: application/json
**Response**
-Here is an example of the response.
+Here's an example of the response.
> **Note**: The response object shown here might be shortened for readability.
v1.0 Ediscovery Noncustodialdatasource Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/ediscovery-noncustodialdatasource-post.md
The following table shows the properties that are required when you create the [
|Property|Type|Description| |:|:|:|
-|applyHoldToSource|Boolean|Indicates if hold is applied to non-custodial data source (such as mailbox or site).|
-|datasource|[microsoft.graph.ediscovery.dataSource](../resources/ediscovery-datasource.md)|Either a userSource or siteSource. For userSource, use "dataSource" : { "@odata.type" : "microsoft.graph.ediscovery.userSource", "email" : "SMTP address"}. For site source use "dataSource" : { "@odata.type" : "microsoft.graph.ediscovery.siteSource", "site@odata.bind" : "siteId" }, where siteId can be derived from the site URL, e.g. `https://contoso.sharepoint.com/sites/HumanResources`, the Microsoft Graph request would be `https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com:/sites/HumanResources`. The ID is the first GUID listed in the ID field.
+|applyHoldToSource|Boolean|Indicates if hold is applied to noncustodial data source (such as mailbox or site).|
+|datasource|[microsoft.graph.ediscovery.dataSource](../resources/ediscovery-datasource.md)|Either a userSource or siteSource. For userSource, use "dataSource" : { "@odata.type" : "microsoft.graph.ediscovery.userSource", "email" : "SMTP address"}. For site source use "dataSource" : { "@odata.type" : "microsoft.graph.ediscovery.siteSource", "site@odata.bind" : "siteId" }, where siteId can be derived from the site URL, for example, `https://contoso.sharepoint.com/sites/HumanResources`, the Microsoft Graph request would be `https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com:/sites/HumanResources`. The ID is the first GUID listed in the ID field.
## Response
If successful, this method returns a `201 Created` response code and a [noncusto
## Examples
-### Example 1: Add a non-custodial data source user or group mailbox with an email
+### Example 1: Add a noncustodial data source user or group mailbox with an email
#### Request
Content-Type: application/json
} ```
-### Example 2: Add a non-custodial data source site with a URL
+### Example 2: Add a noncustodial data source site with a URL
#### Request
v1.0 Educationassignment Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-update.md
Namespace: microsoft.graph
Update an [educationAssignment](../resources/educationassignment.md) object.
-Only teachers in the class can do this. Note that you can't use a PATCH request to change the status of an **assignment**. Use the [publish](../api/educationassignment-publish.md) action to change the **assignment** status.
+Only teachers in the class can do this. You can't use a PATCH request to change the status of an **assignment**. Use the [publish](../api/educationassignment-publish.md) action to change the **assignment** status.
## 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).
PATCH /education/classes/{class-id}/assignments/{assignment-id}
| Content-Type | application/json | ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-| |addedStudentAction|String| Controls the behavior for students who are added after the assignment is published.|
-|addToCalendarAction|educationAddToCalendarOptions|Optional field to control the assignment behavior for adding assignments to students' and teachers' calendars when the assignment is published. Possible values are: `none`, `studentsAndPublisher`, `studentsAndTeamOwners`, `studentsOnly` and `unknownFutureValue`. Default value is `none`. Cannot be modified when assignment is in **Published** state. |
+|addToCalendarAction|educationAddToCalendarOptions|Optional field to control the assignment behavior for adding assignments to students' and teachers' calendars when the assignment is published. Possible values are: `none`, `studentsAndPublisher`, `studentsAndTeamOwners`, `studentsOnly` and `unknownFutureValue`. Default value is `none`. Can't be modified when assignment is in **Published** state. |
|allowLateSubmissions|Boolean| Whether submissions can be submitted after the due date.| |allowStudentsToAddResourcesToSubmission|Boolean| Whether a student can add resources to a submission. Indicated whether the only items on the submission came from the assignment resource list. |
-|assignDateTime|DateTimeOffset| Date the assignment should be published to students. Cannot be edited after the assignment has been published. |
+|assignDateTime|DateTimeOffset| Date the assignment should be published to students. Can't be edited after the assignment has been published. |
|assignTo|[educationAssignmentRecipient](../resources/educationassignmentrecipient.md)| Students who get the assignment.|
-|closeDateTime|DateTimeOffset| Date when the assignment will be closed for submissions. This is an optional field that can be null if the assignment does not allowLateSubmissions or the closeDateTime is the same as the dueDateTime but if specified, it must be greater than or equal to the dueDateTime.|
+|closeDateTime|DateTimeOffset| Date when the assignment is closed for submissions. This is an optional field that can be null if the assignment doesn't allowLateSubmissions or the closeDateTime is the same as the dueDateTime but if specified, it must be greater than or equal to the dueDateTime.|
|displayName|String| Name of assignment. | |dueDateTime|DateTimeOffset| Date assignment is due. |
-|grading|[educationAssignmentGradeType](../resources/educationassignmentgradetype.md)| How the assignment will be graded.|
+|grading|[educationAssignmentGradeType](../resources/educationassignmentgradetype.md)| How the assignment is graded.|
|instructions|itemBody| Instructions to be given to the students along with the assignment. |
-|notificationChannelUrl|String| Channel to post assignment publish notification. Updating the channel URL is not allowed after the assignment has been published and is only allowed when the **assignTo** value is [educationAssignmentClassRecipient](../resources/educationassignmentclassrecipient.md).|
+|notificationChannelUrl|String| Channel to post assignment publish notification. Updating the channel URL isn't allowed after the assignment has been published and is only allowed when the **assignTo** value is [educationAssignmentClassRecipient](../resources/educationassignmentclassrecipient.md).|
## Response If successful, this method returns a `200 OK` response code and an updated [educationAssignment](../resources/educationassignment.md) object in the response body. ## Example ### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability.
v1.0 Educationschool Get Administrativeunit https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationschool-get-administrativeUnit.md
Title: "Get administrativeUnit"
-description: "Retrieve the simple directory **administrativeUnit** that corresponds to this **educationSchool**."
+description: "Retrieve the directory **administrativeUnit** that corresponds to this **educationSchool**."
ms.localizationpriority: medium ms.prod: "education"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve the simple directory **administrativeUnit** that corresponds to this **educationSchool**.
+Retrieve the directory **administrativeUnit** that corresponds to this **educationSchool**.
>**Note:** If the delegated token is used, members can only see information about their own schools. Use the `...beta/education/me/schools` resource in this case.
GET /education/schools/{id}/administrativeUnit
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and an [administrativeUnit](../resources/administrativeunit.md) object in the response body. ## Example ##### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/education/schools/2961761D-8094-4183-A9F6-8
##### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability.
v1.0 Educationuser Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationuser-update.md
PATCH /education/users/{id}
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property | Type | Description | | : | :-- | :- |
In the request body, supply the values for relevant fields that should be update
| middleName | String | Middle Name of user | | surname | String | Surname of user | | mail | String | email address |
-| mobilePhone | String | Mobile number of user |
+| mobilePhone | String | Mobile number of users |
| externalSource | string | Where this user was created from. Possible values are: `sis`, `manual`, or `lms`. |
-| mailingAddress | [physicalAddress] | Mail address of user. Note: `type` and `postOfficeBox` are not supported for `educationUser` resources. |
-| residenceAddress | [physicalAddress] | Address where user lives. Note: `type` and `postOfficeBox` are not supported for `educationUser` resources. |
+| mailingAddress | [physicalAddress] | Mail address of user. Note: `type` and `postOfficeBox` aren't supported for `educationUser` resources. |
+| residenceAddress | [physicalAddress] | Address where user lives. Note: `type` and `postOfficeBox` aren't supported for `educationUser` resources. |
| primaryRole | string | Default Role for a user. The user's role might be different in an individual class. Possible values are: `student`, `teacher`, `enum_sentinel`. |
-| student | [educationStudent] | If the primary role is student, this block will contain student specific data. |
-| teacher | [educationTeacher](../resources/educationteacher.md) | If the primary role is teacher, this block will contain teacher specific data. |
+| student | [educationStudent] | If the primary role is student, this block contains student specific data. |
+| teacher | [educationTeacher](../resources/educationteacher.md) | If the primary role is teacher, this block contains teacher specific data. |
## Response
If successful, this method returns a `200 OK` response code and updated [educati
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
v1.0 Externalconnectors Externalitem Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalconnectors-externalitem-delete.md
DELETE /external/connections/{connection-id}/items/{item-id}
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns `204 No Content` response code. It does not return anything in the response body.
+If successful, this method returns `204 No Content` response code. It doesn't return anything in the response body.
## Examples ### Request
-The following is an example of the request.
+Here's an example of the request.
DELETE https://graph.microsoft.com/beta/external/connections/contosohr/items/TSP
### Response <!-- markdownlint-enable MD024 -->
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Federatedidentitycredential Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedidentitycredential-delete.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
You can also address the federated identity credential with either its **id** or **name**. <!-- { "blockType": "ignored" } -->
v1.0 Federatedidentitycredential Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedidentitycredential-get.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
You can also address the federated identity credential with either its **id** or **name**. <!-- { "blockType": "ignored" } -->
v1.0 Federatedidentitycredential Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedidentitycredential-update.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
You can also address the federated identity credential with either its **id** or **name**. <!-- { "blockType": "ignored" } -->
v1.0 Formatprotection Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/formatprotection-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a [formatProtection](../resources/formatprotection.md) object in the response body. ## Example ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Group Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delta.md
This method supports optional OData query parameters to help customize the respo
- You can use a `$select` query parameter as in any GET request to specify only the properties your need for best performance. The _id_ property is always returned. - You can use `$select=members` to get membership changes. You can additionally track other changes like ownership and more by selecting any [group relationship](../resources/group.md#relationships) of type **directoryObject collection**.-- There is limited support for `$filter`:
- - The only supported `$filter` expression is for tracking changes on a specific object: `$filter=id+eq+{value}`. You can filter multiple objects. For example, `https://graph.microsoft.com/beta/groups/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'`. There is a limit of 50 filtered objects.
+- There's limited support for `$filter`:
+ - The only supported `$filter` expression is for tracking changes on a specific object: `$filter=id+eq+{value}`. You can filter multiple objects. For example, `https://graph.microsoft.com/beta/groups/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'`. There's a limit of 50 filtered objects.
## Request headers
This method supports optional OData query parameters to help customize the respo
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
### Response
-If successful, this method returns `200 OK` response code and [group](../resources/group.md) collection object in the response body. The response also includes a state token which is either a `@odata.nextLink` URL or a `@odata.deltaLink` URL.
+If successful, this method returns `200 OK` response code and [group](../resources/group.md) collection object in the response body. The response also includes a state token that is either a `@odata.nextLink` URL or a `@odata.deltaLink` URL.
- If a `@odata.nextLink` URL is returned:
- - This indicates there are additional pages of data to be retrieved in the session. The application continues making requests using the `@odata.nextLink` URL until a `@odata.deltaLink` URL is included in the response.
+ - This indicates there are more pages of data to be retrieved in the session. The application continues making requests using the `@odata.nextLink` URL until a `@odata.deltaLink` URL is included in the response.
- The response includes the same set of properties as in the initial delta query request. This allows you to capture the full current state of the objects when initiating the delta cycle. - If a `@odata.deltaLink` URL is returned:
- - This indicates there is no more data about the existing state of the resource to be returned. Save and use the `@odata.deltaLink` URL to learn about changes to the resource in the next round.
+ - This indicates there's no more data about the existing state of the resource to be returned. Save and use the `@odata.deltaLink` URL to learn about changes to the resource in the next round.
- You have a choice to specify the `Prefer:return=minimal` header, to include in the response values for only the properties that have changed since the time the `@odata.deltaLink` was issued. #### Default: return the same properties as initial delta request
If successful, this method returns `200 OK` response code and [group](../resourc
By default, requests using a `@odata.deltaLink` or `@odata.nextLink` return the same properties as selected in the initial delta query in the following ways: - If the property has changed, the new value is included in the response. This includes properties being set to null value.-- If the property has not changed, the old value is included in the response.
+- If the property hasn't changed, the old value is included in the response.
- If the property has never been set before it will not be included in the response at all. > **Note:** With this behavior, by looking at the response it is not possible to tell whether a property is changing or not. Also, the delta responses tend to be large because they contain all property values - as shown in the [second example](#request-2) below.
By default, requests using a `@odata.deltaLink` or `@odata.nextLink` return the
Adding an optional request header - `prefer:return=minimal` - results in the following behavior: - If the property has changed, the new value is included in the response. This includes properties being set to null value.-- If the property has not changed, the property is not included in the response at all. (Different from the default behavior.)
+- If the property hasn't changed, the property isn't included in the response at all. (Different from the default behavior.)
> **Note:** The header can be added to a `@odata.deltaLink` request at any point in time in the delta cycle. The header only affects the set of properties included in the response and it does not affect how the delta query is executed. See the [third example](#request-3) below.
Adding an optional request header - `prefer:return=minimal` - results in the fol
#### Request 1
-The following is an example of the request. There is no `$select` parameter, so a default set of properties is tracked and returned.
+Here's an example of the request. There's no `$select` parameter, so a default set of properties is tracked and returned.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/groups/delta
#### Response 1
-The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization.
+Here's an example of the response when using `@odata.deltaLink` obtained from the query initialization.
> **Note:** The response object shown here might be shortened for readability. >
Content-type: application/json
#### Request 2
-The next example shows the initial request selecting 3 properties for change tracking, with default response behavior:
+The next example shows the initial request selecting three properties for change tracking, with default response behavior:
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/groups/delta?$select=displayName,descriptio
#### Response 2
-The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization. Note that all 3 properties are included in the response and it is not known which ones have changed since the `@odata.deltaLink` was obtained.
+Here's an example of the response when using `@odata.deltaLink` obtained from the query initialization. All three properties are included in the response and it isn't known which ones have changed since the `@odata.deltaLink` was obtained.
<!-- { "blockType": "response",
Content-type: application/json
#### Request 3
-The next example shows the initial request selecting 3 properties for change tracking, with alternative minimal response behavior:
+The next example shows the initial request selecting three properties for change tracking, with alternative minimal response behavior:
# [HTTP](#tab/http)
Prefer: return=minimal
#### Response 3
-The following is an example of the response when using `@odata.deltaLink` obtained from the query initialization. Note that the `mailNickname` property is not included, which means it has not changed since the last delta query; `displayName` and `description` are included which means their values have changed.
+Here's an example of the response when using `@odata.deltaLink` obtained from the query initialization. The `mailNickname` property isn't included, which means it hasn't changed since the last delta query; `displayName` and `description` are included which means their values have changed.
<!-- { "blockType": "response",
v1.0 Group Post Acceptedsenders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-acceptedsenders.md
Namespace: microsoft.graph
Add a new user or group to the acceptedSender list.
-Specify the user or group in `@odata.id` in the request body. Users in the accepted senders list can post to conversations of the group . Make sure you do not specify the same user or group in the accepted senders and rejected senders lists, otherwise you will get an error.
+Specify the user or group in `@odata.id` in the request body. Users in the accepted senders list can post to conversations of the group. Make sure you don't specify the same user or group in the accepted senders and rejected senders lists, otherwise you'll get an error.
## Permissions
POST /groups/{id}/acceptedSenders/$ref
## Request body
-In the request body, supply the id of a user or group object.
+In the request body, supply the ID of a user or group object.
## Response
This method returns `204 No Content` response code and no response body.
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Group Post Groups https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-groups.md
The following table shows the properties that are required when you create the [
| displayName | string | The name to display in the address book for the group. Maximum length is 256 characters. Required. | | mailEnabled | boolean | Set to `true` for mail-enabled groups. Required. | | mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : <> , SPACE`. Required. |
-| securityEnabled | boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Azure portal always have **securityEnabled** initially set to `true`. |
+| securityEnabled | boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. |
> [!IMPORTANT] >
Content-type: application/json
{ "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups/$entity",
- "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
- "deletedDateTime": null,
- "classification": null,
- "createdDateTime": "2018-12-22T02:21:05Z",
- "description": "Self help community for golf",
- "displayName": "Golf Assist",
- "expirationDateTime": null,
- "groupTypes": [
- "Unified"
- ],
+ "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
+ "deletedDateTime": null,
+ "classification": null,
+ "createdDateTime": "2018-12-22T02:21:05Z",
+ "description": "Self help community for golf",
+ "displayName": "Golf Assist",
+ "expirationDateTime": null,
+ "groupTypes": [
+ "Unified"
+ ],
"isAssignableToRole": null,
- "mail": "golfassist@contoso.com",
- "mailEnabled": true,
- "mailNickname": "golfassist",
- "membershipRule": null,
- "membershipRuleProcessingState": null,
- "onPremisesLastSyncDateTime": null,
- "onPremisesSecurityIdentifier": null,
- "onPremisesSyncEnabled": null,
- "preferredDataLocation": "CAN",
- "preferredLanguage": null,
- "proxyAddresses": [
- "SMTP:golfassist@contoso.onmicrosoft.com"
- ],
- "renewedDateTime": "2018-12-22T02:21:05Z",
- "resourceBehaviorOptions": [],
- "resourceProvisioningOptions": [],
- "securityEnabled": false,
+ "mail": "golfassist@contoso.com",
+ "mailEnabled": true,
+ "mailNickname": "golfassist",
+ "membershipRule": null,
+ "membershipRuleProcessingState": null,
+ "onPremisesLastSyncDateTime": null,
+ "onPremisesSecurityIdentifier": null,
+ "onPremisesSyncEnabled": null,
+ "preferredDataLocation": "CAN",
+ "preferredLanguage": null,
+ "proxyAddresses": [
+ "SMTP:golfassist@contoso.onmicrosoft.com"
+ ],
+ "renewedDateTime": "2018-12-22T02:21:05Z",
+ "resourceBehaviorOptions": [],
+ "resourceProvisioningOptions": [],
+ "securityEnabled": false,
"securityIdentifier": "S-1-12-1-1753967289-1089268234-832641959-555555555",
- "theme": null,
- "visibility": "Public",
- "onPremisesProvisioningErrors": []
+ "theme": null,
+ "visibility": "Public",
+ "onPremisesProvisioningErrors": []
} ```
v1.0 Group Post Rejectedsenders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-rejectedsenders.md
Namespace: microsoft.graph
Add a new user or group to the rejectedSender list.
-Specify the user or group in `@odata.id` in the request body. Users in the rejected senders list cannot post to conversations of the group (identified in the POST request URL). Make sure you do not specify the same user or group in the rejected senders and accepted senders lists, otherwise you will get an error.
+Specify the user or group in `@odata.id` in the request body. Users in the rejected senders list can't post to conversations of the group (identified in the POST request URL). Make sure you don't specify the same user or group in the rejected senders and accepted senders lists, otherwise you'll get an error.
## Permissions
This method returns `204 No Content` response code and no response body.
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Identitycontainer List B2xuserflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-b2xuserflows.md
GET /identity/b2xUserFlows
## Optional query parameters
-You can use `$expand` to expand specific user flow properties that are not expanded by default.
+You can use `$expand` to expand specific user flow properties that aren't expanded by default.
For more information, see [OData query parameters](/graph/query-parameters).
For more information, see [OData query parameters](/graph/query-parameters).
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a collection of
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/identity/b2xUserFlows
#### Response
-The following is an example of the response.
+Here's an example of the response.
**Note:** The response object shown here might be shortened for readability.
Content-type: application/json
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
GET https://graph.microsoft.com/beta/identity/b2xUserFlows?$expand=identityProvi
#### Response
-The following is an example of the response.
+Here's an example of the response.
**Note:** The response object shown here might be shortened for readability.
v1.0 Identitycontainer Post Authenticationeventsflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventsflows.md
You can specify the following properties when creating an **authenticationEvents
|priority|Int32|Optional. The priority to use for each individual event of the events policy. If multiple competing listeners for an event have the same priority, one is chosen and an error is silently logged. Default is 500. | |onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|Required. The configuration for what to invoke when an authentication flow is ready to be initiated. | |onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|Required. The configuration for what to invoke when authentication methods are ready to be presented to the user. Must have at least one identity provider linked.|
-|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke when attributes are ready to be collected from the user.|
-|onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|The configuration for what to invoke during user creation.|
+|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user.|
+|onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|Optional. The configuration for what to invoke during user creation.|
## Response
v1.0 Identitycontainer Post B2xuserflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-b2xuserflows.md
In the request body, provide a JSON representation of a [b2xIdentityUserFlow](..
|Property|Type|Description| |:|:--|:-|
-|id|String|Required. The name of the user flow. The name will be pre-pended with `B2X_1` after creation.|
-|userFlowType|String|Required. The type of user flow you are creating. This value will always be `signUpOrSignIn`.|
+|id|String|Required. The name of the user flow. The name will be prepended with `B2X_1` after creation.|
+|userFlowType|String|Required. The type of user flow you're creating. This value will always be `signUpOrSignIn`.|
|userFlowTypeVersion|Float|Required. The version of the user flow. This value will always be 1.| |identityProviders|[identityProvider](../resources/identityprovider.md) collection|Optional. The identity providers you want to include in the user flow.| |apiConnectorConfiguration|[userFlowApiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md)|Optional. Configuration for enabling an API connector for use as part of the user flow.| ## Response
-If successful, this method returns a `201 Created` response code and a Location header with a URI to the [b2xIdentityUserFlow](../resources/b2xidentityuserflow.md) object created for this request, with the `B2X_1` prefix added to the name. If unsuccessful, a `4xx` error will be returned with specific details.
+If successful, this method returns a `201 Created` response code and a Location header with a URI to the [b2xIdentityUserFlow](../resources/b2xidentityuserflow.md) object created for this request, with the `B2X_1` prefix added to the name. If unsuccessful, a `4xx` error is returned with specific details.
## Examples
If successful, this method returns a `201 Created` response code and a Location
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
**Note:** The response object shown here might be shortened for readability.
Content-type: application/json
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
**Note:** The response object shown here might be shortened for readability.
Content-type: application/json
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
Content-type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
**Note:** The response object shown here might be shortened for readability.
v1.0 Identityuserflowattribute Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattribute-delete.md
One of the following permissions is required to call this API. To learn more, in
The work or school account needs to belong to one of the following roles:
-* Global administrator
-* External Identity User Flow Attribute administrator
+* Global Administrator
+* External Identity User Flow Attribute Administrator
## HTTP request
v1.0 Identityuserflowattribute Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattribute-get.md
One of the following permissions is required to call this API. To learn more, in
The work or school account needs to belong to one of the following roles:
-* Global administrator
-* External Identity User Flow Attribute administrator
+* Global Administrator
+* External Identity User Flow Attribute Administrator
## HTTP request
v1.0 Identityuserflowattribute List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattribute-list.md
One of the following permissions is required to call this API. To learn more, in
The work or school account needs to belong to one of the following roles:
-* Global administrator
-* External Identity User Flow Attribute administrator
+* Global Administrator
+* External Identity User Flow Attribute Administrator
## HTTP request
v1.0 Identityuserflowattribute Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattribute-post.md
One of the following permissions is required to call this API. To learn more, in
The work or school account needs to belong to one of the following roles:
-* Global administrator
-* External Identity User Flow Attribute administrator
+* Global Administrator
+* External Identity User Flow Attribute Administrator
## HTTP request
v1.0 Identityuserflowattribute Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattribute-update.md
One of the following permissions is required to call this API. To learn more, in
The work or school account needs to belong to one of the following roles:
-* Global administrator
-* External Identity User Flow Attributes administrator
+* Global Administrator
+* External Identity User Flow Attributes Administrator
## HTTP request
v1.0 Meetingattendancereport Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingattendancereport-get.md
GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanc
> [!TIP] >
->- `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
+>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
>- `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. >- `reportId` is the **id** of an [meetingAttendanceReport](../resources/meetingAttendanceReport.md) object. >- `webinarId` is the **id** of an [virtualEventWebinar](../resources/virtualEventWebinar.md) object.
v1.0 Meetingattendancereport List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingattendancereport-list.md
GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanc
> [!TIP] >
->- `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
+>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
>- `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. >- `webinarId` is the **id** of an [virtualEventWebinar](../resources/virtualEventWebinar.md) object. >- `sessionId` is the **id** of an [virtualEventSession](../resources/virtualEventSession.md) object.
v1.0 Nameditem Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/nameditem-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookNamedItem](../resources/workbooknameditem.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Nameditem List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/nameditem-list.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookNamedItem](../resources/workbooknameditem.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Nameditem Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/nameditem-update.md
PATCH /me/drive/root:/{item-path}:/workbook/names/{name}
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [workbookNamedItem](../resources/workbooknameditem.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Networkaccess Branchsite Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-get.md
If successful, this method returns a `200 OK` response code and a [microsoft.gra
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branch
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Networkaccess Crosstenantaccesssettings Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-crosstenantaccesssettings-get.md
GET /networkAccess/settings/crossTenantAccess
``` ## Optional query parameters
-This method does not support any OData query parameters.
+This method doesn't support any OData query parameters.
## Request headers |Name|Description|
This method does not support any OData query parameters.
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a [microsoft.gra
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/networkAccess/settings/crossTenantAccess
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Notebook Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/notebook-get.md
Valid `expand` values for notebooks are `sections` and `sectionGroups`.
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a [notebook](../resources/notebook.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/notebooks/{id}
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Notebook Getrecentnotebooks https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/notebook-getrecentnotebooks.md
The `{id | userPrincipalName}` for the user must match the user encoded in the a
| Parameter | Type |Description| |:|:--|:-|
-|includePersonalNotebooks|Boolean|Include notebooks owned by the user. Set to `true` to include notebooks owned by the user; otherwise, set to `false`. If you don't include the `includePersonalNotebooks` parameter, your request will return a `400` error response.|
+|includePersonalNotebooks|Boolean|Include notebooks owned by the user. Set to `true` to include notebooks owned by the user; otherwise, set to `false`. If you don't include the `includePersonalNotebooks` parameter, your request returns a `400` error response.|
## Request headers | Name | Description|
The `{id | userPrincipalName}` for the user must match the user encoded in the a
| Authorization | Bearer {code}| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response A successful response returns a `200 OK` that contains a JSON collection of **recentNotebooks**.
v1.0 Notebook List Sectiongroups https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/notebook-list-sectiongroups.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [sectionGroup](../resources/sectiongroup.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/notebooks/{id}/sectionGroups
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Notebook List Sections https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/notebook-list-sections.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a collection of [onenoteSection](../resources/onenotesection.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/notebooks/{id}/sections
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Onattributecollectionexternalusersselfservicesignup Delete Attributes https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md
Do not supply a request body for this method.
## Response
-If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error will be returned with specific details.
+If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details.
## Examples #### Request
-The following is an example of a request that removes city as an attribute from the attribute collection step of an external identities self-service sign-up user flow. After executing this step, [update the attributes collected in the userflow](../api/authenticationeventsflow-update.md).
+Here's an example of a request that removes city as an attribute from the attribute collection step of an external identities self-service sign-up user flow. After executing this step, [update the attributes collected in the userflow](../api/authenticationeventsflow-update.md).
# [HTTP](#tab/http) <!-- { "blockType": "request",
DELETE https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313c
#### Response
-The following is an example of the response
+Here's an example of the response
<!-- { "blockType": "response", "truncated": true
v1.0 Onattributecollectionexternalusersselfservicesignup List Attributes https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onattributecollectionexternalusersselfservicesignup-list-attributes.md
Do not supply a request body for this method.
If successful, this method returns a `200 OK` response code and a new [identityUserFlowAttribute](../resources/identityuserflowattribute.md) object in the response body.
+If no user flow attributes are assigned to the user flow, this method returns a `400 Bad Request` error code.
+ ## Examples #### Request
v1.0 Onauthenticationmethodloadstartexternalusersselfservicesignup Delete Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md
DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microso
|Content-Type|application/json. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error will be returned with specific details.
+If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details.
## Examples #### Request
-The following is an example of a request to remove Facebook as an identity provider option for account creation.
+Here's an example of a request to remove Facebook as an identity provider option for account creation.
# [HTTP](#tab/http) <!-- { "blockType": "request",
DELETE https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313c
#### Response
-The following is an example of the response
+Here's an example of the response
<!-- { "blockType": "response", "truncated": true
v1.0 Onenote List Notebooks https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onenote-list-notebooks.md
Valid `expand` values for notebooks are `sections` and `sectionGroups`.
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [notebook](../resources/notebook.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/notebooks
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Onenote List Sectiongroups https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onenote-list-sectiongroups.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [sectionGroup](../resources/sectiongroup.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/sectionGroups
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Onenote List Sections https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onenote-list-sections.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [onenoteSection](../resources/onenotesection.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/sections
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Onenoteoperation Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onenoteoperation-get.md
Title: "Get onenoteOperation"
-description: "Get the status of a long-running OneNote operation. This applies to operations that return the **Operation-Location** header in the response, such as `CopyNotebook`, `CopyToNotebook`, `CopyToSectionGroup`, `and CopyToSection`. "
+description: "Get the status of a long-running OneNote operation. The status applies to operations that return the **Operation-Location** header in the response, such as `CopyNotebook`, `CopyToNotebook`, `CopyToSectionGroup`, `and CopyToSection`. "
ms.localizationpriority: medium ms.prod: "onenote"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get the status of a long-running OneNote operation. This applies to operations that return the **Operation-Location** header in the response, such as `CopyNotebook`, `CopyToNotebook`, `CopyToSectionGroup`, `and CopyToSection`.
+Get the status of a long-running OneNote operation. The status applies to operations that return the **Operation-Location** header in the response, such as `CopyNotebook`, `CopyToNotebook`, `CopyToSectionGroup`, `and CopyToSection`.
You can poll the Operation-Location endpoint until the `status` property returns `completed` or `failed`.
None.
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [onenoteOperation](../resources/onenoteoperation.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/operations/{id}
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Onlinemeeting Createorget https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-createorget.md
POST /users/{userId}/onlineMeetings/createOrGet
``` > [!NOTE]
-> `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). See more details in [application access policy](/graph/cloud-communication-online-meeting-application-access-policy).
+> **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). See more details in [application access policy](/graph/cloud-communication-online-meeting-application-access-policy).
## Request headers | Name | Description |
v1.0 Onlinemeeting Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-delete.md
DELETE /users/{userId}/onlineMeetings/{meetingId}
``` > [!NOTE]
-> - `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Configure application access to online meetings](/graph/cloud-communication-online-meeting-application-access-policy).
+> - **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Configure application access to online meetings](/graph/cloud-communication-online-meeting-application-access-policy).
> - `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. ## Request headers
v1.0 Onlinemeeting Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-get.md
GET /users/{userId}/onlineMeetings/{meetingId}/alternativeRecording
> [!NOTE] >- The `/app` path is deprecated. Going forward, use the `/communications` path.
->- `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
+>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy).
>- `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. > - **videoTeleconferenceId** is generated for Cloud-Video-Interop licensed users and can be found in an [onlineMeeting](../resources/onlinemeeting.md) object. For details, see [VTC conference id](/microsoftteams/cloud-video-interop-for-teams-set-up). >- `joinWebUrl` must be URL encoded.
v1.0 Onlinemeeting Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-update.md
PATCH /users/{userId}/onlineMeetings/{meetingId}
> [!NOTE] >
-> - `userId` is the object ID of a user in [Azure user management portal](https://portal.azure.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [application access policy](/graph/cloud-communication-online-meeting-application-access-policy).
+> - **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [application access policy](/graph/cloud-communication-online-meeting-application-access-policy).
> - `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. ## Request headers
v1.0 Openshift Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/openshift-get.md
GET /teams/{id}/schedule/openShifts/{openShiftId}
## Optional query parameters
-This method does not support OData query parameters to customize the response.
+This method doesn't support OData query parameters to customize the response.
## Request headers
If successful, this method returns a `200 OK` response code and the requested [o
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/teams/3d88b7a2-f988-4f4b-bb34-d66df66af126/
### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability.
v1.0 Organization Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/organization-update.md
The calling user must also be in one of the following [Azure AD roles](/azure/ac
* Partner Tier2 Support * Billing Administrator
+**Note**: To update the **onPremisesSyncEnabled** property requires that the calling user to have one of the following Azure AD roles:
+
+* Global Administrator
+* Directory Synchronization Accounts
+* Hybrid Identity Administrator
+ ## HTTP request <!-- { "blockType": "ignored" } -->
In the request body, supply the values for relevant fields that should be update
| Property | Type |Description| |:|:--|:-| |marketingNotificationEmails|String collection| **Notes**: not nullable. |
+|onPremisesSyncEnabled|Boolean|`true` to enable this object to be synced from an on-premises directory; `false` to disable syncing from an on-premises directory; Nullable. `null` if this object has never been synced from an on-premises directory (default). |
|privacyProfile|[privacyProfile](../resources/privacyprofile.md)|The privacy profile of an organization (set statementUrl and contactEmail). | |securityComplianceNotificationMails|String collection|| |securityComplianceNotificationPhones|String collection||
Content-type: application/json
{ "marketingNotificationEmails" : ["marketing@contoso.com"],
+ "onPremisesSyncEnabled" : true,
"privacyProfile" : { "contactEmail":"alice@contoso.com",
v1.0 Plannerbucket Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannerbucket-update.md
PATCH /planner/buckets/{id}
| If-Match | Last known ETag value for the **plannerBucket** to be updated. Required.| ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
This method can return any of the [HTTP status codes](/graph/errors). The most c
## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Printer Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printer-get.md
GET /print/shares/{id}/printer
## Optional query parameters This method supports some of the OData query parameters including $select, $expand to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
-e.g.
+for example
```http GET /print/printers/{id}?$select=id,displayName,capabilities ```
GET /print/printers/{id}?$select=id,displayName,capabilities
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a [printer](../resources/printer.md) object in the response body.
-By default, the response will not contain [printerCapabilities](../resources/printerCapabilities.md). To get **printerCapabilities**, use the `$select` query parameter.
+By default, the response won't contain [printerCapabilities](../resources/printerCapabilities.md). To get **printerCapabilities**, use the `$select` query parameter.
## Example ### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/print/printers/{id}
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-type: application/json
} ```
-The following is an example of the response, when using $select=id,displayName,capabilities
+Here's an example of the response, when using $select=id,displayName,capabilities
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Printershare Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printershare-delete.md
Title: Delete printerShare
-description: Delete a printer share (unshare the associated printer). This action cannot be undone. If the printer is shared again in the future, any Windows users who had previously installed the printer will need to discover and re-install it.
+description: Delete a printer share (unshare the associated printer). This action can't be undone. If the printer is shared again in the future, any Windows users who had previously installed the printer needs to discover and reinstall it.
ms.localizationpriority: medium ms.prod: cloud-printing
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Delete a printer share (unshare the associated [printer](../resources/printer.md)). This action cannot be undone. If the [printer](../resources/printer.md) is shared again in the future, any Windows users who had previously installed the [printer](../resources/printer.md) will need to discover and reinstall it.
+Delete a printer share (unshare the associated [printer](../resources/printer.md)). This action can't be undone. If the [printer](../resources/printer.md) is shared again in the future, any Windows users who had previously installed the [printer](../resources/printer.md) needs to discover and reinstall it.
## 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).
DELETE /print/printers/{id}/share
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.
+If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
## Example ##### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
DELETE https://graph.microsoft.com/beta/print/shares/{id}
##### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response", "truncated": true
v1.0 Printershare Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printershare-get.md
GET /print/printers/{printerId}/shares/{printerShareId}
## Optional query parameters This method supports some of the OData query parameters including $select, $expand to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
-e.g.
+for example
```http GET /print/printers/{id}?$select=id,displayName,capabilities ``` ### Exceptions
-* The `$count` operator is not supported.
+* The `$count` operator isn't supported.
## Request headers | Name |Description|
GET /print/printers/{id}?$select=id,displayName,capabilities
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a [printerShare](../resources/printershare.md) object in the response body.
-By default, the response will not contain [printerCapabilities](../resources/printerCapabilities.md). To get **printerCapabilities**, use the `$select` query parameter.
+By default, the response won't contain [printerCapabilities](../resources/printerCapabilities.md). To get **printerCapabilities**, use the `$select` query parameter.
## Example ### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/print/shares/{id}
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-type: application/json
} ```
-The following is an example of the response, when using $select=id,displayName,capabilities
+Here's an example of the response, when using $select=id,displayName,capabilities
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Range Offsetrange https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-offsetrange.md
Title: "Range: OffsetRange"
-description: "Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown."
+description: "Gets an object that represents a range that's offset from the specified range. The dimension of the returned range matches this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception is thrown."
ms.localizationpriority: medium ms.prod: "excel"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Gets an object which represents a range that's offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown.
+Gets an object that represents a range that's offset from the specified range. The dimension of the returned range matches this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception is thrown.
## 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).
In the request body, provide a JSON object with the following parameters.
If successful, this method returns `200 OK` response code and [workbookRange](../resources/workbookrange.md) object in the response body. ## Example
-Here is an example of how to call this API.
+Here's an example of how to call this API.
##### Request
-Here is an example of the request.
+Here's an example of the request.
<!-- { "blockType": "request", "name": "range_offsetrange"
Content-type: application/json
``` ##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangeborder Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeborder-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookRangeBorder](../resources/workbookrangeborder.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangeborder List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeborder-list.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookRangeBorder](../resources/workbookrangeborder.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangeborder Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeborder-update.md
PATCH /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/r
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").|
+|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange").|
|style|string|One of the constants of line style specifying the line style for the border. Possible values are: `None`, `Continuous`, `Dash`, `DashDot`, `DashDotDot`, `Dot`, `Double`, `SlantDashDot`.| |weight|string|Specifies the weight of the border around a range. Possible values are: `Hairline`, `Thin`, `Medium`, `Thick`.|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [workbookRangeBorder](../resources/workbookrangeborder.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangefill Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefill-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookRangeFill](../resources/workbookrangefill.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangefill Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefill-update.md
PATCH /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/r
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")|
+|color|string|HTML color code representing the color of the border line, of the form #RRGGBB (for example "FFA500") or as a named HTML color (for example "orange")|
## Response If successful, this method returns a `200 OK` response code and updated [workbookRangeFill](../resources/workbookrangefill.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response" } -->
v1.0 Rangefont Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefont-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookRangeFont](../resources/workbookrangefont.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangefont Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefont-update.md
PATCH /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/r
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-| |bold|boolean|Represents the bold status of font.|
-|color|string|HTML color code representation of the text color. E.g. #FF0000 represents Red.|
+|color|string|HTML color code representation of the text color. for example, #FF0000 represents Red.|
|italic|boolean|Represents the italic status of the font.|
-|name|string|Font name (e.g. "Calibri")|
+|name|string|Font name (for example "Calibri")|
|size|double|Font size.| |underline|string|Type of underline applied to the font. Possible values are: `None`, `Single`, `Double`, `SingleAccountant`, `DoubleAccountant`.|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `200 OK` response code and updated [workbookRangeFont](../resources/workbookrangefont.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangeformat Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookRangeFormat](../resources/workbookrangeformat.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangeformat List Borders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-list-borders.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookRangeBorder](../resources/workbookrangeborder.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/r
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangeformat Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-update.md
PATCH /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/r
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|columnWidth|double|Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.|
+|columnWidth|double|Gets or sets the width of all columns within the range. If the column widths aren't uniform, null is returned.|
|horizontalAlignment|string|Represents the horizontal alignment for the specified object. Possible values are: `General`, `Left`, `Center`, `Right`, `Fill`, `Justify`, `CenterAcrossSelection`, `Distributed`.|
-|rowHeight|double|Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned.|
+|rowHeight|double|Gets or sets the height of all rows in the range. When, the row heights aren't uniform null will be returned.|
|verticalAlignment|string|Represents the vertical alignment for the specified object. Possible values are: `Top`, `Center`, `Bottom`, `Justify`, `Distributed`.| |wrapText|boolean|Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn't have uniform wrap setting|
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
``` ##### Request
-This request updates the font style, size, and color of the third cell. Note that the underline property takes **Single** or **Double** as values.
+This request updates the font style, size, and color of the third cell. The underline property takes **Single** or **Double** as values.
# [HTTP](#tab/http)
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Rangesort Apply https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangesort-apply.md
In the request body, provide a JSON object with the following parameters.
| Parameter | Type |Description| |:|:--|:-| |fields|workbookSortField collection|The list of conditions to sort on.|
-|matchCase|boolean|Optional. Whether to have the casing impact string ordering.|
+|matchCase|boolean|Optional. Whether to have the casing determines string ordering.|
|hasHeaders|boolean|Optional. Whether the range has a header.| |orientation|string|Optional. Whether the operation is sorting rows or columns. Possible values are: `Rows`, `Columns`.| |method|string|Optional. The ordering method used for Chinese characters. Possible values are: `PinYin`, `StrokeCount`.| ## Response
-If successful, this method returns `200 OK` response code. It does not return anything in the response body.
+If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
## Example
-Here is an example of how to call this API.
+Here's an example of how to call this API.
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } -->
v1.0 Regionalandlanguagesettings Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/regionalandlanguagesettings-get.md
One of the following permissions is required to call this API. To learn more, in
GET /settings/regionalAndLanguageSettings ``` ## Optional query parameters
-You can use `$select` to get specific regionalAndLanguageSettings properties, including those that are not returned by default.
+You can use `$select` to get specific regionalAndLanguageSettings properties, including properties that aren't returned by default.
For more information on OData query options, see [OData Query Parameters](/graph/query-parameters).
For more information on OData query options, see [OData Query Parameters](/graph
| Authorization | Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
The following example gets the properties of the signed-in user.
### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/settings/regionalAndLanguageSettings
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability.
v1.0 Reportroot Getformsuseractivitycounts https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getformsuseractivitycounts.md
Title: "reportRoot: getFormsUserActivityCounts"
-description: "Get a report that provides the trend of activity count by activity type over a selected period."
+description: "Get a report that provides the trend of activity count by activity type, over a selected period."
ms.localizationpriority: medium ms.prod: "reports"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get a report that provides the trend of activity count by activity type over a selected period.
+Get a report that provides the trend of activity count by activity type, over a selected period.
## Permissions
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Reports.Read.All |
-> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
+> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
## HTTP request
This method supports the `$format` [OData query parameter](/graph/query-paramete
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
Do not supply a request body for this method.
If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response.
-Preauthenticated download URLs are only valid for a short period of time (a few minutes) and do not require an `Authorization` header.
+Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header.
The CSV file has the following headers for columns:
If successful, this method returns a `200 OK` response code and a JSON object in
### Example 1: CSV output
-The following is an example that outputs CSV.
+Here's an example that outputs CSV.
#### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getFormsUserActivityCounts
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } --> ```http
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe ```
-Follow the 302 redirection and the CSV file that downloads will have the following schema.
+Follow the 302 redirection and the CSV file that downloads have the following schema.
<!-- { "blockType": "response",
Report Refresh Date, Report Period, Forms, Authenticated in responses, Anonymous
### Example 2: JSON output
-The following is an example that returns JSON.
+Here's an example that returns JSON.
#### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getFormsUserActivityCounts(period='
#### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability.
v1.0 Reportroot Getteamsdeviceusagedistributiontotalusercounts https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getteamsdeviceusagedistributiontotalusercounts.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Reports.Read.All |
->**Note**: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure AD limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
+>**Note**: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure AD limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
## HTTP request
This method supports the `$format` [OData query parameter](/graph/query-paramete
If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response.
-Preauthenticated download URLs are only valid for a short period of time (a few minutes) and do not require an `Authorization` header.
+Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header.
The CSV file has the following headers for columns.
If successful, this method returns a `200 OK` response code and a JSON object in
### CSV
-The following is an example that outputs CSV.
+Here's an example that outputs CSV.
#### Request
-The following is an example of the request.
+Here's an example of the request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsDeviceUsageDistributionTota
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "ignored" } -->
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe ```
-Follow the 302 redirection and the CSV file that downloads will have the following schema.
+Follow the 302 redirection and the CSV file that downloads have the following schema.
<!-- { "blockType": "response",
Report Refresh Date,Web,Windows Phone,Android Phone,iOS,Mac,Windows,Chrome OS,Li
### JSON
-The following is an example that returns JSON.
+Here's an example that returns JSON.
#### Request
-The following is an example of the request.
+Here's an example of the request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsDeviceUsageDistributionTota
#### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Reportroot Getteamsteamactivitydetail https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getteamsteamactivitydetail.md
Title: "reportRoot: getTeamsTeamActivityDetail"
-description: "Get details about Microsoft Teams activity by team. The numbers include activities for both licensed and non-licensed users."
+description: "Get details about Microsoft Teams activity by team. The numbers include activities for both licensed and nonlicensed users."
ms.localizationpriority: medium ms.prod: "reports"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get details about Microsoft Teams activity by team. The numbers include activities for both licensed and non-licensed users.
+Get details about Microsoft Teams activity by team. The numbers include activities for both licensed and nonlicensed users.
## Permissions
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Reports.Read.All |
-> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
+> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
## HTTP request
This method supports the `$format` [OData query parameter](/graph/query-paramete
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
Do not supply a request body for this method.
If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response.
-Preauthenticated download URLs are only valid for a short period of time (a few minutes) and do not require an `Authorization` header.
+Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header.
The CSV file has the following headers for columns:
If successful, this method returns a `200 OK` response code and a JSON object in
### Example 1: CSV output
-The following is an example that outputs CSV.
+Here's an example that outputs CSV.
#### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDetail(period='
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "ignored" } -->
Report Refresh Date,Team Name,Team Id,Team Type,Last Activity Date,Report Period
### Example 2: JSON output
-The following is an example that returns JSON.
+Here's an example that returns JSON.
#### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsTeamActivityDetail(period='
#### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Reportroot Getteamsteamcounts https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getteamsteamcounts.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Reports.Read.All |
-> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
+> **Note:** For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure Active Directory limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
## HTTP request <!-- { "blockType": "ignored" } -->
This method supports the `$format` [OData query parameter](/graph/query-paramete
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
Do not supply a request body for this method.
If successful, this method returns a `302 Found` response that redirects to a pre-authenticated download URL for the report. That URL can be found in the `Location` header in the response.
-Pre-authenticated download URLs are only valid for a short period (a few minutes) and do not require an `Authorization` header.
+Pre-authenticated download URLs are only valid for a short period (a few minutes) and don't require an `Authorization` header.
The CSV file has the following headers for columns:
If successful, this method returns a `200 OK` response code and a JSON object in
### Example 1: CSV output
-The following is an example that outputs CSV.
+Here's an example that outputs CSV.
#### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$fo
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "ignored" } -->
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe ```
-Follow the 302 redirection and the CSV file that downloads will have the following schema.
+Follow the 302 redirection and the CSV file that downloads have the following schema.
<!-- { "blockType": "response",
Report Refresh Date,Report Date,Public Teams,Active Public Teams,Private Teams,A
### Example 2: JSON output
-The following is an example that returns JSON.
+Here's an example that returns JSON.
#### Request
-The following is an example of a request.
+Here's an example of a request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsTeamCounts(period='D7')?$fo
#### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Reportroot Getteamsuseractivitydistributiontotalusercounts https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getteamsuseractivitydistributiontotalusercounts.md
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | Reports.Read.All |
->**Note**: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure AD limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
+>**Note**: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure AD limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
## HTTP request
This method supports the `$format` [OData query parameter](/graph/query-paramete
If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response.
-Preauthenticated download URLs are only valid for a short period of time (a few minutes) and do not require an `Authorization` header.
+Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header.
The CSV file has the following headers for columns.
If successful, this method returns a `200 OK` response code and a JSON object in
### CSV
-The following is an example that outputs CSV.
+Here's an example that outputs CSV.
#### Request
-The following is an example of the request.
+Here's an example of the request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsUserActivityDistributionTot
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "ignored" } -->
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe ```
-Follow the 302 redirection and the CSV file that downloads will have the following schema.
+Follow the 302 redirection and the CSV file that downloads have the following schema.
<!-- { "blockType": "response",
Report Refresh Date,Team Chat Messages,Private Chat Messages,Calls,Meetings,Repo
### JSON
-The following is an example that returns JSON.
+Here's an example that returns JSON.
#### Request
-The following is an example of the request.
+Here's an example of the request.
<!-- { "blockType": "ignored",
GET https://graph.microsoft.com/beta/reports/getTeamsUserActivityDistributionTot
#### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability.
v1.0 Search Qna Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/search-qna-update.md
PATCH /search/qnas/{qnaId}
|Content-Type|application/json. Required.| ## Request body
-In the request body, supply a JSON representation of the [qna](../resources/search-qna.md) object. Supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply a JSON representation of the [qna](../resources/search-qna.md) object. Supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
>**Note:** Updates to collection properties will update the entire collection. Any updates to a collection, such as keywords or categories, will replace the collection entirely. |Property|Type|Description| |:|:|:| |displayName|String|Question displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| |description|String|Answer displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).|
-|webUrl|String|Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).|
-|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna will start to appear as a search result. Set as `null` for always available.|
-|availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna will stop to appear as a search result. Set as `null` for always available.|
+|webUrl|String|Qna URL link. When users select this qna in search results, they go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).|
+|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna starts to appear as a search result. Set as `null` for always available.|
+|availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna stops to appear as a search result. Set as `null` for always available.|
|languageTags|String collection|List of countries or regions able to view this qna.| |platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this qna. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.|
-|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.|
+|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings apply to all variations.|
|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this qna to appear in search results.| |state|microsoft.graph.search.answerState|State of the qna. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| |groupIds|String collection|List of security groups able to view this qna.|
v1.0 Search Searchentity Post Qnas https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/search-searchentity-post-qnas.md
The following table shows the properties that are available when you create a [q
|:|:|:| |displayName|String|Question displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| |description|String|Answer displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).|
-|webUrl|String|Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).|
-|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna will start to appear as a search result. Set as `null` for always available.|
-|availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna will stop to appear as a search result. Set as `null` for always available.|
+|webUrl|String|Qna URL link. When users select this qna in search results, they go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).|
+|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna starts to appear as a search result. Set as `null` for always available.|
+|availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna stops to appear as a search result. Set as `null` for always available.|
|languageTags|String collection|List of countries or regions able to view this qna.| |platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this qna. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.|
-|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.|
+|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings apply to all variations.|
|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this qna to appear in search results.| |state|microsoft.graph.search.answerState|State of the qna. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| |groupIds|String collection|List of security groups able to view this qna.|
Content-Type: application/json
### Response
-Here is an example of the response.
+Here's an example of the response.
<!--{ "blockType": "response", "truncated": true,
v1.0 Section Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/section-get.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a [onenoteSection](../resources/onenotesection.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/sections/{id}
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Sectiongroup Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sectiongroup-get.md
The default query expands `parentNotebook` and selects its `id`, `name`, and `se
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a [sectionGroup](../resources/sectiongroup.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/sectionGroups/{id}
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Sectiongroup List Sectiongroups https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sectiongroup-list-sectiongroups.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a collection of [sectionGroup](../resources/sectiongroup.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/sectionGroups/{id}/sectionGroups
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Sectiongroup List Sections https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sectiongroup-list-sections.md
The default query expands `parentNotebook` and selects its `id`, `displayName`,
| Accept | string | `application/json` | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and a collection of [onenoteSection](../resources/onenotesection.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/onenote/sectionGroups/{id}/sections
##### Response
-Here is an example of the response. Note: The response object shown here is truncated for brevity. All of the properties will be returned from an actual call.
+Here's an example of the response. Note: The response object shown here's truncated for brevity. All of the properties will be returned from an actual call.
<!-- { "blockType": "response", "truncated": true,
v1.0 Security Categorytemplate List Subcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-categorytemplate-list-subcategories.md
This method supports some of the OData query parameters to help customize the re
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a collection of
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionL
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Security Ediscoverynoncustodialdatasource Applyhold https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverynoncustodialdatasource-applyhold.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Start the process of applying hold on [eDiscovery non-custodial data sources](../resources/security-ediscoverynoncustodialdatasource.md). After the operation is created, you can get the status by retrieving the `Location` parameter from the response headers. The location provides a URL that will return an [eDiscoveryHoldOperation](../resources/security-ediscoveryholdoperation.md) object.
+Start the process of applying hold on [eDiscovery non-custodial data sources](../resources/security-ediscoverynoncustodialdatasource.md). After the operation is created, you can get the status by retrieving the `Location` parameter from the response headers. The location provides a URL that returns an [eDiscoveryHoldOperation](../resources/security-ediscoveryholdoperation.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).
If successful, this action returns a `202 Accepted` response code.
### Example 1: Apply hold to multiple non-custodial data sources #### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
Content-Type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
HTTP/1.1 202 Accepted
### Example 2: Apply hold to a single non-custodial data source #### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-41
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Security Ediscoverynoncustodialdatasource Release https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverynoncustodialdatasource-release.md
POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/noncustodialDataSources/
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this action returns a `202 Accepted` response code.
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/{ediscovery
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Security Ediscoverynoncustodialdatasource Removehold https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverynoncustodialdatasource-removehold.md
Namespace: microsoft.graph.security
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Start the process of removing hold from [eDiscovery non-custodial data sources](../resources/security-ediscoverynoncustodialdatasource.md). After the operation is created, you can get the status by retrieving the `Location` parameter from the response headers. The location provides a URL that will return an [eDiscoveryHoldOperation](../resources/security-ediscoveryholdoperation.md) object.
+Start the process of removing hold from [eDiscovery non-custodial data sources](../resources/security-ediscoverynoncustodialdatasource.md). After the operation is created, you can get the status by retrieving the `Location` parameter from the response headers. The location provides a URL that returns an [eDiscoveryHoldOperation](../resources/security-ediscoveryholdoperation.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).
If successful, this action returns a `202 Accepted` response code.
### Example 1: Remove hold from multiple non-custodial data sources #### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
Content-Type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
HTTP/1.1 202 Accepted
### Example 2: Remove hold from a single non-custodial data source #### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-41
#### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Security Ediscoveryreviewsetquery Run https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoveryreviewsetquery-run.md
GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/reviewSets/{ediscoveryRev
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this function returns a `200 OK` response code and a [microsoft.g
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/58399dff-ceb
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 Security Ediscoverysearch Post Noncustodialsources https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverysearch-post-noncustodialsources.md
doc_type: "apiPageType"
-# Add Add noncustodialDataSources
+# Add noncustodialDataSources
Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
If successful, this method returns a `204 No Content` response code.
## Examples ### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
Content-Type: application/json
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Serviceprincipal Addkey https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-addkey.md
ServicePrincipals that donΓÇÖt have any existing valid certificates (i.e.: no ce
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Addpassword https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-addpassword.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Addtokensigningcertificate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-addtokensigningcertificate.md
The **passwordCredential** is used to open the PFX file (private key). It and th
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Createpasswordsinglesignoncredentials https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-createpasswordsinglesignoncredentials.md
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } -->
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
```http POST /servicePrincipals/{id}/createPasswordSingleSignOnCredentials POST /servicePrincipals(appId='{appId}')/createPasswordSingleSignOnCredentials
v1.0 Serviceprincipal Delete Claimsmappingpolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-claimsmappingpolicies.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Delete Delegatedpermissionclassifications https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-delegatedpermissionclassifications.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Delete Homerealmdiscoverypolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete-homerealmdiscoverypolicies.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delete.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http DELETE /servicePrincipals/{id}
v1.0 Serviceprincipal Deletepasswordsinglesignoncredentials https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-deletepasswordsinglesignoncredentials.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-get.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http GET /servicePrincipals/{id}
v1.0 Serviceprincipal Getpasswordsinglesignoncredentials https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-getpasswordsinglesignoncredentials.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Post Approleassignedto https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-approleassignedto.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /servicePrincipals/{id}/appRoleAssignedTo
v1.0 Serviceprincipal Post Approleassignments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-approleassignments.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /servicePrincipals/{id}/appRoleAssignments
v1.0 Serviceprincipal Post Claimsmappingpolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-claimsmappingpolicies.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Post Delegatedpermissionclassifications https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-delegatedpermissionclassifications.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /servicePrincipals/{id}/delegatedPermissionClassifications
v1.0 Serviceprincipal Post Homerealmdiscoverypolicies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-homerealmdiscoverypolicies.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Post Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-post-owners.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /servicePrincipals/{id}/owners/$ref
v1.0 Serviceprincipal Removekey https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-removekey.md
As part of the request validation for this method, a proof of possession of an e
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Removepassword https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-removepassword.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Serviceprincipal Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-update.md
One of the following permissions is required to call this API. To learn more, in
|Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All | ## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http PATCH /servicePrincipals/{id}
v1.0 Serviceprincipal Updatepasswordsinglesignoncredentials https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-updatepasswordsinglesignoncredentials.md
One of the following permissions is required to call this API. To learn more, in
## HTTP request
-You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in the Azure portal.
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http
v1.0 Signin Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-get.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get a [signIn](../resources/signin.md) object that contains a specific user sign-in event for your tenant. This includes sign-ins where a user is asked to enter a username or password, and session tokens.
+Get a [signIn](../resources/signin.md) object that contains a specific user sign-in event for your tenant that includes sign-ins where a user is asked to enter a username or password, and session tokens.
[!INCLUDE [GDPR-related-guidance](../../includes/gdpr-msgraph-export-note.md)]
This method supports OData query parameters to help customize the response. For
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and a [signIn](../re
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/auditLogs/signIns/66ea54eb-blah-4ee5-be62-f
### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Site Follow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-follow.md
In the request body, supply an array of JSON objects with the id parameter menti
## Response * If the request is successful, this method returns an array of sites that were followed.
-* If an error occurred while following any of the specified sites, this method returns a `207` status code and the response body will contain an array of entries containing [error](/graph/errors) objects and siteIds indicating which sites were unable to be followed.
+* If an error occurred while following any of the specified sites, this method returns a `207` status code and the response body contains an array of entries containing [error](/graph/errors) objects and siteIds indicating which sites were unable to be followed.
## Example
-The following example shows how to follow multiple sites.
+Here's and example that shows how to follow multiple sites.
### Request
Content-type: application/json
} ```
-If an error occured, it returns the following JSON response
+If an error occurred, it returns the following JSON response
<!-- { "blockType": "response", "@type": "microsoft.graph.site", "isCollection": true, "truncated": true } -->
v1.0 Site Unfollow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-unfollow.md
In the request body, supply an array of JSON objects with the id parameter menti
## Response * If the request is successful, this method returns a `204` status code with no content.
-* If an error occured while unfollowing any of the specified sites, this method returns a `207` status code and the response body will contain an array of entries containing [error](/graph/errors) objects and siteIds indicating which sites unable to be unfollowed.
+* If an error occurred while unfollowing any of the specified sites, this method returns a `207` status code and the response body contain an array of entries containing [error](/graph/errors) objects and siteIds indicating which sites unable to be unfollowed.
## Example
If successful, it returns the following JSON response.
HTTP/1.1 204 No Content ```
-If an error occured, it returns the following JSON response
+If an error occurred, it returns the following JSON response
<!-- { "blockType": "response", "@type": "microsoft.graph.site", "isCollection": true, "truncated": true } -->
v1.0 Skillproficiency Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/skillproficiency-get.md
This method supports the `$select` query parameter. Specify a list of properties
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If successful, this method returns a `200 OK` response code and the requested [s
### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/profile/skills/{id}
### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability.
v1.0 Subjectrightsrequest Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subjectrightsrequest-get.md
GET /privacy/subjectRightsRequests/{subjectRightsRequestId}
## Optional query parameters
-This method does not support the [OData query parameter](/graph/query-parameters) to help customize the response.
+This method doesn't support the [OData query parameter](/graph/query-parameters) to help customize the response.
## Request headers |Name|Description|
This method does not support the [OData query parameter](/graph/query-parameters
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
v1.0 Subjectrightsrequest Getfinalattachment https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subjectrightsrequest-getfinalattachment.md
GET /privacy/subjectRightsRequests/{subjectRightsRequestId}/getFinalAttachment
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
v1.0 Subjectrightsrequest Getfinalreport https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subjectrightsrequest-getfinalreport.md
GET /privacy/subjectRightsRequests{subjectRightsRequestId}/getFinalReport
|Authorization|Bearer {token}. Required.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
v1.0 Subscribedsku List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscribedsku-list.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get the list of commercial subscriptions that an organization has acquired. For the mapping of license names as displayed on the Azure portal or the Microsoft 365 admin center against their Microsoft Graph **skuId** and **skuPartNumber** properties, see [Product names and service plan identifiers for licensing](/azure/active-directory/enterprise-users/licensing-service-plan-reference).
+Get the list of commercial subscriptions that an organization has acquired. For the mapping of license names as displayed on the Microsoft Entra admin center or the Microsoft 365 admin center against their Microsoft Graph **skuId** and **skuPartNumber** properties, see [Product names and service plan identifiers for licensing](/azure/active-directory/enterprise-users/licensing-service-plan-reference).
## Permissions
v1.0 Synchronization Synchronizationjob Post Bulkupload https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/synchronization-synchronizationjob-post-bulkupload.md
Content-Type: application/json
The following bulk request illustrates how to delete an existing Azure AD or on-premises AD user. This example assumes you have configured a mapping that uses **externalId** as the matching identifier. > [!NOTE]
-> If the target directory for the operation is Azure AD, then the matched user is soft-deleted. The user can be seen on the Microsoft Azure portal **Deleted users** page for the next 30 days and can be restored during that time.
+> If the target directory for the operation is Azure AD, then the matched user is soft-deleted. The user can be seen on the Microsoft Entra admin center **Deleted users** page for the next 30 days and can be restored during that time.
> If the target directory for the operation is on-premises Active Directory, then the matched user is hard-deleted. If the **Active Directory Recycle Bin** is enabled, you can restore the deleted on-premises AD user object. > To prevent and recover from accidental deletions, we recommend [configuring accidental deletion threshold](/azure/active-directory/app-provisioning/accidental-deletions) in the provisioning app and [enabling the on-premises Active Directory recycle bin](/azure/active-directory/hybrid/connect/how-to-connect-sync-recycle-bin).
v1.0 Synchronization Synchronizationjob Restart https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/synchronization-synchronizationjob-restart.md
One of the following permissions is required to call this API. To learn more, in
## HTTP Request
-`{servicePrincipalId}` refers to the **id** of the service principal object. **id** is referred to as the **Object ID** of the enterprise application in the Azure portal.
+`{servicePrincipalId}` refers to the **id** of the service principal object. **id** is referred to as the **Object ID** of the enterprise application in app registrations in the Microsoft Entra admin center.
+
+You can address the service principal using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
<!-- { "blockType": "ignored" } --> ```http POST /servicePrincipals/{servicePrincipalId}/synchronization/jobs/{jobId}/restart
+POST /servicePrincipals(appId='{appId}')/synchronization/jobs/{jobId}/restart
``` ## Request headers
HTTP/1.1 204 No Content
"Error: microsoft.graph.microsoft.graph/servicePrincipals: /servicePrincipals/{var}/synchronization/jobs/{var}/restart Uri path requires navigating into unknown object hierarchy: missing property 'jobs' on 'synchronization'. Possible issues:
- 1) Doc bug where 'jobs' isn't defined on the resource.
- 2) Doc bug where 'jobs' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.
- 3) Doc bug where 'synchronization' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."
+ 1) Doc bug where 'jobs' isn't defined on the resource.
+ 2) Doc bug where 'jobs' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.
+ 3) Doc bug where 'synchronization' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."
] } -->
v1.0 Table List Columns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/table-list-columns.md
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/tables/{id|name}/columns
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/columns ``` ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. For reliable results, use the [$top](/graph/query-parameters#top) and [$skip](/graph/query-parameters#skip-parameter) query parameters to page through the results. This will help avoid performance problems related to large result sets.
+This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. For reliable results, use the [$top](/graph/query-parameters#top) and [$skip](/graph/query-parameters#skip-parameter) query parameters to page through the results. This helps avoid performance problems related to large result sets.
## Request headers | Name |Description| |:-|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and collection of [workbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body.
+If successful, the method returns a `200 OK` response code and collection of [workbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body.
## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Table List Rows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/table-list-rows.md
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/tables/{id|name}/rows
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/rows ``` ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. For reliable results, use the [$top](/graph/query-parameters#top) and [$skip](/graph/query-parameters#skip-parameter) query parameters to page through the results. This will help avoid performance problems related to large result sets.
+This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. For reliable results, use the [$top](/graph/query-parameters#top) and [$skip](/graph/query-parameters#skip-parameter) query parameters to page through the results. This helps avoid performance problems related to large result sets.
## Request headers | Name |Description| |:-|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookTableRow](../resources/workbooktablerow.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablecollection Add https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablecollection-add.md
Title: "TableCollection: add"
-description: "Create a new table. The range source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown."
+description: "Create a new table. The range source address determines the worksheet under which the table will be added. If the table can't be added (for example, because the address is invalid, or the table would overlap with another table), an error is thrown."
ms.localizationpriority: medium ms.prod: "excel"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Create a new table. The range source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown.
+Create a new table. The range source address determines the worksheet under which the table will be added. If the table can't be added (for example, because the address is invalid, or the table would overlap with another table), an error is thrown.
## Error Handling
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/add
| Name | Description| |:|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:|:--|:-|
-|address|string|Address or name of the range object representing the data source. If the address does not contain a sheet name, the currently-active sheet is used.|
-|hasHeaders|boolean|Boolean value that indicates whether the data being imported has column labels. If the source does not contain headers (i.e,. when this property set to false), Excel will automatically generate header shifting the data down by one row.|
+|address|string|Address or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used.|
+|hasHeaders|boolean|Boolean value that indicates whether the data being imported has column labels. If the source doesn't contain headers (when this property set to false), Excel will automatically generate header shifting the data down by one row.|
## Response If successful, this method returns `200 OK` response code and [workbookTable](../resources/workbooktable.md) object in the response body. ## Example
-Here is an example of how to call this API.
+Here's an example of how to call this API.
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablecolumn Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablecolumn-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablecolumn List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablecolumn-list.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookTableColumn](../resources/workbooktablecolumn.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablecolumn Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablecolumn-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|values|Json|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|
+|values|Json|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string.|
## Response If successful, this method returns a `200 OK` response code and updated [workbookTableColumn](../resources/workbooktablecolumn.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
> If you want to update multiple fields of a column, make **values** a string array in the request. For example: `"values": [["a"], [1], [2], [3]]`. ##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablerow Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablerow-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookTableRow](../resources/workbooktablerow.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablerow List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablerow-list.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookTableRow](../resources/workbooktablerow.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablerow Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablerow-update.md
PATCH /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name
| Name | Description| |:--|:--| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
-|values|Json|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string.|
+|values|Json|Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contains an error returns the error string.|
## Response If successful, this method returns a `200 OK` response code and updated [workbookTableRow](../resources/workbooktablerow.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Tablesort Clear https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablesort-clear.md
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}
## Response
-If successful, this method returns `200 OK` response code. It does not return anything in the response body.
+If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
## Example
-Here is an example of how to call this API.
+Here's an example of how to call this API.
##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|na
##### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } -->
v1.0 Tablesort Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tablesort-get.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Name |Description| |:-|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and [workbookTableSort](../resources/workbooktablesort.md) object in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/tables/{id|nam
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Team Clone https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-clone.md
You can specify which parts of the team to clone:
> [!NOTE] > A known issue related to owners of cloned teams is associated with this method. For details, see [Known issues](https://developer.microsoft.com/en-us/graph/known-issues/&search=18955).
-When tabs are cloned, they are not configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen.
-If the user who opens the tab does not have permission to configure apps, they will see a message that says that the tab is not configured.
+When tabs are cloned, they aren't configured. The tabs are displayed on the tab bar in Microsoft Teams, and the first time a user opens them, they must go through the configuration screen.
+If the user who opens the tab doesn't have permission to configure apps, they see a message that says that the tab isn't configured.
-Cloning is a long-running operation. After the POST clone returns, you need to GET the [operation](../resources/teamsasyncoperation.md) returned by the `Location:` header to see if it's `running`, `succeeded`, or `failed`. You should continue to GET until the status is not `running`. The recommended delay between GETs is 5 seconds.
+Cloning is a long-running operation. After the POST clone returns, you need to GET the [operation](../resources/teamsasyncoperation.md) returned by the `Location:` header to see if it's `running`, `succeeded`, or `failed`. You should continue to GET until the status isn't `running`. The recommended delay between GETs is 5 seconds.
## Permissions
POST /teams/{id}/clone
| Property | Type |Description| |:|:--|:-|
-|classification|String (optional)|Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList [setting](../resources/directorysetting.md) value, based on the [template definition](../resources/directorysettingtemplate.md). If classification is not specified, the classification will be copied from the original team/group.|
-|description|String (optional)|An optional description for the group. If this property is not specified, it will be left blank.|
-|displayName|String|The display name for the group. This property is required when a group is created and it cannot be cleared during updates. Supports $filter and $orderby.|
-|mailNickname|String|The mail alias for the group, unique in the organization. This property must be specified when a group is created. Supports $filter. If this property is not specified, it will be computed from the displayName. Known issue: this property is currently ignored.|
+|classification|String (optional)|Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList [setting](../resources/directorysetting.md) value, based on the [template definition](../resources/directorysettingtemplate.md). If classification isn't specified, the classification is copied from the original team/group.|
+|description|String (optional)|An optional description for the group. If this property isn't specified, it is left blank.|
+|displayName|String|The display name for the group. This property is required when a group is created and it can't be cleared during updates. Supports $filter and $orderby.|
+|mailNickname|String|The mail alias for the group, unique in the organization. This property must be specified when a group is created. Supports $filter. If this property isn't specified, it's computed from the displayName. Known issue: this property is currently ignored.|
|partsToClone| [clonableTeamParts](../resources/clonableteamparts.md) |A comma-separated list of the parts to clone. Legal parts are "apps, tabs, settings, channels, members".|
-|visibility|[teamVisibilityType](../resources/teamvisibilitytype.md) (optional)| Specifies the visibility of the group. Possible values are: **Private**, **Public**. If visibility is not specified, the visibility will be copied from the original team/group. If the team being cloned is an **educationClass** team, the visibility parameter is ignored, and the new group's visibility will be set to HiddenMembership.|
+|visibility|[teamVisibilityType](../resources/teamvisibilitytype.md) (optional)| Specifies the visibility of the group. Possible values are: **Private**, **Public**. If visibility isn't specified, the visibility is copied from the original team/group. If the team being cloned is an **educationClass** team, the visibility parameter is ignored, and the new group's visibility will be set to HiddenMembership.|
> [!NOTE] > If the **description** property isn't specified in the request body, it takes the value of the **displayName** property from the request payload. ## Response
-If successful, this method will return a `202 Accepted` response code with a Location: header pointing to the [operation](../resources/teamsasyncoperation.md) resource.
-When the operation is complete, the operation resource will tell you the id of the created team.
+If successful, this method returns a `202 Accepted` response code with a Location: header pointing to the [operation](../resources/teamsasyncoperation.md) resource.
+When the operation is complete, the operation resource tells you the id of the created team.
## Example ### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-Type: application/json
#### Response
-The following is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response" } -->
v1.0 Team Unarchive https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-unarchive.md
Title: "Unarchive team"
-description: "Restore an archived team. This restores users' ability to send messages and edit the team, abiding by tenant and team settings. Teams are archived using the archive API."
+description: "Restore an archived team and restores users' ability to send messages and edit the team, abiding by tenant and team settings. Teams are archived using the archive API."
ms.localizationpriority: medium ms.prod: "microsoft-teams"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Restore an archived [team](../resources/team.md). This restores users' ability to send messages and edit the team, abiding by tenant and team settings. Teams are archived using the [archive](team-archive.md) API.
+Restore an archived [team](../resources/team.md) and restores users' ability to send messages and edit the team, abiding by tenant and team settings. Teams are archived using the [archive](team-archive.md) API.
Unarchiving is an async operation. A team is unarchived once the async operation completes successfully, which may occur subsequent to a response from this API.
POST /teams/{id}/unarchive
| Authorization | Bearer {token}. Required. | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
If unarchiving is started successfully, this method returns a `202 Accepted` res
## Example #### Request
-The following is an example of a request.
+Here's an example of a request.
# [HTTP](#tab/http) <!-- {
POST https://graph.microsoft.com/beta/teams/{id}/unarchive
#### Response
-The following is an example of a response.
+Here's an example of a response.
<!-- { "blockType": "response", "name": "unarchive_team"
v1.0 Tenantappmanagementpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantappmanagementpolicy-update.md
Content-Type: application/json
}, { "restrictionType": "passwordLifetime",
- "maxLifetime": "P4DT12H30M5S",
+ "maxLifetime": "P90D",
"restrictForAppsCreatedAfterDateTime": "2017-01-01T10:37:00Z" }, {
Content-Type: application/json
}, { "restrictionType": "symmetricKeyLifetime",
- "maxLifetime": "P40D",
+ "maxLifetime": "P30D",
"restrictForAppsCreatedAfterDateTime": "2015-01-01T10:37:00Z" } ],
Content-Type: application/json
"restrictionType": "asymmetricKeyLifetime", "maxLifetime": "P30D", "restrictForAppsCreatedAfterDateTime": "2015-01-01T10:37:00Z"
- },
+ }
] } }
v1.0 User List Createdobjects https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-createdobjects.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Content-Type | application/json | ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
GET https://graph.microsoft.com/beta/me/createdObjects
##### Response
-The following is an example of the response. From the response, the user created a Microsoft 365 group, an application, and it's service principal.
+Here's an example of the response. From the response, the user created a Microsoft 365 group, an application, and its service principal.
>**Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 User List Ownedobjects https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-ownedobjects.md
This method supports the `$select` [OData query parameter](/graph/query-paramete
| Accept | application/json| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/ownedObjects
##### Response
-Here is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
v1.0 User Post Notifications https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-notifications.md
Namespace: microsoft.graph
Create and send a notification targeting a user through Microsoft Graph. The notification is stored in the Microsoft Graph notification feed store, and is sent to all app clients on all device endpoints that the user is signed in to. ## Permissions
-Your application service does not require any additional permissions to post notifications to your targeted user.
+Your application service doesn't require any additional permissions to post notifications to your targeted user.
> [!IMPORTANT] > If you choose to post notifications on behalf of a user via delegated permissions instead, one of the following permissions is required to call this API. We don't recommend this option for creating notifications. If you'd like to learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).
POST /me/notifications/
In the request body, supply a JSON representation of a [notification](../resources/projectrome-notification.md) object. ## Response
-If successful, this method returns a `201 Created` response code that indicates that the notification was successfully created and stored. The notification will be subsequently fanned-out to all specified endpoints with a valid subscription.
+If successful, this method returns a `201 Created` response code that indicates that the notification was successfully created and stored. The notification is later fanned-out to all specified endpoints with a valid subscription.
The following table lists the possible error and response codes that can be returned.
-|Error code | Descrition |
+|Error code | Description |
|:--|:-|
-|HttpStatusCode.BadRequest | Body is an array (multiple notifications is not supported).|
+|HttpStatusCode.BadRequest | Body is an array (multiple notifications isn't supported).|
|HttpStatusCode.BadRequest | Body doesn't match the contract for the API. | |HttpStatusCode.Forbidden | Caller is on the blocked list. |
-|HttpStatusCode.MethodNotAllowed | The HTTP method used is not supported. |
-|HttpStatusCode.BadRequest | Unsupported headers are present in the request. Two headers are not supported:<br/><br/>If-Modified-Since<br/>If-Range |
+|HttpStatusCode.MethodNotAllowed | The HTTP method used isn't supported. |
+|HttpStatusCode.BadRequest | Unsupported headers are present in the request. Two headers aren't supported:<br/><br/>If-Modified-Since<br/>If-Range |
|HttpStatusCode.UnsupportedMediaType | The header Content-Encoding is present and has compression algorithm values other than `Deflate` or `Gzip`. | |HttpStatusCode.BadRequest | Invalid payload. |
-|HttpStatusCode.Forbidden | Caller is not authorized to act on behalf of the user or send notification to the user. |
+|HttpStatusCode.Forbidden | Caller isn't authorized to act on behalf of the user or send notification to the user. |
|HttpStatusCode.Unauthorized | Request body contains invalid activity data types. | |HttpStatusCode.OK | Activity successfully created. | |HttpStatusCode.NotAcceptable | Request has been throttled or the server is busy. |
The following table lists the possible error and response codes that can be retu
## Example ### Request
-The following is an example of a request.
+Here's an example of a request.
```http POST https://graph.microsoft.com/beta/me/notifications/
Content-type: application/json
``` ### Response
-The following is an example of the corresponding response.
+Here's an example of the corresponding response.
```http HTTP/1.1 201
v1.0 Usersettings Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/usersettings-update.md
To get the user current settings, see [current user settings](usersettings-get.m
### Batch request
-It's also possible to opt-out multiple users from Delve through a batch request.
+It's also possible to opt out multiple users from Delve through a batch request.
To learn more, see [JSON batching](/graph/json-batching). >**Important**: Only members of the [organization management](https://support.office.com/article/permissions-in-the-office-365-security-compliance-center-d10608af-7934-490a-818e-e68f17d0e9c1?ui=en-US&rs=en-US&ad=US) role group can update multiple users.
PATCH /users/{id | userPrincipalName}/settings/
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
##### Request
-Here is an example request on how to opt-out a user from Delve and disable his contribution on content relevancy for the whole organization.
+Here's an example request on how to opt out a user from Delve and disable the user's contribution on content relevancy for the whole organization.
```http PATCH https://graph.microsoft.com/beta/me/settings
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
```http HTTP/1.1 200 OK
v1.0 Virtualendpoint List Cloudpcs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-cloudpcs.md
This method supports `$select`, `$filter`, `$count`, and `$top` OData query para
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
The following example shows how to get a list of all [cloudPC](../resources/clou
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs
#### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- {
The following example shows how to use the `$top` query parameter to get the top
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs?$
#### Response
-The following is an example of the response.
+Here's an example of the response.
>**Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Workbook Closesession https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbook-closesession.md
workbook-session-id: {session-id}
| Name | Description| |:|:-| | Authorization | Bearer {token}. Required. |
-| workbook-session-id | Workbook session Id to be closed |
+| workbook-session-id | Workbook session ID to be closed |
## Request body
-This API does not require any request body.
+This API doesn't require any request body.
## Response
If successful, this method returns `204 No Content` response code.
## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
workbook-session-id: {session-id}
-Note that workbook-session-id header is required.
+Workbook-session-id header is required.
##### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Workbook List Names https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbook-list-names.md
This method supports the [OData Query Parameters](/graph/query-parameters) to he
| Name |Description| |:-|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response If successful, this method returns a `200 OK` response code and collection of [workbookNamedItem](../resources/workbooknameditem.md) objects in the response body. ## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Workbook Post Tables https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbook-post-tables.md
POST /me/drive/root:/{item-path}:/workbook/tables/$/add
| Name | Description| |:|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description| |:|:-|:-|
-| Address | string| Range address. If you are calling this API off of `worksheets/{id or name}/tables/add` path, there is no need to for sheet name prefix in the address. However, if you are calling this off of `workbook/tables/add` path, then supply the sheet name on which the table needs to be created (example: `sheet1!A1:D4`)|
-| hasHeaders | boolean|Boolean value that indicates whether the range has column labels. If the source does not contain headers (i.e,. when this property set to false), Excel will automatically generate header shifting the data down by one row.|
+| Address | string| Range address. If you're calling this API off of `worksheets/{id or name}/tables/add` path, there's no need to for sheet name prefix in the address. However, if you're calling this off of `workbook/tables/add` path, then supply the sheet name on which the table needs to be created (example: `sheet1!A1:D4`)|
+| hasHeaders | boolean|Boolean value that indicates whether the range has column labels. If the source doesn't contain headers (when this property set to false), Excel will automatically generate header shifting the data down by one row.|
## Response
If successful, this method returns `201 Created` response code and [workbookTabl
## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Workbook Refreshsession https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbook-refreshsession.md
workbook-session-id: {session-id}
| workbook-session-id | Workbook session Id to be refreshed | ## Request body
-This API does not require any request body.
+This API doesn't require any request body.
## Response
If successful, this method returns `204 No Content` response code.
## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
workbook-session-id: {session-id}
-Note that workbook-session-id header is required.
+Workbook-session-id header is required.
##### Response
-Here is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response",
v1.0 Workforceintegration Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workforceintegration-update.md
PATCH /teamwork/workforceIntegrations/{workforceIntegrationId}
## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
+In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property | Type | Description | |:-|:|:|
-|apiVersion|Int32|API version for the call back url. Start with 1.|
+|apiVersion|Int32|API version for the callback url. Start with 1.|
|displayName|String|Name of the workforce integration.| |encryption|workforceIntegrationEncryption|The workforce integration encryption resource. | |isActive|Boolean|Indicates whether this workforce integration is currently active and available.| |supports|string| Possible values are `none`, `shift`, `swapRequest`, `openshift`, `openShiftRequest`, `userShiftPreferences`. If selecting more than one value, all values must start with the first letter in uppercase.|
-|supportedEntities|string| This property will replace **supports** in v1.0. We recommend that you use this property instead of **supports**. The **supports** property will still be supported in beta for the time being. Possible values are `none`, `shift`, `swapRequest`, `openshift`, `openShiftRequest`, `userShiftPreferences`. If selecting more than one value, all values must start with the first letter in uppercase.|
+|supportedEntities|string| This property replaces **supports** in v1.0. We recommend that you use this property instead of **supports**. The **supports** property will still be supported in beta for the time being. Possible values are `none`, `shift`, `swapRequest`, `openshift`, `openShiftRequest`, `userShiftPreferences`. If selecting more than one value, all values must start with the first letter in uppercase.|
|url|String| Workforce Integration url for callbacks from the Shift service. | ## Response
The following example updates a **workforceIntegration** object.
#### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
#### Response
-The following is an example of the response.
+Here's an example of the response.
> **Note:** The response object shown here might be shortened for readability.
The following example creates a new **workforceIntegration** with SwapRequest en
#### Request
-The following is an example of the request.
+Here's an example of the request.
``` POST https://graph.microsoft.com/beta/teamwork/workforceIntegrations/ Authorization: Bearer {token}
Content-type: application/json
``` #### Response
-The following is an example of the response.
+Here's an example of the response.
``` HTTP/1.1 200 OK {
To create a new **workforceIntegration** with SwapRequest enabled for eligibilit
### Example 3: Fetching eligible shifts when SwapRequest is included in eligibilityFilteringEnabledEntities
-The interaction between Shifts app and workforce integration endpoints will follow the existing pattern.
+The interaction between Shifts app and workforce integration endpoints follow the existing pattern.
#### Request
-The following is an example of the request made by Shifts to the workforce integration endpoint to fetch eligible shifts for a swap request.
+Here's an example of the request made by Shifts to the workforce integration endpoint to fetch eligible shifts for a swap request.
``` POST https://abcWorkforceIntegration.com/Contoso/{apiVersion}/team/{teamId}/read
Accept-Language: en-us
``` #### Response
-The following is an example of the response from the workforce integration service.
+Here's an example of the response from the workforce integration service.
``` HTTP/1.1 200 OK {
HTTP/1.1 200 OK
} ```
-### Example 4: Shifts synchronous call back to the workforce integration endpoint when enabled for real time notifications on timeCard changes.
+### Example 4: Shifts synchronous callback to the workforce integration endpoint when enabled for real time notifications on timeCard changes.
#### Request
-The following is an example of the request.
+Here's an example of the request.
``` POST https://foobarWorkforceIntegration.com/foobar/v1/teams/788b75d2-a911-48c0-a5e2-dc98480457e3/update Accept-Language: en-us
Content-type: application/json
``` #### Response
-The following is an example of the response.
+Here's an example of the response.
``` HTTP/1.1 200 OK Content-type: application/json
v1.0 Worksheet Post Tables https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/worksheet-post-tables.md
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/add
| Name | Description| |:|:-| | Authorization | Bearer {token}. Required. |
-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.|
+| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.|
## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type|Description| |:|:-|:-|
-| Address | string| Range address. If you are calling this API off of `worksheets/{id|name}/tables/add` path, there is no need to support the sheet name prefix in the address. However, if you are calling this off of `workbook/tables/add` path, then supply the sheet name on which the table needs to be created (example: `sheet1!A1:D4`)|
-| hasHeaders | boolean|Boolean value that indicates whether the range has column labels. If the source does not contain headers (i.e,. when this property set to false), Excel will automatically generate header shifting the data down by one row.|
+| Address | string| Range address. If you're calling this API off of `worksheets/{id|name}/tables/add` path, there's no need to support the sheet name prefix in the address. However, if you're calling this off of `workbook/tables/add` path, then supply the sheet name on which the table needs to be created (example: `sheet1!A1:D4`)|
+| hasHeaders | boolean|Boolean value that indicates whether the range has column labels. If the source doesn't contain headers (when this property set to false), Excel will automatically generate header shifting the data down by one row.|
## Response
If successful, this method returns `201 Created` response code and [workbookTabl
## Example ##### Request
-Here is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+Here's an example of the response. Note: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
v1.0 Worksheetprotection Unprotect https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/worksheetprotection-unprotect.md
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/protection/unpro
| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| ## Request body
-Do not supply a request body for this method.
+Don't supply a request body for this method.
## Response
-If successful, this method returns `200 OK` response code. It does not return anything in the response body.
+If successful, this method returns `200 OK` response code. It doesn't return anything in the response body.
## Example ### Request
-The following is an example of the request.
+Here's an example of the request.
# [HTTP](#tab/http)
POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{i
### Response
-The following is an example of the response.
+Here's an example of the response.
<!-- { "blockType": "response" } -->
v1.0 Accesspackagelocalizedcontent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackagelocalizedcontent.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A complex type used to represent a text in multiple localalized forms. It includes a default text, which is used in any case where the requested localization is not available.
+A complex type used to represent a text in multiple localized forms. It includes a default text, which is used in any case where the requested localization isn't available.
## Properties |Property|Type|Description| |:|:|:|
-|defaultText|String|The fallback string, which is used when a requested localization is not available. Required. |
+|defaultText|String|The fallback string, which is used when a requested localization isn't available. Required. |
|localizedTexts|[accessPackageLocalizedText](../resources/accesspackagelocalizedtext.md) collection|Content represented in a format for a specific locale. | ## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessPackageLocalizedContent"
v1.0 Accesspackagetextinputquestion https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackagetextinputquestion.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A child of **accessPackageQuestion** that has text input as an answer. This is used in the **questions** property of an [accessPackageAssignmentPolicy](accesspackageassignmentpolicy.md) and inside an [accessPackageResourceAttribute](accesspackageresourceattribute.md) of an access package resource.
+A child of **accessPackageQuestion** that has text input as an answer and is used in the **questions** property of an [accessPackageAssignmentPolicy](accesspackageassignmentpolicy.md) and inside an [accessPackageResourceAttribute](accesspackageresourceattribute.md) of an access package resource.
Inherits from [accessPackageQuestion](../resources/accesspackagequestion.md).
Inherits from [accessPackageQuestion](../resources/accesspackagequestion.md).
|id|String|ID of the question. Inherited from [accessPackageQuestion](../resources/accesspackagequestion.md).| |isRequired|Boolean|Indicates whether the requestor is required to supply an answer or not. Inherited from [accessPackageQuestion](../resources/accesspackagequestion.md).| |isSingleLineQuestion|Boolean|Indicates whether the answer will be in single or multiple line format.|
-|regexPattern|String|This is the regex pattern that the corresponding text answer must follow.|
+|regexPattern|String|The regex pattern that the corresponding text answer must follow.|
|sequence|Int32|Relative position of this question when displaying a list of questions to the requestor. Inherited from [accessPackageQuestion](../resources/accesspackagequestion.md).| |text|[accessPackageLocalizedContent](../resources/accesspackagelocalizedcontent.md)|The text of the question to show to the requestor. Inherited from [accessPackageQuestion](../resources/accesspackagequestion.md).|
Inherits from [accessPackageQuestion](../resources/accesspackagequestion.md).
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessPackageTextInputQuestion"
v1.0 Accessreviewapplyaction https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewapplyaction.md
Namespace: microsoft.graph
Represents a base class for apply actions in the [accessReviewScheduleSettings](accessreviewschedulesettings.md) of an [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object. The following derived types are supported: -- [removeAccessApplyAction](removeaccessapplyaction.md) indicates removing access of an entity being reviewed upon completion of the review. This is the default type for the applyActions property in accessReviewScheduleSettings and does not need to be specified.
+- [removeAccessApplyAction](removeaccessapplyaction.md) indicates removing access of an entity being reviewed upon completion of the review. This is the default type for the applyActions property in accessReviewScheduleSettings and doesn't need to be specified.
- [disableAndDeleteUserApplyAction](disableanddeleteuserapplyaction.md) indicates disabling and deleting the user being reviewed upon completion of the review. This is the non-default type and must be explicitly specified in accessReviewScheduleSettings.
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewApplyAction"
v1.0 Accessreviewdecision https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewdecision.md
Namespace: microsoft.graph
[!INCLUDE [accessreviews-disclaimer](../../includes/accessreviews-disclaimer.md)]
-In the Azure AD [access reviews](accessreviews-root.md) feature, the `accessReviewDecision` represents an Azure AD access review decision of a particular entity's access. Within an access review, or an instance of a recurring access review, there is one `accessReviewDecision` per reviewed user. For example, if a group has two guests and one non-guest as members, and an access review of guests is performed for that group, then there will be two access review decision objects. If a reviewer changes their decision, or another reviewer overrides them, then the `accessReviewDecision` is updated.
+In the Azure AD [access reviews](accessreviews-root.md) feature, the `accessReviewDecision` represents an Azure AD access review decision of a particular entity's access. Within an access review, or an instance of a recurring access review, there's one `accessReviewDecision` per reviewed user. For example, if a group has two guests and one nonguest as members, and an access review of guests is performed for that group, then there will be two access review decision objects. If a reviewer changes their decision, or another reviewer overrides them, then the `accessReviewDecision` is updated.
## Methods
-None. Objects of this type are automatically created by the feature when an access review initializes, and cannot be deleted. They can be retrieved from an access review using the [decisions](../api/accessreview-listdecisions.md) and [mydecisions](../api/accessreview-listmydecisions.md) relationships.
+None. Objects of this type are automatically created by the feature when an access review initializes, and can't be deleted. They can be retrieved from an access review using the [decisions](../api/accessreview-listdecisions.md) and [mydecisions](../api/accessreview-listmydecisions.md) relationships.
## Properties
This table illustrates the base properties of objects of this type.
| Property | Type | Description | | : | :-- | :-- |
-| `id` |`String` | The id of the decision within the access review. |
-| `accessReviewId` |`String` | The feature-generated id of the access review. |
+| `id` |`String` | The ID of the decision within the access review. |
+| `accessReviewId` |`String` | The feature-generated ID of the access review. |
| `reviewedBy` |[userIdentity](useridentity.md)| The identity of the reviewer. If the recommendation was used as the review, the userPrincipalName is empty. | | `reviewedDate` |`DateTimeOffset` | The date and time the most recent review for this access right was supplied. | | `reviewResult` |`String` | The result of the review, one of `NotReviewed`, `Deny`, `DontKnow` or `Approve`. | | `justification` |`String` | The reviewer's business justification, if supplied. |
-| `appliedBy` |[userIdentity](useridentity.md)| When the review completes, if the results were manually applied, the user identity of the user who applied the decision. If the review was auto-applied, the userPrincipalName is empty. |
+| `appliedBy` |[userIdentity](useridentity.md)| When the review completes, if the results were manually applied, the user identity of the user who applied the decision. If the review was autoapplied, the userPrincipalName is empty. |
| `appliedDateTime` |`DateTimeOffset` | The date and time when the review decision was applied. | | `applyResult` |`String` | The outcome of applying the decision, one of `NotApplied`, `Success`, `Failed`, `NotFound` or `NotSupported`. | | `accessRecommendation` |`String` | The feature- generated recommendation shown to the reviewer, one of `Approve`, `Deny` or `NotAvailable`. |
-In addition, additional properties may be present depending on the object type of the object possessing the access that was decided upon. For example, if the access review decision is a particular user's group membership or application access, the user who is potentially going to have their access be removed is identified through these properties:
+In addition, more properties may be present depending on the object type of the object possessing the access that was decided upon. For example, if the access review decision is a particular user's group membership or application access, the user who is potentially going to have their access be removed is identified through these properties:
| Property | Type | Description | | : | :-- | :-- |
-| `userId` |`String` | The id of user whose access was reviewed. |
+| `userId` |`String` | The ID of user whose access was reviewed. |
| `userDisplayName` |`String` | The display name of the user whose access was reviewed. | | `userPrincipalName` |`String` | The user principal name of the user whose access was reviewed. |
None. Objects of this type can be retrieved from an access review using the [de
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Accessreviewhistorydefinition https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewhistorydefinition.md
An **accessReviewHistoryDefinition** contains a list of [accessReviewHistoryInst
|:|:|:| |createdBy|[userIdentity](useridentity.md)| User who created this review history definition. | |createdDateTime|DateTimeOffset|Timestamp when the access review definition was created.|
-|decisions|String collection|Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions will be included by default if no decisions are provided on create. Possible values are: `approve`, `deny`, `dontKnow`, `notReviewed`, and `notNotified`.|
+|decisions|String collection|Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions are included by default if no decisions are provided on create. Possible values are: `approve`, `deny`, `dontKnow`, `notReviewed`, and `notNotified`.|
|displayName|String|Name for the access review history data collection. Required.| |id|String|The assigned unique identifier of an access review history definition.| |reviewHistoryPeriodEndDateTime|DateTimeOffset| A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if **scheduleSettings** is not defined. |
-|reviewHistoryPeriodStartDateTime|DateTimeOffset|A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if **scheduleSettings** is not defined.|
-| scheduleSettings |[accessReviewHistoryScheduleSettings](accessReviewHistoryScheduleSettings.md)| The settings for a recurring access review history definition series. Only required if **reviewHistoryPeriodStartDateTime** or **reviewHistoryPeriodEndDateTime** are not defined. Not supported yet.|
+|reviewHistoryPeriodStartDateTime|DateTimeOffset|A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if **scheduleSettings** isn't defined.|
+| scheduleSettings |[accessReviewHistoryScheduleSettings](accessReviewHistoryScheduleSettings.md)| The settings for a recurring access review history definition series. Only required if **reviewHistoryPeriodStartDateTime** or **reviewHistoryPeriodEndDateTime** aren't defined. Not supported yet.|
|scopes|[accessReviewScope](accessreviewscope.md) collection|Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.| |status| accessReviewHistoryStatus|Represents the status of the review history data collection. The possible values are: `done`, `inProgress`, `error`, `requested`, `unknownFutureValue`.|
An **accessReviewHistoryDefinition** contains a list of [accessReviewHistoryInst
|Relationship|Type|Description| |:|:|:|
-|instances|[accessReviewHistoryInstance](accessreviewhistoryinstance.md) collection| If the **accessReviewHistoryDefinition** is a recurring definition, instances represent each recurrence. A definition that does not recur will have exactly one instance.|
+|instances|[accessReviewHistoryInstance](accessreviewhistoryinstance.md) collection| If the **accessReviewHistoryDefinition** is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.|
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Accessreviewhistoryinstance https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewhistoryinstance.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
- Represents a recurrence of an [accessReviewHistoryDefinition](accessreviewhistorydefinition.md) object. A history definition that does not recur will have exactly one instance.
+ Represents a recurrence of an [accessReviewHistoryDefinition](accessreviewhistorydefinition.md) object. A history definition that doesn't recur has exactly one instance.
- Every **accessReviewHistoryInstance** along with its associated **accessReviewHistoryDefinition** contain the properties **reviewHistoryPeriodStartDateTime**, **reviewHistoryPeriodEndDateTime**, **decisions**, **scheduleSettings**, and **scopes**. These properties are used when scheduling recurrences as well as selecting review data and can be modified. Each **accessReviewHistoryInstance** object and data is only available for 30 days. Once an **accessReviewHistoryInstance** status has been moved to `done` a link can be generated to retrieve the instance's data by calling [generateDownloadUri](../api/accessreviewhistoryinstance-generatedownloaduri.md).
+ Every **accessReviewHistoryInstance** along with its associated **accessReviewHistoryDefinition** contain the properties **reviewHistoryPeriodStartDateTime**, **reviewHistoryPeriodEndDateTime**, **decisions**, **scheduleSettings**, and **scopes**. These properties are used when scheduling recurrences and selecting review data and can be modified. Each **accessReviewHistoryInstance** object and data is only available for 30 days. Once an **accessReviewHistoryInstance** status has been moved to `done`, a link can be generated to retrieve the instance's data by calling [generateDownloadUri](../api/accessreviewhistoryinstance-generatedownloaduri.md).
## Methods | Method | Return type | Description | |:|:|:| |[List accessReviewHistoryInstances](../api/accessreviewhistorydefinition-list-instances.md)|[accessReviewHistoryInstance](accessreviewhistoryinstance.md) collection| Retrieve a list of the [accessReviewHistoryInstance](accessreviewhistoryinstance.md) objects and their properties.|
-|[generateDownloadUri](../api/accessreviewhistoryinstance-generatedownloaduri.md)|[accessReviewHistoryDefinition](accessreviewhistorydefinition.md)|Generates a URI which can be used to retrieve the instance's review history data.|
+|[generateDownloadUri](../api/accessreviewhistoryinstance-generatedownloaduri.md)|[accessReviewHistoryDefinition](accessreviewhistorydefinition.md)|Generates a URI that can be used to retrieve the instance's review history data.|
## Properties |Property|Type|Description| |:|:|:|
-|downloadUri|String|Uri which can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.|
+|downloadUri|String|Uri that can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.|
|expirationDateTime|DateTimeOffset|Timestamp when this instance and associated data expires and the history is deleted. Required.| |fulfilledDateTime|DateTimeOffset|Timestamp when all of the available data for this instance was collected. This will be set after this instance's status is set to `done`. Required.| |id|String|The assigned unique identifier of an access review history instance. Read-only. Required.|
-|reviewHistoryPeriodEndDateTime|DateTimeOffset|Timestamp, reviews ending on or before this date will be included in the fetched history data.|
-|reviewHistoryPeriodStartDateTime|DateTimeOffset|Timestamp, reviews starting on or after this date will be included in the fetched history data.|
+|reviewHistoryPeriodEndDateTime|DateTimeOffset|Timestamp, reviews ending on or before this date are in the fetched history data.|
+|reviewHistoryPeriodStartDateTime|DateTimeOffset|Timestamp, reviews starting on or after this date are in the fetched history data.|
|runDateTime|DateTimeOffset|Timestamp when the instance's history data is scheduled to be generated.| |status|accessReviewHistoryStatus|Represents the status of the review history data collection. The possible values are: `done`, `inProgress`, `error`, `requested`, `unknownFutureValue`. Once the **status** has been marked as `done`, a link can be generated to retrieve the instance's data by calling [generateDownloadUri](../api/accessreviewhistoryinstance-generatedownloaduri.md) method.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Accessreviewnotificationrecipientscope https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewnotificationrecipientscope.md
Namespace: microsoft.graph
[!INCLUDE [accessreviews-disclaimer-v2](../../includes/accessreviews-disclaimer-v2.md)]
-The **accessReviewNotificationRecipientScope** represents a base class for defining users who will receive notifications on instances of [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) objects. It is inherited by [accessReviewNotificationRecipientQueryScope](../resources/accessReviewNotificationRecipientQueryScope.md).
+The **accessReviewNotificationRecipientScope** represents a base class for defining users who receive notifications on instances of [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) objects. It's inherited by [accessReviewNotificationRecipientQueryScope](../resources/accessReviewNotificationRecipientQueryScope.md).
## Properties None.
None.
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewNotificationRecipientScope"
v1.0 Accessreviewsettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewsettings.md
Title: "accessReviewSettings resource type (deprecated)"
-description: "Provides additional settings when creating an access review."
+description: "Provides more settings when creating an access review."
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [accessreviews-disclaimer](../../includes/accessreviews-disclaimer.md)]
-Provides additional settings when creating an access review, to control the feature behavior when starting an access review.
+Provides more settings when creating an access review, to control the feature behavior when starting an access review.
## Properties
Provides additional settings when creating an access review, to control the feat
| remindersEnabled | Boolean | Indicates whether sending reminder emails to reviewers is enabled. | | justificationRequiredOnApproval | Boolean | Indicates whether reviewers are required to provide a justification when reviewing access. | | activityDurationInDays | Int64 | The number of days of user activities to show to reviewers. |
-| autoReviewEnabled | Boolean | Indicates whether a decision should be set if the reviewer did not supply one. For use when auto-apply is enabled. If you don't want to have a review decision recorded unless the reviewer makes an explicit choice, set it to `false`.|
-| autoReviewSettings | [autoReviewSettings](autoreviewsettings.md) | Detailed settings for how the feature should set the review decision. For use when auto-apply is enabled. |
+| autoReviewEnabled | Boolean | Indicates whether a decision should be set if the reviewer didn't supply one. For use when, auto-apply is enabled. If you don't want to have a review decision recorded unless the reviewer makes an explicit choice, set it to `false`.|
+| autoReviewSettings | [autoReviewSettings](autoreviewsettings.md) | Detailed settings for how the feature should set the review decision. For use when, auto-apply is enabled. |
| recurrenceSettings | [accessReviewRecurrenceSettings](accessreviewrecurrencesettings.md) | Detailed settings for recurrence. | | autoApplyReviewResultsEnabled | Boolean | Indicates whether the auto-apply capability, to automatically change the target object access resource, is enabled. If not enabled, a user must, after the review completes, apply the access review. | | accessRecommendationsEnabled | Boolean | Indicates whether showing recommendations to reviewers is enabled. |
v1.0 Accessreviewstagesettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviewstagesettings.md
Title: "accessReviewStageSettings resource type"
-description: "In Azure AD access reviews, the accessReviewStageSettings represents the settings of the stages associated with a multi-stage access review."
+description: "In Azure AD access reviews, the accessReviewStageSettings represent the settings of the stages associated with a multi-stage access review."
ms.localizationpriority: medium ms.prod: "governance"
Represents the settings of the stages associated with a [multi-stage access revi
## Properties |Property|Type|Description| |:|:|:|
-|decisionsThatWillMoveToNextStage|String collection|Indicate which decisions will go to the next stage. Can be a sub-set of `Approve`, `Deny`, `Recommendation`, or `NotReviewed`. If not provided, all decisions will go to the next stage. Optional. |
-|dependsOn|String collection| Defines the sequential or parallel order of the stages and depends on the **stageId**. Only sequential stages are currently supported. For example, if **stageId** is `2`, then **dependsOn** must be `1`. If **stageId** is `1`, do not specify **dependsOn**. Required if **stageId** is not `1`. |
-|durationInDays|Int32|The duration of the stage. Required. <br/><br/>**NOTE:** The cumulative value of this property across all stages <br/> 1. Will override the [instanceDurationInDays setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md) object. <br/>2. Cannot exceed the length of one recurrence. That is, if the review recurs weekly, the cumulative **durationInDays** cannot exceed 7. |
-|fallbackReviewers|[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection|If provided, the fallback reviewers are asked to complete a review if the primary reviewers do not exist. For example, if managers are selected as **reviewers** and a principal under review does not have a manager in Azure AD, the fallback reviewers are asked to review that principal. <br/><br/>**NOTE:** The value of this property will override the corresponding setting on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md) object.|
-|recommendationsEnabled|Boolean|Indicates whether showing recommendations to reviewers is enabled. Required. <br/><br/>**NOTE:** The value of this property will override override the corresponding [setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object.|
-| recommendationInsightsSettings | [accessReviewRecommendationInsightSetting](accessReviewRecommendationInsightSetting.md) collection | Determines which recommendations to show to reviewers. <br/><br/>**NOTE:** The value of this property will override the corresponding [setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object.|
-| recommendationLookBackDuration | Duration| Optional field. Indicates the time period of inactivity (with respect to the start date of the review instance) that recommendations will be configured from. The recommendation will be to `deny` if the user is inactive during the look back duration. For reviews of groups and Azure AD roles, any duration is accepted. For reviews of applications, 30 days is the maximum duration. If not specified, the duration is 30 days. <br/><br/>**NOTE:** The value of this property will override the corresponding [setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object. |
-|reviewers|[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection|Defines who the reviewers are. If none are specified, the review is a self-review (users review their own access). For examples of options for assigning reviewers, see [Assign reviewers to your access review definition using the Microsoft Graph API](/graph/accessreviews-reviewers-concept). <br/><br/>**NOTE:** The value of this property will override the corresponding setting on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md). |
-|stageId|String|Unique identifier of the **accessReviewStageSettings**. The **stageId** will be used in **dependsOn** property to indicate the stage relationship. Required. |
+|decisionsThatWillMoveToNextStage|String collection|Indicate which decisions will go to the next stage. Can be a subset of `Approve`, `Deny`, `Recommendation`, or `NotReviewed`. If not provided, all decisions will go to the next stage. Optional. |
+|dependsOn|String collection| Defines the sequential or parallel order of the stages and depends on the **stageId**. Only sequential stages are currently supported. For example, if **stageId** is `2`, then **dependsOn** must be `1`. If **stageId** is `1`, don't specify **dependsOn**. Required if **stageId** isn't `1`. |
+|durationInDays|Int32|The duration of the stage. Required. <br/><br/>**NOTE:** The cumulative value of this property across all stages <br/> 1. Will override the [instanceDurationInDays setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md) object. <br/>2. Can't exceed the length of one recurrence. That is, if the review recurs weekly, the cumulative **durationInDays** can't exceed 7. |
+|fallbackReviewers|[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection|If provided, the fallback reviewers are asked to complete a review if the primary reviewers don't exist. For example, if managers are selected as **reviewers** and a principal under review doesn't have a manager in Azure AD, the fallback reviewers are asked to review that principal. <br/><br/>**NOTE:** The value of this property overrides the corresponding setting on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md) object.|
+|recommendationsEnabled|Boolean|Indicates whether showing recommendations to reviewers is enabled. Required. <br/><br/>**NOTE:** The value of this property overrides the corresponding [setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object.|
+| recommendationInsightsSettings | [accessReviewRecommendationInsightSetting](accessReviewRecommendationInsightSetting.md) collection | Determines which recommendations to show to reviewers. <br/><br/>**NOTE:** The value of this property overrides the corresponding [setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object.|
+| recommendationLookBackDuration | Duration| Optional field. Indicates the time period of inactivity (with respect to the start date of the review instance) from which that recommendations will be configured. The recommendation is to `deny` if the user is inactive during the look back duration. For reviews of groups and Azure AD roles, any duration is accepted. For reviews of applications, 30 days is the maximum duration. If not specified, the duration is 30 days. <br/><br/>**NOTE:** The value of this property overrides the corresponding [setting](accessReviewScheduleSettings.md) on the [accessReviewScheduleDefinition](accessreviewscheduledefinition.md) object. |
+|reviewers|[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection|Defines who the reviewers are. If none is specified, the review is a self-review (users review their own access). For examples of options for assigning reviewers, see [Assign reviewers to your access review definition using the Microsoft Graph API](/graph/accessreviews-reviewers-concept). <br/><br/>**NOTE:** The value of this property overrides the corresponding setting on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md). |
+|stageId|String|Unique identifier of the **accessReviewStageSettings**. The **stageId** is used in **dependsOn** property to indicate the stage relationship. Required. |
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewStageSettings"
v1.0 Actionstep https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/actionstep.md
Represents a single action to take toward completing a [recommendation](../resou
## Properties |Property|Type|Description| |:|:|:|
-|actionUrl|[actionUrl](../resources/actionurl.md)|A link to the documentation or Azure portal page that is associated with the action step.|
+|actionUrl|[actionUrl](../resources/actionurl.md)|A link to the documentation or Microsoft Entra admin center page that is associated with the action step.|
|stepNumber|Int64|Indicates the position for this action in the order of the collection of actions to be taken.| |text|String|Friendly description of the action to take.|
v1.0 Actionurl https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/actionurl.md
Title: "actionUrl resource type"
-description: "The link to the documentation or Azure portal page that provides more information about an actionStep."
+description: "The link to the documentation or Microsoft Entra admin center page that provides more information about an actionStep."
ms.localizationpriority: medium ms.prod: "directory-management"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-The link to the documentation or Azure portal page that provides more information about an [actionStep](../resources/actionstep.md).
+The link to the documentation or Microsoft Entra admin center page that provides more information about an [actionStep](../resources/actionstep.md).
## Properties |Property|Type|Description| |:|:|:| |displayName|String|Brief title for the page that the links directs to.|
-|url|String|The URL to the documentation or Azure portal page.|
+|url|String|The URL to the documentation or Microsoft Entra admin center page.|
## Relationships None.
v1.0 Activity Feed Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/activity-feed-api-overview.md
Each activity represents a unique...
--> ## What makes a great user activity?
-User activities donΓÇÖt just launch apps ΓÇö they are deep links into specific content within your app. The user activities you create can not only be used in your own app, but will also appear in Cortana and Windows Timeline ΓÇö driving more app reengagement and making it easier for your users to continue using your app across multiple devices.
+User activities donΓÇÖt just launch apps ΓÇö they're deep links into specific content within your app. The user activities you create can not only be used in your own app, but will also appear in Cortana and Windows Timeline ΓÇö driving more app reengagement and making it easier for your users to continue using your app across multiple devices.
### What should become an activity?
Apply the following guidelines as you define activities in your app:
**DO:** Record a single activity for a group of related user actions. If your application is used for a sequence of related content, it probably makes sense to record a single activity for the entire engagement session.
-*Playlist scenarios:* This is especially relevant for music playlists or TV shows ΓÇö a single user activity can be updated to show your progress. In this case, you will have a single user activity with multiple [history items](/graph/api/resources/projectrome-historyitem) representing periods of engagement across multiple days or weeks.
+*Playlist scenarios:* This is especially relevant for music playlists or TV shows ΓÇö a single user activity can be updated to show your progress. In this case, you have a single user activity with multiple [history items](/graph/api/resources/projectrome-historyitem) representing periods of engagement across multiple days or weeks.
**DO:** Store user data to the cloud. If you want to support cross-device activities, you need to make sure the content required to reengage this activity is stored to a cloud location. For example, if you publish an activity each time a user edits a document, the document should be stored in the cloud as opposed to locally on the user's device in order to enable cross-device reengagement.
-**DO NOT:** Create a user activity for actions that users do not need to resume in the future.
-If your application is used to complete simple, one-time operations that do not persist status for you to track in the future, you probably do not need to write a user activity.
+**DO NOT:** Create a user activity for actions that users don't need to resume in the future.
+If your application is used to complete simple, one-time operations that don't persist status for you to track in the future, you probably don't need to write a user activity.
-To be clear, even though user activities appear in Windows Timeline, this is not designed as a versioning tool ΓÇö choosing a document-based activity should always show the latest version of that document (including changes that were made by another user.)
+To be clear, even though user activities appear in Windows Timeline, this isn't designed as a versioning tool ΓÇö choosing a document-based activity should always show the latest version of that document (including changes that were made by another user.)
**DO NOT:** Create a user activity for actions completed by *other users*.
-If someone sends the user a message, or @mentions the user within your app, you should not write a new activity. These interactions are better served by surfacing notifications.
+If someone sends the user a message, or @mentions the user within your app, you shouldn't write a new activity. These interactions are better served by surfacing notifications.
*Collaboration scenarios:* If multiple people are working on the same activity (such as a Word document), there will be cases when another user has made changes to the document after you last edited it. In this case, app developers might want to update the visual elements in the activity to reflect changes made to the document. To do this, the app might update the existing activity without creating a new history item.
If someone sends the user a message, or @mentions the user within your app, you
## App interaction patterns and user activities The user activities that you create will vary based on the interaction pattern of your app. While every app is different, most will fall into one of the following interaction patterns:
-* **Document-based apps** ΓÇö Create one activity per document with one or more history records reflecting periods of use. It is important to update your activity card as changes are made to the document.
+* **Document-based apps** ΓÇö Create one activity per document with one or more history records reflecting periods of use. It's important to update your activity card as changes are made to the document.
* **Media playback apps** ΓÇö Create one activity per logical grouping of content such as a playlist, program, or standalone content. * **Games** ΓÇö Create one activity for each saved game or world. If your game supports only a single sequence of levels, you can write the same activity over time, although you might want to update your card to show your latest progress or achievements.
-* **Utility apps** ΓÇö If there is nothing within your app that users would want to resume, you should not publish activities. A good example is a simple single-purpose app like calculator.
-* **Line-of-business apps** ΓÇö Many apps exist for managing simple tasks or workflows. Create one activity for each separate workflow accessed through your app. For example, each expense report would be a separate activity, because you might want to click that activity to see if it was approved.
+* **Utility apps** ΓÇö If there's nothing within your app that users would want to resume, you shouldn't publish activities. A good example is a simple single-purpose app like calculator.
+* **Line-of-business apps** ΓÇö Many apps exist for managing simple tasks or workflows. Create one activity for each separate workflow accessed through your app. For example, each expense report would be a separate activity, because you might want to select that activity to see if it was approved.
*Some complex apps include multiple interaction patterns. You might want to follow different user activity creation patterns for different scenarios handled by your app.*
v1.0 Activitybasedtimeoutpolicy https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/activitybasedtimeoutpolicy.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a policy that can control the idle timeout for web sessions for applications that support activity-based timeout functionality. Applications enforce automatic signout after a period of inactivity. This type of policy can only be applied at the organization level (by setting the **isOrganizationDefault** property to `true`).
+Represents a policy that can control the idle timeout for web sessions for applications that support activity-based timeout functionality. Applications enforce automatic sign out after a period of inactivity. This type of policy can only be applied at the organization level (by setting the **isOrganizationDefault** property to `true`).
Inherits from [stsPolicy](stsPolicy.md).
The properties below form the JSON object that represents an activity-based time
| Property | Type |Description| |:-|:|:| |Version|Integer|Policy version. Set value of 1. Required.|
-|ApplicationPolicies|JSON object|Collection of application policy. An application policy, is a combination of an ApplicationId and a WebSessionIdleTimeout: <br> <ul><li>**ApplicationId**: Allowed values:<ul><li> default: applies the policy to all applications that support activity-based timeout functionality but do not have application-specific override</li><li> c44b4083-3bb0-49c1-b47d-974e53cbdf3c: applies the policy to the Azure Portal</li></ul></li><li>**WebSessionIdleTimeout**: The period of user inactivity after which the user's web session is considered expired. The minimum value is 5 minutes; the maximum value is 1 day.</li></ul> |
+|ApplicationPolicies|JSON object|Collection of application policy. An application policy, is a combination of an ApplicationId and a WebSessionIdleTimeout: <br> <ul><li>**ApplicationId**: Allowed values:<ul><li> default: applies the policy to all applications that support activity-based timeout functionality but don't have application-specific override</li><li> c44b4083-3bb0-49c1-b47d-974e53cbdf3c: applies the policy to the Azure portal</li></ul></li><li>**WebSessionIdleTimeout**: The period of user inactivity after which the user's web session is considered expired. The minimum value is 5 minutes; the maximum value is one day.</li></ul> |
## Relationships
None
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Addin https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/addin.md
Title: "addIn resource type"
-description: "Here is a JSON representation of the resource."
+description: "Here's a JSON representation of the resource."
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: "applications"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams [might configure add-ins](/onedrive/developer/file-handlers/?view=odsp-graph-online&preserve-view=true) for File Handler functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on.
+Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams [might configure add-ins](/onedrive/developer/file-handlers/?view=odsp-graph-online&preserve-view=true) for File Handler functionality. The custom behavior lets services like Microsoft 365 call the application in the context of a document the user is working on.
## Properties | Property | Type |Description| |:|:--|:-|
-|id|guid||
+|ID|guid||
|properties|[keyValue](keyvalue.md) collection|| |type|string|| ## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Album https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/album.md
Title: album resource type
-description: Facet describing a bundle which is a photo album.
+description: Facet describing a bundle that is a photo album.
ms.localizationpriority: medium ms.prod: sharepoint doc_type: resourcePageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A photo album is a way to virtually group [driveItems][driveItem] with [photo][] facets together in a [bundle][]. Bundles of this type will have the **album** property set on the [bundle][] resource.
+A photo album is a way to virtually group [driveItems][driveItem] with [photo][] facets together in a [bundle][]. Bundles of this type have the **album** property set on the [bundle][] resource.
## Properties
A photo album is a way to virtually group [driveItems][driveItem] with [photo][]
| : | :-- | : | | coverImageItemId | String | Unique identifier of the [driveItem][] that is the cover of the album. |
-**Note:** If a **coverImageItemId** has not been set before, the thumbnails for an album are chosen automatically.
+**Note:** If a **coverImageItemId** hasn't been set before, the thumbnails for an album are chosen automatically.
After **coverImageItemId** has been set, the thumbnails for an album will always be the item associated with that id. You can override the default cover by PATCHing the [bundle item][bundle] and setting the **coverImageItemId** property on the `album` to the id of an image contained within the album. To remove a custom-set cover, you can set the **coverImageItemId** property to null, and a default one will be chosen automatically again.
v1.0 Anonymousguestconversationmember https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/anonymousguestconversationmember.md
Namespace: microsoft.graph
Represents an anonymous guest in a chat.
-Anonymous users do not have a Microsoft Teams identity and can join meetings using meeting join links. For more details, see [Anonymous users](/microsoftteams/non-standard-users#anonymous-users).
+Anonymous users don't have a Microsoft Teams identity and can join meetings using meeting join links. For more information, see [Anonymous users](/microsoftteams/non-standard-users#anonymous-users).
Inherits from [conversationMember](../resources/conversationmember.md).
Inherits from [conversationMember](../resources/conversationmember.md).
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Appcredentialsigninactivity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appcredentialsigninactivity.md
Represents an application credential activity in a given tenant. This resource c
| Property | Type | Description | | | | -- |
-| appId | String | The globally unique appId (also called *client ID* on the Azure portal) of the credential application. |
+| appId | String | The globally unique appId (also called *client ID* on the Microsoft Entra admin center) of the credential application. |
| appObjectId | String | The ID of the credential application instance. | | createdDateTime | DateTimeOffset | The date and time when the credential was created. 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`. | | credentialOrigin | applicationKeyOrigin | The type the key credential originated from. Possible values are: `application`, `servicePrincipal`, `unknownFutureValue`. |
v1.0 Appidentity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appidentity.md
Indicates the identity of the application that performed the action or was chang
## Properties
-| Property | Type |Description|
+| Property | Type |Description|
|:|:--|:-| |appId|String|Refers to the unique identifier representing Application Id in the Azure Active Directory.|
-|displayName|String|Refers to the Application Name displayed in the Azure Portal.|
+|displayName|String|Refers to the application name displayed in the Microsoft Entra admin center.|
|servicePrincipalId|String|Refers to the unique identifier indicating Service Principal Id in Azure Active Directory for the corresponding App.| |servicePrincipalName|String|Refers to the Service Principal Name is the Application name in the tenant. |
v1.0 Application https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/application.md
This resource supports:
| disabledByMicrosoftStatus | String | Specifies whether Microsoft has disabled the registered application. Possible values are: `null` (default value), `NotDisabled`, and `DisabledDueToViolationOfServicesAgreement` (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). <br><br> Supports `$filter` (`eq`, `ne`, `not`). | | displayName | String | The display name for the application. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`. | | groupMembershipClaims | String | Configures the `groups` claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following string values: `None`, `SecurityGroup` (for security groups and Azure AD roles), `All` (this gets all security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). |
-| id | String | Unique identifier for the application object. This property is referred to as **Object ID** in the Azure portal. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`). |
+| id | String | Unique identifier for the application object. This property is referred to as **Object ID** in the Microsoft Entra admin center. Inherited from [directoryObject](directoryobject.md). Key. Not nullable. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`). |
| identifierUris | String collection | Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you'll reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form `api://<application-client-id>`, or specify a more readable URI like `https://contoso.com/api`. For more information on valid identifierUris patterns and best practices, see [Azure AD application registration security best practices](/azure/active-directory/develop/security-best-practices-for-app-registration#appid-uri-configuration). Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `ge`, `le`, `startsWith`). | | info | [informationalUrl](informationalurl.md) | Basic profile information of the application, such as it's marketing, support, terms of service, and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more information, see [How to: Add Terms of service and privacy statement for registered Azure AD apps](/azure/active-directory/develop/howto-add-terms-of-service-privacy-statement). <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, and `eq` on `null` values). | | isDeviceOnlyAuthSupported | Boolean | Specifies whether this application supports device authentication without a user. The default is `false`. |
v1.0 Appliedauthenticationeventlistener https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appliedauthenticationeventlistener.md
Title: "appliedAuthenticationEventListener resource type"
-description: "Represents the listeners, such as Azure Logic Apps and Azure Functions, that are triggered by the corresponding events in an sign-in event."
+description: "Represents the listeners such as Azure Logic Apps and Azure Functions that are triggered by the corresponding events in a sign-in event."
ms.localizationpriority: medium ms.prod: "identity-and-access-reports"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the [authentication event listeners](authenticationeventlistener.md), such as Azure Logic Apps and Azure Functions, that are triggered by the corresponding events in a [sign-in event](../resources/signin.md).
+Represents the [authentication event listeners](authenticationeventlistener.md) such as Azure Logic Apps and Azure Functions that are triggered by the corresponding events in a [sign-in event](../resources/signin.md).
## Properties |Property|Type|Description|
Represents the [authentication event listeners](authenticationeventlistener.md),
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.appliedAuthenticationEventListener"
v1.0 Appscope https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appscope.md
None
| Property | Type | Description | |:-- |:- |:-- |
-| id | string | Id of an app-specific container or resource representing the scope of the assignment. Usually the immutable id of the resource. The scope of an assignment determines the set of resources for which the principal has been granted access. This property is required. |
-| type | String | Describes the type of app-specific resource represented by the app scope. Provided for display purposes, so a user interface can convey to the user the kind of app specific resource represented by the app scope. This property is read only. |
+| id | string | ID of an app-specific container or resource representing the scope of the assignment. Usually the immutable ID of the resource. The scope of an assignment determines the set of resources for which the principal has been granted access. This property is required. |
+| type | String | Describes the type of app-specific resource represented by the app scope and is provided for display purposes, so a user interface can convey to the user the kind of app specific resource represented by the app scope. This property is read only. |
| displayName | string | Provides the display name of the app-specific resource represented by the app scope. Provided for display purposes since appScopeId is often an immutable, non-human-readable id. This property is read only. | ## Relationships
None
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Attendee https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attendee.md
Title: "attendee resource type"
-description: "An event attendee. This can be a person or resource such as a meeting room or equipment, that has been set up as a resource on the Exchange server for the tenant."
+description: "An event attendee. The attendee can be a person or resource such as a meeting room or equipment, that has been set up as a resource on the Exchange server for the tenant."
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: "outlook"
Derived from [attendeeBase](attendeebase.md).
| Property | Type |Description| |:|:--|:-| |emailAddress|[emailAddress](emailaddress.md)|Includes the name and SMTP address of the attendee.|
-|proposedNewTime|[timeSlot](timeslot.md)|An alternate date/time proposed by the attendee for a meeting request to start and end. If the attendee hasn't proposed another time, then this property is not included in a response of a GET event.|
+|proposedNewTime|[timeSlot](timeslot.md)|An alternate date/time proposed by the attendee for a meeting request to start and end. If the attendee hasn't proposed another time, then this property isn't included in a response of a GET event.|
|status|[ResponseStatus](responsestatus.md)|The attendee's response (none, accepted, declined, etc.) for the event and date-time that the response was sent.| |type|String|The attendee type: `required`, `optional`, `resource`.| ## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- { "blockType": "resource",
v1.0 Authenticationcontext https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationcontext.md
Namespace: microsoft.graph
Describes the conditional access authentication context of a sign-in event.
-For more details about authentication context in conditional access, see the [conditional access context documentation](/azure/active-directory/conditional-access/concept-conditional-access-cloud-apps#authentication-context-preview).
+For more information about authentication context in conditional access, see the [conditional access context documentation](/azure/active-directory/conditional-access/concept-conditional-access-cloud-apps#authentication-context-preview).
## Properties |Property|Type|Description| |:|:|:| |detail|authenticationContextDetail|Describes how the conditional access authentication context was triggered. A value of `previouslySatisfied` means the auth context was because the user already satisfied the requirements for that authentication context in some previous authentication event. A value of `required` means the user had to meet the authentication context requirement as part of the sign-in flow. The possible values are: `required`, `previouslySatisfied`, `notApplicable`, `unknownFutureValue`.|
-|id|String|The identifier of a authentication context in your tenant.|
+|id|String|The identifier of an authentication context in your tenant.|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.authenticationContext"
v1.0 Authenticationcontextclassreference https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationcontextclassreference.md
Represents an Azure Active Directory authentication context class reference. Aut
| Property | Type | Description | |:-|:|:|
-|id|String| Identifier used to reference the authentication context class. The id is used to trigger step-up authentication for the referenced authentication requirements and is the value that will be issued in the `acrs` claim of an access token. This value in the claim is used to verify that the required authentication context has been satisfied. The allowed values are `c1` through `c25`. <br/> Supports `$filter` (`eq`). |
+|id|String| Identifier used to reference the authentication context class. The ID is used to trigger step-up authentication for the referenced authentication requirements and is the value that will be issued in the `acrs` claim of an access token. This value in the claim is used to verify that the required authentication context has been satisfied. The allowed values are `c1` through `c25`. <br/> Supports `$filter` (`eq`). |
|displayName|String| A friendly name that identifies the authenticationContextClassReference object when building user-facing admin experiences. For example, a selection UX. | |description|String| A short explanation of the policies that are enforced by authenticationContextClassReference. This value should be used to provide secondary text to describe the authentication context class reference when building user facing admin experiences. For example, selection UX. |
-|isAvailable|boolean| Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it is set to `false`, it should not be shown in selection UX used to tag resources with authentication context class values. It will still be shown in the Conditionall Access policy authoring experience. <br/> Supports `$filter` (`eq`). |
+|isAvailable|boolean| Indicates whether the authenticationContextClassReference has been published by the security admin and is ready for use by apps. When it's set to `false`, it shouldn't be shown in selection UX used to tag resources with authentication context class values. It will still be shown in the Conditional Access policy authoring experience. <br/> Supports `$filter` (`eq`). |
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Authenticationflowspolicy https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationflowspolicy.md
Represents the [policy configuration of self-service sign-up experience](../reso
|Property|Type|Description| |:-|:|:-| |id|String| Inherited property. The ID of the authentication flows policy. Optional. Read-only.
-|displayName|String| Inherited property. The human-readable name of the policy. This property is not a key. Optional. Read-only.|
-|description|String|Inherited property. A description of the policy. This property is not a key. Optional. Read-only.|
-|selfServiceSignUp|[selfServiceSignUpAuthenticationFlowConfiguration](../resources/selfservicesignupauthenticationflowconfiguration.md) |Contains [selfServiceSignUpAuthenticationFlowConfiguration](../resources/selfservicesignupauthenticationflowconfiguration.md) settings that convey whether self-service sign-up is enabled or disabled. This property is not a key. Optional. Read-only. |
+|displayName|String| Inherited property. The human-readable name of the policy. This property isn't a key. Optional. Read-only.|
+|description|String|Inherited property. A description of the policy. This property isn't a key. Optional. Read-only.|
+|selfServiceSignUp|[selfServiceSignUpAuthenticationFlowConfiguration](../resources/selfservicesignupauthenticationflowconfiguration.md) |Contains [selfServiceSignUpAuthenticationFlowConfiguration](../resources/selfservicesignupauthenticationflowconfiguration.md) settings that convey whether self-service sign-up is enabled or disabled. This property isn't a key. Optional. Read-only. |
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Authenticationmethodtarget https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationmethodtarget.md
A collection of groups that are enabled to use an authentication method as part
|:|:|:| |id|String|Object identifier of an Azure AD user or group.| |isRegistrationRequired|Boolean|Determines if the user is enforced to register the authentication method.|
-|targetType|authenticationMethodTargetType| Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets will remain but we recommend to move the individual users to a targeted group.|
+|targetType|authenticationMethodTargetType| Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets remain but we recommend moving the individual users to a targeted group.|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Authenticationstrengths Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationstrengths-overview.md
ms.localizationpriority: medium
ms.prod: "identity-and-sign-in" doc_type: "conceptualPageType" Previously updated : 12/10/2022 Last updated : 09/12/2023 # Azure AD authentication strengths API overview
After defining the authentication strength policy, you apply and enforce it for
In the Conditional Access [grant controls](conditionalaccessgrantcontrols.md), configure the **authenticationStrength** relationship by assigning the [authenticationStrengthPolicy](authenticationstrengthpolicy.md) object that should be associated with the conditional access policy. When a conditional access policy applies to a sign-in and that policy has an authentication strength grant control, the user will be required to use one of the allowed authentication method combinations to sign in. Authentication strength policies can also be enforced for guest users through both conditional access policies and [cross-tenant access inbound trust settings](/graph/api/resources/crosstenantaccesspolicy-overview).
-The **authenticationStrength** object corresponds to the 'Require authentication strength' control of the Conditional Access policy's UX on the Azure portal.
+The **authenticationStrength** object corresponds to the 'Require authentication strength' control of the Conditional Access policy's UX on the Microsoft Entra admin center.
You can't configure authentication strengths and the multifactor authentication grant control on the same conditional access policy.
v1.0 Authorizationpolicy https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authorizationpolicy.md
Represents a policy that can control Azure Active Directory authorization settin
|allowEmailVerifiedUsersToJoinOrganization|Boolean| Indicates whether a user can join the tenant by email validation. | |allowInvitesFrom|allowInvitesFrom|Indicates who can invite external users to the organization. Possible values are: `none`, `adminsAndGuestInviters`, `adminsGuestInvitersAndAllMembers`, `everyone`. `everyone` is the default setting for all cloud environments except US Government. See more in the [table below](#allowinvitesfrom-values).| |allowUserConsentForRiskyApps|Boolean| Indicates whether [user consent for risky apps](/azure/active-directory/manage-apps/configure-risk-based-step-up-consent) is allowed. Default value is `false`. We recommend that you keep the value set to `false`. |
-|blockMsolPowerShell|Boolean| To disable the use of the [MSOnline PowerShell module](/powershell/module/msonline) set this property to `true`. This will also disable user-based access to the legacy service endpoint used by the MSOnline PowerShell module. This does not affect Azure AD Connect or Microsoft Graph. |
+|blockMsolPowerShell|Boolean| To disable the use of the [MSOnline PowerShell module](/powershell/module/msonline) set this property to `true`. This will also disable user-based access to the legacy service endpoint used by the MSOnline PowerShell module. This doesn't affect Azure AD Connect or Microsoft Graph. |
|defaultUserRolePermissions|[defaultUserRolePermissions](defaultUserRolePermissions.md)| Specifies certain customizable permissions for default user role. | |description|String| Description of this policy.| |displayName|String| Display name for this policy. |
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 B2cauthenticationmethodspolicy https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/b2cauthenticationmethodspolicy.md
Namespace: microsoft.graph
Azure Active Directory (Azure AD) B2C allows tenant admins to choose a mechanism for letting end users register via local accounts. Local accounts are the accounts where Azure AD does the identity assertion, as opposed to a federated identity provider such as Google or Facebook etc.
-The local accounts in Azure AD B2C do not follow the settings or paradigms from Azure AD. The Azure AD authentication methods policy is not used or enforced by Azure AD B2C. Azure AD B2C stores these settings in a different policy, which is consumed by user flows.
+The local accounts in Azure AD B2C do not follow the settings or paradigms from Azure AD. The Azure AD authentication methods policy isn't used or enforced by Azure AD B2C. Azure AD B2C stores these settings in a different policy, which is consumed by user flows.
## Methods
The local accounts in Azure AD B2C do not follow the settings or paradigms from
| Property | Type | Description | |:-|:|:|
-|id|String|The id of the B2C authentication methods policy. This is a read only property and the key.|
+|id|String|The ID of the B2C authentication methods policy. This is a read only property and the key.|
|isEmailPasswordAuthenticationEnabled|Boolean|The tenant admin can configure local accounts using email if the email and password authentication method is enabled.| |isUserNameAuthenticationEnabled|Boolean|The tenant admin can configure local accounts using username if the username and password authentication method is enabled.| |isPhoneOneTimePasswordAuthenticationEnabled|Boolean|The tenant admin can configure local accounts using phone number if the phone number and one-time password authentication method is enabled.|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 B2xidentityuserflow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/b2xidentityuserflow.md
Title: "b2xIdentityUserFlow resource type"
-description: "Represents a self-service sign up user flow within an Azure Active Directory tenant."
+description: "Represents a self-service sign-up user flow within an Azure Active Directory tenant."
ms.localizationpriority: high doc_type: resourcePageType ms.prod: "identity-and-sign-in"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a self-service sign up user flow within an Azure Active Directory tenant.
+Represents a self-service sign-up user flow within an Azure Active Directory tenant.
User flows are used to enable a [self-service sign up](/azure/active-directory/external-identities/self-service-sign-up-overview) experience for guest users on an application. User flows define the experience the end user sees while signing up, including which [identity providers](/azure/active-directory/external-identities/identity-providers) they can use to authenticate, along with which attributes are collected as part of the sign up process.
User flows are used to enable a [self-service sign up](/azure/active-directory/e
|[List user attribute assignments](../api/b2xidentityuserflow-list-userattributeassignments.md)|[identityUserFlowAttributeAssignment](../resources/identityuserflowattributeassignment.md) collection|Retrieve all user attribute assignments in a B2X user flow.| |[Create user attribute assignment](../api/b2xidentityuserflow-post-userattributeassignments.md)|[identityUserFlowAttributeAssignment](../resources/identityuserflowattributeassignment.md)|Create a user attribute assignment in a B2X user flow.| |[List languages](../api/b2xidentityuserflow-list-languages.md)|[userFlowLanguageConfiguration](../resources/userflowlanguageconfiguration.md) collection|Retrieve all languages within a B2X user flow.|
-|[Get API connectors configuration for user flow](../api/b2xidentityuserflow-get-apiConnectorConfiguration.md)|[userFlowApiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md)| Get the configuration for API connectors used in the user flow. The $expand query parameter is not supported for this method.|
+|[Get API connectors configuration for user flow](../api/b2xidentityuserflow-get-apiConnectorConfiguration.md)|[userFlowApiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md)| Get the configuration for API connectors used in the user flow. The $expand query parameter isn't supported for this method.|
|[Configure an API connector in a user flow](../api/b2xidentityuserflow-put-apiConnectorConfiguration.md)|None| Configure an API connector for specific steps in a user flow by updating the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) property.| ## Properties
User flows are used to enable a [self-service sign up](/azure/active-directory/e
|Property|Type|Description| |:|:--|:-| |id|String|The name of the user flow. This is a required value and is immutable after it's created. The name will be prefixed with the value of `B2X_1_` after creation.|
-|userFlowType|userFlowType|The type of user flow. For self-service sign up user flows, the value can only be `signUpOrSignIn` and cannot be modified after creation.|
-|userFlowTypeVersion|Single|The version of the user flow. For self-service sign up user flows, the version is always `1`.|
-|apiConnectorConfiguration|[userFlowApiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md)|Configuration for enabling an API connector for use as part of the self-service sign up user flow. You can only obtain the value of this object using [Get userFlowApiConnectorConfiguration](../api/b2xidentityuserflow-get-apiConnectorConfiguration.md).|
+|userFlowType|userFlowType|The type of user flow. For self-service sign-up user flows, the value can only be `signUpOrSignIn` and can't be modified after creation.|
+|userFlowTypeVersion|Single|The version of the user flow. For self-service sign-up user flows, the version is always `1`.|
+|apiConnectorConfiguration|[userFlowApiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md)|Configuration for enabling an API connector for use as part of the self-service sign-up user flow. You can only obtain the value of this object using [Get userFlowApiConnectorConfiguration](../api/b2xidentityuserflow-get-apiConnectorConfiguration.md).|
## Relationships
User flows are used to enable a [self-service sign up](/azure/active-directory/e
|userflowIdentityProviders|[identityProviderBase](../resources/identityproviderbase.md) collection|The identity providers included in the user flow.| |identityProviders (deprecated)|[identityProvider](../resources/identityprovider.md) collection|The identity providers included in the user flow.| |userAttributeAssignments|[identityUserFlowAttributeAssignment](../resources/identityuserflowattributeassignment.md) collection|The user attribute assignments included in the user flow.|
-|languages|[userFlowLanguageConfiguration](../resources/userflowlanguageconfiguration.md) collection|The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign up user flow. You cannot create custom languages in self-service sign up user flows.|
+|languages|[userFlowLanguageConfiguration](../resources/userflowlanguageconfiguration.md) collection|The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.|
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Basicauthentication https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/basicauthentication.md
Inherits from [apiAuthenticationConfigurationBase](../resources/apiauthenticatio
|Property|Type|Description| |:|:|:| |username|String| The username. |
-|password|String| The password. It is not returned in the responses. |
+|password|String| The password. It isn't returned in the responses. |
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.basicAuthentication"
v1.0 Bucketaggregationdefinition https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bucketaggregationdefinition.md
Title: "bucketAggregationDefinition resource type"
-description: "Provides the details on how to generate the agregations in the results"
+description: "Provides the details on how to generate the aggregations in the results"
ms.localizationpriority: medium ms.prod: "search"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Provides the details on how to generate the agregations in the results.
+Provides the details on how to generate the aggregations in the results.
## Properties
Provides the details on how to generate the agregations in the results.
|isDescending|Boolean|`True` to specify the sort order as descending. The default is `false`, with the sort order as ascending. Optional.| |minimumCount|Int32|The minimum number of items that should be present in the aggregation to be returned in a bucket. Optional.| |prefixFilter|String|A filter to define a matching criteria. The key should start with the specified prefix to be returned in the response. Optional.|
-|ranges|[bucketAggregationRange](bucketaggregationrange.md) collection|Specifies the manual ranges to compute the aggregations. This is only valid for non-string refiners of date or numeric type. Optional.|
-|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabeticaly based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required.
+|ranges|[bucketAggregationRange](bucketaggregationrange.md) collection|Specifies the manual ranges to compute the aggregations. This is only valid for nonstring refiners of date or numeric type. Optional.|
+|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabetically based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Builtinidentityprovider https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/builtinidentityprovider.md
Namespace: microsoft.graph
Represents built-in identity providers with [External Identities](/azure/active-directory/external-identities/) for an Azure Active Directory tenant.
-For Azure AD B2B scenarios in an Azure AD tenant, the built in identity provider type can be an Azure Active Directory(AAD), Microsoft account(MSA) or email one-time passcode (EmailOTP).
+For Azure AD B2B scenarios in an Azure AD tenant, the built-in identity provider type can be an Azure Active Directory(AAD), Microsoft account(MSA) or email one-time passcode (EmailOTP).
This type will inherit from [identityProviderBase](../resources/identityproviderbase.md).
This type will inherit from [identityProviderBase](../resources/identityprovider
| Method | Return Type |Description| |:|:--|:-|
-|[List](../api/identitycontainer-list-identityproviders.md)|[identityProviderBase](../resources/identityproviderbase.md) collection|Retrieve all identity providers configured in a tenant including the built-in identity providers. There is no way to retrieve only the built-in identity providers in a tenant.|
-|[Get](../api/identityproviderbase-get.md) |builtInIdentityProvider|Retrieve properties of an built-in identity provider.|
+|[List](../api/identitycontainer-list-identityproviders.md)|[identityProviderBase](../resources/identityproviderbase.md) collection|Retrieve all identity providers configured in a tenant including the built-in identity providers. There's no way to retrieve only the built-in identity providers in a tenant.|
+|[Get](../api/identityproviderbase-get.md) |builtInIdentityProvider|Retrieve properties of a built-in identity provider.|
|[List available provider types](../api/identityproviderbase-availableprovidertypes.md)|String collection|Retrieve all available identity provider types available in the tenant.| ## Properties
This type will inherit from [identityProviderBase](../resources/identityprovider
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Calendarpermission https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/calendarpermission.md
The permissions of a user with whom the calendar has been shared or delegated in
List, create, get, update, and delete of calendar permissions is supported on behalf of only the calendar owner.
-Getting the calendar permissions of a calendar on behalf of a sharee or delegate returns an empty calendar permissions collection.
+Getting the calendar permissions of a calendar on behalf of a share recipient or delegate returns an empty calendar permissions collection.
-Once a sharee or delegate has been set up for a calendar, you can [update](../api/calendarpermission-update.md) only the **role** property to change the permissions of a sharee or delegate. You cannot **update** the **allowedRoles**, **emailAddress**, **isInsideOrganization**, or **isRemovable** property. To change these properties, you should [delete](../api/calendarpermission-delete.md) the corresponding **calendarPermission** object and create another sharee or delegate in an Outlook client.
+Once a share recipient or delegate has been set up for a calendar, you can [update](../api/calendarpermission-update.md) only the **role** property to change the permissions of a share recipient or delegate. You can't **update** the **allowedRoles**, **emailAddress**, **isInsideOrganization**, or **isRemovable** property. To change these properties, you should [delete](../api/calendarpermission-delete.md) the corresponding **calendarPermission** object and create another share recipient or delegate in an Outlook client.
## Methods
Once a sharee or delegate has been set up for a calendar, you can [update](../ap
| Property | Type | Description | |:-|:|:| |allowedRoles|[calendarRoleType](#calendarroletype-values) collection| List of allowed sharing or delegating permission levels for the calendar. Possible values are: `none`, `freeBusyRead`, `limitedRead`, `read`, `write`, `delegateWithoutPrivateEventAccess`, `delegateWithPrivateEventAccess`, `custom`.|
-|emailAddress|[emailAddress](emailaddress.md)| Represents a sharee or delegate who has access to the calendar. For the "My Organization" sharee, the **address** property is null. Read-only. |
-|id|String| The unique identifier of the user (sharee or delegate) with whom the calendar has been shared. Read-only.|
-|isInsideOrganization|Boolean| True if the user in context (sharee or delegate) is inside the same organization as the calendar owner.|
-|isRemovable|Boolean| `True` if the user can be removed from the list of sharees or delegates for the specified calendar, `false` otherwise. The "My organization" user determines the permissions other people within your organization have to the given calendar. You cannot remove "My organization" as a sharee to a calendar.|
-|role|[calendarRoleType](#calendarroletype-values)| Current permission level of the calendar sharee or delegate. |
+|emailAddress|[emailAddress](emailaddress.md)| Represents a share recipient or delegate who has access to the calendar. For the "My Organization" share recipient, the **address** property is null. Read-only. |
+|id|String| The unique identifier of the user (share recipient or delegate) with whom the calendar has been shared. Read-only.|
+|isInsideOrganization|Boolean| True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.|
+|isRemovable|Boolean| `True` if the user can be removed from the list of recipients or delegates for the specified calendar, `false` otherwise. The "My organization" user determines the permissions other people within your organization have to the given calendar. You can't remove "My organization" as a recipient to a calendar.|
+|role|[calendarRoleType](#calendarroletype-values)| Current permission level of the calendar share recipient or delegate. |
### calendarRoleType values | Member | Description | |:--|:|
-| none | Calendar is not shared with the user. |
-| freeBusyRead | User is a sharee who can view free/busy status of the owner on the calendar. |
-| limitedRead | User is a sharee who can view free/busy status, and titles and locations of the events on the calendar. |
-| read | User is a sharee who can view all the details of the events on the calendar, except for the owner's private events. |
-| write | User is a sharee who can view all the details (except for private events) and edit events on the calendar. |
-| delegateWithoutPrivateEventAccess | User is a delegate who has write access but cannot view information of the owner's private events on the calendar. |
+| none | Calendar isn't shared with the user. |
+| freeBusyRead | User is a share recipient who can view free/busy status of the owner on the calendar. |
+| limitedRead | User is a share recipient who can view free/busy status, and titles and locations of the events on the calendar. |
+| read | User is a share recipient who can view all the details of the events on the calendar, except for the owner's private events. |
+| write | User is a share recipient who can view all the details (except for private events) and edit events on the calendar. |
+| delegateWithoutPrivateEventAccess | User is a delegate who has write access but can't view information of the owner's private events on the calendar. |
| delegateWithPrivateEventAccess | User is a delegate who has write access and can view information of the owner's private events on the calendar. | | custom | User has custom permissions to the calendar. | ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Callrecords Directroutinglogrow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-directroutinglogrow.md
Represents a row of data in the direct routing call log. Each row maps to one ca
|Property|Type|Description| |:|:|:|
-|calleeNumber|String|Number of the user or bot who received the call ([E.164](https://en.wikipedia.org/wiki/E.164) format, but may include additional data).|
+|calleeNumber|String|Number of the user or bot who received the call ([E.164](https://en.wikipedia.org/wiki/E.164) format, but may include more data).|
|callEndSubReason|Int32|In addition to the SIP codes, Microsoft has own subcodes that indicate the specific issue.|
-|callerNumber|String|Number of the user or bot who made the call ([E.164](https://en.wikipedia.org/wiki/E.164) format, but may include additional data).|
+|callerNumber|String|Number of the user or bot who made the call ([E.164](https://en.wikipedia.org/wiki/E.164) format, but may include more data).|
|callType|String|Call type and direction.| |correlationId|String|Identifier (GUID) for the call that you can use when calling Microsoft Support.| |duration|Int32|Duration of the call in seconds.|
Represents a row of data in the direct routing call log. Each row maps to one ca
|finalSipCode|Int32|The code with which the call ended ([RFC 3261](https://tools.ietf.org/html/rfc3261)).| |finalSipCodePhrase|String|Description of the SIP code and Microsoft subcode.| |id|String|Unique call identifier (GUID).|
-|inviteDateTime|DateTimeOffset|When the initial invite was sent.|
+|inviteDateTime|DateTimeOffset|The date and time when the initial invite was sent.|
|mediaBypassEnabled|Boolean|Indicates if the trunk was enabled for media bypass or not.| |mediaPathLocation|String|The data center used for media path in non-bypass call.|
-|otherPartyCountryCode|String|Country code of the caller in case of an incoming call, or callee in case of an outgoing call. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).|
+|otherPartyCountryCode|String|Country code of the caller for an incoming call, or callee for an outgoing call. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).|
|signalingLocation|String|The data center used for signaling for both bypass and non-bypass calls.| |startDateTime|DateTimeOffset|Call start time.<br/>For failed and unanswered calls, this can be equal to invite or failure time.| |successfulCall|Boolean|Success or attempt.| |trunkFullyQualifiedDomainName|String|Fully qualified domain name of the session border controller.| |userCountryCode|String|Country code of the user. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).| |userDisplayName|String|Display name of the user.|
-|userId|String|The unique identifier (GUID) of the user in Azure Active Directory. This and other user info will be null/empty for bot call types.|
-|userPrincipalName|String|The user principal name (sign-in name) in Azure Active Directory. This is usually the same as the user's SIP address, and can be same as the user's e-mail address.|
+|userId|String|The unique identifier (GUID) of the user in Azure Active Directory. This and other user info is null/empty for bot call types.|
+|userPrincipalName|String|The user principal name (sign-in name) in Azure Active Directory, is usually the same as the user's SIP address, and can be same as the user's e-mail address.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.callRecords.directRoutingLogRow",
v1.0 Callrecords Feedbacktokenset https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-feedbacktokenset.md
Namespace: microsoft.graph.callRecords
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-This is an _open type_ that represents the set of feedback tokens provided by the user of this endpoint for the Session. This is a set of Boolean properties. The property names should not be relied upon since they may change depending on what tokens are offered to the user.
+This is an _open type_ that represents the set of feedback tokens provided by the user of this endpoint for the Session. This is a set of Boolean properties. The property names shouldn't be relied upon since they may change depending on what tokens are offered to the user.
## Properties
-Explicit property names will not be documented since the feedback token names can change, hence this is an [open type](/aspnet/web-api/overview/odata-support-in-aspnet-web-api/odata-v4/use-open-types-in-odata-v4).
+Explicit property names won't be documented since the feedback token names can change, hence this is an [open type](/aspnet/web-api/overview/odata-support-in-aspnet-web-api/odata-v4/use-open-types-in-odata-v4).
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Callrecords Pstncalllogrow https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-pstncalllogrow.md
Represents a row of data in the public switched telephone network (PSTN) call lo
|id|String|Unique call identifier (GUID).| |inventoryType|String|User's phone number type, such as a service of toll-free number.| |licenseCapability|String|The license used for the call.|
-|operator|String|The telecommunications operator which provided PSTN services for this call. This may be Microsoft, or it may be a third-party operator via the [Operator Connect Program](https://techcommunity.microsoft.com/t5/microsoft-teams-blog/introducing-operator-connect-and-more-teams-calling-updates/ba-p/2176398).|
-|otherPartyCountryCode|String|Country code of the caller in case of an incoming call, or callee in case of an outgoing call. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).|
+|operator|String|The telecommunications operator that provided PSTN services for this call. This may be Microsoft, or it may be a third-party operator via the [Operator Connect Program](https://techcommunity.microsoft.com/t5/microsoft-teams-blog/introducing-operator-connect-and-more-teams-calling-updates/ba-p/2176398).|
+|otherPartyCountryCode|String|Country code of the caller for an incoming call, or callee for an outgoing call. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).|
|startDateTime|DateTimeOffset|Call start time.| |tenantCountryCode|String|Country code of the tenant. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).| |usageCountryCode|String|Country code of the user. For details, see [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Chatmessagehostedcontent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagehostedcontent.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Represents Teams content hosted in a chat message, such as images or code snippets.
-[File attachments](chatmessageattachment.md) are not hosted content;
-they are stored in SharePoint or OneDrive.
+[File attachments](chatmessageattachment.md) aren't hosted content;
+they're stored in SharePoint or OneDrive.
## Methods
chatMessageHostedContent derives from [teamworkHostedContent](teamworkhostedcont
| Property | Type | Description | |:-|:|:| |id |String | Read-only. Represents the chat message hosted content identifier.|
-|contentBytes |Edm.Binary | Write-only. When posting new chat message hosted content, represents the bytes of the payload. These are represented as a base64Encoded string.|
+|contentBytes |Edm.Binary | Write-only. When posting new chat message hosted content, represents the bytes of the payload as a base64 encoded string.|
|contentType |String | Write-only. When posting new chat message hosted content, represents the type of content, such as image/png.| ### Instance attributes
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Chatmessageinfo https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessageinfo.md
Represents a preview of a [chatMessage](../resources/chatmessage.md) resource. T
## Properties |Property|Type|Description| |:|:|:|
-|body|[itemBody](../resources/itembody.md)|Body of the [chatMessage](../resources/chatmessage.md). This will still contain markers for @mentions and attachments even though the object does not return @mentions and attachments.|
+|body|[itemBody](../resources/itembody.md)|Body of the [chatMessage](../resources/chatmessage.md). This will still contain markers for @mentions and attachments even though the object doesn't return @mentions and attachments.|
|createdDateTime|DateTimeOffset|Date time object representing the time at which message was created.|
-|eventDetail|[eventMessageDetail](../resources/eventmessagedetail.md)|Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, members were added, and so on. For event messages, the **messageType** property will be set to `systemEventMessage`.|
+|eventDetail|[eventMessageDetail](../resources/eventmessagedetail.md)|Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, members were added, and so on. For event messages, the **messageType** property is set to `systemEventMessage`.|
|from|[chatMessageFromIdentitySet](../resources/chatmessagefromidentityset.md)|Information about the sender of the message.| |id|String|ID of the [chatMessage](../resources/chatmessage.md).| |isDeleted|Boolean|If set to `true`, the original message has been deleted.|
Represents a preview of a [chatMessage](../resources/chatmessage.md) resource. T
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Chatmessagepolicyviolation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagepolicyviolation.md
Title: "chatMessagePolicyViolation resource type"
-description: "Represents a policy violation on a chat message. Policy violations are typically set by a data loss prevention (DLP) application."
+description: "Represents a policy violation on a chat message. Data loss prevention (DLP) applications typically set policy violations."
doc_type: resourcePageType ms.localizationpriority: medium
Represents a policy violation on a chat message. Policy violations are typically
|dlpAction|**chatMessagePolicyViolationDlpActionType**|The action taken by the DLP provider on the message with sensitive content. Supported values are: <li>None</li><li>NotifySender -- Inform the sender of the violation but allow readers to read the message.</li><li>BlockAccess -- Block readers from reading the message.</li><li>BlockAccessExternal -- Block users outside the organization from reading the message, while allowing users within the organization to read the message.</li>| |justificationText|string|Justification text provided by the sender of the message when overriding a policy violation.| |policyTip|[chatMessagePolicyViolationPolicyTip](chatmessagepolicyviolationpolicytip.md)|Information to display to the message sender about why the message was flagged as a violation. |
-|userAction|**chatMessagePolicyViolationUserActionType**|Indicates the action taken by the user on a message blocked by the DLP provider. Supported values are: <li>None</li><li>Override</li><li>ReportFalsePositive</li>When the DLP provider is updating the message for blocking sensitive content, userAction is not required.|
-|verdictDetails|**chatMessagePolicyViolationVerdictDetailsType**|Indicates what actions the sender may take in response to the policy violation. Supported values are: <li>None</li><li>AllowFalsePositiveOverride -- Allows the sender to declare the policyViolation to be an error in the DLP app and its rules, and allow readers to see the message again if the dlpAction had hidden it.</li><li>AllowOverrideWithoutJustification -- Allows the sender to overriide the DLP violation and allow readers to see the message again if the dlpAction had hidden it, without needing to provide an explanation for doing so. </li><li>AllowOverrideWithJustification -- Allows the sender to overriide the DLP violation and allow readers to see the message again if the dlpAction had hidden it, after providing an explanation for doing so.</li>AllowOverrideWithoutJustification and AllowOverrideWithJustification are mutually exclusive.|
+|userAction|**chatMessagePolicyViolationUserActionType**|Indicates the action taken by the user on a message blocked by the DLP provider. Supported values are: <li>None</li><li>Override</li><li>ReportFalsePositive</li>When the DLP provider is updating the message for blocking sensitive content, userAction isn't required.|
+|verdictDetails|**chatMessagePolicyViolationVerdictDetailsType**|Indicates what actions the sender may take in response to the policy violation. Supported values are: <li>None</li><li>AllowFalsePositiveOverride -- Allows the sender to declare the policyViolation to be an error in the DLP app and its rules, and allow readers to see the message again if it was hidden by dlpAction.</li><li>AllowOverrideWithoutJustification -- Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, without needing to provide an explanation for doing so. </li><li>AllowOverrideWithJustification -- Allows the sender to override the DLP violation and allow readers to see the message again if the dlpAction hides it, after providing an explanation for doing so.</li>AllowOverrideWithoutJustification and AllowOverrideWithJustification are mutually exclusive.|
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Claimsmapping https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/claimsmapping.md
After the custom identity provider sends an ID token back to Azure AD B2C, Azure
## Properties |Property|Type|Description| |:-|:|:-|
-|userId|String|The claim that provides the unique identifier for the signed-in user. It is a required propoerty.|
-|displayName|String|The claim that provides the display name or full name for the user. It is a required propoerty.|
+|userId|String|The claim that provides the unique identifier for the signed-in user. It is a required property.|
+|displayName|String|The claim that provides the display name or full name for the user. It's a required property.|
|givenName|String|The claim that provides the first name of the user.| |surname|String|The claim that provides the last name of the user.| |email|String|The claim that provides the email address of the user.|
After the custom identity provider sends an ID token back to Azure AD B2C, Azure
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.claimsMapping"
v1.0 Cloudpc https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpc.md
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|[List for user](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the [cloudPC](../resources/cloudpc.md) devices that are attributed to the signed-in user.| |[Get launch info for user](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.| |[Get connectivity history](../api/cloudpc-getcloudpcconnectivityhistory.md)|[cloudPcConnectivityEvent](../resources/cloudpcconnectivityevent.md) collection|Get the Cloud PC connectivity history.|
-|[Get shift work access state](../api/cloudpc-getshiftworkcloudpcaccessstate.md)|[shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values)|Get the access state of the shift work Cloud PC. The possible values are: {unassigned, noLicensesAvailable, activationFailed, active, activating, waitlisted, unknownFutureValue, standbyMode}. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values): {standbyMode}.|
+|[Get shift work access state](../api/cloudpc-getshiftworkcloudpcaccessstate.md)|[shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values)|Get the access state of the shift work Cloud PC. The possible values are: {unassigned, noLicensesAvailable, activationFailed, active, activating, waitlisted, unknownFutureValue, standbyMode}. You must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values): {standbyMode}.|
|[Get supported remote actions](../api/cloudpc-getsupportedcloudpcremoteactions.md)|[cloudPcRemoteActionCapability](../resources/cloudpcremoteactioncapability.md) collection|Get a list of supported Cloud PC remote actions for a specific Cloud PC device, including the action names and capabilities.|
-|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents which failed to install on the [cloudPC](../resources/cloudpc.md).|
-|[Bulk resize](../api/cloudpc-retrypartneragentinstallation.md)|[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of [cloudPCs](../resources/cloudpc.md) that have successfully passed validation (cloudPC: validateBulkResize). If any devices cannot be resized, they will be labeled as "resize failed," while the remaining devices will be `provisioned` for the resize process.|
+|[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the [cloudPC](../resources/cloudpc.md).|
+|[Bulk resize](../api/cloudpc-retrypartneragentinstallation.md)|[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of [cloudPCs](../resources/cloudpc.md) that have successfully passed validation (cloudPC: validateBulkResize). If any devices can't be resized, they'll be labeled as "resize failed," while the remaining devices are `provisioned` for the resize process.|
|[Validate bulk resize](../api/cloudpc-validatebulkresize.md)|[cloudPcResizeValidateResult](../resources/cloudPcResizeValidationResult.md) collection|Validate that a set of [cloudPC](../resources/cloudpc.md) devices meet the requirements to be bulk resized.| ## Properties
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|connectivityResult|[cloudPcConnectivityResult](../resources/cloudpcconnectivityresult.md)|The connectivity health check result of a Cloud PC, including the updated timestamp and whether the Cloud PC can be connected.| |diskEncryptionState|[cloudPcDiskEncryptionState](#cloudpcdiskencryptionstate-values)|The disk encryption applied to the Cloud PC. Possible values: `notAvailable`, `notEncrypted`, `encryptedUsingPlatformManagedKey`, `encryptedUsingCustomerManagedKey`, and `unknownFutureValue`.| |displayName|String|The display name of the Cloud PC.|
-|gracePeriodEndDateTime|DateTimeOffset|The date and time when the grace period ends and reprovisioning/deprovisioning happens. Required only if the status is `inGracePeriod`. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
+|gracePeriodEndDateTime|DateTimeOffset|The date and time when the grace period ends and reprovisioning or deprovisioning happen. Required only if the status is `inGracePeriod`. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
|id|String|The unique identifier for the Cloud PC. Read-only.| |imageDisplayName|String|Name of the OS image that's on the Cloud PC.| |lastLoginResult|[cloudPcLoginResult](../resources/cloudpcloginresult.md)|The last login result of the Cloud PC. For example, `{ "time": "2014-01-01T00:00:00Z"}`.|
Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into
|Member|Description| |:|:|
-|notAvailable|The Cloud PC is not provisioned, or is in a state where encryption is not available.|
-|notEncrypted|The Cloud PC should be encrypted, but the encryption is not done yet (reserved, should not happen).|
-|encryptedUsingPlatformManagedKey|The Cloud PC is encrypted using a platform managed key. This is the default value if the customer-managed key is not enabled.|
+|notAvailable|The Cloud PC isn't provisioned, or is in a state where encryption isn't available.|
+|notEncrypted|The Cloud PC should be encrypted, but the encryption isn't done so yet (reserved, shouldn't happen).|
+|encryptedUsingPlatformManagedKey|The Cloud PC is encrypted using a platform managed key. This is the default value if the customer-managed key isn't enabled.|
|encryptedUsingCustomerManagedKey|The Cloud PC is encrypted using the customer-managed key.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
### cloudPcStatus values The following table lists the members of an `[evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations)`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `movingRegion`.
The following table lists the members of an `[evolvable enumeration](/graph/best
|resizing|The Cloud PC is resizing.| |pendingProvision|The provisioning is pending on the Cloud PC. In this case, the number of Cloud PCs in grace period is more than the number of total available licenses. | |restoring|The Cloud PC is restoring.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
|movingRegion|Indicates that the Cloud PC is being moved from one region to another.|
-|resizePendingLicense|Indicates that the Cloud PC resize process has been initiated but cannot be completed because the target license hasn't been identified. It is currently awaiting customer action to resolve the licensing issue.|
+|resizePendingLicense|Indicates that the Cloud PC resize process has been initiated but can't be completed because the target license hasn't been identified. It's currently awaiting customer action to resolve the licensing issue.|
### cloudPcPowerState values
The following table lists the members of an [evolvable enumeration](#shiftworkcl
|Member|Description| |:|:|
-|unassigned|Set to unassigned if the Cloud PC is not consuming any shared-use licenses. The default value is unassigned.|
+|unassigned|Set to unassigned if the Cloud PC isn't consuming any shared-use licenses. The default value is unassigned.|
|noLicensesAvailable|Indicates that all shared-use licenses are in use.| |activationFailed|Indicates that the shift work Cloud PC activation failed after the user requested a shift work Cloud PC.| |active|Indicates that the shift work Cloud PC is in an active state with a shared-use license assigned, and the user can connect to the Cloud PC.| |activating|Indicates that a user requested to connect the Cloud PC and the service is starting.| |waitlisted (deprecated)|Indicates that the shift work Cloud PC is in waitlisted state after the user requests to connect this Cloud PC and all shared use licenses are being actively used. This value is deprecated and will stop returning on May 17, 2023. |
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
|standbyMode|Indicates that the shift work Cloud PC is in a standby state before it's shut down and deallocated. A shift work Cloud PC in standby state is still accessible by the user.| ## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Cloudpcpartneragentinstallresult https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcpartneragentinstallresult.md
Describe installation result details for a partner agent on a Cloud PC.
|Property|Type|Description| |:|:|:| |installStatus|[cloudPcPartnerAgentInstallStatus](#cloudpcpartneragentinstallstatus-values)|The status of a partner agent installation. Possible values are: installed, installFailed, installing, uninstalling, uninstallFailed and licensed. Read-Only.|
-|isThirdPartyPartner|Boolean|Indicates if the partner agent is a third party. When 'TRUE', the agent is a third-party (non-Microsoft) agent. When 'FALSE', the agent is a Microsoft agent or is not known. The default value is 'FALSE'.|
+|isThirdPartyPartner|Boolean|Indicates if the partner agent is a third party. When 'TRUE' the agent is a third-party (non-Microsoft) agent and when 'FALSE' the agent is a Microsoft agent or isn't known. The default value is 'FALSE'|
|partnerAgentName|[cloudPcPartnerAgentName](#cloudpcpartneragentname-values)|The name of the partner agent, whether first party or third party. Possible values for third-party partners are `Citrix` and `VMware`. Read-Only.|
-|retriable|Boolean|Indicates if the partner agent is a third party. When 'TRUE', the agent is a third-party (non-Microsoft) agent. When 'FALSE', the agent is a Microsoft agent or is not known. The default value is 'FALSE'.|
+|retriable|Boolean|Indicates if the partner agent is a third party. When 'TRUE' the agent is a third-party (non-Microsoft) agent and when 'FALSE' the agent is a Microsoft agent or isn't known. The default value is 'FALSE'|
### cloudPcPartnerAgentName values |Member|Description| |:|:| |citrix| A third-party partner named Citrix.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
|vMware| A third-party partner named VMware.| #### cloudPcPartnerAgentInstallStatus values
Describe installation result details for a partner agent on a Cloud PC.
|installed|The partner agent has been installed.| |installFailed|The partner agent installation failed although the license has been assigned.| |installing|The partner agent is installing.|
-|uninstalling|The partner agent will automatically be removed. This occurs when there is no third-party-partner license but the third-party-partner agent was previously installed.|
+|uninstalling|The partner agent is removed when there's no third-party-partner license but the third-party-partner agent was previously installed.|
|uninstallFailed|Indicates the partner agent uninstallation failed, although a license was already unassigned.|
-|licensed|The partner license was assigned to this Cloud PC, but the third-party partner agent is not yet installed.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|licensed|The partner license was assigned to this Cloud PC, but the third-party partner agent isn't yet installed.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.cloudPcPartnerAgentInstallResult"
v1.0 Cloudpcresizevalidationresult https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcresizevalidationresult.md
Title: "cloudPcResizeValidationResult resource type"
-description: "Represents the validation result of a single resized Cloud PC during the bulk-resize action ."
+description: "Represents the validation result of a single resized Cloud PC during the bulk-resize action."
ms.localizationpriority: medium ms.prod: "cloud-pc"
Represents the validation result of a single resized Cloud PC during the bulk-re
|Property|Type|Description| |:|:|:|
-|cloudPcId|String|The [cloudPC](../resources/cloudpc.md) id that corresponds to its unique identifier.|
+|cloudPcId|String|The [cloudPC](../resources/cloudpc.md) ID that corresponds to its unique identifier.|
|validationResult|[cloudPcResizeValidationCode](#cloudpcresizevalidationcode-values)|Describes a list of the validation result for the Cloud PC resize action. The possible values are: `success`, `cloudPcNotFound`, `operationCnflict`, `operationNotSupported`, `targetLicenseHasAssigned`, `internalServerError`, and `unknownFutureValue`.|
Represents the validation result of a single resized Cloud PC during the bulk-re
|Member|Description| |:|:| |success|Indicates that the resize validation was successful.|
-|cloudPcNotFound|Indicates that the Cloud PC was not found.|
+|cloudPcNotFound|Indicates that the Cloud PC wasn't found.|
|operationConflict|Indicates that resize action has a conflict with another action.|
-|operationNotSupported|Indicates that the resize action is not supported for the Cloud PC.|
+|operationNotSupported|Indicates that the resize action isn't supported for the Cloud PC.|
|targetLicenseHasAssigned|Indicates that the target license has already been assigned to the user.| |internalServerError|Indicates that the validation failed with an internal server error.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.cloudPcResizeValidationResult"
v1.0 Cloudpcrestorepointsetting https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcrestorepointsetting.md
Represents the settings of a point-in-time restore of a Cloud PC.
|Property|Type|Description| |:|:|:| |frequencyInHours|Int32|The time interval in hours to take snapshots (restore points) of a Cloud PC automatically. Possible values are `4`, `6`, `12`, `16`, and `24`. The default frequency is 12 hours.|
-|userRestoreEnabled|Boolean|If `true`, the user has the ability to use snapshots to restore Cloud PCs. If `false`, non-admin users cannot use snapshots to restore the Cloud PC.|
+|userRestoreEnabled|Boolean|If `true`, the user has the ability to use snapshots to restore Cloud PCs. If `false`, non-admin users can't use snapshots to restore the Cloud PC.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.cloudPcRestorePointSetting"
v1.0 Cloudpcsupportedregion https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcsupportedregion.md
Represents a supported region to establish an Azure network connection for Cloud
|: |: |: | |displayName|String|The name for the supported region. Read-only.| |id|String|The unique identifier for the supported region. Read-only.|
-|regionGroup|[cloudPcRegionGroup](#cloudpcregiongroup-values)|The geographic group this region belongs to. Multiple regions can belong to one region group. For example, the `europeUnion` region group contains the Northern Europe and Western Europe regions. A customer can select a region group when provisioning a Cloud PC; however, the Cloud PC will be put under one of the regions under the group based on resource capacity. The region with more quota will be chosen. Possible values are: `default`, `australia`, `canada`, `usCentral`, `usEast`, `usWest`, `france`, `germany`, `europeUnion`, `unitedKingdom`, `japan`, `asia`, `india`, `southAmerica`, `euap`, `usGovernment`, `usGovernmentDOD`, `unknownFutureValue`, `norway`, `switzerland`，`southKorea`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `norway`, `switzerland`，`southKorea`. Read-only.|
+|regionGroup|[cloudPcRegionGroup](#cloudpcregiongroup-values)|The geographic group this region belongs to. Multiple regions can belong to one region group. For example, the `europeUnion` region group contains the Northern Europe and Western Europe regions. A customer can select a region group when provisioning a Cloud PC; however, the Cloud PC is put under one of the regions under the group based on resource capacity. The region with more quota will be chosen. Possible values are: `default`, `australia`, `canada`, `usCentral`, `usEast`, `usWest`, `france`, `germany`, `europeUnion`, `unitedKingdom`, `japan`, `asia`, `india`, `southAmerica`, `euap`, `usGovernment`, `usGovernmentDOD`, `unknownFutureValue`, `norway`, `switzerland`，`southKorea`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `norway`, `switzerland`，`southKorea`. Read-only.|
|regionStatus|[cloudPcSupportedRegionStatus](#cloudpcsupportedregionstatus-values)|The status of the supported region. Possible values are: `available`, `restricted`, `unavailable`, `unknownFutureValue`. Read-only.|
-|supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.|
+|supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.|
### cloudPcSupportedRegionStatus values
Represents a supported region to establish an Azure network connection for Cloud
|available|The region is available and fully supports Cloud PCs to be provisioned in that region.| |restricted|The region is considered a restricted region and can only have a Cloud PC provisioned in that region for specific tenants.| |unavailable|The region has no support for Cloud PC provisioning.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
### cloudPcRegionGroup values
Represents a supported region to establish an Azure network connection for Cloud
| euap | The region belongs to the region group: Early Update Access Program. | | usGovernment | The region belongs to the region group: US Government. | | usGovernmentDOD | The region belongs to the region group: US Government Department of Defense (DOD). |
-| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
| norway | The region belongs to the region group: Norway. | | switzerland | The region belongs to the region group: Switzerland. | | southKorea | The region belongs to the region group: South Korea. |
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Coachmarklocation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/coachmarklocation.md
Represents details about a coachmark location.
|externalTag| Coachmark from external tag. | |displayName| Coachmark from display name. | |messageBody| Coachmark from email body. |
-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use. |
+|unknownFutureValue| Evolvable enumeration sentinel value. Don't use. |
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.coachmarkLocation"
v1.0 Commsoperation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/commsoperation.md
Represents the status of certain long-running operations.
This resource can be returned as the response to an action, or as the content of a [commsNotification](commsNotification.md).
-When it is returned as a response to an action, the status indicates whether there will be subsequent notifications. If, for example, an operation with status of `completed` or `failed` is returned, there will not be any subsequent operation via the notification channel.
+When it's returned as a response to an action, the status indicates whether there will be subsequent notifications. If for example, an operation with status of `completed` or `failed` is returned, there won't be any subsequent operation via the notification channel.
-If a `null` operation, or an operation with a status of `notStarted` or `running` is returned, subsequent updates will come via the notification channel.
+If an operation with a status of `notStarted`, `running` or `null` is returned, subsequent updates come via the notification channel.
## Properties | Property | Type | Description | | :-- | :-- | :-| | clientContext | String | Unique Client Context string. Max limit is 256 chars. |
-| id | String | The operation ID. Read-only. |
+| ID | String | The operation ID. Read-only. |
| resultInfo | [resultInfo](resultinfo.md) | The result information. Read-only. | | status | String | Possible values are: `notStarted`, `running`, `completed`, `failed`. Read-only. |
None
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Communicationsapplicationidentity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/communicationsapplicationidentity.md
Inherits from [identity](identity.md).
| id | String | Inherited from **identity**. The application's client ID from Azure Active Directory. | | displayName | String | Inherited from **identity**. The display name associated with the application. | | applicationType | String | First party Microsoft application presenting this **identity**. |
-| hidden | Boolean | True if the participant would not like to be shown in other participants' rosters. |
+| hidden | Boolean | True if the participant wouldn't like to be shown in other participants' rosters. |
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Communicationsencryptedidentity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/communicationsencryptedidentity.md
Title: "communicationsEncryptedIdentity resource type"
-description: "Represents the identity of a user whose underlying identity is not available to the application due to privacy restrictions."
+description: "Represents the identity of a user whose underlying identity isn't available to the application due to privacy restrictions."
ms.localizationpriority: medium ms.prod: "cloud-communications"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the identity of a user whose underlying identity is not available to the application due to privacy restrictions. For example, in a group call, participants other than the one who invited a Skype Consumer user will not have access to the identity of that user in the call roster.
+Represents the identity of a user whose underlying identity isn't available to the application due to privacy restrictions. For example, in a group call, participants other than the one who invited a Skype Consumer user won't have access to the identity of that user in the call roster.
Inherits from [identity](identity.md).
Inherits from [identity](identity.md).
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Conditionalaccessguestsorexternalusers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conditionalaccessguestsorexternalusers.md
Represents internal guests and external users in a policy scope.
| Property | Type | Description | |:-|:|:|
-| externalTenants | [conditionalAccessExternalTenants](conditionalaccessexternaltenants.md) | The tenant IDs of the selected types of external users. Either all B2B tenant or a collection of tenant IDs. External tenants can be specified only when the property **guestOrExternalUserTypes** is not `null` or an empty String. |
-| guestOrExternalUserTypes | conditionalAccessGuestOrExternalUserTypes | Indicates internal guests or external user types. This is a multi-valued property. Possible values are: `none`, `internalGuest`, `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`. |
+| externalTenants | [conditionalAccessExternalTenants](conditionalaccessexternaltenants.md) | The tenant IDs of the selected types of external users. Either all B2B tenant or a collection of tenant IDs. External tenants can be specified only when the property **guestOrExternalUserTypes** isn't `null` or an empty String. |
+| guestOrExternalUserTypes | conditionalAccessGuestOrExternalUserTypes | Indicates internal guests or external user types, and is a multi-valued property. Possible values are: `none`, `internalGuest`, `b2bCollaborationGuest`, `b2bCollaborationMember`, `b2bDirectConnectUser`, `otherExternalUser`, `serviceProvider`, `unknownFutureValue`. |
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Contenttype https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contenttype.md
Represents a content type in SharePoint. Content types allow you to define a set
| Property | Type | Description| |:|:|:-|
-| associatedHubsUrls | String collection | List of canonical URLs for hub sites with which this content type is associated to. This will contain all hubsites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type will be applied to the lists in the enforced sites.|
+| associatedHubsUrls | String collection | List of canonical URLs for hub sites with which this content type is associated to. This contains all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type will be applied to the lists in the enforced sites.|
| documentSet | [documentSet][] | [Document Set](/sharepoint/governance/document-set-planning#about-document-sets) metadata.| | documentTemplate | [documentSetContent][] | Document template metadata. To make sure that documents have consistent content across a site and its subsites, you can associate a Word, Excel, or PowerPoint template with a site content type.| | description | String | The descriptive text for the item.|
Represents a content type in SharePoint. Content types allow you to define a set
| order | [contentTypeOrder][] | Specifies the order in which the content type appears in the selection UI.| | parentId | String | The unique identifier of the content type.| | propagateChanges | Boolean | If `true`, any changes made to the content type will be pushed to inherited content types and lists that implement the content type.|
-| readOnly | Boolean | If `true`, the content type cannot be modified unless this value is first set to `false`.|
-| sealed | Boolean | If `true`, the content type cannot be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.|
+| readOnly | Boolean | If `true`, the content type can't be modified unless this value is first set to `false`.|
+| sealed | Boolean | If `true`, the content type can't be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.|
## Relationships
Represents a content type in SharePoint. Content types allow you to define a set
| columnPositions | [columnDefinition][] collection | Column order information in a content type.| | columns | [columnDefinition][] collection | The collection of column definitions for this contentType.|
-For more details, see [Introduction to content types and content type publishing][contentTypeIntro].
+For more information, see [Introduction to content types and content type publishing][contentTypeIntro].
[columnLink]: columnlink.md [contentTypeIntro]: https://support.office.com/article/Introduction-to-content-types-and-content-type-publishing-e1277a2e-a1e8-4473-9126-91a0647766e5
For more details, see [Introduction to content types and content type publishing
## JSON representation
-The following is a JSON representation of a resource.
+Here's a JSON representation of a resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.contentType","keyProperty":"id" } -->
v1.0 Contract https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contract.md
Represents an existing partnership that the partner tenant has with a customer t
|:|:--|:-| |contractType|String|Type of contract. Possible values are: `SyndicationPartner`, `BreadthPartner`, `ResellerPartner`. See more in the [table below](#contracttype-values). | |customerId|Guid|The unique identifier for the customer tenant referenced by this partnership. Corresponds to the id property of the customer tenant's organization resource. |
-|defaultDomainName|String|A copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's default domain name changes.|
-|displayName|String|A copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's display name changes.|
+|defaultDomainName|String|A copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's default domain name changes.|
+|displayName|String|A copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's display name changes.|
|id|String| The unique identifier for the partnership. Key, read-only | ### contractType values
Represents an existing partnership that the partner tenant has with a customer t
|Member|Description| |:|:| |SyndicationPartner|Partner that *exclusively* resells and manages O365 and Intune for this customer. They resell and support their customers.|
-|BreadthPartner|Partner has the ability to provide administrative support for this customer. However, the partner is not allowed to resell to the customer.|
-|ResellerPartner|Partner that is similar to a syndication partner, except that the partner doesnΓÇÖt have exclusive access to a tenant. In the syndication case, the customer cannot buy additional direct subscriptions from Microsoft or from other partners.|
+|BreadthPartner|Partner has the ability to provide administrative support for this customer. However, the partner isn't allowed to resell to the customer.|
+|ResellerPartner|Partner that is similar to a syndication partner, except that the partner doesnΓÇÖt have exclusive access to a tenant. In the syndication case, the customer can't buy additional direct subscriptions from Microsoft or from other partners.|
## Relationships None ## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Copystatusmodel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/copystatusmodel.md
Title: "copyStatusModel resource type"
-description: "Here is a JSON representation of the copyStatusModel resource."
+description: "Here's a JSON representation of the copyStatusModel resource."
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: non-product-specific
Namespace: microsoft.graph
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Customextensionauthenticationconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customextensionauthenticationconfiguration.md
This abstract type is inherited by the following resource types:
- [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) - [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md)
-The type of token authentication used depends on the token security. If the token security value is normal, you will use the [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) resource type. If the value is Proof of Possession, you will use the [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md) resource type.
+The type of token authentication used depends on the token security. If the token security value is normal, you use the [azureAdTokenAuthentication](../resources/azureadtokenauthentication.md) resource type. If the value is Proof of Possession, you use the [azureAdPopTokenAuthentication](../resources/azureAdPopTokenAuthentication.md) resource type.
## Properties
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration",
v1.0 Customextensionstagesetting https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customextensionstagesetting.md
Defines when to execute a [accessPackageAssignmentRequestWorkflowExtension](../r
Inherits from [entity](../resources/entity.md).
-To read the **customExtensionStageSettings** objects on a policy, append `?$expand=customExtensionStageSettings` to a [GET accessPackageAssignmentPolicy](../api/accesspackageassignmentpolicy-get.md) request. For example, `GET https://graph.microsoft.com/bet#example-2-retrieve-the-custom-extension-handlers-for-a-policy).
+To read the **customExtensionStageSettings** objects on a policy, append `?$expand=customExtensionStageSettings` to a [GET accessPackageAssignmentPolicy](../api/accesspackageassignmentpolicy-get.md) request. For example, `GET https://graph.microsoft.com/bet#example-2-retrieve-the-custom-extension-handlers-for-a-policy).
-To delete the **customExtensionStageSettings** objects from a policy, call the [Update accessPackageAssignmentPolicy](../api/accesspackageassignmentpolicy-update.md) and specify the customExtensionHandlers property as an empty collection. For more details, see [Example 2: Remove the customExtensionStageSettings from a policy](../api/accesspackageassignmentpolicy-update.md#example-3-remove-the-customextensionstagesettings-from-a-policy).
+To delete the **customExtensionStageSettings** objects from a policy, call the [Update accessPackageAssignmentPolicy](../api/accesspackageassignmentpolicy-update.md) and specify the customExtensionHandlers property as an empty collection. For more information, see [Example 2: Remove the customExtensionStageSettings from a policy](../api/accesspackageassignmentpolicy-update.md#example-3-remove-the-customextensionstagesettings-from-a-policy).
## Methods None
None
## Relationships |Relationship|Type|Description| |:|:|:|
-|customExtension|[customCalloutExtension](../resources/customcalloutextension.md)|Indicates the custom workflow extension that will be executed at this stage. Nullable. Supports `$expand`.|
+|customExtension|[customCalloutExtension](../resources/customcalloutextension.md)|Indicates the custom workflow extension that is executed at this stage. Nullable. Supports `$expand`.|
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Datetimecolumn https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/datetimecolumn.md
The **dateTimeColumn** on a [columnDefinition](columndefinition.md) resource ind
## JSON representation
-Here is a JSON representation of a **dateTimeColumn** resource.
+Here's a JSON representation of a **dateTimeColumn** resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.dateTimeColumn" } -->
Here is a JSON representation of a **dateTimeColumn** resource.
| Value | Description | | :-- | : | | **default** | Uses the default rendering in the UX. |
-| **friendly** | Uses a friendly relative representation (eg. "today at 3:00 PM") |
-| **standard** | Uses the standard absolute representation (eg. "5/10/2017 3:20 PM") |
+| **friendly** | Uses a friendly relative representation (for example "today at 3:00 PM") |
+| **standard** | Uses the standard absolute representation (for example "5/10/2017 3:20 PM") |
<!-- {
v1.0 Defaultuserrolepermissions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/defaultuserrolepermissions.md
Contains certains customizable permissions of default user role in Azure AD.
| Property | Type | Description | |:-- |:- |:-- |
-| allowedToCreateApps | Boolean | Indicates whether the default user role can create applications. This setting corresponds to the _Users can register applications_ setting in the [User settings menu in the Azure portal](/azure/active-directory/fundamentals/users-default-permissions?context=graph%2Fcontext#restrict-member-users-default-permissions). |
-| allowedToCreateSecurityGroups | Boolean | Indicates whether the default user role can create security groups. This setting corresponds to the following menus in the Azure portal: <br/><li> _The Users can create security groups in Azure portals, API or PowerShell_ setting in the [Group settings menu](/azure/active-directory/enterprise-users/groups-self-service-management). <li> _Users can create security groups_ setting in the [User settings menu](/azure/active-directory/fundamentals/users-default-permissions?context=graph%2Fcontext#restrict-member-users-default-permissions). |
-| allowedToCreateTenants | Boolean | Indicates whether the default user role can create tenants. This setting corresponds to the _Restrict non-admin users from creating tenants_ setting in the [User settings menu in the Azure portal](/azure/active-directory/fundamentals/users-default-permissions?context=graph%2Fcontext#restrict-member-users-default-permissions).<br/><br/> When this setting is `false`, users assigned the [Tenant Creator](/azure/active-directory/roles/permissions-reference?context=graph%2Fcontext#tenant-creator) role can still create tenants. |
+| allowedToCreateApps | Boolean | Indicates whether the default user role can create applications. This setting corresponds to the _Users can register applications_ setting in the [User settings menu in the Microsoft Entra admin center](/azure/active-directory/fundamentals/users-default-permissions?context=graph%2Fcontext#restrict-member-users-default-permissions). |
+| allowedToCreateSecurityGroups | Boolean | Indicates whether the default user role can create security groups. This setting corresponds to the following menus in the Microsoft Entra admin center: <br/><li> _The Users can create security groups in Microsoft Entra admin centers, API or PowerShell_ setting in the [Group settings menu](/azure/active-directory/enterprise-users/groups-self-service-management). <li> _Users can create security groups_ setting in the [User settings menu](/azure/active-directory/fundamentals/users-default-permissions?context=graph%2Fcontext#restrict-member-users-default-permissions). |
+| allowedToCreateTenants | Boolean | Indicates whether the default user role can create tenants. This setting corresponds to the _Restrict non-admin users from creating tenants_ setting in the [User settings menu in the Microsoft Entra admin center](/azure/active-directory/fundamentals/users-default-permissions?context=graph%2Fcontext#restrict-member-users-default-permissions).<br/><br/> When this setting is `false`, users assigned the [Tenant Creator](/azure/active-directory/roles/permissions-reference?context=graph%2Fcontext#tenant-creator) role can still create tenants. |
| allowedToReadBitlockerKeysForOwnedDevice | Boolean | Indicates whether the registered owners of a device can read their own BitLocker recovery keys with default user role. | | allowedToReadOtherUsers | Boolean | Indicates whether the default user role can read other users. **DO NOT SET THIS VALUE TO `false`**. |
v1.0 Delegatedadminrelationship https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/delegatedadminrelationship.md
Represents a delegated admin relationship between a partner and customer.
|accessDetails|[delegatedAdminAccessDetails](../resources/delegatedadminaccessdetails.md)|The access details that contain the identifiers of the administrative roles that the partner admin is requesting in the customer tenant.| |activatedDateTime|DateTimeOffset|The date and time in ISO 8601 format and in UTC time when the relationship became active. Read-only.| |createdDateTime|DateTimeOffset|The date and time in ISO 8601 format and in UTC time when the relationship was created. Read-only.|
-|customer|[delegatedAdminRelationshipCustomerParticipant](../resources/delegatedadminrelationshipcustomerparticipant.md)|The display name and unique identifier of the customer of the relationship. This is configured either by the partner at the time the relationship is created or by the system after the customer approves the relationship. Cannot be changed by the customer.|
-|displayName|String|The display name of the relationship used for ease of identification. Must be unique across *all* delegated admin relationships of the partner. This is set by the partner only when the relationship is in the `created` status and cannot be changed by the customer.|
-|duration|Duration|The duration of the relationship in ISO 8601 format. Must be a value between `P1D` and `P2Y` inclusive. This is set by the partner only when the relationship is in the `created` status and cannot be changed by the customer.|
+|customer|[delegatedAdminRelationshipCustomerParticipant](../resources/delegatedadminrelationshipcustomerparticipant.md)|The display name and unique identifier of the customer of the relationship. This is configured either by the partner at the time the relationship is created or by the system after the customer approves the relationship. Can't be changed by the customer.|
+|displayName|String|The display name of the relationship used for ease of identification. Must be unique across *all* delegated admin relationships of the partner. This is set by the partner only when the relationship is in the `created` status and can't be changed by the customer.|
+|duration|Duration|The duration of the relationship in ISO 8601 format. Must be a value between `P1D` and `P2Y` inclusive. This is set by the partner only when the relationship is in the `created` status and can't be changed by the customer.|
|endDateTime|DateTimeOffset|The date and time in ISO 8601 format and in UTC time when the **status** of relationship changes to either `terminated` or `expired`. Calculated as `endDateTime = activatedDateTime + duration`. Read-only.| |id|String|The unique identifier of the relationship. Read-only. Inherited from [entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|The date and time in ISO 8601 format and in UTC time when the relationship was last modified. Read-only.|
Represents a delegated admin relationship between a partner and customer.
| activating | The system starts provisioning of the relationship. | | active | The system completes the provisioning of the relationship. | | expiring | The relationship has passed its expiration date. |
-| expired | The system completes the de-provisioning of the relationship. |
+| expired | The system completes the deprovisioning of the relationship. |
| terminationRequested | The partner or customer has requested termination of the relationship through the `terminate` action of a [delegatedAdminRelationshipRequest](delegatedadminrelationshiprequest.md) object. |
-| terminating | The system starts de-provisioning the relationship. |
-| terminated | The system has completed de-provisioning the relationship. |
-| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
+| terminating | The system starts deprovisioning the relationship. |
+| terminated | The system has completed deprovisioning the relationship. |
+| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
## Relationships |Relationship|Type|Description|
Represents a delegated admin relationship between a partner and customer.
|requests|[delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) collection|The requests associated with the delegated admin relationship.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Delegatedadminrelationships Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/delegatedadminrelationships-api-overview.md
ms.localizationpriority: medium ms.prod: "customer-relationship-management" doc_type: resourcePageType+ # Granular delegated admin privileges (GDAP) API overview
This section describes the ways that Microsoft partners can use the GDAP APIs to
To manage delegated admin relationships, the calling principal must be in the partner tenant and be granted the appropriate [granular delegated admin privileges permissions](/graph/permissions-reference#granular-delegated-admin-privileges-gdap-permissions).
+<!-- Start of: Link to ZT guidance: H2 section -->
++
+<!-- End of: Link to ZT guidance -->
## See also + [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction)+++
+<!-- {
+ "type": "#page.annotation",
+ "description": "",
+ "keywords": "",
+ "section": "documentation",
+ "suppressions": [
+ "Error: /resources/delegatedadminrelationships-api-overview.md:
+ Exception processing links.
+ Link Definition was null. Link text: !INCLUDE zero-trust (Parameter 'Definition')"
+ ]
+} -->
v1.0 Delegatedpermissionclassification https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/delegatedpermissionclassification.md
Delegated permission classifications can be used in combination with user consen
| Property | Type | Description | |:|:--|:-| | id | String | A unique identifier for the **delegatedPermissionClassification** Key. Not nullable. Read-only. |
-| classification | permissionClassificationType | The classification value being given. Possible value: `low`. Does not support `$filter`. |
-| permissionId | Guid | The unique identifier (**id**) for the delegated permission listed in the **publishedPermissionScopes** collection of the [servicePrincipal](servicePrincipal.md). Required on create. Does not support `$filter`. |
-| permissionName | String | The claim value (**value**) for the delegated permission listed in the **publishedPermissionScopes** collection of the [servicePrincipal](servicePrincipal.md). Does not support `$filter`. |
+| classification | permissionClassificationType | The classification value being given. Possible value: `low`. Doesn't support `$filter`. |
+| permissionId | Guid | The unique identifier (**id**) for the delegated permission listed in the **publishedPermissionScopes** collection of the [servicePrincipal](servicePrincipal.md). Required on create. Doesn't support `$filter`. |
+| permissionName | String | The claim value (**value**) for the delegated permission listed in the **publishedPermissionScopes** collection of the [servicePrincipal](servicePrincipal.md). Doesn't support `$filter`. |
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Directorysettingtemplate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directorysettingtemplate.md
Namespace: microsoft.graph
Directory setting templates represent system-defined settings available to the tenant. [Directory settings](directorysetting.md) can be created based on the available **directorySettingTemplates**, and values changed from their preset defaults. Directory setting templates cannot be created, updated or deleted. These settings can represent tenant-wide settings, or can represent specific entity settings. Currently, the only templates available for groups apply to Microsoft 365 groups, and include settings such as whether users can create groups or invite guests from outside the organization to become members of a group.
-For more information about each setting, see [group (directory) settings](/graph/group-directory-settings).
+For more information about the Microsoft 365 groups-specific settings, see [group (directory) settings](/graph/group-directory-settings).
> [!TIP] > The `/v1.0` version of this resource is named [groupSettingTemplate](/graph/api/resources/groupsettingtemplate?view=graph-rest-1.0&preserve-view=true).
v1.0 Disableanddeleteuserapplyaction https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/disableanddeleteuserapplyaction.md
Namespace: microsoft.graph
[!INCLUDE [accessreviews-disclaimer-v2](../../includes/accessreviews-disclaimer-v2.md)]
-Disable any B2B guest user who is denied in an access review for 30 days, and then subsequently delete their account. This option does not contain any configuration options.
+Disable any B2B guest user who is denied in an access review for 30 days, and then delete their account. This option doesn't contain any configuration options.
Inherits from [accessReviewApplyAction](../resources/accessreviewapplyaction.md).
None.
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.disableAndDeleteUserApplyAction"
v1.0 Domaindnscnamerecord https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnscnamerecord.md
Represents a CNAME record added to the DNS zone file of a particular domain in t
## Methods
-Direct queries to this resource are not supported. Please see the [domain](domain.md) topic for information on how to query for domain service records.
+Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records.
## Properties | Property | Type |Description|
Direct queries to this resource are not supported. Please see the [domain](domai
|isOptional|Boolean| If false, the CNAME record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. Not nullable | |label|String| Value used when configuring the *alias/host/name* of the CNAME record at the DNS host. | |recordType|String| Type of DNS record. The value is always *CName*. Key|
-|supportedService|String| Microsoft Online Service or feature that has a dependency on this CNAME record.</br></br>Can be one of the following values: **null**, *Email*, *Sharepoint*, *EmailInternalRelayOnly*, *OfficeCommunicationsOnline*, *SharePointDefaultDomain*, *FullRedelegation*, *SharePointPublic*, *OrgIdAuthentication*, *Yammer*, *Intune*|
+|supportedService|String| Microsoft Online Service or feature that has a dependency on this CNAME record. Can be one of the following values: **null**, *Email*, *Sharepoint*, *EmailInternalRelayOnly*, *OfficeCommunicationsOnline*, *SharePointDefaultDomain*, *FullRedelegation*, *SharePointPublic*, *OrgIdAuthentication*, *Yammer*, *Intune*|
|ttl|Int32| Value to use when configuring the time-to-live (ttl) property of the CNAME record at the DNS host. Not nullable | ## Relationships
None
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Domaindnsmxrecord https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnsmxrecord.md
Title: "domainDnsMxRecord resource type"
-description: "Represents a MX record added to the DNS zone file of a particular domain in the tenant."
+description: "Represents an MX record added to the DNS zone file of a particular domain in the tenant."
ms.localizationpriority: medium ms.prod: "directory-management"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a MX record added to the DNS zone file of a particular domain in the tenant. Inherited from [DomainDnsRecord](domaindnsrecord.md) entity.
+Represents an MX record added to the DNS zone file of a particular domain in the tenant. Inherited from [DomainDnsRecord](domaindnsrecord.md) entity.
## Methods
-Direct queries to this resource are not supported. Please see the [domain](domain.md) topic for information on how to query for domain service records.
+Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records.
## Properties | Property | Type |Description|
Direct queries to this resource are not supported. Please see the [domain](domai
|mailExchange|String| Value used when configuring the *answer/destination/value* of the MX record at the DNS host.| |preference|Int32| Value used when configuring the *Preference/Priority* property of the MX record at the DNS host. | |recordType|String| Type of DNS record. The value is always *Mx*. Key |
-|supportedService|String| Microsoft Online Service or feature that has a dependency on this MX record.</br></br>Can be one of the following values: **null**, *Email*, *Sharepoint*, *EmailInternalRelayOnly*, *OfficeCommunicationsOnline*, *SharePointDefaultDomain*, *FullRedelegation*, *SharePointPublic*, *OrgIdAuthentication*, *Yammer*, *Intune* |
+|supportedService|String| Microsoft Online Service or feature that has a dependency on this MX record. Can be one of the following values: **null**, *Email*, *Sharepoint*, *EmailInternalRelayOnly*, *OfficeCommunicationsOnline*, *SharePointDefaultDomain*, *FullRedelegation*, *SharePointPublic*, *OrgIdAuthentication*, *Yammer*, *Intune* |
|ttl|Int32| Value to use when configuring the *time-to-live (ttl)* property of the MX record at the DNS host. Not nullable | ## Relationships None ## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Domaindnsrecord https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnsrecord.md
None.
|id|String| Unique identifier assigned to this entity. Not nullable, Read-only.| |isOptional|Boolean| If false, this record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. | |label|String| Value used when configuring the name of the DNS record at the DNS host. |
-|recordType|String| Indicates what type of DNS record this entity represents.</br></br>The value can be one of the following: `CName`, `Mx`, `Srv`, `Txt`. |
-|supportedService|String| Microsoft Online Service or feature that has a dependency on this DNS record.</br></br>Can be one of the following values: `null`, `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer`, `Intune`.|
+|recordType|String| Indicates what type of DNS record this entity represents. The value can be one of the following: `CName`, `Mx`, `Srv`, `Txt`. |
+|supportedService|String| Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: `null`, `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer`, `Intune`.|
|ttl|Int32| Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable. | ## Relationships None ## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Domaindnstxtrecord https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domaindnstxtrecord.md
Namespace: microsoft.graph
Represents a TXT record added to the DNS zone file of a particular domain in the tenant. Inherited from [DomainDnsRecord](domaindnsrecord.md) entity. ## Methods
-Direct queries to this resource are not supported. Please see the [domain](domain.md) topic for information on how to query for domain service records.
+Direct queries to this resource aren't supported. See the [domain](domain.md) article for information on how to query for domain service records.
## Properties | Property | Type |Description|
Direct queries to this resource are not supported. Please see the [domain](domai
|isOptional|Boolean| If false, the TXT record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. | |label|String| Value to use when configuring the *name* property of the TXT record at the DNS host.| |recordType|String| Type of DNS record. The value is always *Txt*. Key |
-|supportedService|String| Microsoft Online Service or feature that has a dependency on this TXT record.</br></br>Can be one of the following values: **null**, *Email*, *Sharepoint*, *EmailInternalRelayOnly*, *OfficeCommunicationsOnline*, *SharePointDefaultDomain*, *FullRedelegation*, *SharePointPublic*, *OrgIdAuthentication*, *Yammer*, *Intune* |
+|supportedService|String| Microsoft Online Service or feature that has a dependency on this TXT record. Can be one of the following values: **null**, *Email*, *Sharepoint*, *EmailInternalRelayOnly*, *OfficeCommunicationsOnline*, *SharePointDefaultDomain*, *FullRedelegation*, *SharePointPublic*, *OrgIdAuthentication*, *Yammer*, *Intune* |
|text|String| Value used when configuring the *text* property at the DNS host. | |ttl|Int32| Value to use when configuring the *time-to-live (ttl)* property of the MX record at the DNS host. Not nullable |
None
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Domainidentitysource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domainidentitysource.md
Title: "domainIdentitySource resource type"
-description: "The domainIdentitySource type identifies a non-tenant domain as an identity source for a connected organization."
+description: "The domainIdentitySource type identifies a nontenant domain as an identity source for a connected organization."
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
Used in the identity sources of an [connectedOrganization](connectedOrganization.md). The `@odata.type` value `#microsoft.graph.domainIdentitySource` indicates that this type identifies a domain as an identity source for a connected organization.
-When [creating a new connectedOrganization](../api/entitlementmanagement-post-connectedorganizations.md), if the caller provides in the identitySources collection a domainIdentitySource and the domain corresponds to a registered domain of an Azure Active Directory tenant, then the resulting connectedOrganization that is created will have an identitySources collection containing a single member of the [azureActiveDirectoryTenant](azureactivedirectorytenant.md) type.
+When [creating a new connectedOrganization](../api/entitlementmanagement-post-connectedorganizations.md), if the caller provides in the identitySources collection a domainIdentitySource and the domain corresponds to a registered domain of an Azure Active Directory tenant, then the resulting connectedOrganization that is created has an identitySources collection containing a single member of the [azureActiveDirectoryTenant](azureactivedirectorytenant.md) type.
## Properties
None.
## JSON representation
-The following is a JSON representation of the type.
+Here's a JSON representation of the type.
<!-- { "blockType": "resource",
v1.0 Downgradejustification https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/downgradejustification.md
Represents user input on why downgrade was performed. Downgrade justification mi
| Property | Type | Description | | :- | : | : |
-| isDowngradeJustified | Boolean | Indicates whether the downgrade is or is not justified. |
-| justificationMessage | String | Message that indicates why a downgrade is justified. The message will appear in administrative logs. |
+| isDowngradeJustified | Boolean | Indicates whether the downgrade is or isn't justified. |
+| justificationMessage | String | Message that indicates why a downgrade is justified. The message appears in administrative logs. |
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Driveitem https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driveitem.md
-description: "The driveItem resource represents a file, folder, or other item stored in a drive."
+description: "Represents a file, folder, or other item stored in a drive."
Title: driveItem ms.localizationpriority: medium ms.prod: "sites-and-lists"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-The **driveItem** resource represents a file, folder, or other item stored in a drive.
+Represents a file, folder, or other item stored in a drive.
All file system objects in OneDrive and SharePoint are returned as **driveItem** resources. Items in SharePoint document libraries can be represented as [listItem][] or **driveItem** resources.
For example:
Items with the **folder** facet act as containers of items and therefore have a `children` reference pointing to a collection of **driveItems** under the folder.
->**Note:** In OneDrive for Business or SharePoint document libraries, the **cTag** property is not returned, if the **driveItem** has a [folder][] facet.
+>**Note:** In OneDrive for Business or SharePoint document libraries, the **cTag** property isn't returned, if the **driveItem** has a [folder][] facet.
## Methods
Items with the **folder** facet act as containers of items and therefore have a
| [Revoke grants](../api/permission-revokegrants.md) | `PATCH /drive/items/{item-id}/permissions/{perm-id}/revokeGrants` | | [Extract sensitivity labels](../api/driveitem-extractsensitivitylabels.md) | `POST /drive/items/{item-id}/extractSensitivityLabels` | | [Assign sensitivity label](../api/driveitem-assignsensitivitylabel.md) | `POST /drive/items/{item-id}/assignSensitivityLabel` |
+| [Get retention label](../api/driveitem-getretentionlabel.md) | `GET /drives/{drive-id}/items/{id}/retentionLabel` |
+| [Set retention label](../api/driveitem-setretentionlabel.md) | `PATCH /drives/{drive-id}/items/{id}/retentionLabel` |
+| [Remove retention label](../api/driveitem-removeretentionlabel.md) | `DELETE /drives/{drive-id}/items/{id}/retentionLabel` |
+| [Lock or unlock record](../api/driveitem-lockorunlockrecord.md) | `PATCH /drives/{drive-id}/items/{id}/retentionLabel` |
## Properties
Items with the **folder** facet act as containers of items and therefore have a
| audio | [audio][] | Audio metadata, if the item is an audio file. Read-only. Only on OneDrive Personal. | bundle | [bundle][] | Bundle metadata, if the item is a bundle. Read-only. | content | Stream | The content stream, if the item represents a file.
-| createdBy | [identitySet][] | Identity of the user, device, and application which created the item. Read-only.
+| createdBy | [identitySet][] | Identity of the user, device, and application, which created the item. Read-only.
| createdDateTime | DateTimeOffset | Date and time of item creation. Read-only.
-| cTag | String | An eTag for the content of the item. This eTag is not changed if only the metadata is changed. **Note** This property is not returned if the item is a folder. Read-only.
+| cTag | String | An eTag for the content of the item. This eTag isn't changed if only the metadata is changed. **Note** This property isn't returned if the item is a folder. Read-only.
| deleted | [deleted][] | Information about the deleted state of the item. Read-only. | description | String | Provides a user-visible description of the item. Read-write. Only on OneDrive Personal. | eTag | String | eTag for the entire item (metadata + content). Read-only.
Items with the **folder** facet act as containers of items and therefore have a
| folder | [folder][] | Folder metadata, if the item is a folder. Read-only. | id | String | The unique identifier of the item within the Drive. Read-only. | image | [image][] | Image metadata, if the item is an image. Read-only.
-| lastModifiedBy | [identitySet][] | Identity of the user, device, and application which last modified the item. Read-only.
+| lastModifiedBy | [identitySet][] | Identity of the user, device, and application, which last modified the item. Read-only.
| lastModifiedDateTime | DateTimeOffset | Date and time at which the item was last modified. Read-only. | location | [geoCoordinates][] | Location metadata, if the item has location data. Read-only. | malware | [malware][] | Malware metadata, if the item was detected to contain malware. Read-only.
Items with the **folder** facet act as containers of items and therefore have a
| parentReference | [itemReference][] | Parent information, if the item has a parent. Read-write. | pendingOperations | [pendingOperations][] | If present, indicates that indicates that one or more operations that may affect the state of the driveItem are pending completion. Read-only. | photo | [photo][] | Photo metadata, if the item is a photo. Read-only.
-| publication | [publicationFacet][] | Provides information about the published or checked-out state of an item, in locations that support such actions. This property is not returned by default. Read-only. |
+| publication | [publicationFacet][] | Provides information about the published or checked-out state of an item, in locations that support such actions. This property isn't returned by default. Read-only. |
| remoteItem | [remoteItem][] | Remote item data, if the item is shared from a drive other than the one being accessed. Read-only. | root | [root][] | If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. | searchResult | [searchResult][] | Search metadata, if the item is from a search result. Read-only.
The eTag value is only modified when the folder's properties are changed, except
| createdByUser | [user][] | Identity of the user who created the item. Read-only. | lastModifiedByUser | [user][] | Identity of the user who last modified the item. Read-only. | listItem | [listItem][] | For drives in SharePoint, the associated document library list item. Read-only. Nullable.
+| retentionLabel | [itemRetentionLabel][] | Information about retention label and settings enforced on the **driveItem**. Read-write.
| permissions | [permission][] collection | The set of permissions for the item. Read-only. Nullable. | subscriptions | [subscription][] collection | The set of subscriptions on the item. Only supported on the root of a drive. | thumbnails | [thumbnailSet][] collection | Collection containing [ThumbnailSet][] objects associated with the item. For more info, see [getting thumbnails][]. Read-only. Nullable. | versions | [driveItemVersion][] collection | The list of previous versions of the item. For more info, see [getting previous versions][]. Read-only. Nullable.
-| workbook | [workbook][] | For files that are Excel spreadsheets, accesses the workbook API to work with the spreadsheet's contents. Nullable.
+| workbook | [workbook][] | For files that are Excel spreadsheets, access to the workbook API to work with the spreadsheet's contents. Nullable.
## Instance Attributes Instance attributes are properties with special behaviors.
-These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.
+These properties are temporary and either define behavior the service should perform or provide short-term property values, like a download URL for an item that expires.
| Property name | Type | Description |:-|:-|:--
-| @microsoft.graph.conflictBehavior | string | The conflict resolution behavior for actions that create a new item. You can use the values *fail*, *replace*, or *rename*. The default for PUT is *replace*. An item will never be returned with this annotation. Write-only.
-| @microsoft.graph.downloadUrl | string | A URL that can be used to download this file's content. Authentication is not required with this URL. Read-only.
-| @microsoft.graph.sourceUrl | string | When issuing a PUT request, this instance annotation can be used to instruct the service to download the contents of the URL, and store it as the file. Write-only.
+| @microsoft.graph.conflictBehavior | string | The conflict resolution behavior for actions that create a new item. You can use the values *fail*, *replace*, or *rename*. The default for PUT is *replace*. An item is never returned with this annotation. Write-only.
+| @microsoft.graph.downloadUrl | string | A URL that can be used to download this file's content. Authentication isn't required with this URL. Read-only.
+| @microsoft.graph.sourceUrl | string | This instance annotation can be used to instruct the service to download the contents of the URL when issuing a PUT request, and stores it as the file. Write-only.
**Note:** The @microsoft.graph.downloadUrl value is a short-lived URL and can't be cached.
-The URL will only be available for a short period of time (1 hour) before it is invalidated.
+The URL is only available for a short period of time (1 hour) before it's invalidated.
Removing file permissions for a user may not immediately invalidate the URL. >**Note:** The parameter @microsoft.graph.conflictBehavior should be included in the URL instead of the body of the request. ## JSON representation
-Here is a JSON representation of a **driveItem** resource.
+The following shows an example of the JSON representation of a **driveItem** resource.
The **driveItem** resource is derived from [**baseItem**][baseItem] and inherits properties from that resource.
The **driveItem** resource is derived from [**baseItem**][baseItem] and inherits
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}], "children": [{ "@odata.type": "microsoft.graph.driveItem" }], "createdByUser": { "@odata.type": "microsoft.graph.user" },
+ "itemRetentionLabel": [{ "@odata.type": "microsoft.graph.itemRetentionLabel" }],
"lastModifiedByUser": { "@odata.type": "microsoft.graph.user" }, "permissions": [ {"@odata.type": "microsoft.graph.permission"} ], "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],
The **driveItem** resource is derived from [**baseItem**][baseItem] and inherits
[itemActivity]: itemactivity.md [itemAnalytics]: itemanalytics.md [itemReference]: itemreference.md
+[itemRetentionLabel]: itemretentionlabel.md
[geoCoordinates]: geocoordinates.md [List activities]: ../api/activities-list.md [listItem]: listitem.md
v1.0 Dynamics Account https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-account.md
Represents an account object in Dynamics 365 Business Central.
## Properties | Property | Type |Description| |:|:--|:-|
-|blocked|Boolean|Specifies that entries cannot be posted to the G/L account. `True` indicates that the account is blocked and posting is not allowed.|
+|blocked|Boolean|Specifies that entries can't be posted to the G/L account. `True` indicates that the account is blocked and posting isn't allowed.|
|category|String|Specifies the category of the G/L account. Maximum size is 20.| |displayName|String|Specifies the name of the G/L account. Maximum size is 50.| |id|GUID|The unique identifier for the account.|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json
v1.0 Dynamics Customerpayment https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-customerpayment.md
Represents a customer payment in Dynamics 365 Business Central. A customer payme
|appliesToInvoiceId|GUID|The unique ID of the invoice that the payment is related to.| |appliesToInvoiceNumber|String|The number of the invoice that the payment is related to. Maximum supported size is 20 characters.| |comment|String|A user specified comment on the customer payment. Maximum supported size is 250 characters.|
-|contactId|String|The exchange contact id for the given customer. If a customer id is not specified, we will use the contact id to find it. Maximum supported size is 250 characters.|
+|contactId|String|The exchange contact ID for the given customer. If a customer id isn't specified, we'll use the contact id to find it. Maximum supported size is 250 characters.|
|customerId|GUID|The unique ID of the customer that the payment is related to.| |customerNumber|String|The number of the customer that the payment is related to. Maximum supported size is 20 characters.| |description|String|The description of the customer payment, provided by the user or autocreated. Maximum supported size is 50 characters.|
Represents a customer payment in Dynamics 365 Business Central. A customer payme
|postingDate|Date|The date that the customer payment is posted.| ## Relationships
-A customer payment is a subpage of a customer payment journal. It cannot be accessed directly.
+A customer payment is a subpage of a customer payment journal. It can't be accessed directly.
A customer payment can be a "Parent Entity" of the dimension lines.
An Invoice (appliesToInvoiceId) must exist in the Sales Invoices Table.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json {
v1.0 Dynamics Dimension https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-dimension.md
Represents a dimension in Dynamics 365 Business Central.
|:-|:-|:-| |id |GUID |The unique ID of the item.| |code |string, maximum size 20|The dimension code. |
-|displayName |string |Specifies the dimension's name. This name will appear where the dimension is used.|
+|displayName |string |Specifies the dimension's name. This name appears where the dimension is used.|
|lastModifiedDateTime|datetime |The last datetime the dimension was modified.| ## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json
v1.0 Dynamics Dimensionvalue https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-dimensionvalue.md
Represents a dimension value in Dynamics 365 Business Central.
|:-|:-|:--| |id |GUID |The unique ID of the item. | |code |string, maximum size 20|The dimension value code. |
-|displayName |string |Specifies the dimension value's name. This name will appear where the dimension value is used.|
+|displayName |string |Specifies the dimension value's name. This name appears where the dimension value is used.|
|lastModifiedDateTime|datetime |The last datetime the dimension value was modified.| ## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json
v1.0 Dynamics Item https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-item.md
Represents an item in Dynamics 365 Business Central.
## Properties | Property | Type |Description | |:-|:-|:-|
-|id |GUID |The unique ID of the item. Non-editable. |
+|id |GUID |The unique ID of the item. Noneditable. |
|number |string |The item number. | |displayName |string |Specifies a description of the item. | |type |numeric |The inventory type for the item. 1 = inventory item, 2 = service item. This is a required property.|
-|blocked |boolean |Specifies that transactions with the item cannot be posted, for example, because the item is in quarantine. Set to **true**, if item is blocked.|
+|blocked |boolean |Specifies that transactions with the item can't be posted, for example, because the item is in quarantine. Set to **true**, if item is blocked.|
|baseUnitOfMeasureId |GUID |Specifies the ID of the unit of measure. | |baseUnitOfMeasure |[NAV.UnitOfMeasure](../resources/dynamics-complextypes.md)|Specifies the unit in which the item is held in inventory.|
-|gtin |numeric |This is the Global Trade Item Number. |
+|gtin |numeric |The Global Trade Item Number. |
|itemCategoryId |GUID |Specifies the category that the item belongs to. Item categories also contain any assigned item attributes.| |inventory |decimal |Specifies how many units, such as pieces, boxes, or cans, of the item are in inventory. Read-Only.| |unitPrice |decimal |Specifies the price for one unit of the item in the specified currency.|
A Tax Group(taxGroupCode) must exist in the Tax Group table.
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json
v1.0 Dynamics Itemcategories https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-itemcategories.md
Title: "itemCategories resource type"
-description: "Represents a category for a number of items in Dynamics 365 Business Central."
+description: "Represents a category for many items in Dynamics 365 Business Central."
documentationcenter: ""
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a category for a number of items in Dynamics 365 Business Central.
+Represents a category for many items in Dynamics 365 Business Central.
## Methods
Represents a category for a number of items in Dynamics 365 Business Central.
|:-|:-|:--| |code |String |The item category code. | |displayName |String |The display name of the item category. |
-|id |String |The unique ID of the item category. Non-editable.|
+|id |String |The unique ID of the item category. Noneditable.|
|lastModifiedDateTime|Datetime|The date and time when the item category was last modified. Read-Only.|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json {
v1.0 Dynamics Journal https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-journal.md
Represents a journal in Dynamics 365 Business Central.
|lastModifiedDateTime|datetime |The last datetime the journal was modified. Read-Only.| ## Bound actions
-The journal resource type offers a bound action called `post` which posts the corresponding general journal batch.
+The journal resource type offers a bound action called `post` that posts the corresponding general journal batch.
Posting the general journal batch is illustrated in the following example: `POST https://graph.microsoft.com/beta/financials/companies{id}/journals{id}/post`.
The response has no content; the response code is 204.
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json
v1.0 Dynamics Paymentterms https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-paymentterms.md
Represents a [payment term](../resources/dynamics-paymentterms.md) in Dynamics 3
## Properties | Property | Type |Description | |:--|:-|:-|
-|calculateDiscountOnCreditMemos|Boolean |Specifies whether the discount should be applied to credit memos. `True` indicates a discount will be given; `false`* indicates a discount will not be given.|
+|calculateDiscountOnCreditMemos|Boolean |Specifies whether the discount should be applied to credit memos. `True` indicates a discount is given; `false`* indicates a discount won't be given.|
|code |string |Specifies the payment term code. | |discountDateCalculation |string |Specifies the formula that is used to calculate the date that a payment must be made in order to obtain a discount.| |discountPercent |decimal |Specifies the discount percentage that is applied for early payment of an invoice amount.|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json
v1.0 Dynamics Shipmentmethods https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-shipmentmethods.md
Represents a method of shipment in Dynamics 365 Business Central, such as UPS, F
|:|:--|:-| |code|String|The shipment method code.| |displayName|String|The display name for the shipment method.|
-|id|String|The unique identifier of the **shipmentMethod**. Non-editable.|
+|id|String|The unique identifier of the **shipmentMethod**. Noneditable.|
|lastModifiedDateTime|Datetime|The date and time when the shipment method was last modified. Read-Only.|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
```json {
v1.0 Dynamics Unitsofmeasure https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-unitsofmeasure.md
Represents a unit of measure, which is a standard of measurement of a quantity,
## Properties | Property | Type |Description| |:|:--|:-|
-|id|GUID|The unique ID of the unitsOfMeasure. Non-editable.|
+|id|GUID|The unique ID of the unitsOfMeasure. Noneditable.|
|code|string|Specifies the code for the unit of measure.| |displayName|string|Specifies the unit of measure's display name.|
-|internationalStandardCode|string|Specifies the unit of measure code expressed according to the UNECE Rec20 standard in connection with electronic sending of sales documents.|
+|internationalStandardCode|string|Specifies the unit of measure code expressed according to the UNECE Rec20 standard for electronically ending sales documents.|
|lastModifiedDateTime|datetime|The last datetime the unit of measure was modified. Read-Only.|
None
## JSON representation
-Here is a JSON representation of the **unitsOfMeasure** resource.
+Here's a JSON representation of the **unitsOfMeasure** resource.
```json {
v1.0 Ediscovery Casesettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-casesettings.md
Title: "caseSettings resource type"
-description: "Contains ettings for an eDiscovery case."
+description: "Contains settings for an eDiscovery case."
ms.localizationpriority: medium ms.prod: "ediscovery"
Inherits from [entity](../resources/entity.md).
|Id|String|The ID of the eDiscovery case. Inherited from [entity](../resources/entity.md).| |ocr|[microsoft.graph.ediscovery.ocrSettings](../resources/ediscovery-ocrsettings.md)|The OCR (Optical Character Recognition) settings for the case.| |redundancyDetection|[microsoft.graph.ediscovery.redundancyDetectionSettings](../resources/ediscovery-redundancydetectionsettings.md)|The redundancy (near duplicate and email threading) detection settings for the case.|
-|topicModeling|[microsoft.graph.ediscovery.topicModelingSettings](../resources/ediscovery-topicmodelingsettings.md)|The Topic Modeling (Themes) settings for the case.|
+|topicModeling|[microsoft.graph.ediscovery.topicModelingSettings](../resources/ediscovery-topicmodelingsettings.md)|The article Modeling (Themes) settings for the case.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Ediscovery Datasource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-datasource.md
None
|:|:|:| |createdBy|[identitySet](../resources/identityset.md)|The user who created the **dataSource**.| |createdDateTime|DateTimeOffset|The date and time the **dataSource** was created.|
-|displayName|String|The display name of the **dataSource**. This will be the name of the SharePoint site.|
-|id|String| The ID of the **dataSource**. This is not the ID of the actual site.|
+|displayName|String|The display name of the **dataSource**, and is the name of the SharePoint site.|
+|id|String| The ID of the **dataSource**. This isn't the ID of the actual site.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Ediscovery Noncustodialdatasource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-noncustodialdatasource.md
Title: "noncustodialDataSource resource type"
-description: "Non-custodial data sources lets you add data to a case without having to associate it to a custodian"
+description: "Noncustodial data sources let you add data to a case without having to associate it to a custodian"
ms.localizationpriority: medium ms.prod: "ediscovery"
Namespace: microsoft.graph.ediscovery
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Non-custodial data sources let you add data to a case without having to associate it to a custodian. To learn more, visit [Add non-custodial data sources to an Advanced eDiscovery case
+Noncustodial data sources let you add data to a case without having to associate it to a custodian. To learn more, visit [Add noncustodial data sources to an Advanced eDiscovery case
](/microsoft-365/compliance/non-custodial-data-sources) Inherits from [dataSourceContainer](../resources/ediscovery-datasourcecontainer.md).
Inherits from [dataSourceContainer](../resources/ediscovery-datasourcecontainer.
|:|:|:| |[List noncustodialDataSources](../api/ediscovery-noncustodialdatasource-list.md)|[microsoft.graph.ediscovery.noncustodialDataSource](../resources/ediscovery-noncustodialdatasource.md) collection|Get a list of the [noncustodialDataSource](../resources/ediscovery-noncustodialdatasource.md) objects and their properties.| |[Get noncustodialDataSource](../api/ediscovery-noncustodialdatasource-get.md)|[microsoft.graph.ediscovery.noncustodialDataSource](../resources/ediscovery-noncustodialdatasource.md)|Read the properties and relationships of a [noncustodialDataSource](../resources/ediscovery-noncustodialdatasource.md) object.|
-|[Release dataSource](../api/ediscovery-noncustodialdatasource-release.md)|None|Releases a non-custodial data source.|
+|[Release dataSource](../api/ediscovery-noncustodialdatasource-release.md)|None|Releases a noncustodial data source.|
|[List dataSource](../api/ediscovery-noncustodialdatasource-list-datasource.md)|[microsoft.graph.ediscovery.dataSource](../resources/ediscovery-datasource.md) collection|Get the dataSource resources from the dataSource navigation property.| |[Create dataSource](../api/ediscovery-noncustodialdatasource-post.md)|[microsoft.graph.ediscovery.dataSource](../resources/ediscovery-datasource.md)|Create a new dataSource object.|
Inherits from [dataSourceContainer](../resources/ediscovery-datasourcecontainer.
|Property|Type|Description| |:|:|:|
-|applyHoldToSource|Boolean|Indicates if hold is applied to non-custodial data source (such as mailbox or site).|
+|applyHoldToSource|Boolean|Indicates if hold is applied to noncustodial data source (such as mailbox or site).|
|createdDateTime|DateTimeOffset|Created date and time of the nonCustodialDataSource. Inherited from [microsoft.graph.ediscovery.dataSourceContainer](../resources/ediscovery-datasourcecontainer.md).| |displayName|String|Display name of the noncustodialDataSource. Inherited from [microsoft.graph.ediscovery.dataSourceContainer](../resources/ediscovery-datasourcecontainer.md).| |id|String|Unique identifier of the nonCustodialDataSource. Inherited from [entity](../resources/entity.md).|
Inherits from [dataSourceContainer](../resources/ediscovery-datasourcecontainer.
|Relationship|Type|Description| |:|:|:|
-|dataSource|[microsoft.graph.ediscovery.dataSource](../resources/ediscovery-datasource.md)|User source or SharePoint site data source as non-custodial data source.|
+|dataSource|[microsoft.graph.ediscovery.dataSource](../resources/ediscovery-datasource.md)|User source or SharePoint site data source as noncustodial data source.|
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Ediscovery Topicmodelingsettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-topicmodelingsettings.md
Title: "topicModelingSettings resource type"
-description: "Topic modeling settings for an eDiscovery case"
+description: "Article modeling settings for an eDiscovery case"
ms.localizationpriority: medium ms.prod: "ediscovery"
Namespace: microsoft.graph.ediscovery
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Topic modeling (Themes) settings for an eDiscovery case. To learn more, see [Configure search and analytics settings in Advanced eDiscovery](/microsoft-365/compliance/configure-search-and-analytics-settings-in-advanced-ediscovery).
+Article modeling (Themes) settings for an eDiscovery case. To learn more, see [Configure search and analytics settings in Advanced eDiscovery](/microsoft-365/compliance/configure-search-and-analytics-settings-in-advanced-ediscovery).
## Properties
Topic modeling (Themes) settings for an eDiscovery case. To learn more, see [Con
|:|:|:| |dynamicallyAdjustTopicCount|Boolean|To learn more, see [Adjust maximum number of themes dynamically](/microsoft-365/compliance/configure-search-and-analytics-settings-in-advanced-ediscovery#themes).| |ignoreNumbers|Boolean|To learn more, see [Include numbers in themes](/microsoft-365/compliance/configure-search-and-analytics-settings-in-advanced-ediscovery#themes).|
-|isEnabled|Boolean|Indicates whether themes is enabled for the case.|
+|isEnabled|Boolean|Indicates whether themes are enabled for the case.|
|topicCount|Int32|To learn more, see [Maximum number of themes](/microsoft-365/compliance/configure-search-and-analytics-settings-in-advanced-ediscovery#themes).| ## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.ediscovery.topicModelingSettings"
v1.0 Educationassignmentgradetype https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentgradetype.md
Title: "educationAssignmentGradeType resource type"
-description: "Represents how an assignment will be graded. This is used within the **assignments.grading** property."
+description: "Represents how an assignment is graded. This is used within the **assignments.grading** property."
ms.localizationpriority: medium ms.prod: "education"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents how an assignment will be graded. This is used within the **assignments.grading** property.
+Represents how an assignment is graded. This is used within the **assignments.grading** property.
-This superclass can not be used directly in the assignment property. It exists to allow for multiple different ways to grade assignments.
+This superclass canΓÇÖt be used directly in the assignment property. It exists to allow for multiple different ways to grade assignments.
Base class for [educationAssignmentPointsGradeType](../resources/educationassignmentpointsgradetype.md).
v1.0 Educationassignmentresource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentresource.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] A wrapper object that stores the resources associated with an assignment. The wrapper adds the **distributeForStudentWork** property and indicates that this resource will
-be copied to the student submission. If the object is not copied, each student will see a link to the resource on the assignment. The student will not be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in. If the resource is distributed, each student
-will receive a copy of this resource in the resource list of their submission. Each student will be able to modify their copy and submit it for grading.
+be copied to the student submission. If the object isn't copied, each student sees a link to the resource on the assignment. The student won't be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in. If the resource is distributed, each student
+receives a copy of this resource in the resource list of their submission. Each student is able to modify their copy and submit it for grading.
## Methods
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Educationassignmentsettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationassignmentsettings.md
Specifies class-level assignments settings.
|Property|Type|Description| |:|:|:| |id|String|Unique identifier for the educationAssignmentSettings.|
-|submissionAnimationDisabled|Boolean|Indicates whether turn-in celebration animation will be shown. If `true`, the animation will not be shown. The default value is `false`.|
+|submissionAnimationDisabled|Boolean|Indicates whether turn-in celebration animation will be shown. If `true`, the animation won't be shown. The default value is `false`.|
## Relationships | Relationship | Type |Description|
Specifies class-level assignments settings.
|grading categories|[educationGradingCategory](educationgradingcategory.md) collection| When set, enables users to weight assignments differently when computing a class average grade.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Educationlinkresource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationlinkresource.md
Title: "educationLinkResource resource type"
-description: "A subclass of educationResource. This resource is a link and does not have any additional data associated with it."
+description: "A subclass of educationResource. This resource is a link and doesn't have any other data associated with it."
ms.localizationpriority: medium ms.prod: "education"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A subclass of [educationResource](educationresource.md). This resource is a link and does not have any additional data associated with it.
+A subclass of [educationResource](educationresource.md). This resource is a link and doesn't have any other data associated with it.
## Properties
A subclass of [educationResource](educationresource.md). This resource is a link
|:|:--|:-| |link|String|URL to the resource.| |createdBy|String|The display name of the user that created this object.|
-|createdDateTime|DateTimeOffset|Date time the resoruce was added.|
+|createdDateTime|DateTimeOffset|Date time the resource was added.|
|displayName|string|The display name of the resource.| |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. 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`.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Educationmoduleresource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationmoduleresource.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A wrapper object that stores the resources associated with a module. The student will not be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in.
+A wrapper object that stores the resources associated with a module. The student won't be able to update this resource. This is a handout from the teacher to the student with nothing to be turned in.
## Methods
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Educationsubmissionresource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationsubmissionresource.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A wrapper around a resource for use on a submission. The wrapper adds a pointer to the assignment resource if this was copied from the assignment.
+A wrapper around a resource for use on a submission. The wrapper adds a pointer to the assignment resource if the resource was copied from the assignment.
## Methods
A wrapper around a resource for use on a submission. The wrapper adds a pointer
## Properties | Property | Type |Description| |:|:--|:-|
-|assignmentResourceUrl|String|Pointer to the assignment from which this resource was copied. If this is null, the student uploaded the resource.|
+|assignmentResourceUrl|String|Pointer to the assignment from which the resource was copied. If the value is null, the student uploaded the resource.|
|id|String| Read-only.| |resource|[educationResource](educationresource.md)|Resource object.|
None
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Educationterm https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationterm.md
Title: "educationTerm resource type"
-description: "A term. This represents a designated portion of the academic year. It is used within educationClass."
+description: "A term. This represents a designated portion of the academic year. It's used within educationClass."
ms.localizationpriority: medium ms.prod: "education"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A term. This represents a designated portion of the academic year. It is used within [educationClass](educationclass.md).
+A term. This represents a designated portion of the academic year. It's used within [educationClass](educationclass.md).
## Properties | Property | Type |Description|
A term. This represents a designated portion of the academic year. It is used wi
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Educationuser https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationuser.md
This object provides a targeted subset of properties from the core [user] object
| department | String | The name for the department in which the user works. Supports \$filter. | | displayName | String | The name displayed in the address book for the user. Supports $filter and $orderby. | | externalSource | String | The type of external source this resource was generated from (automatically determined from `externalSourceDetail`). Possible values are: `sis`, `lms`, or `manual`. |
-| externalSourceDetail | String | The name of the external source this resources was generated from. |
+| externalSourceDetail | String | The name of the external source this resource was generated from. |
| givenName | String | The given name (first name) of the user. Supports \$filter. | | mail | String | The SMTP address for the user; for example, "jeff@contoso.onmicrosoft.com". Read-Only. Supports \$filter. | | mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Supports \$filter. |
-| mailingAddress | [physicalAddress] | Mail address of user. Note: `type` and `postOfficeBox` are not supported for `educationUser` resources. |
+| mailingAddress | [physicalAddress] | Mail address of user. Note: `type` and `postOfficeBox` aren't supported for `educationUser` resources. |
| middleName | String | The middle name of user. | | mobilePhone | String | The primary cellular telephone number for the user. |
-| onPremisesInfo | [educationOnPremisesInfo] | Additional information used to associate the AAD user with it's Active Directory counterpart. |
-| passwordPolicies | String | Specifies password policies for the user. See standard [user] resource for additional details. |
-| passwordProfile | [passwordProfile] | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. See standard [user] resource for additional details. |
+| onPremisesInfo | [educationOnPremisesInfo] | Additional information used to associate the Azure Active Directory user with its Active Directory counterpart. |
+| passwordPolicies | String | Specifies password policies for the user. See standard [user] resource for more details. |
+| passwordProfile | [passwordProfile] | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. See standard [user] resource for more details. |
| preferredLanguage | String | The preferred language for the user. Should follow ISO 639-1 Code; for example, "en-US". | | primaryRole | string | Default role for a user. The user's role might be different in an individual class. Possible values are: `student`, `teacher`, `faculty`. Supports \$filter. | | provisionedPlans | [provisionedPlan] collection | The plans that are provisioned for the user. Read-only. Not nullable. | | relatedContacts | [relatedContact] collection | Related records related to the user. Possible relationships are `parent`, `relative`, `aide`, `doctor`, `guardian`, `child`, `other`, `unknownFutureValue` |
-| residenceAddress | [physicalAddress] | Address where user lives. Note: `type` and `postOfficeBox` are not supported for `educationUser` resources. |
-| student | [educationStudent] | If the primary role is student, this block will contain student specific data. |
+| residenceAddress | [physicalAddress] | Address where user lives. Note: `type` and `postOfficeBox` aren't supported for `educationUser` resources. |
+| student | [educationStudent] | If the primary role is student, this block contains student specific data. |
| surname | String | The user's surname (family name or last name). Supports \$filter. | | teacher | [educationTeacher] | If the primary role is teacher, this block will contain teacher specific data. | | usageLocation | String | A two-letter country code ([ISO 3166 Alpha-2]). Required for users who will be assigned licenses. Not nullable. Supports \$filter. |
This object provides a targeted subset of properties from the core [user] object
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Emailauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailauthenticationmethodconfiguration.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset, or by external users for authentication during invitation redemption and self-service sign-up for specific apps in user flows.
+Represents this tenant's email OTP authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. Email OTP may be used by the tenant's cloud-native users for self-service password reset. Email OTP may be used by external users for authentication during invitation redemption and self-service sign up for specific apps in user flows.
Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
Inherits from [authenticationMethodConfiguration](../resources/authenticationmet
|Property|Type|Description| |:|:|:|
-|allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who did not use public preview will automatically have email OTP enabled beginning in October 2021.|
+|allowExternalIdToUseEmailOtp|externalEmailOtpState|Determines whether email OTP is usable by external users for authentication. Possible values are: `default`, `enabled`, `disabled`, `unknownFutureValue`. Tenants in the `default` state who didn't use public preview will automatically have email OTP enabled beginning in October 2021.|
|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy.| |id|String|The authentication method policy identifier. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).| |state|authenticationMethodState|Indicates whether this authentication method is enabled or not. Possible values are: `enabled`, `disabled`.|
Inherits from [authenticationMethodConfiguration](../resources/authenticationmet
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Emailpayloaddetail https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/emailpayloaddetail.md
Inherits from [payloadDetail](../resources/payloaddetail.md).
|content|String|Payload content details. Inherited from [payloadDetail](../resources/payloaddetail.md).| |fromEmail|String|Email address of the user.| |fromName|String|Display name of the user.|
-|isExternalSender|Boolean|Indicates whether the sender is not from the user's organization.|
+|isExternalSender|Boolean|Indicates whether the sender isn't from the user's organization.|
|phishingUrl|String|Phishing URL used to target a user. Inherited from [payloadDetail](../resources/payloaddetail.md).| |subject|String|The subject of the email address sent to the user.|
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.emailPayloadDetail"
v1.0 Entity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entity.md
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Enums https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums.md
Namespace: microsoft.graph
| Member | | :-- | | asymmetricKeyLifetime |
+| trustedCertificateAuthority |
| unknownFutureValue | ### synchronizationSecret values
v1.0 Extension https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/extension.md
An abstract type to support the OData v4 open type [openTypeExtension](opentypee
## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- { "blockType": "resource",
None
## Methods
-See the methods of the derived type [openTypeExtension](opentypeextension.md) for actually supported methods.
+See the methods of the derived type [openTypeExtension](opentypeextension.md) for supported methods.
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Externalconnectors Externalgroupmember https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-externalgroupmember.md
Represents a member of an [externalGroup](externalconnectors-externalgroup.md) u
| Property | Type | Description | |:|:|:|
-| id | String | The unique ID of the member. It would be the objectId in case of Azure Active Directory users or groups and the **id** property of the **externalGroup** in case of external groups. |
+| id | String | The unique ID of the member. It would be the objectId for Azure Active Directory users or groups and the **id** property of the **externalGroup** for external groups. |
| type | microsoft.graph.externalConnectors.externalGroupMemberType | The type of member added to the external group. Possible values are: `user` or `group` when the **identitySource** is `azureActiveDirectory` and just `group` when the **identitySource** is `external`. | | identitySource | microsoft.graph.externalConnectors.identitySourceType | The identity source that the member belongs to. Possible values are: `azureActiveDirectory`, `external`. |
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Externalconnectors Identity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalconnectors-identity.md
Represents an entity used to set permissions on external content added to Micros
| Property | Type | Description | |:|:|:|
-| id | String | The unique ID of the identity. It would be the objectId property in case of Azure Active Directory (Azure AD) users or groups and the **id** property of the **externalGroup** in the case of external groups. |
+| id | String | The unique ID of the identity. It would be the objectId property for Azure Active Directory (Azure AD) users or groups and the **id** property of the **externalGroup** in the case of external groups. |
| type | microsoft.graph.externalConnectors.identityType | The type of identity. Possible values are: `user` or `group` for Azure AD identities and `externalgroup` for groups in an external system. | ## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Fido2combinationconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fido2combinationconfiguration.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Configuration to require specific FIDO2 key types in an authentication strength. An administrator may use this entity to specify which Authenticator Attesttation GUIDs (AAGUIDs) are allowed to be used, as part of certain authentication method combinations, in an [authentication strength](authenticationstrengthpolicy.md).
+Configuration to require specific FIDO2 key types in an authentication strength. An administrator may use this entity to specify which Authenticator Attestations GUIDs (AAGUIDs) are allowed, as part of certain authentication method combinations, in an [authentication strength](authenticationstrengthpolicy.md).
Inherits and derived from [authenticationCombinationConfiguration](../resources/authenticationcombinationconfiguration.md).
None.
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 File https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/file.md
Namespace: microsoft.graph
The **File** resource groups file-related data items into a single structure.
-If a [**DriveItem**](driveitem.md) has a non-null **file** facet, the item represents an file.
-In addition to other properties, files have a **content** relationship which contains the byte stream of the file.
+If a [**DriveItem**](driveitem.md) has a non-null **file** facet, the item represents a file.
+In addition to other properties, files have a **content** relationship that contains the byte stream of the file.
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Fileattachment https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fileattachment.md
Derived from [attachment](attachment.md).
|:|:--|:-| |contentBytes|Edm.Binary|The base64-encoded contents of the file.| |contentId|String|The ID of the attachment in the Exchange store.|
-|contentLocation|String|Do not use this property as it is not supported.|
+|contentLocation|String|Don't use this property as it isn't supported.|
|contentType|String|The content type of the attachment.| |id|String|The attachment ID.| |isInline|Boolean|Set to `true` if this is an inline attachment.| |lastModifiedDateTime|DateTimeOffset|The date and time when the attachment was last modified.|
-|name|String|The name representing the text that is displayed below the icon representing the embedded attachment.This does not need to be the actual file name.|
+|name|String|The name representing the text that is displayed below the icon representing the embedded attachment. This doesn't need to be the actual file name.|
|size|Int32|The size in bytes of the attachment.| ## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Followupflag https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/followupflag.md
Allows setting a flag for the user to follow up on an item later. Supported item
| Property | Type |Description| |:|:--|:-| |completedDateTime|[dateTimeTimeZone](datetimetimezone.md)|The date and time that the follow-up was finished.|
-|dueDateTime|**dateTimeTimeZone**|The date and time that the follow up is to be finished. **Note**: To set the due date, you must also specify the `startDateTime`; otherwise, you will get a `400 Bad Request` response.|
+|dueDateTime|**dateTimeTimeZone**|The date and time that the follow-up is to be finished. **Note**: To set the due date, you must also specify the `startDateTime`; otherwise, you get a `400 Bad Request` response.|
|flagStatus|String|The status for follow-up for an item. Possible values are `notFlagged`, `complete`, and `flagged`.| |startDateTime|**dateTimeTimeZone**|The date and time that the follow-up is to begin.| ## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- { "blockType": "resource",
v1.0 Governanceresource https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/governanceresource.md
Title: "governanceResource resource type"
-description: "Represents resources that could be managed by Privileged Identity Management (PIM). For Azure resources, it can be a subscription, a resource group, and a resource such as a virtual machine, a SQL database, etc."
+description: "Represents resources that are managed Privileged Identity Management (PIM). For Azure resources, it can be a subscription, a resource group, and a resource such as a virtual machine, etc."
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [pim-v2ResourceRoles-deprecation](../../includes/pim-v2ResourceRoles-deprecation.md)]
-Represents resources that could be managed by Privileged Identity Management (PIM). For Azure resources, it can be a subscription, a resource group, and a resource such as a virtual machine, a SQL database, etc.
+Represents Privileged Identity Management (PIM) resources. For Azure resources, it can be a subscription, a resource group, and a resource such as a virtual machine, etc.
## Methods
No `POST`, `PUT`, `PATCH`, `DELETE` are supported on `roleDefinitions` entity se
|status |String |The status of a given resource. For example, it could represent whether the resource is locked or not (values: `Active`/`Locked`). Note: This property may be extended in the future to support more scenarios.| |registeredDateTime|DateTimeOffset |Represents the date time when the resource is registered in PIM.| |registeredRoot|String |The externalId of the resource's root scope that is registered in PIM. The root scope can be the parent, grandparent, or higher ancestor resources.|
-|roleAssignmentCount|Int32 |Optional. The number of role assignments for the given resource. To get the property, please explictly use `$select=roleAssignmentCount` in the query.|
-|roleDefinitionCount|Int32 |Optional. The number of role definitions for the given resource. To get the property, please explictly use `$select=roleDefinitionCount` in the query.|
-|permissions|[governancePermission](../resources/governancepermission.md) |Optional. It represents the status of the requestor's access to the resource.To get the property, please explictly use `$select=permissions` in the query.|
+|roleAssignmentCount|Int32 |Optional. The number of role assignments for the given resource. To get the property, explicitly use `$select=roleAssignmentCount` in the query.|
+|roleDefinitionCount|Int32 |Optional. The number of role definitions for the given resource. To get the property, explicitly use `$select=roleDefinitionCount` in the query.|
+|permissions|[governancePermission](../resources/governancepermission.md) |Optional. It represents the status of the requestor's access to the resource. To get the property, explicitly use `$select=permissions` in the query.|
## Relationships | Relationship | Type |Description| |:|:|:-| |roleAssignments |[governanceRoleAssignment](../resources/governanceroleassignment.md) collection|The collection of role assignments for the resource.|
-|roleDefinitions |[governanceRoleDefinition](../resources/governanceroledefinition.md) collection|The collection of role defintions for the resource.|
+|roleDefinitions |[governanceRoleDefinition](../resources/governanceroledefinition.md) collection|The collection of role definitions for the resource.|
|roleAssignmentRequests |[governanceRoleAssignmentRequest](../resources/governanceroleassignmentrequest.md) collection|The collection of role assignment requests for the resource.| |roleSettings |[governanceRoleSetting](../resources/governancerolesetting.md) collection|The collection of role settings for the resource.| |parent |[governanceResource](../resources/governanceresource.md) |Read-only. The parent resource. for `pimforazurerbac` scenario, it can represent the subscription the resource belongs to.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Groups Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groups-overview.md
ms.localizationpriority: high ms.prod: "groups" doc_type: conceptualPageType Previously updated : 12/15/2022 Last updated : 09/12/2023 # Working with groups in Microsoft Graph
The dynamic membership rules are specified through the **membershipRule** proper
- The `Property` is defined following this syntax: `object.property`. For example `user.department` or `device.accountEnabled`. - The rule syntax supports various operators. For more information, see [Supported expression operators](/azure/active-directory/enterprise-users/groups-dynamic-membership).-- A `Value` of type String must be enclosed in double quotes ("). You must use a backslash to escape any double quotes inside double quotes. This requirement doesn't apply when using the rule builder in the Azure portal because the expression isn't enclosed in double quotes.
+- A `Value` of type String must be enclosed in double quotes ("). You must use a backslash to escape any double quotes inside double quotes. This requirement doesn't apply when using the rule builder in the Microsoft Entra admin center because the expression isn't enclosed in double quotes.
The following example shows shows a complete rule.
v1.0 Groupwritebackconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groupwritebackconfiguration.md
Title: "groupWritebackConfiguration resource type"
-description: "Indicates whether writeback of cloud groups to on-premise Active Directory is enabled and the target group type for the on-premise group."
+description: "Indicates whether writeback of cloud groups to on-premises Active Directory is enabled and the target group type for the on-premises group."
ms.localizationpriority: medium ms.prod: "groups"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Indicates whether writeback of cloud groups to on-premise Active Directory is enabled and the target group type for the on-premise group.
+Indicates whether writeback of cloud groups to on-premises Active Directory is enabled and the target group type for the on-premises group.
- By default, all Azure AD security groups are not writeback enabled. For Microsoft 365 groups, the default settings that are defined by the properties of this resource can be overwritten by the `NewUnifiedgroupWritebackDefault` [directory setting object](directorysetting.md).
+ By default, all Azure AD security groups aren't writeback enabled. For Microsoft 365 groups, the default settings that are defined by the properties of this resource can be overwritten by the `NewUnifiedgroupWritebackDefault` [directory setting object](directorysetting.md).
Inherits from [writebackConfiguration](../resources/writebackconfiguration.md). ## Properties |Property|Type|Description| |:|:|:|
-|isEnabled|Boolean|Indicates whether writeback of cloud groups to on-premise Active Directory is enabled. Nullable. Default value is `true` for Microsoft 365 groups and `false` for security groups. Inherited from [writebackConfiguration](../resources/writebackconfiguration.md).|
-|onPremisesGroupType|String|Indicates the target on-premise group type the cloud object will be written back as. Nullable. The possible values are: `universalDistributionGroup`, `universalSecurityGroup`, `universalMailEnabledSecurityGroup`.<ol><li>If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: `universalDistributionGroup`, `universalSecurityGroup`, `universalMailEnabledSecurityGroup`. </li><li>Azure AD security groups can be written back as `universalSecurityGroup`. </li><li>If **isEnabled** or the `NewUnifiedGroupWritebackDefault` [group setting](directorysetting.md) is `true` but this property is not explicitly configured: <ul><li>Microsoft 365 groups will be written back as `universalDistributionGroup` by default</li></ul><ul><li>Security groups will be written back as `universalSecurityGroup` by default</li></ul>|
+|isEnabled|Boolean|Indicates whether writeback of cloud groups to on-premises Active Directory is enabled. Nullable. Default value is `true` for Microsoft 365 groups and `false` for security groups. Inherited from [writebackConfiguration](../resources/writebackconfiguration.md).|
+|onPremisesGroupType|String|Indicates the target on-premises group type the cloud object is written back as. Nullable. The possible values are: `universalDistributionGroup`, `universalSecurityGroup`, `universalMailEnabledSecurityGroup`.<ol><li>If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: `universalDistributionGroup`, `universalSecurityGroup`, `universalMailEnabledSecurityGroup`. </li><li>Azure AD security groups can be written back as `universalSecurityGroup`. </li><li>If **isEnabled** or the `NewUnifiedGroupWritebackDefault` [group setting](directorysetting.md) is `true` but this property isn't explicitly configured: <ul><li>Microsoft 365 groups are written back as `universalDistributionGroup` by default</li></ul><ul><li>Security groups are written back as `universalSecurityGroup` by default</li></ul>|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.groupWritebackConfiguration"
v1.0 Hardwareoathauthenticationmethodconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hardwareoathauthenticationmethodconfiguration.md
- Title: "hardwareOathAuthenticationMethodConfiguration resource type"
-description: "Represents a Hardware OATH authentication methods policy."
-
-doc_type: resourcePageType
--
-# hardwareOathAuthenticationMethodConfiguration resource type
-
-Namespace: microsoft.graph
--
-Represents a Hardware OATH authentication method policy. Authentication method policies define configuration settings and users or groups that are enabled to use the authentication method.
-
-Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
-
-## Methods
-|Method|Return type|Description|
-|:|:|:|
-|[Get hardwareOathAuthenticationMethodConfiguration](../api/hardwareoathauthenticationmethodconfiguration-get.md)|[hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md)|Read the properties and relationships of a [hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md) object.|
-|[Update hardwareOathAuthenticationMethodConfiguration](../api/hardwareoathauthenticationmethodconfiguration-update.md)|[hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md)|Update the properties of a [hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md) object.|
-|[Delete hardwareOathAuthenticationMethodConfiguration](../api/hardwareoathauthenticationmethodconfiguration-delete.md)|None|Reverts the hardwareOathAuthenticationMethodConfiguration object to its default configuration.|
-
-## Properties
-|Property|Type|Description|
-|:|:|:|
-|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).|
-|id|String|The authentication method policy identifier. Inherited from [entity](../resources/entity.md).|
-|state|authenticationMethodState|Possible values are: `enabled`, `disabled`. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).|
--
-## Relationships
-|Relationship|Type|Description|
-|:|:|:|
-|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.|
-
-## JSON representation
-The following is a JSON representation of the resource.
-<!-- {
- "blockType": "resource",
- "keyProperty": "id",
- "@odata.type": "microsoft.graph.hardwareOathAuthenticationMethodConfiguration",
- "baseType": "microsoft.graph.authenticationMethodConfiguration",
- "openType": false
-}
>
-``` json
-{
- "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethodConfiguration",
- "id": "String (identifier)",
- "state": "String",
- "excludeTargets": [
- {
- "@odata.type": "microsoft.graph.excludeTarget"
- }
- ]
-}
-```
+
+ Title: "hardwareOathAuthenticationMethodConfiguration resource type"
+description: "Represents a Hardware OATH authentication methods policy."
+
+ms.localizationpriority: medium
++
+# hardwareOathAuthenticationMethodConfiguration resource type
+
+Namespace: microsoft.graph
++
+Represents a Hardware OATH authentication method policy. Authentication method policies define configuration settings and users or groups that are enabled to use the authentication method.
+
+Inherits from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).
+
+## Methods
+|Method|Return type|Description|
+|:|:|:|
+|[Get hardwareOathAuthenticationMethodConfiguration](../api/hardwareoathauthenticationmethodconfiguration-get.md)|[hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md)|Read the properties and relationships of a [hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md) object.|
+|[Update hardwareOathAuthenticationMethodConfiguration](../api/hardwareoathauthenticationmethodconfiguration-update.md)|[hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md)|Update the properties of a [hardwareOathAuthenticationMethodConfiguration](../resources/hardwareoathauthenticationmethodconfiguration.md) object.|
+|[Delete hardwareOathAuthenticationMethodConfiguration](../api/hardwareoathauthenticationmethodconfiguration-delete.md)|None|Reverts the hardwareOathAuthenticationMethodConfiguration object to its default configuration.|
+
+## Properties
+|Property|Type|Description|
+|:|:|:|
+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups of users that are excluded from the policy. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).|
+|id|String|The authentication method policy identifier. Inherited from [entity](../resources/entity.md).|
+|state|authenticationMethodState|Possible values are: `enabled`, `disabled`. Inherited from [authenticationMethodConfiguration](../resources/authenticationmethodconfiguration.md).|
++
+## Relationships
+|Relationship|Type|Description|
+|:|:|:|
+|includeTargets|[authenticationMethodTarget](../resources/authenticationmethodtarget.md) collection|A collection of groups that are enabled to use the authentication method. Expanded by default.|
+
+## JSON representation
+Here's a JSON representation of the resource.
+<!-- {
+ "blockType": "resource",
+ "keyProperty": "id",
+ "@odata.type": "microsoft.graph.hardwareOathAuthenticationMethodConfiguration",
+ "baseType": "microsoft.graph.authenticationMethodConfiguration",
+ "openType": false
+}
+-->
+``` json
+{
+ "@odata.type": "#microsoft.graph.hardwareOathAuthenticationMethodConfiguration",
+ "id": "String (identifier)",
+ "state": "String",
+ "excludeTargets": [
+ {
+ "@odata.type": "microsoft.graph.excludeTarget"
+ }
+ ]
+}
+```
v1.0 Hostsecuritystate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hostsecuritystate.md
Title: "hostSecurityState resource type"
-description: " > **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported."
+description: " > **Important:** APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications isn't supported."
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: security
Contains stateful information about the host (including devices, computers, and
|isAzureAadRegistered|Boolean|True if the host registered with Azure Active Directory Device Registration (BYOD devices - that is, not fully managed by enterprise).| |isHybridAzureDomainJoined|Boolean|True if the host is domain joined to an on-premises Active Directory domain.| |netBiosName|String|The local host name, without the DNS domain name.|
-|os|String|Host Operating System. (For example, Windows10, MacOS, RHEL, etc.).|
+|os|String|Host Operating System. (For example, Windows 10, macOS, RHEL, etc.).|
|privateIpAddress|String|Private (not routable) IPv4 or IPv6 address (see [RFC 1918](https://tools.ietf.org/html/rfc1918)) at the time of the alert.| |publicIpAddress|String|Publicly routable IPv4 or IPv6 address (see [RFC 1918](https://tools.ietf.org/html/rfc1918)) at time of the alert.| |riskScore|String|Provider-generated/calculated risk score of the host. Recommended value range of 0-1, which equates to a percentage.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Hybridagentupdaterconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hybridagentupdaterconfiguration.md
A tenant admin can configure for each onPremisesPublishingProfile the time windo
For example, for the agents in onPremisesPublishingProfile of type "provisioning" the steps could be as below. 1) Tenant administrator can configure to not receive any updates to the Provisioning agents for the next n days.
-2) Tenant administrator can configure an update window(start and end time) during which the agents can recive updates.
-3) Tenant administrator can enable allowUpdateConfigurationOverride which overrides the updater configutration for Provisioning agents and alows them to receive the next available update.
+2) Tenant administrator can configure an update window(start and end time) during which the agents can receive updates.
+3) Tenant administrator can enable allowUpdateConfigurationOverride which overrides the updater configuration for Provisioning agents and allows them to receive the next available update.
-The DateTime/Time information specified in the updater configuration will be converted to the local timezone reported by the agent during evaluvation.
+The DateTime/Time information specified in the updater configuration will be converted to the local timezone reported by the agent during evaluation.
-The update of the agent will follow the below priority list
+The update of the agent follows the below priority list
1) If allowUpdateConfigurationOverride is set to true the updater configuration set by the tenant will be skipped and the agent will receive an update when the next version of the agent is available (priority 1).
-2) If the defer update is set, the agent will not be updated until the defer update date time (priority 2).
-3) If the update window is set, the agent will be updated only during that time window in a 24 hour day (priority 3).
+2) If the defer update is set, the agent won't be updated until the defer update date time (priority 2).
+3) If the update window is set, the agent is updated only during that time window in a 24 hour day (priority 3).
4) If no valid updater configuration is set by the tenant, the agent will receive an update when the next version of the agent is available ## Properties
The update of the agent will follow the below priority list
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Identitybuiltinuserflowattribute https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitybuiltinuserflowattribute.md
Title: "identityBuiltInUserFlowAttribute resource type"
-description: "Represents a built-in user flow attribute in Azure Active Directory tenants that can be used in self-service sign-up user flows."
+description: "Represents a built-in user flow attribute in Azure AD for workforce tenants, Azure AD for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows."
ms.localizationpriority: medium ms.prod: "identity-and-sign-in"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a built-in user flow attribute in Azure Active Directory tenants that can be used in your self-service sign-up user flows. These attributes cannot be modified and are read-only.
+Represents a built-in user flow attribute in Azure AD for workforce tenants, Azure AD for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows. These attributes can't be modified and are read-only.
Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).
Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute
|Property|Type|Description| |:|:|:|
-|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)|
+|id|String|The identifier of the user flow attribute and is a read-only attribute that is automatically created. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)|
|displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.| |description|String|The description of the user flow attribute that's shown to the user at the time of sign-up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|
-|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. This is a read-only attribute that is automatically set. The value for this property will be `builtIn`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|
-|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This cannot be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|
+|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute and is a read-only attribute that is automatically set. The value for this property will be `builtIn`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|
+|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute and can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md). Read-only.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Identitycustomuserflowattribute https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitycustomuserflowattribute.md
Title: "identityCustomUserFlowAttribute resource type"
-description: "Represents a custom user flow attribute in Azure Active Directory tenants that can be used in your self-service sign-up user flows."
+description: "Represents a custom user flow attribute in Azure AD for workforce tenants, Azure AD for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows."
ms.localizationpriority: medium ms.prod: "identity-and-sign-in"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents a custom user flow attribute in Azure Active Directory tenants that can be used in your self-service sign-up user flows. These attributes cannot be modified and are read-only.
+Represents a custom user flow attribute in Azure AD for workforce tenants, Azure AD for customers tenants, and Azure AD B2C tenants that can be used in self-service sign-up user flows.
Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).
Inherits from [identityUserFlowAttribute](../resources/identityuserflowattribute
|displayName|String|The display name of the user flow attribute. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| |description|String|The description of the user flow attribute that's shown to the user at the time of sign-up. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md)| |userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. This is a read-only attribute that is automatically set. The value for this property will be `custom`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).|
-|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This cannot be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).|
+|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This can't be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`. Inherited from [identityUserFlowAttribute](../resources/identityuserflowattribute.md).|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Identitygovernance Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-overview.md
ms.prod: "governance" doc_type: conceptualPageType Last updated 11/29/2022+ # Overview of Azure AD Identity Governance using Microsoft Graph
When a principal has access to resources in your organization, it's important to
For example, suppose your organization automates employee access to a specific business-sensitive resource. For guests, you've granted them access to the resource through a group. It's important to periodically confirm that the guests still have a legitimate need for access to the group and by extension, the resource.
-Access reviews are a form of auditing the effectiveness of the organizationΓÇÖs internal controls. For more information, see the [overview of access reviews](/graph/api/resources/accessreviewsv2-overview).
+Access reviews are a form of auditing the effectiveness of the organization's internal controls. For more information, see the [overview of access reviews](/graph/api/resources/accessreviewsv2-overview).
## Manage access to privileged roles
The [privileged identity management APIs](/graph/api/resources/privilegedidentit
## Enforce terms of use for your resources
-Every organization has its terms and conditions that users may need to abide by before they can access the organizationΓÇÖs resources. You can define and enforce these terms and conditions through Azure AD Terms of Use.
+Every organization has its terms and conditions that users may need to abide by before they can access the organization's resources. You can define and enforce these terms and conditions through Azure AD Terms of Use.
Terms of use can be a general company policy for all users in your organization; or terms for individual users like guests and contractors; or terms that users must agree to before they can use a sensitive app in the tenant. The [terms of use APIs](/graph/api/resources/agreement) in Microsoft Graph allow you to configure the terms and conditions that users may need to accept and agree to before they can access your resources.
-## Identity governance and Zero Trust
+<!-- Start of: Link to ZT guidance: H2 section -->
-With identities being the common denominator when considering the security of your data, identity governance APIs in Microsoft Graph help your organization to achieve the [Identity Zero Trust deployment objectives](#see-also).
+
+<!-- End of: Link to ZT guidance -->
## See also + [What is Azure AD Identity Governance?](/azure/active-directory/governance/identity-governance-overview) + [Azure AD built-in roles](/azure/active-directory/roles/permissions-reference)
-+ [Securing identity with Zero Trust](/security/zero-trust/deploy/identity#iv-identities-and-access-privileges-are-managed-with-identity-governance)
++
+<!-- {
+ "type": "#page.annotation",
+ "description": "",
+ "keywords": "",
+ "section": "documentation",
+ "suppressions": [
+ "Error: /resources/identitygovernance-overview.md:
+ Exception processing links.
+ Link Definition was null. Link text: !INCLUDE zero-trust (Parameter 'Definition')"
+ ]
+} -->
v1.0 Identitygovernance Workflowbase https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflowbase.md
None.
|description|String|A string that describes the purpose of the workflow.| |displayName|String|A string to identify the workflow.| |executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines when and for who the workflow will run.|
-|isEnabled|Boolean|Whether the workflow is enabled or disabled. If this setting is `true`, the workflow can be run on demand or on schedule when **isSchedulingEnabled** is `true`.|
-|isSchedulingEnabled|Boolean|If `true`, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Cannot be `true` for a disabled workflow (where **isEnabled** is `false`).|
+|isEnabled|Boolean|Determines whether the workflow is enabled or disabled. If this setting is `true`, the workflow can be run on demand or on schedule when **isSchedulingEnabled** is `true`.|
+|isSchedulingEnabled|Boolean|If `true`, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can't be `true` for a disabled workflow (where **isEnabled** is `false`).|
|lastModifiedDateTime|DateTimeOffset|When the workflow was last modified.| ## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Identitygovernance Workflowexecutiontrigger https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflowexecutiontrigger.md
Namespace: microsoft.graph.identityGovernance
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-This is an abstract type that represents the workflow execution trigger when the [workflow runs on schedule](../resources/identitygovernance-triggerandscopebasedconditions.md). It is inherited by the following derived types:
+This is an abstract type that represents the workflow execution trigger when the [workflow runs on schedule](../resources/identitygovernance-triggerandscopebasedconditions.md). It's inherited by the following derived types:
+ [timeBasedAttributeTrigger](../resources/identitygovernance-timebasedattributetrigger.md) ## Properties
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionTrigger"
v1.0 Identityuserflowattribute https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityuserflowattribute.md
Title: "identityUserFlowAttribute resource type"
-description: "Represents user flow attributes in an Azure Active Directory tenant and an Azure AD B2C tenant."
+description: "Represents attributes that can be added to a user flow in an Azure AD workforce tenant, an Azure AD for customers tenant, and an Azure AD B2C tenant."
+ms.localizationpriority: medium
doc_type: resourcePageType ms.prod: "identity-and-sign-in"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents user flow attributes in an Azure Active Directory (Azure AD) tenant and an Azure AD B2C tenant.
+Represents attributes that can be added to a user flow in an Azure AD workforce tenant, an Azure AD for customers tenant, and an Azure AD B2C tenant.
-Configuring user flow attributes in your Azure AD or Azure AD B2C tenant allows you to collect information about a user during sign-up. You can choose to collect a built-in set of attribute; for example, Given Name, Surname, City, and Postal Code. You can also configure custom user flow attributes to collect information from a user that is not built in to the directory. Custom user flow attributes are an abstraction over [Azure Active Directory schema extensions](/azure/active-directory/develop/active-directory-schema-extensions).
+Configuring user flow attributes in your Azure AD or Azure AD B2C tenant allows you to collect information about a user during sign-up. You can choose to collect a built-in set of attribute; for example, Given Name, Surname, City, and Postal Code; or you can configure custom user flow attributes. Custom user flow attributes are an abstraction over [directory extensions](/graph/extensibility-overview#directory-azure-ad-extensions).
[identityBuiltInUserFlowAttributes](../resources/identitybuiltinuserflowattribute.md) and [identityCustomUserFlowAttributes](../resources/identitycustomuserflowattribute.md) both inherit from this base type.
Configuring user flow attributes in your Azure AD or Azure AD B2C tenant allows
|Property|Type|Description| |:|:--|:-|
-|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created.|
-|displayName|String|The display name of the user flow attribute.|
+|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This cannot be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`).|
+|displayName|String|The display name of the user flow attribute. <br/><br/> Supports `$filter` (`eq`, `ne`). |
|description|String|The description of the user flow attribute that's shown to the user at the time of sign-up.|
-|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. This is a read-only attribute that is automatically set. Depending on the type of attribute, the values for this property will be `builtIn`, `custom`, or `required`.|
-|dataType|identityUserFlowAttributeDataType|The data type of the user flow attribute. This cannot be modified after the custom user flow attribute is created. The supported values for **dataType** are: `string` , `boolean` , `int64` , `stringCollection` , `dateTime`.|
+|id|String|The identifier of the user flow attribute. This is a read-only attribute that is automatically created. <br/><br/> Supports `$filter` (`eq`, `ne`). |
+|userFlowAttributeType|identityUserFlowAttributeType|The type of the user flow attribute. This is a read-only attribute that is automatically set. Depending on the type of attribute, the values for this property will be `builtIn`, `custom`, `required`, `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`, `ne`). |
## JSON representation
v1.0 Importstatusmodel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/importstatusmodel.md
Title: "importStatusModel resource type"
-description: "Here is a JSON representation of the importStatusModel resource."
+description: "Here's a JSON representation of the importStatusModel resource."
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: non-product-specific
Namespace: microsoft.graph
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Incompletedata https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/incompletedata.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] The **incompleteData** facet indicates that a resource was generated with incomplete data.
-The properties within may provide information about why there is incomplete data.
+The properties within may provide information about why there's incomplete data.
## JSON representation
The properties within may provide information about why there is incomplete data
| Property | Type | Description |:--|:|:--
-| missingDataBeforeDateTime | DateTimeOffset | The service does not have source data before the specified time.
-| wasThrottled | Boolean | Some data was not recorded due to excessive activity.
+| missingDataBeforeDateTime | DateTimeOffset | The service doesn't have source data before the specified time.
+| wasThrottled | Boolean | Some data wasn't recorded due to excessive activity.
<!-- {
v1.0 Insights Used https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-used.md
Title: "usedInsight resource type"
-description: "An insight representing documents used by a specific user. The insights returns the most relevant documents that a user viewed or modified."
+description: "An insight representing documents used by a specific user. The insights return the most relevant documents that a user viewed or modified."
ms.localizationpriority: medium ms.prod: "insights"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-An insight representing documents used by a specific user. The insights returns the most relevant documents that a user viewed or modified. This includes documents in:
+An insight representing documents used by a specific user. The insights return the most relevant documents that a user viewed or modified. This includes documents in:
- OneDrive for Business - SharePoint
An insight representing documents used by a specific user. The insights returns
| resource | [entity](entity.md) collection | Used for navigating to the item that was used. For file attachments, the type is *fileAttachment*. For linked attachments, the type is *driveItem*. | ## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- { "blockType": "resource",
v1.0 Invalidlicensealertincident https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invalidlicensealertincident.md
Title: "invalidLicenseAlertIncident resource type"
-description: "Represents the details of an alert incident that is triggered if the current tenant does not have a valid Azure AD Premium P2 license."
+description: "Represents the details of an alert incident that is triggered if the current tenant doesn't have a valid Azure AD Premium P2 license."
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the details of an alert incident that is triggered if the current tenant does not have a valid Azure AD Premium P2 license.
+Represents the details of an alert incident that is triggered if the current tenant doesn't have a valid Azure AD Premium P2 license.
Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md).
Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanag
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Invitation https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invitation.md
The invitation process uses the following flow:
* An invitation is created * An invitation is sent to the invited user (containing an invitation link)
-* The invited user clicks on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes
+* The invited user select on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes
* The user is redirected to a specific page after redemption completes
-Creating an invitation will return a redemption URL in the response (*inviteRedeemUrl*). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the *sendInvitationMessage* to true. You can also customize the message that will be sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the *sendInvitationMessage* to false and use the redeem URL from the response to craft your own communication. Currently, there is no API to perform the redemption process. The invited user has to click on the *inviteRedeemUrl* link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization.
+Creating an invitation returns a redemption URL in the response (*inviteRedeemUrl*). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the *sendInvitationMessage* to true. You can also customize the message that is sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the *sendInvitationMessage* to false and use the redeem URL from the response to craft your own communication. Currently, there's no API to perform the redemption process. The invited user has to select the *inviteRedeemUrl* link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization.
>[!NOTE] >The invitation status is tracked using the **externalUserState** and the **externalUserStateChangeDateTime** properties on the external [user](user.md) resource created as part of the invitation request.
Creating an invitation will return a redemption URL in the response (*inviteRede
| Property | Type |Description| |:|:--|:-| |invitedUserDisplayName|String|The display name of the user being invited.|
-|invitedUserEmailAddress|String|The email address of the user being invited. Required. The following special characters are not permitted in the email address:<br><ul><li>Tilde (~)</li><li>Exclamation point (`!`)</li><li>At sign (`@`)</li><li>Number sign (`#`)</li><li>Dollar sign (`$`)</li><li>Percent (`%`)</li><li>Circumflex (`^`)</li><li>Ampersand (`&`)</li><li>Asterisk (`*`)</li><li>Parentheses (`( )`)</li><li>Hyphen (`-`)</li><li>Plus sign (`+`)</li><li>Equal sign (`=`)</li><li>Brackets (`[ ]`)</li><li>Braces (`{ }`)</li><li>Backslash (`\`)</li><li>Slash mark (`/`)</li><li>Pipe (`|`)</li><li>Semicolon (`;`)</li><li>Colon (`:`)</li><li>Quotation marks (`"`)</li><li>Angle brackets (`< >`)</li><li>Question mark (`?`)</li><li>Comma (`,`)</li></ul><br>However, the following exceptions apply:<br><ul><li>A period (`.`) or a hyphen (`-`) is permitted anywhere in the user name, except at the beginning or end of the name.</li><li>An underscore (`_`) is permitted anywhere in the user name. This includes at the beginning or end of the name.</li></ul>|
+|invitedUserEmailAddress|String|The email address of the user being invited. Required. The following special characters aren't permitted in the email address:<br><ul><li>Tilde (~)</li><li>Exclamation point (`!`)</li><li>At sign (`@`)</li><li>Number sign (`#`)</li><li>Dollar sign (`$`)</li><li>Percent (`%`)</li><li>Circumflex (`^`)</li><li>Ampersand (`&`)</li><li>Asterisk (`*`)</li><li>Parentheses (`( )`)</li><li>Hyphen (`-`)</li><li>Plus sign (`+`)</li><li>Equal sign (`=`)</li><li>Brackets (`[ ]`)</li><li>Braces (`{ }`)</li><li>Backslash (`\`)</li><li>Slash mark (`/`)</li><li>Pipe (`|`)</li><li>Semicolon (`;`)</li><li>Colon (`:`)</li><li>Quotation marks (`"`)</li><li>Angle brackets (`< >`)</li><li>Question mark (`?`)</li><li>Comma (`,`)</li></ul><br>However, the following exceptions apply:<br><ul><li>A period (`.`) or a hyphen (`-`) is permitted anywhere in the user name, except at the beginning or end of the name.</li><li>An underscore (`_`) is permitted anywhere in the user name. This includes at the beginning or end of the name.</li></ul>|
|invitedUserMessageInfo|[invitedUserMessageInfo](invitedusermessageinfo.md)|Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.| |inviteRedirectUrl|String|The URL user should be redirected to once the invitation is redeemed. Required.| |inviteRedeemUrl|String|The URL the user can use to redeem their invitation. Read-only.|
-|invitedUserType|String|The userType of the user being invited. By default, this is `Guest`. You can invite as `Member` if you're are company administrator. The default is `false`. |
+|invitedUserType|String|The userType of the user being invited. By default, this is `Guest`. You can invite as `Member` if you're a company administrator. The default is `false`. |
|resetRedemption|Boolean|Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. For more information about using this property, see [Reset redemption status for a guest user (Preview)](/azure/active-directory/external-identities/reset-redemption-status#use-microsoft-graph-api-to-reset-redemption-status).| |sendInvitationMessage|Boolean|Indicates whether an email should be sent to the user being invited. The default is `false`.| |status|String|The status of the invitation. Possible values: `PendingAcceptance`, `Completed`, `InProgress`, and `Error`|
Creating an invitation will return a redemption URL in the response (*inviteRede
|invitedUserSponsors|[directoryObject](../resources/directoryobject.md) collection|The users or groups who are sponsors of the invited user. Sponsors are users and groups that are responsible for guest users' privileges in the tenant and for keeping the guest users' information and access up to date. | ## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- {
v1.0 Invitedusermessageinfo https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invitedusermessageinfo.md
The invitedUserMessageInfo object allows you to configure the [invitation](invit
## Properties | Property | Type |Description| |:|:--|:-|
-|ccRecipients|[recipient](recipient.md) collection|Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported.|
+|ccRecipients|[recipient](recipient.md) collection|Additional recipients the invitation message should be sent to. Currently only one additional recipient is supported.|
|customizedMessageBody|String|Customized message body you want to send if you don't want the default message.| |messageLanguage|String|The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US.| ## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- {"blockType": "resource", "@odata.type": "microsoft.graph.invitedUserMessageInfo"} --> ```json
v1.0 Ipv4cidrrange https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ipv4cidrrange.md
Inherits from [ipRange](../resources/iprange.md)
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Ipv6cidrrange https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ipv6cidrrange.md
Inherits from [ipRange](../resources/iprange.md)
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Itemretentionlabel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/itemretentionlabel.md
+
+ Title: "itemRetentionLabel resource type"
+description: "Groups retention and compliance-related properties on an item into a single structure."
+
+ms.localizationpriority: medium
++
+# itemRetentionLabel resource type
+
+Namespace: microsoft.graph
++
+Groups retention and compliance-related properties on an item into a single structure. Currently, supported only for [driveItem](../resources/driveitem.md).
+
+## Properties
+
+| Property | Type | Description |
+|:-|:--|:-|
+| isLabelAppliedExplicitly | Boolean | Specifies whether the label is applied explicitly on the item. `True` indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only. |
+| labelAppliedBy | [identitySet](../resources/identityset.md) | Identity of the user who applied the label. Read-only. |
+| labelAppliedDateTime | DateTimeOffset | The date and time when the label was applied on the item. The DateTimeOffset 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. |
+| name | String | The retention label on the document. Read-write. |
+| retentionSettings | [retentionLabelSettings](../resources/retentionlabelsettings.md) | The retention settings enforced on the item. Read-write. |
+
+## JSON representation
+
+The following shows an example of a JSON representation of the resource.
+
+<!-- {
+"blockType": "resource",
+"@odata.type": "microsoft.graph.itemRetentionLabel",
+"optionalProperties": []
+}-->
+
+```json
+{
+ "isLabelAppliedExplicitly": "Boolean",
+ "labelAppliedBy": { "@odata.type": "microsoft.graph.identitySet" },
+ "labelAppliedDateTime": "String (timestamp)",
+ "name": "String",
+ "retentionSettings": { "@odata.type": "microsoft.graph.retentionLabelSettings" }
+}
+```
v1.0 Keycredentialconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/keycredentialconfiguration.md
Title: "keyCredentialConfiguration resource type"
-description: "Key credential configuration complex type to configure key credential restriction, maxLifetime, and enforcement date"
+description: "Represents a key credential configuration object that contains properties to configure restrictions for application certificates."
ms.localizationpriority: medium ms.prod: "identity-and-sign-in"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Key credential configuration object that contains properties to configure restrictions such as restricting the lifetime of key secrets.
+Represents a key credential configuration object that contains properties to configure restrictions for application certificates.
## Properties | Property | Type | Description | | :- | : | :-- |
-| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. |
| maxLifeTime | Duration |Value that can be used as the maximum duration in days, hours, minutes, or seconds from the date of key creation, for which the key is valid. Defined in ISO 8601 format for Durations. For example, `P4DT12H30M5S` represents a duration of four days, twelve hours, thirty minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`. | | restrictForAppsCreatedAfterDateTime | DateTimeOffset | Timestamp when the policy is enforced for all apps created on or after the specified date. For existing applications, the enforcement date would be back dated. To apply to all applications regardless of their creation date, this property would be `null`. Nullable. |
+| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. |
## Relationships
The following is a JSON representation of the resource.
```json { "@odata.type": "#microsoft.graph.keyCredentialConfiguration",
- "restrictionType": {
- "@odata.type": "microsoft.graph.appKeyCredentialRestrictionType"
- },
"maxLifetime": "String (duration)",
- "restrictForAppsCreatedAfterDateTime": "DateTimeOffset"
+ "restrictForAppsCreatedAfterDateTime": "String (timestamp)",
+ "restrictionType": "String"
} ```
v1.0 Keyvalue https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/keyvalue.md
Title: "keyValue resource type"
-description: "Provides additional relevant information about the sign-in request"
+description: "Provides more relevant information about the sign-in request"
ms.localizationpriority: medium ms.prod: "identity-and-access-reports"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Provides additional authentication processing information, such as the server name and the presence of hints for sign in and domain.
+Provides more authentication processing information, such as the server name and the presence of hints for sign in and domain.
The configuration of this resource is shared by the following objects: + The **attributeCollection** property of the [contentCustomization](contentcustomization.md) complex type of [organizationalBrandingProperties](organizationalbrandingproperties.md). + The **additionalDetails** property of the [directoryAudit](directoryaudit.md) resource type.
The configuration of this resource is shared by the following objects:
| Attribute_Country | Country/Region | | Attribute_DisplayName | Display Name | | Attribute_Email | Email Address |
-| Attribute_Generic_ConfirmationLabel | Re-enter |
+| Attribute_Generic_ConfirmationLabel | Reenter |
| Attribute_GivenName | Given Name | | Attribute_JobTitle | Job Title | | Attribute_Password | Password |
-| Attribute_Password_MismatchErrorString | Passwords do not match. |
+| Attribute_Password_MismatchErrorString | Passwords don't match. |
| Attribute_PostalCode | Postal Code | | Attribute_State | State/Province | | Attribute_StreetAddress | Street Address |
The configuration of this resource is shared by the following objects:
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Licenseassignmentstate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/licenseAssignmentState.md
Title: "licenseAssignmentState resource type"
-description: "The **licenseAssignmentStates** property of the user entity is a collection of **licenseAssignmentState**. It provides details about license assignments to a user. The details includes information like: "
+description: "The **licenseAssignmentStates** property of the user entity is a collection of **licenseAssignmentState**. It provides details about license assignments to a user. The details include information like: "
ms.localizationpriority: medium doc_type: resourcePageType ms.prod: "users"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-The **licenseAssignmentStates** property of the [user](user.md) entity is a collection of **licenseAssignmentState**. It provides details about license assignments to a user. The details includes information like:
+The **licenseAssignmentStates** property of the [user](user.md) entity is a collection of **licenseAssignmentState**. It provides details about license assignments to a user. The details include information like:
- What plans are disabled for a user - Whether the license was assigned to the user directly or inherited from a group
The **licenseAssignmentStates** property of the [user](user.md) entity is a coll
|:|:--|:-| |assignedByGroup|String|Indicates whether the license is directly-assigned or inherited from a group. If directly-assigned, this field is `null`; if inherited through a group membership, this field contains the ID of the group. Read-Only.| |disabledPlans|String collection|The service plans that are disabled in this assignment. Read-Only.|
-|error|String|License assignment failure error. If the license is assigned successfully, this field will be Null. Read-Only. The possible values are `CountViolation`, `MutuallyExclusiveViolation`, `DependencyViolation`, `ProhibitedInUsageLocationViolation`, `UniquenessViolation`, and `Other`. For more information on how to identify and resolve license assignment errors see [here](/azure/active-directory/users-groups-roles/licensing-groups-resolve-problems).|
+|error|String|License assignment failure error. If the license is assigned successfully, this field will be Null. Read-Only. The possible values are `CountViolation`, `MutuallyExclusiveViolation`, `DependencyViolation`, `ProhibitedInUsageLocationViolation`, `UniquenessViolation`, and `Other`. For more information on how to identify and resolve license assignment errors, see [here](/azure/active-directory/users-groups-roles/licensing-groups-resolve-problems).|
|lastUpdatedDateTime|DateTimeOffset|The timestamp when the state of the license assignment was last updated.| |skuId|String|The unique identifier for the SKU. Read-Only.| |state|String|Indicate the current state of this assignment. Read-Only. The possible values are `Active`, `ActiveWithError`, `Disabled`, and `Error`.| ## JSON representation
-Here is a JSON representation of the resource
+Here's a JSON representation of the resource
<!-- { "blockType": "resource",
v1.0 Licenseunitsdetail https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/licenseunitsdetail.md
The **prepaidUnits** property of the [subscribedSku](subscribedsku.md) entity is
| Property | Type | Description | | :-- | :- | :- | | enabled | Int32 | The number of units that are enabled for the active subscription of the service SKU. |
-| lockedOut | Int32 | The number of units that are locked out because the customer cancelled their subscription of the service SKU. |
-| suspended | Int32 | The number of units that are suspended because the subscription of the service SKU has been cancelled. The units cannot be assigned but can still be reactivated before they are deleted. |
-| warning | Int32 | The number of units that are in warning status. When the subscription of the service SKU has expired, the customer has a grace period to renew their subscription before it is cancelled (moved to a `suspended` state). |
+| lockedOut | Int32 | The number of units that are locked out because the customer canceled their subscription of the service SKU. |
+| suspended | Int32 | The number of units that are suspended because the subscription of the service SKU has been canceled. The units can't be assigned but can still be reactivated before they're deleted. |
+| warning | Int32 | The number of units that are in warning status. When the subscription of the service SKU has expired, the customer has a grace period to renew their subscription before it's canceled (moved to a `suspended` state). |
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Loginpagelayoutconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/loginPageLayoutConfiguration.md
Contains details of the layout of the sign-in page for a tenant.
|Property|Type|Description| |:|:|:|
-| layoutTemplateType | layoutTemplateType | Represents the layout template to be displayed on the login page for a tenant. The possible values are <ul><li> `default` - Represents the default Microsoft layout with a centered lightbox. <li> `verticalSplit` - Represents a layout with a backgound on the left side and a full-height lightbox to the right. <li> `unknownFutureValue` - Evolvable enumeration sentinel value. Do not use. </ul> |
+| layoutTemplateType | layoutTemplateType | Represents the layout template to be displayed on the login page for a tenant. The possible values are <ul><li> `default` - Represents the default Microsoft layout with a centered lightbox. <li> `verticalSplit` - Represents a layout with a background on the left side and a full-height lightbox to the right. <li> `unknownFutureValue` - Evolvable enumeration sentinel value. Don't use. </ul> |
| isHeaderShown | Boolean | Option to show the header on the sign-in page. | | isFooterShown | Boolean | Option to show the footer on the sign-in page. |
Contains details of the layout of the sign-in page for a tenant.
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.loginPageLayoutConfiguration"
v1.0 Managedtenants Auditevent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/managedtenants-auditevent.md
Represents an audit event for managed tenants in Microsoft 365 Lighthouse.
## Properties |Property|Type|Description| |:|:|:|
-|activity|String|A string which uniquely represents the operation that occurred. Required. Read-only.|
-|activityDateTime|DateTimeOffset|The time when the activity ocurred. Required. Read-only.|
+|activity|String|A string that uniquely represents the operation that occurred. Required. Read-only.|
+|activityDateTime|DateTimeOffset|The time when the activity occurred. Required. Read-only.|
|activityId|String|The identifier of the activity request that made the audit event. Required. Read-only.|
-|category|String|A category which represents a logical grouping of activities. Required. Read-only.|
+|category|String|A category that represents a logical grouping of activities. Required. Read-only.|
|httpVerb|String|The HTTP verb that was used when making the API request. Required. Read-only.| |id|String|The unique identifier of the audit event. Required. Read-only.| |initiatedByAppId|String|The identifier of the app that was used to make the request. Required. Read-only.|
Represents an audit event for managed tenants in Microsoft 365 Lighthouse.
|ipAddress|String|The IP address of where the activity was initiated. This may be an IPv4 or IPv6 address. Required. Read-only.| |requestBody|String|The raw HTTP request body. Some sensitive information may be removed.| |requestUrl|String|The raw HTTP request URL. Required. Read-only.|
-|tenantIds|String|The collection of Azure Active Directory tenant identifiers for the [managed tenants](../resources/managedtenants-tenant.md) that were impacted by this change. This is formatted as a list of comma-separated values. Required. Read-only.|
-|tenantNames|String|The collection of tenant names that were impacted by this change. This is formatted as a list of comma-separated values. Required. Read-only.|
+|tenantIds|String|The collection of Azure Active Directory tenant identifiers for the [managed tenants](../resources/managedtenants-tenant.md) that were affected by a change, and is formatted as a list of comma-separated values. Required. Read-only.|
+|tenantNames|String|The collection of tenant names that were affected by a change, and is formatted as a list of comma-separated values. Required. Read-only.|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Microsoftmanageddesktop https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoftManagedDesktop.md
Represents specific settings for the Microsoft Managed Desktop that enables cust
|Member|Description| |:|:|
-|notManaged|The device is not managed by Microsoft Managed Desktop.|
-|premiumManaged|The device is managed by Microsoft Managed Desktop premium plan.|
-|standardManaged|The device is managed by Microsoft Managed Desktop standard plan.|
-|starterManaged|The device is managed by Microsoft Managed Desktop starter plan.|
-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.|
+|notManaged|Microsoft Managed Desktop doesn't manage this device.|
+|premiumManaged| Microsoft Managed Desktop premium plan manages this device.|
+|standardManaged| Microsoft Managed Desktop standard plan manages this device.|
+|starterManaged| Microsoft Managed Desktop starter plan manages this device.|
+|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.|
## Relationships
None.
## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.microsoftManagedDesktop"
v1.0 Microsoftauthenticatorauthenticationmethodtarget https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/microsoftauthenticatorauthenticationmethodtarget.md
A collection of groups enabled to use [Microsoft Authenticator authentication me
|authenticationMode|microsoftAuthenticatorAuthenticationMode|Determines which types of notifications can be used for sign-in. The possible values are: `deviceBasedPush` (passwordless only), `push`, and `any`.| |id|String|Object identifier of an Azure AD user or group. Inherited from [authenticationMethodTarget](authenticationmethodtarget.md).| |isRegistrationRequired|Boolean|Determines whether the user is enforced to register the authentication method. Inherited from [authenticationMethodTarget](authenticationmethodtarget.md). **Not supported**. |
-|targetType|authenticationMethodTargetType| Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets will remain but we recommend to move the individual users to a targeted group. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).|
+|targetType|authenticationMethodTargetType| Possible values are: `group`, and `unknownFutureValue`. From December 2022, targeting individual users using `user` is no longer recommended. Existing targets remain but we recommend moving the individual users to a targeted group. Inherited from [authenticationMethodTarget](authenticationMethodTarget.md).|
|numberMatchingRequiredState (deprecated)|advancedConfigState|Requires number matching for MFA notifications. Value is ignored for phone sign-in notifications. Possible values are: `enabled`, `disabled`, `default`.|
-|displayAppInformationRequiredState (deprecated)|advancedConfigState|Determines whether the user is shown additional context in their Authenticator app notification. In the body of the Authenticator notification, the user will be shown the app they are signing into along with the location that the authentication request originated from. Possible values are: `enabled`, `disabled`, `default`.|
+|displayAppInformationRequiredState (deprecated)|advancedConfigState|Determines whether the user is shown more context in their Authenticator app notification. In the body of the Authenticator notification, the user is shown the app they're signing into along with the location that the authentication request originated from. Possible values are: `enabled`, `disabled`, `default`.|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Multivaluelegacyextendedproperty https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/multivaluelegacyextendedproperty.md
open extensions or extended properties, and how to specify extended properties.
| Method | Return Type |Description| |:|:--|:-|
-|[Post](../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md) | A supported resource instance: [message](../resources/message.md), [mailFolder](../resources/mailfolder.md), [event](../resources/event.md), [calendar](../resources/calendar.md), [contact](../resources/contact.md), [contactFolder](../resources/contactfolder.md), [Outlook task](../resources/outlooktask.md), or [Outlook task folder](../resources/outlooktaskfolder.md). Note that group [post](../resources/post.md) is not supported. | Create a **multiValueLegacyExtendedProperty** in a new or existing instance of a supported resource. |
+|[Post](../api/multivaluelegacyextendedproperty-post-multivalueextendedproperties.md) | A supported resource instance: [message](../resources/message.md), [mailFolder](../resources/mailfolder.md), [event](../resources/event.md), [calendar](../resources/calendar.md), [contact](../resources/contact.md), [contactFolder](../resources/contactfolder.md), [Outlook task](../resources/outlooktask.md), or [Outlook task folder](../resources/outlooktaskfolder.md). Group [post](../resources/post.md) isn't supported. | Create a **multiValueLegacyExtendedProperty** in a new or existing instance of a supported resource. |
|[Get](../api/multivaluelegacyextendedproperty-get.md) |A supported resource instance ([message](../resources/message.md), [mailFolder](../resources/mailfolder.md), [event](../resources/event.md), [calendar](../resources/calendar.md), [contact](../resources/contact.md), [contactFolder](../resources/contactfolder.md), [Outlook task](../resources/outlooktask.md), [Outlook task folder](../resources/outlooktaskfolder.md), or group [post](../resources/post.md)) expanded with a [multiValueLegacyExtendedProperty](multivaluelegacyextendedproperty.md) object. |Get a resource instance with an extended property using `$expand`.| ## Properties
None
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Networkaccess Conditionalaccesssettings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-conditionalaccesssettings.md
Title: "conditionalAccessSettings resource type"
-description: "Conditional access settings defines how you can restore users source IP and how you can use compliant network validation to ensure that the user is connecting from a verified network."
+description: "Conditional access settings define how you can restore users source IP and how you can use compliant network validation to ensure that the user is connecting from a verified network."
ms.localizationpriority: medium ms.prod: identity-and-access
Namespace: microsoft.graph.networkaccess
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Conditional access settings defines how you can restore users source IP and how you can use compliant network validation. Source IP restoration preserves your original user IP context for all AAD and M365 traffic, and compliant network validation ensures the user is connecting from a verified network.
+Conditional access settings define how you can restore users source IP and how you can use compliant network validation. Source IP restoration preserves your original user IP context for all Azure Active Directory and Microsoft 365 traffic, and compliant network validation ensures the user is connecting from a verified network.
For more information about conditional access settings, see [Universal Conditional Access through Global Secure Access](https://github.com/azure/global-secure-access/how-to-target-resource) and [Source IP restoration](https://github.com/azure/global-secure-access/how-to-universal-tenant-restrictions).
Inherits from [microsoft.graph.entity](../resources/entity.md).
|Property|Type|Description| |:|:|:| |id|String|Identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).|
-|signalingStatus|microsoft.graph.networkaccess.status|When SignalingStatus is enabled, the Conditional Access policy includes zero trust network access information.The possible values are: `enabled`, `disabled`.|
+|signalingStatus|microsoft.graph.networkaccess.status|When SignalingStatus is enabled, the Conditional Access policy includes zero trust network access information. The possible values are: `enabled`, `disabled`.|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess Connectivity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-connectivity.md
None.
## Relationships |Relationship|Type|Description| |:|:|:|
-|branches|[microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) collection|Branch represent locations for connectivity.|
+|branches|[microsoft.graph.networkaccess.branchSite](../resources/networkaccess-branchsite.md) collection|Branches represent locations for connectivity.|
## JSON representation
-The following is a JSON representation of the resource.
+Here's is a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess Forwardingpolicy https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-forwardingpolicy.md
Title: "forwardingPolicy resource type"
-description: "A forwarding policy defines the specific traffic that is routed through the Global Secure Access services. It is then added to a forwarding profile."
+description: "A forwarding policy defines the specific traffic that is routed through the Global Secure Access services. It's then added to a forwarding profile."
ms.localizationpriority: medium ms.prod: identity-and-access
Namespace: microsoft.graph.networkaccess
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-A forwarding policy defines the specific traffic that is routed through the Gloval Secure Access services. It is then added to a [forwarding profile](networkaccess-forwardingprofile.md).
+A forwarding policy defines the specific traffic that is routed through the Global Secure Access services. It's then added to a [forwarding profile](networkaccess-forwardingprofile.md).
Inherits from [microsoft.graph.networkaccess.policy](../resources/networkaccess-policy.md).
Inherits from [microsoft.graph.networkaccess.policy](../resources/networkaccess-
|policyRules|[microsoft.graph.networkaccess.policyRule](../resources/networkaccess-policyrule.md) collection| Represents the definition of the policy ruleset that makes up the core definition of a policy. Inherited from [microsoft.graph.networkaccess.policy](../resources/networkaccess-policy.md). Supports `$expand`.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess Global Secure Access Api Overview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-global-secure-access-api-overview.md
ms.localizationpriority: medium ms.prod: "governance" doc_type: resourcePageType+ # Secure access to cloud, public, and private apps using Microsoft Graph network access APIs
You can also retrieve summarized counts of traffic relating to devices, users, t
The Global Secure Access services enable you to enrich the [Microsoft 365 audit logs](/microsoft-365/compliance/audit-log-search?view=o365-worldwide&preserve-view=true) with network traffic information. With enriched traffic logs, you can review network diagnostic data, performance data, and security events relevant to Microsoft 365 apps. Traffic relating to the following three Microsoft 365 workloads can be enriched with network traffic information: SharePoint, Microsoft Teams, and Exchange Online.
+<!-- Start of: Link to ZT guidance: H2 section -->
++
+<!-- End of: Link to ZT guidance -->
+ ## See also -- [What is Global Secure Access?](/azure/global-secure-access/overview-what-is-global-secure-access)
+- [What is Global Secure Access?](/azure/global-secure-access/overview-what-is-global-secure-access)
++
+<!-- {
+ "type": "#page.annotation",
+ "description": "",
+ "keywords": "",
+ "section": "documentation",
+ "suppressions": [
+ "Error: /resources/networkaccess-global-secure-access-api-overview.md:
+ Exception processing links.
+ Link Definition was null. Link text: !INCLUDE zero-trust (Parameter 'Definition')"
+ ]
+} -->
v1.0 Networkaccess Logs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-logs.md
Title: "logs resource type"
-description: "Represnts network connections that are routed through the Global Secure Access services."
+description: "Represents network connections that are routed through the Global Secure Access services."
ms.localizationpriority: medium ms.prod: identity-and-access
Namespace: microsoft.graph.networkaccess
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represnts network connections that are routed through the Global Secure Access services.
+Represents network connections that are routed through the Global Secure Access services.
Inherits from [microsoft.graph.entity](../resources/entity.md).
None.
|traffic|[microsoft.graph.networkaccess.networkAccessTraffic](../resources/networkaccess-networkaccesstraffic.md) collection|Represents a collection of log entries in the network access traffic log.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess M365forwardingrule https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-m365forwardingrule.md
None.
|Property|Type|Description| |:|:|:| |action|microsoft.graph.networkaccess.forwardingRuleAction|The action applies to traffic. The possible values are: `bypass`, `forward`.|
-|category|microsoft.graph.networkaccess.forwardingCategory|Defines the category of Office 365 traffic used by a forwarding rule for M365 traffic (e.g., optimized traffic) .The possible values are: `default`, `optimized`, `allow`.|
+|category|microsoft.graph.networkaccess.forwardingCategory|Defines the category of Office 365 traffic used by a forwarding rule for Microsoft 365 traffic (for example, optimized traffic). The possible values are: `default`, `optimized`, `allow`.|
|destinations|[microsoft.graph.networkaccess.ruleDestination](../resources/networkaccess-ruledestination.md) collection|destinations à Maintains the list of potential destinations and destination types that the user could be accessing in the context of a forwarding policy, including IPs and FQDNs/URLs Inherited from [microsoft.graph.networkaccess.forwardingRule](../resources/networkaccess-forwardingrule.md).|
-|id|String|Identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).|
+|ID|String|Identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).|
|name|String|Name. Inherited from [microsoft.graph.networkaccess.policyRule](../resources/networkaccess-policyrule.md).|
-|ports|String collection|The port(s) used by a forwarding rule for M365 traffic are specified to determine the specific network port(s) through which the Microsoft 365 traffic is directed and forwarded.|
-|protocol|microsoft.graph.networkaccess.networkingProtocol|Defines the networking protocol type used by a forwarding rule for M365 traffic .The possible values are: `ip`, `icmp`, `igmp`, `ggp`, `ipv4`, `tcp`, `pup`, `udp`, `idp`, `ipv6`, `ipv6RoutingHeader`, `ipv6FragmentHeader`, `ipSecEncapsulatingSecurityPayload`, `ipSecAuthenticationHeader`, `icmpV6`, `ipv6NoNextHeader`, `ipv6DestinationOptions`, `nd`, `raw`, `ipx`, `spx`, `spxII`|
-|ruleType|microsoft.graph.networkaccess.networkDestinationType|Destination Type. Inherited from [microsoft.graph.networkaccess.forwardingRule](../resources/networkaccess-forwardingrule.md).The possible values are: `url`, `fqdn`, `ipAddress`, `ipRange`, `ipSubnet`, `webCategory`.|
+|ports|String collection|The port(s) used by a forwarding rule for Microsoft 365 traffic are specified to determine the specific network port(s) through which the Microsoft 365 traffic is directed and forwarded.|
+|protocol|microsoft.graph.networkaccess.networkingProtocol|Defines the networking protocol type used by a forwarding rule for Microsoft 365 traffic. The possible values are: `ip`, `icmp`, `igmp`, `ggp`, `ipv4`, `tcp`, `pup`, `udp`, `idp`, `ipv6`, `ipv6RoutingHeader`, `ipv6FragmentHeader`, `ipSecEncapsulatingSecurityPayload`, `ipSecAuthenticationHeader`, `icmpV6`, `ipv6NoNextHeader`, `ipv6DestinationOptions`, `nd`, `raw`, `ipx`, `spx`, `spxII`|
+|ruleType|microsoft.graph.networkaccess.networkDestinationType|Destination Type. Inherited from [microsoft.graph.networkaccess.forwardingRule](../resources/networkaccess-forwardingrule.md). The possible values are: `url`, `fqdn`, `ipAddress`, `ipRange`, `ipSubnet`, `webCategory`.|
## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess Profile https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-profile.md
Inherits from [microsoft.graph.entity](../resources/entity.md).
|id|String|Identifier for the profile. Inherited from [microsoft.graph.entity](../resources/entity.md).| |lastModifiedDateTime|DateTimeOffset|Profile last modified time.| |name|String|Profile name.|
-|state|microsoft.graph.networkaccess.status|Profile state.The possible values are: `enabled`, `disabled`.|
+|state|microsoft.graph.networkaccess.status|Profile state. The possible values are: `enabled`, `disabled`.|
|version|String|Profile version.| ## Relationships
Inherits from [microsoft.graph.entity](../resources/entity.md).
|policies|[microsoft.graph.networkaccess.policyLink](../resources/networkaccess-policylink.md) collection|Traffic forwarding policies associated with this profile.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess Tenantstatus https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-tenantstatus.md
Inherits from [microsoft.graph.entity](../resources/entity.md).
|Property|Type|Description| |:|:|:| |id|String|Identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).|
-|onboardingErrorMessage|String|Reflects a message to the user in case of an error.|
+|onboardingErrorMessage|String|Reflects a message to the user if there's an error.|
|onboardingStatus|microsoft.graph.networkaccess.onboardingStatus|Reflects the tenant onboarding status. The possible values are: `offboarded`, `offboardingInProgress`, `onboardingInProgress`, `onboarded`, `onboardingErrorOccurred`, `offboardingErrorOccurred`.| ## Relationships None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Networkaccess Tunnelconfigurationikev2default https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkaccess-tunnelconfigurationikev2default.md
Title: "tunnelConfigurationIKEv2Default resource type"
-description: "Specifies connectivity settings such as protocol, IPSec policy, and presharked key) for establishing connectivity."
+description: "Specifies connectivity settings such as protocol, IPSec policy, and preshared key) for establishing connectivity."
ms.localizationpriority: medium ms.prod: identity-and-access
Namespace: microsoft.graph.networkaccess
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Specifies connectivity settings such as protocol, IPSec policy, and presharked key) for establishing connectivity.
+Specifies connectivity settings such as protocol, IPSec policy, and preshared key) for establishing connectivity.
Inherits from [microsoft.graph.networkaccess.tunnelConfiguration](../resources/networkaccess-tunnelconfiguration.md).
Inherits from [microsoft.graph.networkaccess.tunnelConfiguration](../resources/n
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "@odata.type": "microsoft.graph.networkaccess.tunnelConfigurationIKEv2Default"
v1.0 Networkinterface https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/networkinterface.md
Represents a Network Interface Card (NIC) associated with this host.
| Property | Type |Description| |:|:--|:-|
-|description|String|Description of the NIC (e.g. Ethernet adapter, Wireless LAN adapter Local Area Connection, and so on).|
+|description|String|Description of the NIC (for example, Ethernet adapter, Wireless LAN adapter Local Area Connection, and so on).|
|ipV4Address|String|Last IPv4 address associated with this NIC.|
-|ipV6Address|String|Last Public (aka global) IPv6 address associated with this NIC.|
+|ipV6Address|String|Last Public (also known as global) IPv6 address associated with this NIC.|
|localIpV6Address|String|Last local (link-local or site-local) IPv6 address associated with this NIC.| |macAddress|String|MAC address of the NIC on this host.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Nomfaonroleactivationalertconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomfaonroleactivationalertconfiguration.md
Title: "noMfaOnRoleActivationAlertConfiguration resource type"
-description: "Represents an alert configuration that is triggered if roles do not require multi-factor authentication for activation."
+description: "Represents an alert configuration that is triggered if roles don't require multi-factor authentication for activation."
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents an alert configuration that is triggered if roles do not require multi-factor authentication for activation. Without multi-factor authentication, privileged roles can be activated more easily by compromised users.
+Represents an alert configuration that is triggered if roles don't require multi-factor authentication for activation. Without multi-factor authentication, privileged roles can be activated more easily by compromised users.
Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md).
Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrole
|alertDefinition|[unifiedRoleManagementAlertDefinition](../resources/unifiedrolemanagementalertdefinition.md)| The definition of the alert that contains its description, impact, and measures to mitigate or prevent it. Supports `$expand`.| ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Nomfaonroleactivationalertincident https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomfaonroleactivationalertincident.md
Title: "noMfaOnRoleActivationAlertIncident resource type"
-description: "Represents the details of an alert incident that is triggered if roles do not require multi-factor authentication for activation."
+description: "Represents the details of an alert incident that is triggered if roles don't require multi-factor authentication for activation."
ms.localizationpriority: medium ms.prod: "governance"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Represents the details of an alert incident that is triggered if roles do not require multi-factor authentication for activation.
+Represents the details of an alert incident that is triggered if roles don't require multi-factor authentication for activation.
Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md).
Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanag
None. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource", "keyProperty": "id",
v1.0 Objectidentity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/objectidentity.md
The **identities** property of the [user](user.md) resource is an **objectIdenti
| Property | Type |Description| |:|:--|:-|
-|signInType|String| Specifies the user sign-in types in your directory, such as `emailAddress`, `userName`, `federated`, or `userPrincipalName`. `federated` represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a `userPrincipalName` identity will update the value of the **userPrincipalName** property on the user object. The validations performed on the `userPrincipalName` property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a `userPrincipalName` identity. Additional validation is enforced on **issuerAssignedId** when the sign-in type is set to `emailAddress` or `userName`. This property can also be set to any custom string.|
-|issuer|string|Specifies the issuer of the identity, for example `facebook.com`.<br>For local accounts (where **signInType** is not `federated`), this property is the local B2C tenant default domain name, for example `contoso.onmicrosoft.com`.<br>For external users from other Azure AD organization, this will be the domain of the federated organization, for example `contoso.com`.<br><br>Supports `$filter`. 512 character limit.|
+|signInType|String| Specifies the user sign-in types in your directory, such as `emailAddress`, `userName`, `federated`, or `userPrincipalName`. `federated` represents a unique identifier for a user from an issuer, that can be in any format chosen by the issuer. Setting or updating a `userPrincipalName` identity will update the value of the **userPrincipalName** property on the user object. The validations performed on the `userPrincipalName` property on the user object, for example, verified domains and acceptable characters, will be performed when setting or updating a `userPrincipalName` identity. Extra validation is enforced on **issuerAssignedId** when the sign-in type is set to `emailAddress` or `userName`. This property can also be set to any custom string.|
+|issuer|string|Specifies the issuer of the identity, for example `facebook.com`.<br>For local accounts (where **signInType** isn't `federated`), this property is the local B2C tenant default domain name, for example `contoso.onmicrosoft.com`.<br>For external users from other Azure AD organization, this is the domain of the federated organization, for example `contoso.com`.<br><br>Supports `$filter`. 512 character limit.|
|issuerAssignedId|string|Specifies the unique identifier assigned to the user by the issuer. The combination of **issuer** and **issuerAssignedId** must be unique within the organization. Represents the sign-in name for the user, when **signInType** is set to `emailAddress` or `userName` (also known as local accounts).<br>When **signInType** is set to: <ul><li>`emailAddress`, (or a custom string that starts with `emailAddress` like `emailAddress1`) **issuerAssignedId** must be a valid email address</li><li>`userName`, **issuerAssignedId** must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _</li></ul>Supports `$filter`. 64 character limit.| ### Filtering When filtering on the **identities** property for an **issuerAssignedId**, you must supply both **issuer** and **issuerAssignedId**. In addition: - Filtering for entries with a **signInType** of `federated` requires a valid **issuer** and **issuerAssignedId**. - Filtering for entries with a **signInType** of `userName` or `emailAddress` ignores the issuer value. This is by design. -- Filtering for entries with a **signInType** of `userPrincipalName` is not supported. This can instead be accomplished by filtering on the **userPrincipalName** property on the user object.
+- Filtering for entries with a **signInType** of `userPrincipalName` isn't supported. This can instead be accomplished by filtering on the **userPrincipalName** property on the user object.
Filtering on **issuer** alone is supported for the following values: `google.com`, `facebook.com`, `mail`, and `phone`. ## JSON representation
-The following is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Onenoteidentity https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onenoteidentity.md
Namespace: microsoft.graph
The OneNoteIdentity type represents an identity of a _user_.
-In future, this type will be merged with [identity](identity.md)
+In future, this type is merged with [identity](identity.md)
## JSON representation
-Here is a JSON representation of the resource.
+Here's a JSON representation of the resource.
<!-- { "blockType": "resource",
v1.0 Onlinemeetinginfo