Updates from: 05/26/2024 04:22:43
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Accesspackage Delete Incompatibleaccesspackage https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete-incompatibleaccesspackage.md
DELETE https://graph.microsoft.com/beta/identityGovernance/entitlementManagement
[!INCLUDE [sample-code](../includes/snippets/php/remove-incompatibleaccesspackage-from-accesspackage-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
-# [PowerShell](#tab/powershell)
- # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/remove-incompatibleaccesspackage-from-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Accesspackage Delete Incompatiblegroup https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete-incompatiblegroup.md
DELETE https://graph.microsoft.com/beta/identityGovernance/entitlementManagement
[!INCLUDE [sample-code](../includes/snippets/php/remove-incompatiblegroup-from-accesspackage-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
-# [PowerShell](#tab/powershell)
- # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/remove-incompatiblegroup-from-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Accesspackage Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete.md
Namespace: microsoft.graph
Delete an [accessPackage](../resources/accesspackage.md) object.
-You can't delete an access package if it has any **accessPackageAssignment**. To delete the access package, first [query if there are any assignments](entitlementmanagement-list-accesspackageassignments.md) with a filter to indicate the specific access package, such as: `$filter=accessPackage/id eq 'a914b616-e04e-476b-aa37-91038f0b165b'`. For more information on how to remove assignments that are still in the delivered state, see [Remove an assignment](entitlementmanagement-post-accesspackageassignmentrequests.md#example-4-remove-an-assignment).
+You can't delete an access package if it has any **accessPackageAssignment**. To delete the access package, first [query if there are any assignments](entitlementmanagement-list-accesspackageassignments.md) with a filter to indicate the specific access package, such as: `$filter=accessPackage/id eq 'a914b616-e04e-476b-aa37-91038f0b165b'`. For more information on how to remove assignments that are still in the delivered state, see [Remove an assignment](entitlementmanagement-post-accesspackageassignmentrequests.md#example-2-remove-an-assignment).
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
v1.0 Accesspackage Post Accesspackageresourcerolescopes https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-post-accesspackageresourcerolescopes.md
Content-type: application/json
"section": "documentation", "tocPath": "" }-->++
+### Example 3: Add a Microsoft Entra role as a resource in an access package
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_accesspackageresourcerolescope_role_accesspackage"
+}-->
+
+```http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackages/{id}/accessPackageResourceRoleScopes
+Content-type: application/json
+
+{
+ "role": {
+ "originId": "Eligible",
+ "displayName": "Eligible Member",
+ "originSystem": "DirectoryRole",
+ "resource": {
+ "id": "ea036095-57a6-4c90-a640-013edf151eb1"
+ }
+ },
+ "scope": {
+ "description": "Root Scope",
+ "displayName": "Root",
+ "isRootScope": true,
+ "originSystem": "DirectoryRole",
+ "originId": "c4e39bd9-1100-46d3-8c65-fb160da0071f"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageResourceRoleScope"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "id": "ea036095-57a6-4c90-a640-013edf151eb1_c4e39bd9-1100-46d3-8c65-fb160da0071f",
+ "createdDateTime": "2023-06-28T01:19:48.4216782Z"
+}
+```
v1.0 Accesspackageresource Refresh https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackageresource-refresh.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-In [Azure AD entitlement management](../resources/entitlementmanagement-overview.md), refresh the [accessPackageResource](../resources/accesspackageresource.md) object to fetch the latest details for **displayName**, **description**, and **resourceType** from the origin system. For the `AadApplication` originSystem, this operation also updates the **displayName** and **description** for the [accessPackageResourceRole](../resources/accesspackageresourcerole.md).
+In [Microsoft Entra entitlement management](../resources/entitlementmanagement-overview.md), refresh the [accessPackageResource](../resources/accesspackageresource.md) object to fetch the latest details for **displayName**, **description**, and **resourceType** from the origin system. For the `AadApplication` originSystem, this operation also updates the **displayName** and **description** for the [accessPackageResourceRole](../resources/accesspackageresourcerole.md).
v1.0 Adminconsentrequestpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminconsentrequestpolicy-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "adminconsentrequestpolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/adminconsentrequestpolicy-get-permissions.md)]
-When calling on behalf of a user, the user needs to belong to one of the following directory roles. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-+ Global Administrator
+When calling on behalf of a user, the user needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
+ Global Reader + Cloud Application Administrator + Application Administrator
v1.0 Adminconsentrequestpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminconsentrequestpolicy-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "adminconsentrequestpolicy_update" } --> [!INCLUDE [permissions-table](../includes/permissions/adminconsentrequestpolicy-update-permissions.md)]
-When calling on behalf of a user, the user needs to belong to the [Global Administrator](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) directory role.
+For delegated scenarios, the calling user needs to belong to at least the *Application Administrator* or *Cloud Application Administrator* [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request
v1.0 Administrativeunit List Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-list-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "administrativeunit_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-list-members-permissions.md)] + > [!NOTE]
-> To view the members with a hidden membership in an administrative unit, the app must be granted the `Member.Read.Hidden` delegated or application permission.
+> To view the members with a hidden membership in an administrative unit, the app must be granted the *Member.Read.Hidden* delegated or application permission.
[!INCLUDE [rbac-admin-units-apis-read](../includes/rbac-for-apis/rbac-admin-units-apis-read.md)] - ## HTTP request ```http
v1.0 Administrativeunit Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-post-members.md
The following table shows the properties of the [group](../resources/group.md) r
|:|:--|:-| | displayName | string | The name to display in the address book for the group. Required. | | description | string | A description for the group. Optional. |
-| isAssignableToRole | Boolean | Set to **true** to enable the group to be assigned to a Microsoft Entra role. Only Privileged Role Administrator and Global Administrator can set the value of this property. Optional. |
+| isAssignableToRole | Boolean | Set to **true** to enable the group to be assigned to a Microsoft Entra role. Privileged Role Administrator is the least privileged role to set the value of this property. Optional. |
| mailEnabled | boolean | Set to **true** for mail-enabled groups. Required. | | mailNickname | string | The mail alias for the group. These characters cannot be used in the mailNickName: `@()\[]";:.<>,SPACE`. Required. | | securityEnabled | boolean | Set to **true** for security-enabled groups, including Microsoft 365 groups. Required. |
v1.0 Administrativeunit Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "administrativeunit_update" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-update-permissions.md)]
-To update an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-
-* Privileged Role Administrator
-* Global Administrator
+To update an administrative unit, the calling principal must be assigned at least the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Appcatalogs List Teamsapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appcatalogs-list-teamsapps.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog.
-It includes apps from the Microsoft Teams store, and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
+
+This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request.
> [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource.
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "appcatalogs_list_teamsapps" } --> [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)]
-> **Note**:
-The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward.
+> [!NOTE]
+> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward.
## HTTP request
Content-Type: application/json
### Example 4: List applications with a given ID, and return the submission review state
-The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the the admin rejected the app.
+The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected app.
#### Request
v1.0 Application Addpassword https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-addpassword.md
Title: "application: addPassword" description: "Add a strong password to an application." ms.localizationpriority: medium-+ doc_type: "apiPageType"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Adds a strong password to an [application](../resources/application.md).
+Adds a strong password to an [application](../resources/application.md). You can also [add passwords while creating the application](../api/application-post-applications.md#example-2-create-a-new-application-and-add-a-password-secret).
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
POST /applications(appId='{appId}')/addPassword
In the request body, provide an optional `passwordCredential` object with the following properties.
-| Property | Type |Description|
+| Property | Type |Description|
|:|:--|:-| | displayName | String | Friendly name for the password. Optional. | | endDateTime | DateTimeOffset | The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Optional. The default value is "startDateTime + 2 years". |
v1.0 Application List Extensionproperty https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-extensionproperty.md
Title: "List extensionProperties (directory extensions)"
description: "Retrieve a list of directory extension definitions." ms.localizationpriority: medium + doc_type: "apiPageType"
v1.0 Application Post Applications https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-applications.md
Namespace: microsoft.graph
Create a new [application](../resources/application.md) object. > [!IMPORTANT]
-> Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords or secrets for an application.
> > Do not share application client IDs (**appId**) in API documentation or code samples.
In the request body, supply a JSON representation of [application](../resources/
If successful, this method returns `201 Created` response code and an [application](../resources/application.md) object in the response body. ## Examples
-### Request
+
+### Example 1: Create an application with the default settings
+
+#### Request
The following example shows a request. # [HTTP](#tab/http)
Content-type: application/json
-### Response
+#### Response
The following example shows the response. > **Note:** The response object shown here might be shortened for readability.
Content-type: application/json
} ```
+### Example 2: Create a new application and add a password secret
+
+#### Request
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_application_with_passwordcredentials"
+}-->
+```http
+POST https://graph.microsoft.com/beta/applications
+Content-type: application/json
+
+{
+ "displayName": "MyAppName",
+ "passwordCredentials": [
+ {
+ "displayName": "Password name"
+ }
+ ]
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response. The **secretText** property in the response object contains the strong passwords or secret generated by Microsoft Entra ID and is 16-64 characters in length. There is no way to retrieve this password in the future.
+
+> **Note**: The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.passwordCredential"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications/$entity",
+ "id": "83ab4737-da9d-4084-86f2-f8fbec220647",
+ "deletedDateTime": null,
+ "appId": "9519e58c-bd06-4120-a7fd-2220d4de8409",
+ "applicationTemplateId": null,
+ "disabledByMicrosoftStatus": null,
+ "createdDateTime": "2024-04-01T19:10:02.6626202Z",
+ "displayName": "MyAppName",
+ "description": null,
+ "keyCredentials": [],
+ "parentalControlSettings": {
+ "countriesBlockedForMinors": [],
+ "legalAgeGroupRule": "Allow"
+ },
+ "passwordCredentials": [
+ {
+ "customKeyIdentifier": null,
+ "displayName": "Password name",
+ "endDateTime": "2026-04-01T19:10:02.6576213Z",
+ "hint": "puE",
+ "keyId": "09a0c91a-1bc3-4eaf-a945-c88c041fad6c",
+ "secretText": "1234567890abcdefghijklmnopqrstuvwxyzabcd",
+ "startDateTime": "2024-04-01T19:10:02.6576213Z"
+ }
+ ],
+ "publicClient": {
+ "redirectUris": []
+ }
+}
+```
+ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
v1.0 Application Post Calls https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-calls.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "application_post_calls" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)]
-> **Notes:**
-> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table.
-> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser.
+> [!NOTE]
> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table.
+
+Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Application Post Extensionproperty https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-extensionproperty.md
Title: "Create extensionProperty (directory extension)"
description: "Create a new directory extension." ms.localizationpriority: medium + doc_type: "apiPageType"
v1.0 Application Post Onlinemeetings https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-onlinemeetings.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "application_post_onlinemeetings" } --> [!INCLUDE [permissions-table](../includes/permissions/application-post-onlinemeetings-permissions.md)]
-To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path).
+> [!NOTE]
+> To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path).
## HTTP request
POST /users/{userId}/onlineMeetings
``` > [!NOTE]
->- **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).
+>- **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 information, 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 Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-update.md
In the request body, supply the values for relevant fields that should be update
| spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. | | tags | String collection | Custom strings that can be used to categorize and identify the application. Not nullable. | | tokenEncryptionKeyId | String | Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. |
+| uniqueName | String | The unique identifier that can be assigned to an application and used as an alternate key. Can updated only if `null` and is immutable once set. |
| uniqueName | String | The unique identifier that can be assigned to an application as an alternative identifier. Immutable. Read-only. | | web | [webApplication](../resources/webapplication.md) | Specifies settings for a web application. | | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. |
v1.0 Application Upsert https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-upsert.md
Create a new [application](../resources/application.md) object if it doesn't exi
> [!IMPORTANT] > Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./application-addpassword.md) and [removePassword](./application-removepassword.md) methods to update the password or secret for an application. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Applicationtemplate Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-get.md
Namespace: microsoft.graph
Retrieve the properties of an [applicationTemplate](../resources/applicationtemplate.md) object. ## Permissions
v1.0 Applicationtemplate Instantiate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-instantiate.md
Add an instance of an application from the [Microsoft Entra application gallery]
The application template with ID `8adf8e6e-67b2-4cf2-a259-e3dc5476c621` can be used to add a [non-gallery app](/azure/active-directory/manage-apps/add-non-gallery-app) that you can configure different single-sign on (SSO) modes like SAML SSO and password-based SSO. ## Permissions
v1.0 Applicationtemplate List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-list.md
Namespace: microsoft.graph
Retrieve a list of [applicationTemplate](../resources/applicationtemplate.md) objects from the Microsoft Entra application gallery. ## Permissions
v1.0 Assignedcomputeinstancedetails Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/assignedcomputeinstancedetails-get.md
description: "Read the properties and relationships of an assignedComputeInstanc
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Attacksimulationroot Delete Trainingcampaigns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md
+
+ Title: "Delete trainingCampaign"
+description: "Delete a trainingCampaign object."
+
+ms.localizationpriority: medium
++
+# Delete trainingCampaign
+
+Namespace: microsoft.graph
++
+Delete a [trainingCampaign](../resources/trainingcampaign.md) object.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "attacksimulationroot_delete_trainingcampaigns" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /security/attackSimulation/trainingCampaigns/{trainingCampaignId}/$ref
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_trainingcampaign"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns/{trainingCampaignId}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Attacksimulationroot List Trainingcampaigns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-list-trainingcampaigns.md
+
+ Title: "List trainingCampaign objects"
+description: "Get a list of trainingCampaign objects and their properties."
+
+ms.localizationpriority: medium
++
+# List trainingCampaign objects
+
+Namespace: microsoft.graph
++
+Get a list of [trainingCampaign](../resources/trainingcampaign.md) objects and their properties.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "attacksimulationroot_list_trainingcampaigns" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns
+```
+
+## Optional query parameters
+
+This method supports the `$count`, `$filter`, `$orderby`, `$skipToken`, `$top`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. You can use the `$filter` and `$orderby` query parameters on the **campaignSchedule/completionDateTime**, **displayName**, **campaignSchedule/launchDateTime**, and **campaignSchedule/status** properties.
+
+If the result set spans multiple pages, the response body contains an `@odata.nextLink` that you can use to page through the result set.
+
+The following list shows some examples of requests that use the supported OData query parameters:
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/trainingCampaigns?$count=true
+GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'
+GET /security/attackSimulation/trainingCampaigns?$filter={property} eq '{property-value}'&$top=5
+GET /security/attackSimulation/trainingCampaigns?$orderby={property}
+GET /security/attackSimulation/trainingCampaigns?$skipToken={skipToken}
+GET /security/attackSimulation/trainingCampaigns?$top=1
+GET /security/attackSimulation/trainingCampaigns?$select={property}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [trainingCampaign](../resources/trainingcampaign.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_trainingcampaign"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.trainingCampaign)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.etag": "W/\"dub9zfj4Rk68MmY/KYwXKgADRgyGsw==\"",
+ "id": "81c59451-2929-5b39-86f0-5a2b15f1314f",
+ "displayName": "Sample Training Campaign",
+ "description": "Sample Training Campaign Description",
+ "createdDateTime": "2024-02-18T08:36:07.6534871Z",
+ "lastModifiedDateTime": "2024-02-19T08:00:01.9417887Z",
+ "endUserNotificationSetting": null,
+ "includedAccountTarget": null,
+ "excludedAccountTarget": null,
+ "trainingSetting": null,
+ "campaignSchedule": {
+ "launchDateTime": "2024-02-18T08:37:44Z",
+ "completionDateTime": "2024-02-19T07:59:44Z",
+ "status": "completed"
+ },
+ "createdBy": {
+ "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ },
+ "lastModifiedBy": {
+ "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ },
+ }
+ ]
+}
+```
+
v1.0 Attacksimulationroot Post Trainingcampaigns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attacksimulationroot-post-trainingcampaigns.md
+
+ Title: "Create trainingCampaign"
+description: "Create a new trainingCampaign object."
+
+ms.localizationpriority: medium
++
+# Create trainingCampaign
+
+Namespace: microsoft.graph
++
+Create a new [trainingCampaign](../resources/trainingcampaign.md) object.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "attacksimulationroot_post_trainingcampaigns" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /security/attackSimulation/trainingCampaigns
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [trainingCampaign](../resources/trainingcampaign.md) object.
+
+You can specify the following properties when creating a **trainingCampaign**.
+
+|Property|Type|Description|
+|:|:|:|
+|createdBy|[emailIdentity](../resources/emailidentity.md)|The identity of the user who created the training campaign. Optional.|
+|createdDateTime|DateTimeOffset|The date and time when the training campaign was created. Optional.|
+|description|String|The description of the training campaign. Optional.|
+|displayName|String|The display name of the training campaign. Required.|
+|endUserNotificationSetting|[endUserNotificationSetting](../resources/endusernotificationsetting.md)|Details about the end user notification setting. Required.|
+|excludedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are excluded from the training campaign. Optional.|
+|includedAccountTarget|[accountTargetContent](../resources/accounttargetcontent.md)|The users who are targeted in the training campaign. Required.|
+|lastModifiedDateTime|DateTimeOffset|The identity of the user who most recently modified the training campaign. Optional.|
+|trainingSetting|[trainingSetting](../resources/trainingsetting.md)|Details about the training settings for a training campaign. Required.|
+|campaignSchedule|[campaignSchedule](../resources/campaignschedule.md)|Details about the schedule and current status for a training campaign. Required.|
+
+## Response
+
+If successful, this method returns a `202 Accepted` response code and a tracking header named `location` in the response.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_trainingcampaign_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/security/attackSimulation/trainingCampaigns
+Content-Type: application/json
+
+{
+ "displayName": "Graph Training Campaign",
+ "description": "Graph Training Campaign Description",
+ "createdBy": {
+ "email": "john@contoso.com"
+ },
+ "lastModifiedBy": {
+ "email": "john@contoso.com"
+ },
+ "includedAccountTarget": {
+ "type": "addressBook",
+ "accountTargetEmails": [
+ "john@contoso.com"
+ ]
+ },
+ "endUserNotificationSetting": {
+ "notificationPreference": "microsoft",
+ "settingType": "trainingSelected",
+ "trainingReminder": {
+ "deliveryFrequency": "weekly",
+ "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('fe521249-9901-4584-a987-026a9980c58e')",
+ "defaultLanguage": "en"
+ },
+ "trainingAssignment": {
+ "endUserNotification@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/endUserNotifications('36fb4dc1-7c37-4b96-9096-12e6d6014fae')",
+ "defaultLanguage": "en"
+ }
+ },
+ "trainingSetting": {
+ "settingType": "microsoftCustom",
+ "trainingAssignmentMappings": [
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('40454905-dc26-4f36-b854-3042a5362cb3')"
+ },
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('ea70ae06-3859-4818-be9d-270ee81d80a4')"
+ },
+ {
+ "assignedTo": [
+ "allUsers"
+ ],
+ "training@odata.bind": "https://graph.microsoft.com/beta/security/attackSimulation/trainings('d733d88c-1b5a-48e3-a588-9910e41ac21d')"
+ }
+ ]
+ },
+ "campaignSchedule": {
+ "launchDateTime": "2024-02-15T07:59:44Z",
+ "completionDateTime": "2024-02-18T07:59:44Z",
+ "status": "Scheduled"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+```http
+HTTP/1.1 202 Accepted
+```
v1.0 Attendancerecord List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attendancerecord-list.md
GET /me/onlineMeetings/{meetingId}/attendanceReports/{reportId}/attendanceRecord
GET /users/{userId}/onlineMeetings/{meetingId}/attendanceReports/{reportId}/attendanceRecords ```
-To get attendance records of a webinar session's attendance report:
+To get attendance records of a webinar session's attendance report with delegated and app permission:
<!-- {"blockType": "ignored"}--> ``` http GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}/attendanceRecords
v1.0 Authentication Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authentication-get.md
Title: "Get authentication signInPreferences"
-description: "Read the properties of a user's authentication sign in preferences."
+ Title: "Get authentication method states"
+description: "Read the properties of a user's authentication method states, such as their sign-in preferences."
ms.localizationpriority: medium
doc_type: apiPageType
-# Get authentication signInPreferences
+# Get authentication method states
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Read the properties and relationships of a [signInPreferences](../resources/signInPreferences.md) object.
+Read the properties of a user's authentication method states. Use this API to retrieve the following information:
+
+- A user's [signInPreferences](../resources/signInPreferences.md)
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
[!INCLUDE [rbac-authentication-methods-apis-read-others](../includes/rbac-for-apis/rbac-authentication-methods-apis-read-others.md)] ## HTTP request-
+To retrieve the sign-in preferences for a user:
<!-- { "blockType": "ignored" }
Don't supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and a [signInPreferences](../resources/signInPreferences.md) object in the response body.
+For sign-in preferences: If successful, this method returns a `200 OK` response code and a [signInPreferences](../resources/signInPreferences.md) object in the response body.
## Examples
v1.0 Authentication Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authentication-update.md
Title: "Update authentication signInPreferences"
-description: "Update the properties of a user's authentication sign in preferences."
+ Title: "Update authentication method states"
+description: "Update the properties of a user's authentication method states."
ms.localizationpriority: medium
doc_type: apiPageType
-# Update authentication signInPreferences
+# Update authentication method states
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Update the properties of a [signInPreferences](../resources/signInPreferences.md) object.
+Update the properties of a user's authentication method states. Use this API to update the following information:
+
+- A user's [signInPreferences](../resources/signInPreferences.md)
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
PATCH /users/{id | userPrincipalName}/authentication/signInPreferences
## Response
-If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body.
+If successful, this method returns a `204 No Content` response code.
## Examples
v1.0 Authenticationmethodsroot Usersregisteredbyfeature https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationmethodsroot-usersregisteredbyfeature.md
The following table shows the parameters that can be used with this function.
|includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.| |includedUserTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`.|
-The value `privilegedAdmin` consists of the following privileged admin roles:
+The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
* Global Administrator * Security Administrator
The value `privilegedAdmin` consists of the following privileged admin roles:
* User Administrator * Authentication Administrator
-The value `admin` includes all Azure Active Director admin roles.
+The value `admin` includes all Microsoft Entra admin roles.
## Request headers
v1.0 Authenticationmethodsroot Usersregisteredbymethod https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationmethodsroot-usersregisteredbymethod.md
The following table shows the parameters that can be used with this function.
|includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.| |includedUserTypes|includedUserTypes|User type. Possible values are: `all`, `member`, `guest`.|
-The value `privilegedAdmin` consists of the following privileged admin roles:
+The value `privilegedAdmin` consists of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
* Global Administrator * Security Administrator
v1.0 Authorizationsystem Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authorizationsystem-get.md
description: "Read the properties and relationships of an authorizationSystem ob
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Authorizationsystemtypeservice Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authorizationsystemtypeservice-get.md
description: "Read the properties and relationships of an authorizationSystemTyp
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsassociatedidentities List All https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsassociatedidentities-list-all.md
description: "Get a list of the awsIdentity objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsassociatedidentities List Roles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsassociatedidentities-list-roles.md
description: "Get the awsRole resources from the awsRoles navigation property."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsassociatedidentities List Users https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsassociatedidentities-list-users.md
description: "Get a list of the awsUser objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystem List Actions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-actions.md
description: "List the awsAuthorizationSystemAction objects and their properties
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystem List Policies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-policies.md
description: "List all awsPolicy objects and their properties for a specific AWS
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystem List Resources https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-resources.md
description: "List the awsAuthorizationSystemResource objects and their properti
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystem List Services https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list-services.md
description: "Get all services in an AWS authorization system."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystem List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystem-list.md
description: "Get a list of the awsAuthorizationSystem objects and their propert
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystemresource Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystemresource-get.md
description: "Read the properties and relationships of an awsAuthorizationSystem
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsauthorizationsystemtypeaction Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsauthorizationsystemtypeaction-get.md
description: "Read the properties and relationships of an awsAuthorizationSystem
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsexternalsystemaccessfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessfinding-get.md
description: "Read the properties and relationships of an awsExternalSystemAcces
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsexternalsystemaccessfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessfinding-list.md
description: "Get a list of the awsExternalSystemAccessFinding objects and their
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsexternalsystemaccessrolefinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessrolefinding-get.md
description: "Read the properties and relationships of an awsExternalSystemAcces
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsexternalsystemaccessrolefinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsexternalsystemaccessrolefinding-list.md
description: "Get a list of the awsExternalSystemAccessRoleFinding objects and t
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentity Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentity-get.md
description: "Read the properties and relationships of an awsIdentity object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentityaccessmanagementkeyagefinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyagefinding-aggregatedsummary.md
description: "Get a raw count of AWS IAM Access Keys and their ages"
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentityaccessmanagementkeyagefinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyagefinding-get.md
description: "Read the properties and relationships of an awsIdentityAccessManag
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentityaccessmanagementkeyagefinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyagefinding-list.md
description: "Get a list of the awsIdentityAccessManagementKeyAgeFinding objects
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentityaccessmanagementkeyusagefinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyusagefinding-aggregatedsummary.md
description: "Get a count of the AWS IAM Access Keys that have not been used in
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentityaccessmanagementkeyusagefinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyusagefinding-get.md
description: "Read the properties and relationships of an awsIdentityAccessManag
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsidentityaccessmanagementkeyusagefinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsidentityaccessmanagementkeyusagefinding-list.md
description: "Get a list of the awsIdentityAccessManagementKeyUsageFinding objec
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awspolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awspolicy-get.md
description: "Read the properties and relationships of an awsPolicy object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsrole Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsrole-get.md
description: "Read the properties and relationships of an awsRole object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsuser Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsuser-get.md
description: "Read the properties and relationships of an awsUser object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Awsuser List Assumableroles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/awsuser-list-assumableroles.md
description: "Get the assumableRole objects for an awsUser."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureadauthentication Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureadauthentication-get.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Read the properties and relationships of an [azureADAuthentication](../resources/azureadauthentication.md) object to find the level of Microsoft Entra authentication availability for your tenant. The Microsoft Entra service Level Agreement (SLA) commits to at least 99.99% authentication availability, as described in [Microsoft Entra SLA performance](/azure/active-directory/reports-monitoring/reference-azure-ad-sla-performance). This object provides you with your tenantΓÇÖs actual performance against this commitment.
+Read the properties and relationships of an [azureADAuthentication](../resources/azureadauthentication.md) object to find the level of Microsoft Entra authentication availability for your tenant. The Microsoft Entra service Level Agreement (SLA) commits to at least 99.99% authentication availability, as described in [Microsoft Entra SLA performance](/azure/active-directory/reports-monitoring/reference-azure-ad-sla-performance). This object provides you with your tenant's actual performance against this commitment.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "azureadauthentication_get" } --> [!INCLUDE [permissions-table](../includes/permissions/azureadauthentication-get-permissions.md)]
-In addition to the delegated permissions, the signed-in user needs to belong to one of the following directory roles that allow them to read sign-in reports. To learn more about directory roles, see [Microsoft Entra built-in roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-+ Global Administrator
+For delegated scenarios, the calling user needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
+ Global Reader + Reports Reader + Security Administrator
Don't supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and an [azureADAuthentication](../resources/azureadauthentication.md) object in the response body. Each returned value includes a score indicating the availability percentage of the tenantΓÇÖs authentications for the month, along with a startDate and endDate indicating the month that the availability percentage is assigned to.
+If successful, this method returns a `200 OK` response code and an [azureADAuthentication](../resources/azureadauthentication.md) object in the response body. Each returned value includes a score indicating the availability percentage of the tenant's authentications for the month, along with a startDate and endDate indicating the month that the availability percentage is assigned to.
## Examples
v1.0 Azureassociatedidentities List All https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-all.md
description: "Get a list of the azureIdentity objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureassociatedidentities List Managedidentities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-managedidentities.md
description: "Get a list of the azureManagedIdentity objects and their propertie
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureassociatedidentities List Serviceprincipals https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-serviceprincipals.md
description: "Get a list of the azureServicePrincipal objects and their properti
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureassociatedidentities List Users https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureassociatedidentities-list-users.md
description: "Get a list of the azureUser objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystem List Actions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-actions.md
description: "List the azureAuthorizationSystemTypeAction objects and their prop
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystem List Resources https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-resources.md
description: "List the azureAuthorizationSystemResource objects and their proper
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystem List Roledefinitions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-roledefinitions.md
description: "Lists all Azure roles in an Azure authorization system."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystem List Services https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list-services.md
description: "Get all services in an Azure authorization system onboarded to Per
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystem List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystem-list.md
description: "Get a list of the azureAuthorizationSystem objects and their prope
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystemresource Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystemresource-get.md
description: "Read the properties and relationships of an azureAuthorizationSyst
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureauthorizationsystemtypeaction Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureauthorizationsystemtypeaction-get.md
description: "Read the properties and relationships of an azureAuthorizationSyst
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureidentity Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureidentity-get.md
description: "Read the properties and relationships of an azureIdentity object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azuremanagedidentity Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azuremanagedidentity-get.md
description: "Read the properties and relationships of an azureManagedIdentity o
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureroledefinition Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureroledefinition-get.md
description: "Gets an Azure role in an Azure authorization system."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureserviceprincipal Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureserviceprincipal-get.md
description: "Read the properties and relationships of an azureServicePrincipal
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Azureuser Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/azureuser-get.md
description: "Read the properties and relationships of an azureUser object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 B2cidentityuserflow Delete Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-delete-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_delete_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-delete-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
DELETE https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_CustomerSign
[!INCLUDE [sample-code](../includes/snippets/php/delete-b2xuserflows-identityproviders-1-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
-# [PowerShell](#tab/powershell)
- # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-b2xuserflows-identityproviders-1-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 B2cidentityuserflow Delete Userflowidentityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-delete-userflowidentityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_delete_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-delete-userflowidentityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External ID user flow administrator
## HTTP request
v1.0 B2cidentityuserflow Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-delete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow Get Apiconnectorconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-get-apiconnectorconfiguration.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_get_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-get-apiconnectorconfiguration-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_get" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-get-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow List Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow List Languages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-languages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-languages-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow List Userflowidentityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-userflowidentityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-userflowidentityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External ID user flow administrator
## HTTP request
v1.0 B2cidentityuserflow Post Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-post-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-post-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow Put Apiconnectorconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-put-apiconnectorconfiguration.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Update the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) property in a [b2cIdentityUserFlow](../resources/b2cidentityuserflow.md) to enable or disable an API connector in a user flow. Each relationship of the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) corresponds to a specific step in the user flow that can be configured to call an API connector. You configure an API connector for a particular step one at a time as shown below.
+Update the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) property in a [b2cIdentityUserFlow](../resources/b2cidentityuserflow.md) to enable or disable an API connector in a user flow. Each relationship of the [apiConnectorConfiguration](../resources/userflowapiconnectorconfiguration.md) corresponds to a specific step in the user flow that can be configured to call an API connector. You configure an API connector for a particular step in the user flow at a time.
## Permissions
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_put_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-put-apiconnectorconfiguration-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
If successful, this method returns a `204 No Content` response code.
## Examples
-### Example 1: Enable API connector for Post IDP Federation on sign up
+### Example 1: Enable API connector for Post IdP Federation on sign-up
#### Request
The following example shows the response.
HTTP/1.1 204 No Content ```
-### Example 2: Enable API connector for Post Attribute Collection on sign up
+### Example 2: Enable API connector for Post Attribute Collection on sign-up
#### Request
The following example shows the response.
HTTP/1.1 204 No Content ```
-### Example 3: Disable an API connector for Post Attribute Collection on sign up
+### Example 3: Disable an API connector for Post Attribute Collection on sign-up
#### Request
v1.0 B2cidentityuserflow Put Languages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-put-languages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_put_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-put-languages-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_update" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2cidentityuserflow Userflowidentityproviders Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-userflowidentityproviders-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2cidentityuserflow_userflowidentityproviders_update" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-userflowidentityproviders-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External ID user flow administrator
## HTTP request
v1.0 B2xidentityuserflow Delete Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow Delete Userflowidentityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete-userflowidentityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-userflowidentityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External ID user flow administrator
## HTTP request
v1.0 B2xidentityuserflow Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-delete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow Get Apiconnectorconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-get-apiconnectorconfiguration.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_get_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-get-apiconnectorconfiguration-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_get" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-get-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow List Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow List Languages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-languages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_languages" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-languages-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow List Userflowidentityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-userflowidentityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_userflowidentityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-userflowidentityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External ID user flow administrator
## HTTP request
v1.0 B2xidentityuserflow Post Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-post-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-post-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow Put Apiconnectorconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-put-apiconnectorconfiguration.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_put_apiconnectorconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-put-apiconnectorconfiguration-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 B2xidentityuserflow Userflowidentityproviders Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-userflowidentityproviders-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "b2xidentityuserflow_userflowidentityproviders_update" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-userflowidentityproviders-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External ID user flow administrator
## HTTP request
v1.0 Basesitepage Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/basesitepage-delete.md
If successful, this method returns a `204 No Content` response code. It doesn't
The following example shows a request. ```http
-DELETE https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}
+DELETE https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca
``` ### Response
v1.0 Basesitepage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/basesitepage-get.md
If successful, this method returns a `200` and a [baseSitePage](../resources/bas
--> ```msgraph-interactive
-GET /sites/{site-id}/pages/{page-id}
+GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202
``` # [C#](#tab/csharp)
Content-type: application/json
"id": "f45354cb-d634-45df-8b88-2b4e96a1dc45", "lastModifiedDateTime": "2023-04-16T10:01:41Z", "name": "Electronic Convertible.aspx",
- "webUrl": "SitePages/Electronic Convertible.aspx",
+ "webUrl": "https://contoso.sharepoint.com/SitePages/Electronic Convertible.aspx",
"title": "Electronic Convertible", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/_layouts/15/images/sitepagethumbnail.png",
v1.0 Basesitepage List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/basesitepage-list.md
Get the collection of [baseSitePage][] objects from the site pages [list][] in a
| :-- | :- | | [sitePage][] | Represents a regular page. |
-[basesitepage]: ../resources/baseSitePage.md
-[sitepage]: ../resources/sitePage.md
+[baseSitePage]: ../resources/baseSitePage.md
+[sitePage]: ../resources/sitePage.md
[list]: ../resources/list.md [site]: ../resources/site.md
The following example shows a request.
--> ```msgraph-interactive
-GET /sites/{site-id}/pages
+GET /sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages
``` # [C#](#tab/csharp)
Content-type: application/json
"id": "5fa48f95-2fdf-40e8-a28c-6d0d8345bcd2", "lastModifiedDateTime": "2023-04-16T08:37:51Z", "name": "Account holistic.aspx",
- "webUrl": "SitePages/Account holistic.aspx",
+ "webUrl": "https://contoso.sharepoint.com/SitePages/Account holistic.aspx",
"title": "CSS Global Lithuanian meter", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png",
Content-type: application/json
"id": "da0f67be-977e-4d09-88ac-506a1002e678", "lastModifiedDateTime": "2023-04-16T06:39:30Z", "name": "Analyst Fresh.aspx",
- "webUrl": "SitePages/Analyst Fresh.aspx",
+ "webUrl": "https://contoso.sharepoint.com/SitePages/Analyst Fresh.aspx",
"title": "Lesotho Account Metal Analyst du", "pageLayout": "article", "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/a830edad9050849vanaukyisx52.spgrid.com/_layouts/15/images/sitepagethumbnail.png",
v1.0 Bitlocker List Recoverykeys https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bitlocker-list-recoverykeys.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "bitlocker_list_recoverykeys" } --> [!INCLUDE [permissions-table](../includes/permissions/bitlocker-list-recoverykeys-permissions.md)]
-For delegated permissions to allow apps to get **bitLockerRecoveryKey** resources on behalf of the signed-in user, the user must be the registered owner of the device that the BitLocker recovery key was originally backed up from, or the calling user must be in one of the following directory roles:
-
-* Global administrator
-* Cloud device administrator
-* Helpdesk administrator
-* Intune service administrator
-* Security administrator
-* Security reader
-* Global reader
+For delegated permissions to allow apps to get **bitLockerRecoveryKey** resources on behalf of the signed-in user, the user must be the registered owner of the device that the BitLocker recovery key was originally backed up from, or the calling user must be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
+
+* Cloud Device Administrator
+* Helpdesk Administrator
+* Intune Service Administrator
+* Security Administrator
+* Security Reader
+* Global Reader
## HTTP request To get a list of BitLocker keys within the tenant:
v1.0 Bitlockerrecoverykey Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bitlockerrecoverykey-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "bitlockerrecoverykey_get" } --> [!INCLUDE [permissions-table](../includes/permissions/bitlockerrecoverykey-get-permissions.md)]
->**Note:** For delegated permissions to allow apps to get **bitLockerRecoveryKey** resources on behalf of the signed-in user, the tenant administrator must have assigned the user one of the following roles, or the user must be the **registered owner** of the device that the BitLocker key was originally backed up from:
-* Global administrator
-* Cloud device administrator
-* Helpdesk administrator
-* Intune service administrator
-* Security administrator
-* Security reader
-* Global reader
+>**Note:** For delegated permissions to allow apps to get **bitLockerRecoveryKey** resources on behalf of the signed-in user, the tenant administrator must have assigned the user one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json), or the user must be the **registered owner** of the device that the BitLocker key was originally backed up from:
+
+* Cloud Device Administrator
+* Helpdesk Administrator
+* Intune Service Administrator
+* Security Administrator
+* Security Reader
+* Global Reader
## HTTP request To get the specified BitLocker key without returning the **key** property:
v1.0 Bookingappointment Cancel https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-cancel.md
Namespace: microsoft.graph
Cancel the specified [bookingAppointment](../resources/bookingappointment.md) in the specified [bookingBusiness](../resources/bookingbusiness.md), and send a message to the involved customer and staff members. ## Permissions
v1.0 Bookingappointment Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-delete.md
Namespace: microsoft.graph
Delete a [bookingAppointment](../resources/bookingappointment.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingappointment Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-get.md
Get the properties and relationships of a [bookingAppointment](../resources/book
The **start** and **end** properties are always returned in UTC. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingappointment Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-update.md
Namespace: microsoft.graph
Update the properties of a [bookingAppointment](../resources/bookingappointment.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingbusiness Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-delete.md
Namespace: microsoft.graph
Delete a [bookingBusiness](../resources/bookingbusiness.md) object. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-get.md
Namespace: microsoft.graph
Get the properties and relationships of a [bookingBusiness](../resources/bookingbusiness.md) object. ## Permissions
v1.0 Bookingbusiness Getstaffavailability https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-getstaffavailability.md
Namespace: microsoft.graph
Get the availability information of [staff members](../resources/bookingstaffmember.md) of a [Microsoft Bookings calendar](../resources/bookingappointment.md). ## Permissions
v1.0 Bookingbusiness List Appointments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-appointments.md
Namespace: microsoft.graph
Get a list of [bookingAppointment](../resources/bookingappointment.md) objects for the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness List Calendarview https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-calendarview.md
Namespace: microsoft.graph
Get the collection of [bookingAppointment](../resources/bookingappointment.md) objects for a [bookingBusiness](../resources/bookingbusiness.md), that occurs in the specified date range. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness List Customers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-customers.md
Namespace: microsoft.graph
Get a list of [bookingCustomer](../resources/bookingcustomer.md) objects. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness List Customquestions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-customquestions.md
Namespace: microsoft.graph
Get the [bookingCustomQuestion](../resources/bookingcustomquestion.md) resources associated with a [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingbusiness List Services https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-services.md
Namespace: microsoft.graph
Get a list of [bookingService](../resources/bookingservice.md) objects in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingbusiness List Staffmembers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-staffmembers.md
Namespace: microsoft.graph
Get a list of [bookingStaffMember](../resources/bookingstaffmember.md) objects in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingbusiness List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list.md
You can also query for Bookings businesses by specifying a string in a `query` p
> **Note:** Results are limited to 500 mailboxes. Pagination of the results is not currently supported. ## Permissions
v1.0 Bookingbusiness Post Appointments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-appointments.md
Namespace: microsoft.graph
Create a new [bookingAppointment](../resources/bookingappointment.md) for the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingbusiness Post Bookingbusinesses https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-bookingbusinesses.md
Create a new Microsoft Bookings business in a tenant.
This is the first step in setting up a Bookings business where you must specify the business display name. You can include other information such as business address, web site address, and scheduling policy, or set that information later by [updating](bookingbusiness-update.md) the **bookingBusiness**. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Post Customers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-customers.md
Namespace: microsoft.graph
Create a new [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Post Customquestions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-customquestions.md
Namespace: microsoft.graph
Create a new [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions
v1.0 Bookingbusiness Post Services https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-services.md
Namespace: microsoft.graph
Create a new [bookingService](../resources/bookingservice.md) for the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Post Staffmembers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-staffmembers.md
Namespace: microsoft.graph
Create a new [staff member](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Publish https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-publish.md
Make the scheduling page of this business available to external customers.
Set the **isPublished** property to true, and **publicUrl** property to the URL of the scheduling page. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Unpublish https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-unpublish.md
Make the scheduling page of this business not available to external customers.
Set the **isPublished** property to false, and **publicUrl** property to null. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingbusiness Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-update.md
Namespace: microsoft.graph
Update the properties of a [bookingBusiness](../resources/bookingbusiness.md) object. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingcurrency Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcurrency-get.md
Namespace: microsoft.graph
Get the properties of a [bookingCurrency](../resources/bookingcurrency.md) object that is available to a Microsoft Bookings business. Use the **id** property, which is the currency code, to specify the currency. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingcurrency List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcurrency-list.md
Namespace: microsoft.graph
Get a list of [bookingCurrency](../resources/bookingcurrency.md) objects available to a Microsoft Bookings business. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingcustomer Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-delete.md
Namespace: microsoft.graph
Delete the specified [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingcustomer Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-get.md
Namespace: microsoft.graph
Get the properties and relationships of a [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingcustomer Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-update.md
Namespace: microsoft.graph
Update the properties of a [bookingCustomer](../resources/bookingcustomer.md) object. ## Permissions
v1.0 Bookingcustomquestion Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomquestion-delete.md
Namespace: microsoft.graph
Delete the specified [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions
v1.0 Bookingcustomquestion Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomquestion-get.md
Namespace: microsoft.graph
Read the properties and relationships of a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions
v1.0 Bookingcustomquestion Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomquestion-update.md
Namespace: microsoft.graph
Update the properties of a [bookingCustomQuestion](../resources/bookingcustomquestion.md) object. ## Permissions
v1.0 Bookingservice Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-delete.md
Namespace: microsoft.graph
Delete a [bookingService](../resources/bookingservice.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingservice Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-get.md
Namespace: microsoft.graph
Get the properties and relationships of a [bookingService](../resources/bookingservice.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
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:
- 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 Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingstaffmember Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-delete.md
Namespace: microsoft.graph
Delete a [staff member](../resources/bookingstaffmember.md) in the specified [bookingbusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Bookingstaffmember Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-get.md
Namespace: microsoft.graph
Get the properties and relationships of a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions
v1.0 Bookingstaffmember Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-update.md
Namespace: microsoft.graph
Update the properties of a [bookingStaffMember](../resources/bookingstaffmember.md) in the specified [bookingBusiness](../resources/bookingbusiness.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Calendar Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calendar-delete.md
The following example shows a request.
DELETE https://graph.microsoft.com/beta/me/calendar ```
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
- # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/delete-calendar-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
-# [PHP](#tab/php)
-
-# [Python](#tab/python)
- ##### Response
v1.0 Callrecording Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/callrecording-delta.md
A GET request with the delta function returns either:
- A `@odata.nextLink` (that contains a URL with a **delta** function call and a `skipToken`), or - A `@odata.deltaLink` (that contains a URL with a **delta** function call and `deltaToken`).
-State tokens are completely opaque to the client. To proceed with a round of change tracking, simply copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next **delta** function call for that same recording view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you start the next round of synchronization to get the new recordings added after acquiring `@odata.deltaLink`.
+State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next **delta** function call for that same recording view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you start the next round of synchronization to get the new recordings added after acquiring `@odata.deltaLink`.
For more information, see the [delta query](/graph/delta-query-overview) documentation.
+### Known issues
+
+The following known issues are associated with this API:
+
+- [Using the `$top` query parameter might not return the @odata.nextLink](https://developer.microsoft.com/en-us/graph/known-issues/?search=22931).
+- [Transcript URLs might not include any content](https://developer.microsoft.com/en-us/graph/known-issues/?search=22932).
+- [Recordings aren't exported for meetings that don't have transcription turned on](https://developer.microsoft.com/en-us/graph/known-issues/?search=22933).
+- [Delta queries might return older artifacts when meetings have unrelated changes](https://developer.microsoft.com/en-us/graph/known-issues/?search=22934).
+ ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
Choose the permission or permissions marked as least privileged for this API. Us
## HTTP request <!-- { "blockType": "ignored" } -->
-```http
-GET /users/{id}/onlineMeetings/getAllRecordings/delta?$filter=meetingOrganizerId%20eq%20'{id}'
+``` http
+GET /users/{usersId}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta
```
->**Note:** If you don't specify a **meetingOrganizerId**, the request fails.
+>**Note:** If you don't pass the function parameter **meetingOrganizerUserId**, the request fails.
## Query parameters
In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLin
|:|:--|:-| | `$deltatoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next round of change tracking for that collection.| | `$skiptoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating that there are further changes to be tracked. |
+| `$top` | integer | Allows the caller to specify the maximum number of objects per page. |
## Request headers+ | Header | Value | ||| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
The following example shows a series of three requests to synchronize the call r
- Step 2: [second request](#second-request) and [response](#second-response) - Step 3: [third request](#third-request) and [final response](#third-and-final-response-for-the-round).
-See also what you'll do in the [next round to get additional recordings](#example-2-next-round-to-get-additional-recordings).
+See also what you'll do in the [next round to get more recordings](#example-2-next-round-to-get-more-recordings).
#### Initial request
In this example, the call recordings are being synchronized for the first time,
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings/delta?$filter=meetingOrganizerId%20eq%20'8b081ef6-4792-4def-b2c9-c363a1bf41d5'
+GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta
``` #### Initial response
HTTP/1.1 200 OK
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
- "@odata.count": 2,
- "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg",
- "value":[
- {
- "@odata.type": "#microsoft.graph.callRecording",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
- "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-03T22:29:42.6514074Z",
- "id": "MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl"
- },
- {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
+ "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken1}",
+ "@odata.count": 1,
+ "value": [
+ {
"@odata.type": "#microsoft.graph.callRecording",
- "meetingId": "MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-05T11:24:30.6414074Z",
- "id": "MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl"
- }
- ]
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
+ ]
} ```
Content-type: application/json
The second request specifies the `@odata.nextLink` URL returned from the previous response. Notice that it no longer has to specify the same query parameters as in the initial request, as the `skipToken` in the `@odata.nextLink` URL encodes and includes them. - <!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg
+GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta
+$skiptoken={skipToken1}
``` #### Second response
-The second response returns the next two call recordings and a `@odata.nextLink` property with a `skipToken`, which indicates there are more recordings.
+The second response returns one or more next call recordings and a `@odata.nextLink` property with a `skipToken`, which indicates there are more recordings.
<!-- { "blockType": "response",
HTTP/1.1 200 OK
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
- "@odata.count": 2,
- "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg",
- "value":[
- {
- "@odata.type": "#microsoft.graph.callRecording",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
- "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-11T21:29:42.6514074Z",
- "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl"
- },
- {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
+ "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}",
+ "@odata.count": 1,
+ "value": [
+ {
"@odata.type": "#microsoft.graph.callRecording",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-12T11:24:30.6414074Z",
- "id": "MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl"
- }
- ]
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
+ ]
} ```
The third request continues to use the latest `@odata.nextLink` returned from th
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeeting/getAllRecordings?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg
+GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}
``` #### Third and final response for the round
-The third response returns the only remaining recordings and a `@odata.deltaLink` property with a `deltaToken` which indicates that all recordings have been returned. Save and use the `@odata.deltaLink` URL to query for any new recording that is added from this point onwards.
+The third response returns the only remaining recordings and a `@odata.deltaLink` property with a `deltaToken`, which indicates that all recordings are returned. Save and use the `@odata.deltaLink` URL to query for any new recording that is added from this point onwards.
<!-- { "blockType": "response",
HTTP/1.1 200 OK
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
- "@odata.count": 1,
- "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4",
- "value":[
- {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}",
+ "@odata.count": 1,
+ "value": [
+ {
"@odata.type": "#microsoft.graph.callRecording",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-11T21:29:42.6514074Z",
- "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl"
- }
- ]
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
+ ]
} ```
-### Example 2: Next round to get additional recordings
+### Example 2: Next round to get more recordings
Using the `@odata.deltaLink` from the last request in the last round, you can get only those recordings added since the `@odata.deltaLink` was acquired.
The following example shows a request.
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4
+GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}
``` - #### Response The following example shows the response.
Content-type: application/json
{ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callRecording)",
- "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_yjz2nsMoh1gXNtXii7s78HapCi5woifXqwXlVNxICh8wUUnvE2gExsa8eZ2Vy_ch5rVIhm067_1mUPML3iYUVyg.3o0rhgaBUduuxOr98An5pjBDP5JjKUiVWku3flSiOsk",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken2}",
+ "@odata.count": 1,
"value": [
- {
+ {
"@odata.type": "#microsoft.graph.callRecording",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "recordingContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/recordings/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-11T21:29:42.6514074Z",
- "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl"
- }
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "recordingContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
] } ```
v1.0 Callrecording Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/callrecording-get.md
For a recording, this API returns the metadata of the single recording associate
> * This API doesn't support meetings created by using the [create onlineMeeting API](/graph/api/application-post-onlinemeetings) that are not associated with an event on the user's calendar. > * This API works differently in one or more national clouds. For details, see [Microsoft Teams API implementation differences in national clouds](/graph/teamwork-national-cloud-differences). ## Permissions
v1.0 Calltranscript Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calltranscript-delta.md
Title: "callTranscript: delta"
-description: "Get a set of callTranscript resources that have been added for onlineMeeting instances organized by the specified user."
+description: "Get a set of callTranscript resources added for onlineMeeting instances organized by the specified user."
ms.localizationpriority: medium doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get a set of [callTranscript](../resources/calltranscript.md) resources that have been added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.
+Get a set of [callTranscript](../resources/calltranscript.md) resources added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.
-Delta query supports both full synchronization that gets all the transcripts for online meetings organized by a given user, and incremental synchronization that gets transcripts that have been added since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that transcript view periodically.
+Delta query supports both full synchronization that gets all the transcripts for online meetings organized by the user, and incremental synchronization that gets transcripts added since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that transcript view periodically.
A GET request with the delta function returns either: - A `@odata.nextLink` (that contains a URL with a **delta** function call and a `skipToken`), or - A `@odata.deltaLink` (that contains a URL with a **delta** function call and `deltaToken`).
-State tokens are completely opaque to the client. To proceed with a round of change tracking, simply copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next **delta** function call for that same transcript view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you start the next round of synchronization to get the new transcripts that have been added after acquiring `@odata.deltaLink`..
+State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next **delta** function call for that same transcript view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you start the next round of synchronization to get the new transcripts added after acquiring `@odata.deltaLink`.
For more information, see the [delta query](/graph/delta-query-overview) documentation.
+### Known issues
+
+The following known issues are associated with this API:
+
+- [Using the `$top` query parameter might not return the @odata.nextLink](https://developer.microsoft.com/en-us/graph/known-issues/?search=22931).
+- [Delta queries might return older artifacts when meetings have unrelated changes](https://developer.microsoft.com/en-us/graph/known-issues/?search=22934).
+ ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
Choose the permission or permissions marked as least privileged for this API. Us
## HTTP request <!-- { "blockType": "ignored" } -->
-```http
-GET /users/{id}/onlineMeetings/getAllTranscripts/delta?$filter=meetingOrganizerId%20eq%20'{id}'
+``` http
+GET /users/{usersId}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta
```
->**Note:** If you don't specify a **meetingOrganizerId**, the request fails.
+>**Note:** If you don't pass the function parameter **meetingOrganizerUserId**, the request fails.
## Query parameters
In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLin
|:|:--|:-| | `$deltatoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next round of change tracking for that collection.| | `$skiptoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating that there are further changes to be tracked. |
+| `$top` | integer | Allows the caller to specify the maximum number of objects per page. |
+ ## Request headers | Header | Value |
The following example shows a series of three requests to synchronize the call t
- Step 2: [second request](#second-request) and [response](#second-response) - Step 3: [third request](#third-request) and [final response](#third-and-final-response-for-the-round).
-See also what you'll do in the [next round to get additional transcripts](#example-2-next-round-to-get-additional-transcripts).
+See also what you'll do in the [next round to get more transcripts](#example-2-next-round-to-get-more-transcripts).
#### Initial request
In this example, the call transcripts are being synchronized for the first time,
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts/delta?$filter=meetingOrganizerId%20eq%20'8b081ef6-4792-4def-b2c9-c363a1bf41d5'
+GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta
``` #### Initial response
The response includes two call transcripts and a `@odata.nextLink` response head
<!-- { "blockType": "response", "truncated": true,
- "@odata.type": "Collection(microsoft.graph.callTranscript)"
+ "@odata.type": "microsoft.graph.callTranscript",
+ "isCollection": true
} --> ```http HTTP/1.1 200 OK Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
- "@odata.count": 2,
- "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg",
- "value":[
- {
- "@odata.type": "#microsoft.graph.callTranscript",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
- "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-03T22:29:42.6514074Z",
- "id": "MSMjMCMjZDExYWQ2OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl"
- },
- {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
+ "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken1}",
+ "@odata.count": 1,
+ "value": [
+ {
"@odata.type": "#microsoft.graph.callTranscript",
- "meetingId": "MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA5MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19OMUUxWTFJME56QXRabVF5T0MxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-05T11:24:30.6414074Z",
- "id": "MSMjMCMjZDExYWQ3OGEtMWVhYS00MGFjLWJkZWItMTExNjMyNjExYzRl"
- }
- ]
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
+ ]
} ```
Content-type: application/json
The second request specifies the `@odata.nextLink` URL returned from the previous response. Notice that it no longer has to specify the same query parameters as in the initial request, as the `skipToken` in the `@odata.nextLink` URL encodes and includes them. - <!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXvkS7mbjFAe9Uidm2D70e58K-BOnoJadAqkZEJmoLprr5eSP1hQPlb3dJ1AVz3xCYKxov6hSEJhsasyg
+GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta
+$skiptoken={skipToken1}
``` #### Second response
-The second response returns the next 2 call transcripts and a `@odata.nextLink` property with a `skipToken` which indicates there are more transcripts.
+The second response returns one or more next call transcripts and a `@odata.nextLink` property with a `skipToken`, which indicates there are more transcripts.
<!-- { "blockType": "response", "truncated": true,
- "@odata.type": "Collection(microsoft.graph.callTranscript)"
+ "@odata.type": "microsoft.graph.callTranscript",
+ "isCollection": true
} --> ```http HTTP/1.1 200 OK Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
- "@odata.count": 2,
- "@odata.nextLink": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg",
- "value":[
- {
- "@odata.type": "#microsoft.graph.callTranscript",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
- "meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-11T21:29:42.6514074Z",
- "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl"
- },
- {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
+ "@odata.nextLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}",
+ "@odata.count": 1,
+ "value": [
+ {
"@odata.type": "#microsoft.graph.callTranscript",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19BQkMxRDFEMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-12T11:24:30.6414074Z",
- "id": "MSMjMCMjZDIyYWQyMmEtMmVhYS0yMmFjLWJkZWItMjIyNjMyNjExYzRl"
- }
- ]
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
+ ]
} ```
The third request continues to use the latest `@odata.nextLink` returned from th
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$skiptoken=GGXve9Uidm2D70kS7mbjFAe58K-BOnPlb3dJ1AVz3xCYmoLprr5eSP1hQKxov6hSEJhsasyg
+GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}
``` #### Third and final response for the round
-The third response returns the only remaining transcripts and a `@odata.deltaLink` property with a `deltaToken` which indicates that all transcripts have been returned. Save and use the `@odata.deltaLink` URL to query for any new transcript that is added from this point onwards.
+The third response returns the only remaining transcripts and a `@odata.deltaLink` property with a `deltaToken`, which indicates that all transcripts are returned. Save and use the `@odata.deltaLink` URL to query for any new transcript that is added from this point onwards.
<!-- { "blockType": "response", "truncated": true,
- "@odata.type": "Collection(microsoft.graph.callTranscript)"
+ "@odata.type": "microsoft.graph.callTranscript",
+ "isCollection": true
} --> ```http HTTP/1.1 200 OK Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
- "@odata.count": 1,
- "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4",
- "value":[
- {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}",
+ "@odata.count": 1,
+ "value": [
+ {
"@odata.type": "#microsoft.graph.callTranscript",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-11T21:29:42.6514074Z",
- "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl"
- }
- ]
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
+ }
+ ]
} ```
-### Example 2: Next round to get additional transcripts
+### Example 2: Next round to get more transcripts
-Using the `@odata.deltaLink` from the last request in the last round, you can get only those transcripts that have been added since the `@odata.deltaLink` was acquired.
+Using the `@odata.deltaLink` from the last request in the last round, you can get only those transcripts added since the `@odata.deltaLink` was acquired.
#### Request
+The following example shows a request.
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4
+GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}
```- #### Response
+The following example shows the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true,
- "@odata.type": "Collection(microsoft.graph.callTranscript)"
+ "@odata.type": "microsoft.graph.callTranscript",
+ "isCollection": true
} --> ```http HTTP/1.1 200 OK
Content-type: application/json
{ "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(callTranscript)",
- "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_yjz2nsMoh1gXNtXii7s78HapCi5woifXqwXlVNxICh8wUUnvE2gExsa8eZ2Vy_ch5rVIhm067_1mUPML3iYUVyg.3o0rhgaBUduuxOr98An5pjBDP5JjKUiVWku3flSiOsk",
+ "@odata.deltaLink": "https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken2}",
+ "@odata.count": 1,
"value": [ { "@odata.type": "#microsoft.graph.callTranscript",
- "meetingId": "MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy",
+ "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=",
+ "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy",
"meetingOrganizerId": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
- "transcriptContentUrl": "https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSo4YjA4MWVmNi00NzkyLTRkZWYtYjJjOS1jMzYzYTFiZjQxZDUqMCoqMTk6bWVldGluZ19IMU4xMlgxSTBOekF0Wm1ReU8xQzIxMU5HWTFMV0UwTTJFdFpXTTFOVFkxWW1Rd05HTTBAdGhyZWFkLnYy/transcripts/MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl/content",
- "createdDateTime": "2023-08-11T21:29:42.6514074Z",
- "id": "MSMjMCMjZDMzYWQzM2EtMmVhYS0zM2FjLWJkZWItMjMzNjMyNjExYzRl"
+ "createdDateTime": "2023-12-02T06:59:34.7411768Z",
+ "transcriptContentUrl": "https://graph.microsoft.com/betAtOWJiMy1jMTUzYzE4ODY4NGY=/content",
+ "meetingOrganizer": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5",
+ "displayName": null,
+ "userIdentityType": "aadUser",
+ "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853"
+ }
+ }
} ] }
v1.0 Calltranscript Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calltranscript-get.md
Retrieving the transcript returns the metadata of the single transcript associat
> * This API works differently in one or more national clouds. For details, see [Implementation differences in national clouds](/graph/teamwork-national-cloud-differences). > * If you want to retrieve meeting transcripts, use the [Create event](../api/user-post-events.md#example-5-create-and-enable-an-event-as-an-online-meeting) API instead. ## Permissions
v1.0 Certificatebasedapplicationconfiguration List Trustedcertificateauthorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-list-trustedcertificateauthorities.md
The following example shows how to get a list of trusted certificate authorities
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_certificateauthorityasentity"
The following example shows a request.
--> ``` http
-GET directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities
+GET https://graph.microsoft.com/beta/directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities
```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++ ### Response The following example shows the response.
The following example shows the response.
} --> ``` http
-HTTP/1.1 201 Created
+HTTP/1.1 200 OK
Content-Type: application/json {
v1.0 Certificatebasedapplicationconfiguration Post Trustedcertificateauthorities https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-post-trustedcertificateauthorities.md
If successful, this method returns a `201 Created` response code and a [certific
### Request The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_certificateauthorityasentity_from_"
The following example shows a request.
--> ``` http
-POST directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities
+POST https://graph.microsoft.com/beta/directory/certificateAuthorities/certificateBasedApplicationConfigurations/0a6a9b97-b84c-406a-a703-14d699d1fbb1/trustedCertificateAuthorities
Content-Type: application/json {
Content-Type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++ ### Response The following example shows the response.
v1.0 Certificatebasedauthconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-delete.md
Title: "Delete certificateBasedAuthConfiguration" description: "Delete certificateBasedAuthConfiguration." ms.localizationpriority: medium-+ doc_type: "apiPageType"
v1.0 Certificatebasedauthconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-get.md
Title: "Get certificateBasedAuthConfiguration" description: "Get the properties of a certificatebasedauthconfiguration object." ms.localizationpriority: medium-+ doc_type: "apiPageType"
v1.0 Certificatebasedauthconfiguration List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-list.md
Title: "List certificateBasedAuthConfigurations" description: "Get a list of certificatebasedauthconfiguration objects." ms.localizationpriority: medium-+ doc_type: "apiPageType"
v1.0 Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md
Title: "Create certificateBasedAuthConfiguration" description: "Use this API to create a new certificateBasedAuthConfiguration." ms.localizationpriority: medium-+ doc_type: "apiPageType"
v1.0 Channel Archive https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-archive.md
+
+ Title: "channel: archive"
+description: "Archive a channel in a team. "
+
+ms.localizationpriority: medium
+++
+# channel: archive
+
+Namespace: microsoft.graph
++
+Archive a [channel](../resources/channel.md) in a team. When a channel is archived, users can't send new messages or react to existing messages in the channel, edit the channel settings, or make other changes to the channel.
+
+You can delete an archived channel, or add and remove members from it. If you archive a team, its channels are archived for you.
+
+Archiving is asynchronous; a channel is archived after the asynchronous archiving operation completes successfully, which might occur after the response returns.
+
+A channel without an owner, or that belongs to a [group](../resources/group.md) that has no owner, can't be archived.
+
+To restore a channel from its archived state, use the [unarchive](channel-unarchive.md) method. A channel canΓÇÖt be archived or unarchived if its team is archived.
++
+## Permissions
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "channel_archive" } -->
+
+> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /teams/{team-id}/channels/{channel-id}/archive
+POST /groups/{team-id}/team/channels/{channel-id}/archive
+```
+
+## Request headers
+
+| Header | Value |
+|:|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+In the request, you can optionally include the `shouldSetSpoSiteReadOnlyForMembers` parameter in a JSON body, as follows.
+```JSON
+{
+ "shouldSetSpoSiteReadOnlyForMembers": true
+}
+```
+This optional parameter defines whether to set permissions for channel members to read-only on the SharePoint Online site associated with the team. Setting it to false or omitting the body altogether results in this step being skipped.
+
+## Response
+
+If archiving is started successfully, this method returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [teamsAsyncOperation](../resources/teamsasyncoperation.md) that was created to handle archiving of the channel in a team. Check the status of the archiving operation by making a GET request to this location.
+
+## Examples
+
+### Example 1: Archive a channel
+
+The following example shows a request to archive a channel.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "archive_channel"
+}-->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "name": "archive_channel"
+}-->
+```http
+HTTP/1.1 202 Accepted
+Location: /teams/{team-id}/operations/{operation-id}
+Content-Type: text/plain
+Content-Length: 0
+```
+
+### Example 2: Archive a channel when the team is archived
+
+The following example shows a request when the **team is archived**.
+
+#### Request
+
+<!-- { "blockType": "ignored" } -->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive
+```
+
+#### Response
+The following example shows the `400` error response.
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+http/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 193
+
+{
+ "error": {
+ "code": "BadRequest",
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "innerError": {
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "code": "Unknown",
+ "innerError": {},
+ "date": "2023-12-11T04:26:35",
+ "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
+ "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
+ }
+ }
+}
+
+```
+
+<!-- uuid: e848414b-4669-4484-ac36-1504c58a3fb8
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Archive Channel",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}
+-->
v1.0 Channel Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-get.md
Choose the permission or permissions marked as least privileged for this API. Us
This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. + <!-- { "blockType": "permissions", "name": "channel_get" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-get-permissions.md)]
HTTP/1.1 200 OK
"email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "standard",
+ "isArchived": false,
"moderationSettings": { "userNewMessageRestriction": "everyone", "replyRestriction": "everyone",
Content-type: application/json
"email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "standard",
+ "isArchived": false,
"moderationSettings": { "userNewMessageRestriction": "moderators", "replyRestriction": "everyone",
Content-type: application/json
"email": "", "webUrl": "https://teams.microsoft.com/l/channel/19%3Ad468258bc90f4a358361b5d73b89d39b%40thread.skype/General?groupId=8bb12236-b929-42e0-94a0-1c417466ebf8&tenantId=139d16b4-7223-43ad-b9a8-674ba63c7924", "membershipType": "private",
+ "isArchived": false,
"moderationSettings": null } ```
v1.0 Channel Getallretainedmessages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-getallretainedmessages.md
To learn more about how to use the Microsoft Teams export APIs to export content
[!INCLUDE [teams-metered-apis](../../includes/teams-metered-apis.md)]
+> [!NOTE]
+> This API requires [Teams retention policies](/purview/create-retention-policies?tabs=teams-retention) to be configured. For more information, see [Manage retention policies for Microsoft Teams](/microsoftteams/retention-policies).
+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions
v1.0 Channel List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-list.md
Content-type: application/json
"description": "AutoTestTeam_20210311_150740.2550_fim3udfdjen9", "membershipType": "standard", "email": "someperson@microsoft.com",
- "moderationSettings": null
+ "moderationSettings": null,
+ "isArchived": false
} ] }
Content-type: application/json
"createdDateTime": "2020-05-27T19:22:25.692Z", "displayName": "General", "description": "test private team",
- "membershipType": "private"
+ "membershipType": "private",
+ "isArchived": false,
} ] }
Content-length: 262
"webUrl": "https://teams.microsoft.com/l/channel/19%3ALpxShHZZh9utjNcEmUS5aOEP9ASw85OUn05NcWYAhX81%40thread.tacv2/shared%20channel-01?groupId=6a720ba5-7373-463b-bc9f-4cd04b5c6742&tenantId=df81db53-c7e2-418a-8803-0e68d4b88607", "membershipType": "shared", "email": "someperson@microsoft.com",
+ "isArchived": false,
"moderationSettings": null } ]
v1.0 Channel Patch Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-patch-tabs.md
Update the properties of the specified [tab](../resources/teamstab.md).
This API can be used to configure the content of the tab.
+> [!NOTE]
+> You can't use this API to update a static tab. An attempt to update a static tab returns a `400 Bad Request` response code.
+ [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions
v1.0 Channel Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-members.md
Include the following properties in the request body.
If successful, this method returns a `201 Created` response code and a [conversationMember](../resources/conversationmember.md) object in the response body.
+> [!NOTE]
+> The response code `404 Not Found` is returned when you attempt to add a disabled/blocked user.
+ ## Examples ### Example 1: Add a member to a private channel
v1.0 Channel Post Messages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-messages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "channel_post_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
-In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
<!-- markdownlint-disable MD024 --> <!-- markdownlint-disable MD001 -->
v1.0 Channel Post Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-tabs.md
Namespace: microsoft.graph
Add (pin) a [tab](../resources/teamstab.md) to the specified [channel](../resources/channel.md) within a [team](../resources/team.md). The app must be [preinstalled in the team](../api/team-list-installedapps.md) and have the [configurableTabs](/microsoftteams/platform/resources/schema/manifest-schema#configurabletabs) property defined in the app manifest.
+> **Note**: If the app manifest for a given **appId** contains a static tab that matches the current scope (**team**), the static tab is pinned by default.
+ [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions
POST /teams/{id}/channels/{id}/tabs
## Request body
-A [teamsTab](../resources/teamstab.md).
+In the request body, supply a JSON representation of a [teamsTab](../resources/teamstab.md).
+
+> [!NOTE]
+> When you pin a static tab, Teams takes the **displayName** and **configuration** from the app manifest. If these properties are specified in the request body, this API returns a `400 Bad Request` response code.
## Response
v1.0 Channel Unarchive https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-unarchive.md
+
+ Title: "channel: unarchive"
+description: "Restore an archived channel in a team. Unarchiving restores the ability for users to send messages and edit the channel."
+ms.localizationpriority: medium
++++
+# channel: unarchive
+
+Namespace: microsoft.graph
++
+Restore an archived [channel](../resources/channel.md). Unarchiving restores the ability for users to send messages and edit the channel. Channels are archived via the [archive](channel-archive.md) API.
+
+Unarchiving is an asynchronous operation; a channel is unarchived when the asynchronous unarchive operation completes successfully, which might occur after this method responds.
+
+> **Note**: An archived channel that belongs to an archived team cannot be unarchived. Unarchive the team before you unarchive the channel; otherwise, an error will occur.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "channel_unarchive" } -->
+
+> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of.
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /teams/{team-id}/channels/{channel-id}/unarchive
+POST /groups/{team-id}/team/channels/{channel-id}/unarchive
+```
+
+## Request headers
+
+| Header | Value |
+|:|:--|
+| Authorization | Bearer {token}. Required. |
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If unarchiving is started successfully, this method returns a `202 Accepted` response code. The response contains a `Location` header, which contains the location of the [teamsAsyncOperation](../resources/teamsasyncoperation.md) that was created to handle unarchiving of the channel of the team. Check the status of the unarchiving operation by making a GET request to this location.
+
+## Example
+
+### Example 1: Unarchive a channel
+The following example shows a request to unarchive a channel.
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "unarchive_channel"
+}-->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "name": "unarchive_channel"
+}-->
+```http
+HTTP/1.1 202 Accepted
+Location: /teams/{team-id}/operations/{operation-id}
+Content-Type: text/plain
+Content-Length: 0
+```
+
+### Example 2: Unarchive a channel when the team is archived
+
+The following example shows a request to unarchive a channel in an archived team.
+
+#### Request
+
+<!-- { "blockType": "ignored" } -->
+```http
+POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/unarchive
+```
+
+#### Response
+The following example shows the `400` error response.
+
+<!-- { "blockType": "ignored" } -->
+```http
+http/1.1 400 Bad Request
+Content-Type: application/json
+Content-Length: 193
+
+{
+ "error": {
+ "code": "BadRequest",
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "innerError": {
+ "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
+ "code": "Unknown",
+ "innerError": {},
+ "date": "2023-12-11T04:26:35",
+ "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
+ "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
+ }
+ }
+}
+
+```
+<!-- uuid: 9a9bb83f-6f35-4426-bb04-73ca43ad6cc8
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Unarchive channel",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": []
+}
+-->
v1.0 Chat Delete Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_delete_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-installedapps-permissions.md)]
-> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Delete Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_delete_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-members-permissions.md)]
-> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Delete Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-delete-tabs.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_delete_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-delete-tabs-permissions.md)]
-> **Note**: The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat Get Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)]
-> **Note**:
-The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
Content-type: application/json
``` ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat
-The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set.
+The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set.
#### Request
v1.0 Chat Get Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-members-permissions.md)]
-> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
GET /users/{user-id | user-principal-name}/chats/{chat-id}/members/{membership-i
## Optional query parameters
-This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
v1.0 Chat Get Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get-tabs.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-tabs-permissions.md)]
-> **Note**: The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_get" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-get-permissions.md)]
-> **Note**: The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
Content-type: application/json
"viewpoint": { "isHidden": true, "lastMessageReadDateTime": "2021-05-06T23:55:07.191Z"
- }
+ },
+ "isHiddenForAllMembers": false
} ```
Content-type: application/json
"viewpoint": { "isHidden": false, "lastMessageReadDateTime": "2021-07-06T22:26:27.98Z"
- }
+ },
+ "isHiddenForAllMembers": false
} ```
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-08-09T17:38:24.101Z" },
+ "isHiddenForAllMembers": false,
"members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-08-17T18:04:32.583Z" },
+ "isHiddenForAllMembers": false,
"onlineMeetingInfo": { "calendarEventId": "AAMkADAzMjNhY2NiLWVmNDItNDVjYS05MnFjLTExY2U0ZWMyZTNmZQBGAAAAAAARDMODhhR0TZRGWo9nN0NcBwAmvYmLhDvYR6hCFdQLgxR-AAAAAAENAAAmvYmLhDvYR6hCFdQLgxR-AABkrglJAAA=", "joinWebUrl": "https://teams.microsoft.com/l/meetup-join/19%3Ameeting_YDZlYTYxOWUtYzdlMi00ZmMxLWIxMTAtN2YzODZlZjAxYzI4%40thread.v2/0?context=%7b%22Tid%22%3a%222432b57b-0abd-43db-aa7b-16eadd115d34%22%2c%22Oid%22%3a%22bfb5bb25-3a8d-487d-9828-7875ced51a30%22%7d",
Content-type: application/json
"isHidden": true, "lastMessageReadDateTime": "2022-09-08T23:11:54.353Z" },
+ "isHiddenForAllMembers": false,
"lastMessagePreview@odata.context": "https://graph.microsoft.com/beta/$metadata#chats('19%3Aebe3857aa388434bab0cad9d2e09f4de%40thread.v2')/lastMessagePreview/$entity", "lastMessagePreview": { "id": "1662678714353",
v1.0 Chat Getallretainedmessages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-getallretainedmessages.md
Namespace: microsoft.graph
Get all retained messages from all [chats](../resources/chatmessage.md) that a user is a participant in, including one-on-one chats, group chats, and meeting chats.
+To learn more about how to use the Microsoft Teams export APIs to export content, see [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content).
+ [!INCLUDE [teams-metered-apis](../../includes/teams-metered-apis.md)]
+> [!NOTE]
+> This API requires [Teams retention policies](/purview/create-retention-policies?tabs=teams-retention) to be configured. For more information, see [Manage retention policies for Microsoft Teams](/microsoftteams/retention-policies).
+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions
The following example shows a request that uses the `$top` and `$filter` query p
```http GET /users/{id}/chats/getAllRetainedMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z ```+
+The following table lists examples that show how to use the `$filter` parameter.
+
+|Scenario | `$filter` parameter |Possible values |
+|:--|:|:--|
+|Get messages sent by user identity type |$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' |aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser|
+|Get messages sent by application type |$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' |aadApplication, bot, tenantBot, office365Connector, outgoingWebhook |
+|Get messages sent by user ID |$filter=from/user/id eq '{oid}' ||
+|Get control (system event) messages |$filter=messageType eq 'systemEventMessage' ||
+|Exclude control (system event) messages |$filter=messageType ne 'systemEventMessage' ||
+ ## Request headers |Name|Description|
v1.0 Chat List Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)]
-> **Note:**
-The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent):
+> [!NOTE]
+> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent):
> - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All
v1.0 Chat List Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-members-permissions.md)]
-> **Note**: The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat List Messages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-messages.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_messages" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-messages-permissions.md)]
-> **Note:** The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
This method supports the following [OData query parameters](/graph/query-paramet
| [$orderby](/graph/query-parameters#orderby-parameter) | Currently supports the **lastModifiedDateTime** (default) and **createdDateTime** properties in descending order. The ascending order is currently not supported.| | [$filter](/graph/query-parameters#filter-parameter) | Sets the date range filter for the **lastModifiedDateTime** and **createdDateTime** properties. The **lastModifiedDateTime** property supports the `gt` and `lt` operators. The **createdDateTime** property supports the `lt` operator. You can only filter results if the request URL contains the `$orderby` and `$filter` query parameters configured for the same property; otherwise, the `$filter` query option is ignored.|
-The other [OData query parameters](/graph/query-parameters) are not currently supported.
+The other [OData query parameters](/graph/query-parameters) aren't currently supported.
## Request headers
v1.0 Chat List Operations https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-operations.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_operations" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-operations-permissions.md)]
-> **Note:** The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- {
v1.0 Chat List Permissiongrants https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list-permissiongrants.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_list_permissiongrants" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-list-permissiongrants-permissions.md)]
-> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chat List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-list.md
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-06-03T08:05:49.521Z" },
- "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f"
+ "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",
+ "isHiddenForAllMembers": false
}, { "id": "19:561082c0f3f847a58069deb8eb300807@thread.v2",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-05-27T22:13:01.577Z" },
- "webUrl": "https://teams.microsoft.com/l/chat/19%3A561082c0f3f847a58069deb8eb300807@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f"
+ "webUrl": "https://teams.microsoft.com/l/chat/19%3A561082c0f3f847a58069deb8eb300807@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",
+ "isHiddenForAllMembers": false
}, { "id": "19:d74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "0001-01-01T00:00:00Z" },
- "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f"
+ "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",
+ "isHiddenForAllMembers": false
} ] }
Content-type: application/json
"lastMessageReadDateTime": "2021-04-02T08:15:02.091Z" }, "webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",
+ "isHiddenForAllMembers": false,
"members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember",
Content-type: application/json
"lastMessageReadDateTime": "0001-01-01T00:00:00Z" }, "webUrl": "https://teams.microsoft.com/l/chat/19%3A561082c0f3f847a58069deb8eb300807@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",
+ "isHiddenForAllMembers": false,
"members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember",
Content-type: application/json
"lastMessageReadDateTime": "2021-06-05T00:31:30.047Z" }, "webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f",
+ "isHiddenForAllMembers": false,
"members": [ { "@odata.type": "#microsoft.graph.aadUserConversationMember",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-06-05T00:31:30.047Z" },
+ "isHiddenForAllMembers": false,
"lastMessagePreview": { "id": "1622853091207", "createdDateTime": "2021-06-05T00:31:31.207Z",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-06-03T08:05:49.521Z" },
+ "isHiddenForAllMembers": false,
"lastMessagePreview": { "id": "1622707540293", "createdDateTime": "2021-06-03T08:05:40.293Z",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-06-04T05:34:23.712Z" },
+ "isHiddenForAllMembers": false,
"lastMessagePreview": { "id": "1622784857324", "createdDateTime": "2021-06-04T05:34:17.324Z",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-05-27T22:13:01.577Z" },
+ "isHiddenForAllMembers": false,
"lastMessagePreview": { "id": "1621533401696", "createdDateTime": "2021-05-20T17:56:41.696Z",
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-06-05T00:01:30.233Z" },
+ "isHiddenForAllMembers": false,
"webUrl": "https://teams.microsoft.com/l/chat/19%3Ameeting_MjdhNjM4YzUtYzExZi00OTFkLTkzZTAtNTVlNmZmMDhkNGU2@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", "members": [ {
Content-type: application/json
"isHidden": false, "lastMessageReadDateTime": "2021-06-05T00:31:30.047Z" },
+ "isHiddenForAllMembers": false,
"webUrl": "https://teams.microsoft.com/l/chat/19%3Ad74fc2ed-cb0e-4288-a219-b5c71abaf2aa_8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca@unq.gbl.spaces/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f", "members": [ {
Content-type: application/json
"viewpoint": { "isHidden": false, "lastMessageReadDateTime": "2022-05-03T18:15:42.307Z"
- }
+ },
+ "isHiddenForAllMembers": false
}, { "id": "19:82fe7758-5bb3-4f0d-a43f-e555fd399c6f_bfb5bb25-3a8d-487d-9828-7875ced51a30@unq.gbl.spaces",
Content-type: application/json
"viewpoint": { "isHidden": true, "lastMessageReadDateTime": "2022-03-08T19:55:30.491Z"
- }
+ },
+ "isHiddenForAllMembers": false
} ] }
Content-type: application/json
"viewpoint": { "isHidden": false, "lastMessageReadDateTime": "2023-06-29T10:22:15.024Z"
- }
+ },
+ "isHiddenForAllMembers": false
} ]
v1.0 Chat Patch Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-patch-tabs.md
Namespace: microsoft.graph
Update the properties of the specified [tab](../resources/teamstab.md) in a [chat](../resources/chat.md). This API can be used to configure the content of the tab.
-> **Note:** If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab pinned in the meeting will be updated.
+> [!NOTE]
+> - If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab pinned in the meeting will be updated.
+> - You can't use this API to update a static tab. An attempt to update a static tab returns a `400 Bad Request` response code.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_patch_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-patch-tabs-permissions.md)]
-> **Note:** The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
PATCH /chats/{chat-id}/tabs/{tab-id}
| Content-Type | application/json. Required. | ## Request body
-In the request body, supply a JSON representation of [tab](../resources/teamstab.md) object.
+In the request body, supply a JSON representation of a [tab](../resources/teamstab.md) object.
## Response
v1.0 Chat Patch https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-patch.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_patch" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-patch-permissions.md)]
-> **Note:**S The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Post Installedapps https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-installedapps.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_installedapps" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)]
-> **Notes:**
+> [!NOTE]
> - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
v1.0 Chat Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_members" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-members-permissions.md)]
-> **Note:** The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Post Tabs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-tabs.md
Namespace: microsoft.graph
Add (pin) a [tab](../resources/teamstab.md) to the specified [chat](../resources/chat.md). The corresponding app must already be [installed in the chat](../api/chat-list-installedapps.md).
-> **Note:** If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then, effectively, the tab will get added to the meeting.
+> **Notes**:
+> * If the chat is associated with an [onlineMeeting](../resources/onlinemeeting.md) instance, then the tab is effectively added to the meeting.
+> * If the app manifest for a given **appId** contains a static tab that matches the current scope (`chat`/`groupChat`), the static tab is pinned by default.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_post_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-post-tabs-permissions.md)]
-> **Note:** The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
POST /chats/{chat-id}/tabs
In the request body include a JSON representation of a [teamsTab](../resources/teamstab.md).
+> [!NOTE]
+> When you pin a static tab, Teams takes the **displayName** and **configuration** from the app manifest. If these properties are specified in the request body, this API returns a `400 Bad Request` response code.
+ ## Response If successful, this method returns a `201 Created` response code and an instance of the [teamsTab](../resources/teamstab.md) resource in the body.
v1.0 Chat Sendactivitynotification https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-sendactivitynotification.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_sendactivitynotification" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-sendactivitynotification-permissions.md)]
->**Note:** The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request
v1.0 Chat Teamsappinstallation Upgrade https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-teamsappinstallation-upgrade.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chat_teamsappinstallation_upgrade" } --> [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)]
-> **Notes:**
+> [!NOTE]
> - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
v1.0 Chatmessage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All|
-> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
+> [!NOTE]
+> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
## HTTP request
GET /me/chats/{chat-id}/messages/{message-id}
``` ## Optional query parameters
-This method does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers | Header | Value |
Content-type: application/json
"messageHistory": [] } ```
+### Example 4: Get a chat message with custom emojis and reactions
+
+The following example shows a request to get a chat message that contains custom emojis in the message body and includes custom reactions.
+
+#### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_chatmessage_4",
+ "sampleKeys": ["19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2", "1706763669648"]
+}-->
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706763669648
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response. The message body contains a `<customemoji></customemoji>` tag, and the message includes a custom reaction indicated by `"reactionType": "custom"`. You can access both custom emojis and reactions as content hosted within a chat message.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.chatMessage"
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#chats('19%3Abcf84b15c2994a909770f7d05bc4fe16%40thread.v2')/messages/$entity",
+ "id": "1706763669648",
+ "replyToId": null,
+ "etag": "1707948456260",
+ "messageType": "message",
+ "createdDateTime": "2024-02-01T05:01:09.648Z",
+ "lastModifiedDateTime": "2024-02-14T22:07:36.26Z",
+ "lastEditedDateTime": null,
+ "deletedDateTime": null,
+ "subject": null,
+ "summary": null,
+ "chatId": "19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2",
+ "importance": "normal",
+ "locale": "en-us",
+ "webUrl": null,
+ "channelIdentity": null,
+ "onBehalfOf": null,
+ "policyViolation": null,
+ "eventDetail": null,
+ "from": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "670374fa-3b0e-4a3b-9d33-0e1bc5ff1956",
+ "displayName": "Adele Vance",
+ "userIdentityType": "aadUser",
+ "tenantId": "2432b57b-0abd-43db-aa7b-16eadd115d34"
+ }
+ },
+ "body": {
+ "contentType": "html",
+ "content": "<p>I am looking&nbsp;<emoji id=\"1f440_eyes\" alt=\"👀\" title=\"Eyes\"></emoji><customemoji id=\"dGVzdHNjOzAtd3VzLWQyLTdiNWRkZGQ2ZGVjMDNkYzIwNTgxY2NkYTE1MmEyZTM4\" alt=\"testsc\" source=\"https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706638496169/hostedContents/aWQ9LHR5cGU9MSx1cmw9aHR0cHM6Ly91cy1jYW5hcnkuYXN5bmNndy50ZWFtcy5taWNyb3NvZnQuY29tL3YxL29iamVjdHMvMC13dXMtZDItN2I1ZGRkZDZkZWMwM2RjMjA1ODFjY2RhMTUyYTJlMzgvdmlld3MvaW1ndDJfYW5pbQ==/$value\"></customemoji></p>"
+ },
+ "attachments": [],
+ "mentions": [],
+ "reactions": [
+ {
+ "reactionType": "💯",
+ "reactionContentUrl": null,
+ "createdDateTime": "2024-02-14T22:07:36.3Z",
+ "user": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "670374fa-3b0e-4a3b-9d33-0e1bc5ff1956",
+ "displayName": null,
+ "userIdentityType": "aadUser"
+ }
+ }
+ },
+ {
+ "reactionType": "custom",
+ "reactionContentUrl": "https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706763669648/hostedContents/aWQ9MC13dXMtZDExLTc3ZmI2NmY4MTMwMGI2OGEzYzRkOWUyNmU1YTc5ZmMyLHR5cGU9MSx1cmw9/$value",
+ "createdDateTime": "2024-02-14T22:07:02.288Z",
+ "user": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "28c10244-4bad-4fda-993c-f332faef94f0",
+ "displayName": null,
+ "userIdentityType": "aadUser"
+ }
+ }
+ }
+ ]
+}
+```
## Related content
v1.0 Chatmessage List Hostedcontents https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-hostedcontents.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md)
+Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md).s
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco
|Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All |
-> **Note**: The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
+> [!NOTE]
+> The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco
|Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All|
-> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
+> [!NOTE]
+> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc).
## HTTP request
v1.0 Chatmessage List Replies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-replies.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_list_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)]
-> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
+> [!NOTE]
+> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chatmessage Post Replies https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-post-replies.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_post_replies" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams).
-In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
+> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Chatmessage Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-post.md
Namespace: microsoft.graph
Send a new [chatMessage](../resources/chatmessage.md) in the specified [channel](../resources/channel.md) or a [chat](../resources/chat.md).
-> **Notes:**
+> [!NOTE]
> - We don't recommend that you use this API for data migration. It does not have the throughput necessary for a typical migration. > - It is a violation of the [terms of use](/legal/microsoft-apis/terms-of-use) to use Microsoft Teams as a log file. Only send messages that people will read.
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "chatmessage_post" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)]
-> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
-
-> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
+> [!NOTE]
+> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
+> - Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported.
### Permissions for chat <!-- { "blockType": "permissions", "name": "chatmessage_post_2" } -->
Content-type: application/json
"messageHistory": [] } ```
+### Example 5: Send a message with a file attachment in it using file share link
+
+#### Request
+The following example shows a request
+
+>**Notes:**
+> - The file to attach must already be in SharePoint. Use any GUID for your attachment ID. Use the file share link as **contentURL**. User must have permissions to drive item using the file [share link](/graph/api/shares-get?view=graph-rest-1.0&tabs=http).
+> - Using file share link for sending messages is not supported in [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams) scenario.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "post_chatmessage_5",
+ "sampleKeys": ["1e769eab-06a8-4b2e-ac42-1f040a4e52a1", "19:e28d1f9b354f4de88d2e9e4d8b983763@thread.tacv2"]
+}-->
+```http
+POST https://graph.microsoft.com/v1.0/teams/1e769eab-06a8-4b2e-ac42-1f040a4e52a1/channels/19:e28d1f9b354f4de88d2e9e4d8b983763@thread.tacv2/messages
+Content-type: application/json
+
+{
+ "body": {
+ "contentType": "html",
+ "content": "Testing with file share link. <attachment id=\"668f7fa8-8129-4de7-b32b-fe1b442e6ef1\"></attachment>"
+ },
+ "attachments": [
+ {
+ "id": "668f7fa8-8129-4de7-b32b-fe1b442e6ef1",
+ "contentType": "reference",
+ "contentUrl": "https://teamsgraph-my.sharepoint.com/:w:/g/personal/test_teamsgraph_onmicrosoft_com/Eah_j2YpgedNsyv-G0QubvEBma6Sd_76UtYkXwoJ-nYVEg?e=0H2Ibm"
+ }
+ ]
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.chatMessage"
+} -->
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('1e769eab-06a8-4b2e-ac42-1f040a4e52a1')/channels('19%3Ae28d1f9b354f4de88d2e9e4d8b983763%40thread.tacv2')/messages/$entity",
+ "id": "1709663385319",
+ "replyToId": null,
+ "etag": "1709663385319",
+ "messageType": "message",
+ "createdDateTime": "2024-03-05T18:29:45.319Z",
+ "lastModifiedDateTime": "2024-03-05T18:29:45.319Z",
+ "lastEditedDateTime": null,
+ "deletedDateTime": null,
+ "subject": null,
+ "summary": null,
+ "chatId": null,
+ "importance": "normal",
+ "locale": "en-us",
+ "webUrl": "https://teams.microsoft.com/l/message/19%3Ae28d1f9b354f4de88d2e9e4d8b983763%40thread.tacv2/1709663385319?groupId=1e769eab-06a8-4b2e-ac42-1f040a4e52a1&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1709663385319&parentMessageId=1709663385319",
+ "policyViolation": null,
+ "eventDetail": null,
+ "from": {
+ "application": null,
+ "device": null,
+ "user": {
+ "@odata.type": "#microsoft.graph.teamworkUserIdentity",
+ "id": "28c10244-4bad-4fda-993c-f332faef94f0",
+ "displayName": "Test User",
+ "userIdentityType": "aadUser"
+ }
+ },
+ "body": {
+ "contentType": "html",
+ "content": "Testing with file share link. <attachment id=\"668f7fa8-8129-4de7-b32b-fe1b442e6ef1\"></attachment>"
+ },
+ "channelIdentity": {
+ "teamId": "1e769eab-06a8-4b2e-ac42-1f040a4e52a1",
+ "channelId": "19:e28d1f9b354f4de88d2e9e4d8b983763@thread.tacv2"
+ },
+ "attachments": [
+ {
+ "id": "668f7fa8-8129-4de7-b32b-fe1b442e6ef1",
+ "contentType": "reference",
+ "contentUrl": "https://teamsgraph-my.sharepoint.com/personal/test_teamsgraph_onmicrosoft_com/Documents/Personal%20Drive%20file%201.docx",
+ "content": null,
+ "name": "Personal Drive file 1.docx",
+ "thumbnailUrl": null,
+ "teamsAppId": null
+ }
+ ],
+ "mentions": [],
+ "reactions": []
+}
+```
-### Example 5: Send inline images along with the message
+### Example 6: Send inline images along with the message
#### Request The following example shows a request.
The following example shows a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "post_chatmessage_5",
+ "name": "post_chatmessage_6",
"sampleKeys": ["19:2da4c29f6d7041eca70b638b43d45437@thread.v2"] }--> ```http
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
} ```
-### Example 6: Send a card with inline images
+### Example 7: Send a card with inline images
#### Request The following example shows a request.
The following example shows a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "post_chatmessage_6",
+ "name": "post_chatmessage_7",
"sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] }--> ```http
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
} ```
-### Example 7: @mention a channel in a channel message
+### Example 8: @mention a channel in a channel message
#### Request The following example shows a request. For information about how to get a list of channels in a team, see [List channels](../api/channel-list.md).
Content-type: application/json
} ```
-### Example 8: @mention a team in a channel message
+### Example 9: @mention a team in a channel message
#### Request The following example shows a request.
Content-type: application/json
} ```
-### Example 9: @mention a tag in a channel message
+### Example 10: @mention a tag in a channel message
#### Request The following example shows a request. For information about how to get a list of tags in a team, see [List teamworkTags](../api/teamworktag-list.md).
Content-type: application/json
} ```
-### Example 10: Send message that contains cards that are attributed to a Teams app
+### Example 11: Send message that contains cards that are attributed to a Teams app
#### Request
The following example shows a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "post_chatmessage_e10",
+ "name": "post_chatmessage_11",
"sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] }-->
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
} ```
-### Example 11: Send a message that contains an announcement
+### Example 12: Send a message that contains an announcement
#### Request
The following example shows a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "post_chatmessage_11",
+ "name": "post_chatmessage_12",
"sampleKeys": ["5c884e2f-83f8-4cff-af8e-0177f260b9f8", "19:81f49626414645c99469ee65a1a7e1a4@thread.tacv2"] }-->
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
```
-### Example 12: Send a message with an emoji
+### Example 13: Send a message with an emoji
#### Request
The following example shows a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "post_chatmessage_12",
+ "name": "post_chatmessage_13",
"sampleKeys": ["19:7fb82b685f9c457296a0ab6a1d98b4c1@thread.v2"] }-->
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Chatmessage Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-update.md
You can update all the properties of **chatMessage** in delegated permissions sc
Updating works only for chats where conversation members are Microsoft Teams users. If one of the members is using Skype, the operation fails.
-This method does not support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message.
+This method doesn't support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message.
[!INCLUDE [teams-model-A-only-disclaimer](../../includes/teams-model-A-only-disclaimer.md)]
One of the following permissions is required to call this API. To learn more, in
| Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** |
-> **Note:** The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
+> [!NOTE]
+> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
PATCH /teams/(team-id)/channels/{channel-id}/messages/{message-id}/replies/{repl
PATCH /chats/{chatThread-id}/messages/{message-id}?model=A ```
-If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) will be used.
+If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) is used.
## Request headers
HTTP/1.1 204 NoContent
The following example shows a request to update the attachments on a Microsoft Teams channel message by using delegated permissions. - # [HTTP](#tab/http) <!-- { "blockType": "request",
v1.0 Chatmessagehostedcontent Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessagehostedcontent-get.md
One of the following permissions is required to call this API. To learn more, in
|Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All |
-> **Note:**: The Group.Read.All and Group.ReadWrite.All permissionsare supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
+> [!NOTE]
+> The Group.Read.All and Group.ReadWrite.All permissionsare supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.
### Permissions for chat <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->
GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id}
## Optional query parameters
-This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response.
+This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response.
## Request headers
v1.0 Chats Getallmessages https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chats-getallmessages.md
GET /users/{id | user-principal-name}/chats/getAllMessages
You can use the `model` query parameter, which supports the values `A` and `B`, based on the preferred [licensing and payment model](/graph/teams-licenses), as shown in the following examples.
+<!-- { "blockType": "ignored" } -->
```http GET /users/{id | user-principal-name}/chats/getAllMessages?model=A GET /users/{id | user-principal-name}/chats/getAllMessages?model=B
If no `model` parameter is specified, [evaluation mode](/graph/teams-licenses#ev
This method also supportsΓÇ»[date range parameters](/graph/query-parameters) to customize the response, as shown in the following example.
+<!-- { "blockType": "ignored" } -->
``` http GET /users/{id}/chats/getAllMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z ```
If successful, this method returns a `200 OK` response code and a list of [chatM
### Request
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "chat_getallmessages_1"
+}-->
```msgraph-interactive GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllMessages ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response >**Note:** The response object shown here might be shortened for readability.
v1.0 Cloudclipboarditem Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudclipboarditem-get.md
Read the properties and relationships of a [cloudClipboardItem](../resources/clo
This API doesn't support using another user's credentials to get a [cloudClipboardItem](../resources/cloudclipboarditem.md) for a user. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudclipboardroot List Items https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudclipboardroot-list-items.md
Get a list of the [cloudClipboardItem](../resources/cloudclipboarditem.md) objec
This API doesn't support using another user's credentials to get a [cloudClipboardItem](../resources/cloudclipboarditem.md) for a user. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudpc Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-get.md
Content-Type: application/json
"userPrincipalName": "pmitchell@contoso.com", "lastModifiedDateTime": "2020-11-03T18:14:34Z", "gracePeriodEndDateTime": "2020-11-010T20:00:34Z",
- "provisioningType": "shared",
+ "provisioningType": "sharedByUser",
"diskEncryptionState": "notAvailable" } ```
Content-Type: application/json
The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request",
The following example shows a request.
--> ``` http
-GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f?$select=id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult
+GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/40cee9d2-03fb-4066-8d35-dbdf2875c33f?$select=id,displayName,imageDisplayName,lastModifiedDateTime,lastRemoteActionResult,lastLoginResult,connectivityResult,allotmentDisplayName
``` # [C#](#tab/csharp)
Content-Type: application/json
"additionalDetails": "SessionHost unhealthy: SessionHost is not joined to a domain" } ]
- }
+ },
+ "allotmentDisplayName": null
} ```
Content-Type: application/json
"userPrincipalName": "pmitchell@contoso.com", "lastModifiedDateTime": "2020-11-03T18:14:34Z", "gracePeriodEndDateTime": "2020-11-010T20:00:34Z",
- "provisioningType": "shared",
+ "provisioningType": "dedicated",
"diskEncryptionState": "notAvailable" } ```
v1.0 Cloudpc Getprovisionedcloudpcs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-getprovisionedcloudpcs.md
Content-Type: application/json
"lastModifiedDateTime": "2020-07-23T10:29:57Z", "statusDetails": null, "provisioningType": "dedicated",
+ "allotmentDisplayName": null,
"connectivityResult": "", "gracePeriodEndDateTime": null, "lastLoginResult": "2020-07-23T10:29:57Z",
Content-Type: application/json
"lastModifiedDateTime": "2020-07-28T18:14:34Z", "statusDetails": null, "provisioningType": "dedicated",
+ "allotmentDisplayName": null,
"connectivityResult": "", "gracePeriodEndDateTime": null, "lastLoginResult": "2020-07-23T10:29:57Z",
v1.0 Cloudpcauditevent Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcauditevent-get.md
HTTP/1.1 200 OK
Content-Type: application/json {
- "@odata.type": "#microsoft.graph.cloudPcAuditEvent",
- "id": "250473f5-029f-4037-813d-ba4768201d61",
- "displayName": "Display Name value",
- "componentName": "Component Name value",ΓÇ»
- "activity": "Activity value",ΓÇ»
- "activityDateTime": "2021-02-14T13:10:51.814636+08:00",
- "activityType": " Activity Type value", 
- "activityOperationType": "Activity Operation Type value",
- "activityResult": "Activity Result value",ΓÇ»
- "correlationId": "a5c71cc6-2271-4d5c-9bfe-d94781e83fe6",
- "category": "Category value",
- "actor": {
- "@odata.type": "microsoft.graph.cloudPcAuditActor",
- "type": "Type value",
- "userPermissions": [
- "User Permissions value"
- ],
- "applicationId": "Application Id value",
- "applicationDisplayName": "Application Display Name value",
- "userPrincipalName": "User Principal Name value",
- "servicePrincipalName": "Service Principal Name value",
- "ipAddress": "Ip Address value",
- "userId": "User Id value",
- "userRoleScopeTags": [
- {
- "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo",
- "displayName": "Display Name value",
- "roleScopeTagId": "Role Scope Tag Id value"
- }
- ],
- "remoteTenantId": "Remote Tenant Id value",
- "remoteUserId": "Remote User Id value"
- },
- "resources": [
+ "@odata.type": "#microsoft.graph.cloudPcAuditEvent",
+ "id": "250473f5-029f-4037-813d-ba4768201d61",
+ "displayName": "Update OnPremisesConnection",
+ "componentName": "CloudPcOnPremisesConnectionsController",
+ "activity": null,
+ "activityDateTime": "2021-02-14T13:10:51.814636+08:00",
+ "activityType": "Patch CloudPcOnPremisesConnection",
+ "activityOperationType": "Patch",
+ "activityResult": "Success",
+ "correlationId": "a5c71cc6-2271-4d5c-9bfe-d94781e83fe6",
+ "category": "Cloud PC",
+ "actor": {
+ "@odata.type": "microsoft.graph.cloudPcAuditActor",
+ "type": "application",
+ "userPermissions": [],
+ "applicationId": "69cc3193-b6c4-4172-98e5-ed0f38ab3ff8",
+ "applicationDisplayName": "Cloud PC Ibiza",
+ "userPrincipalName": null,
+ "servicePrincipalName": null,
+ "ipAddress": null,
+ "userId": "ccaf0214-2d5c-4c72-b23f-191ff2c87313",
+ "userRoleScopeTags": [
+ {
+ "@odata.type": "microsoft.graph.cloudPcUserRoleScopeTagInfo",
+ "displayName": "Europe",
+ "roleScopeTagId": "8ad48104-cb5c-497c-b144-6fc9927354ab"
+ }
+ ],
+ "remoteTenantId": "33c73c76-bf5d-45ba-ab4f-ee49c9a9be76",
+ "remoteUserId": "ccaf0214-2d5c-4c72-b23f-191ff2c87313"
+ },
+ "resources": [
+ {
+ "@odata.type": "microsoft.graph.cloudPcAuditResource",
+ "displayName": "ecmadao-test-azureconnection-1",
+ "modifiedProperties": [
{
- "@odata.type": "microsoft.graph.cloudPcAuditResource",
- "displayName": "Display Name value",
- "modifiedProperties": [
- {
- "@odata.type": "microsoft.graph.cloudPcAuditProperty",
- "displayName": "Display Name value",
- "oldValue": "Old Value value",
- "newValue": "New Value value"
- }
- ],
- "type": "Type value",
- "resourceId": "Resource Id value"
+ "@odata.type": "microsoft.graph.cloudPcAuditProperty",
+ "displayName": "AdDomainUsername",
+ "oldValue": "12312",
+ "newValue": "new-adDomainUsername"
}
- ]
+ ],
+ "type": "CloudPcOnPremisesConnection",
+ "resourceType": "CloudPcOnPremisesConnection",
+ "resourceId": "a7508af8-d334-41ba-83a7-26cc88959724"
+ }
+ ]
} ```
v1.0 Cloudpcbulkaction Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcbulkaction-get.md
+
+ Title: "Get cloudPcBulkAction"
+description: "Read the properties and relationships of a cloudPcBulkAction object."
+
+ms.localizationpriority: medium
+++
+# Get cloudPcBulkAction
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object.
++
+## Permissions
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "cloudpcbulkaction_get" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /deviceManagement/virtualEndpoint/bulkActions/{cloudPcBulkActionId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object in the response body.
+
+## Examples
+
+### Request
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_cloudpcbulkaction"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/bulkActions/231ad98f-41b3-872b-dd37-c70bf22cbdac
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.cloudPcBulkAction"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.cloudPcBulkAction",
+ "id": "231ad98f-41b3-872b-dd37-c70bf22cbdac",
+ "displayName": "Bulk Power Off by Andy",
+ "cloudPcIds": [
+ "d6e0b8ee-8836-4b8d-b038-6130a97a3a9d",
+ "85994912-197b-4927-b569-447bd81350ec"
+ ],
+ "actionSummary": {
+ "failedCount": 1,
+ "inProgressCount": 0,
+ "notSupportedCount": 0,
+ "pendingCount": 1,
+ "successfulCount": 0
+ },
+ "scheduledDuringMaintenanceWindow": true,
+ "createdDateTime": "2024-02-05T10:29:57Z"
+ }
+}
+```
+
v1.0 Cloudpcdeviceimage Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-delete.md
If successful, this method returns a `204 No Content` response code.
### Request
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_deviceimages_from_virtualendpoint"
If successful, this method returns a `204 No Content` response code.
DELETE https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/435849e6-0263-4621-9f93-8657667af3bb ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response **Note:** The response object shown here might be shortened for readability.
v1.0 Cloudpcdeviceimage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcDevice
### Request
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcdeviceimage"
If successful, this method returns a `200 OK` response code and a [cloudPcDevice
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/deviceImages/eda7ed64-7705-4079-9d08-c2bd883f4fff ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response **Note:** The response object shown here might be shortened for readability.
v1.0 Cloudpcexportjob Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcexportjob-get.md
Read the properties and relationships of a [cloudPcExportJob](../resources/cloud
You can download a report by first [creating a new cloudPcExportJob resource](cloudpcreports-post-exportjobs.md) to initiate downloading.
-Use this GET operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. When the property becomes `completed`, the report has finished downloading in the location specified by the **exportUrl** property.
+Use this GET operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. The property becomes `completed` when the report finishes downloading in the location specified by the **exportUrl** property.
## Permissions
-Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+Choose the least privileged permission or permissions to download reports with this API. Delegated access require read access to the report that you need to export. App-only tokens with CloudPC.ReadWrite.All have permission or permissions to download all reports without specific permission. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
<!-- { "blockType": "permissions", "name": "cloudpcexportjob_get" } --> [!INCLUDE [permissions-table](../includes/permissions/cloudpcexportjob-get-permissions.md)]
+The following permissions in the in the [Cloud PC admin portal](https://intune.microsoft.com/#view/Microsoft_Intune_DeviceSettings/RolesLandingMenuBlade/~/myPermissions) provide access to specific kinds of reports:
+- ActionStatus/Read
+- DeviceRecommendation/Read
+- CrossRegionDisasterRecovery/Read
+- FrontlineReports/Read
+- InaccessibleReports/Read
+- PerformanceReports/Read
+ ## HTTP request <!-- {
If successful, this method returns a `200 OK` response code and a [cloudPcExport
### Example 1: Get an export job for the TotalAggregatedRemoteConnectionReports report
-The following example shows how to get an export job that was created by the POST request for the `TotalAggregatedRemoteConnectionReports` report.
+The following example shows how to get an export job that a POST request for the `TotalAggregatedRemoteConnectionReports` report created.
#### Request
Content-Type: application/json
### Example 2: Get an export job for the RemoteConnectionQualityReports report
-The following example shows how to get an export job that was created by the POST request for the `RemoteConnectionQualityReports` report.
+The following example shows how to get an export job that a POST request for the `RemoteConnectionQualityReports` report created.
#### Request
v1.0 Cloudpcgalleryimage Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcgalleryimage-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcGaller
The following example shows a request.
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcgalleryimage",
The following example shows a request.
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/galleryImages/MicrosoftWindowsDesktop_windows-ent-cpc_19h2-ent-cpc-os ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++ ### Response The following example shows the response.
v1.0 Cloudpcprovisioningpolicy Apply https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-apply.md
+
+ Title: "cloudPcProvisioningPolicy: apply"
+description: "Apply the current provisioning policy configuration to all Cloud PC devices under a specified policy."
+
+ms.localizationpriority: medium
+++
+# cloudPcProvisioningPolicy: apply
+
+Namespace: microsoft.graph
++
+Apply the current [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration to all Cloud PC devices under a specified policy. Currently, the region is the only policy setting that you can apply.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "cloudpcprovisioningpolicy_apply" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+POST /deviceManagement/virtualEndpoint/provisioningPolicies/{id}/apply
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the parameters.
+
+The following table shows the parameter that you can use with this method.
+
+|Parameter|Type|Description|
+|:|:|:|
+|policySettings|cloudPcPolicySettingType|The target property of this apply action. Possible values are: `region`, `singleSignOn`, `unknownFutureValue`. The default value is `region`. This action applies `region` as a value if this parameter is `null`.|
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "apply_cloudpcprovisioningpolicy"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff/apply
+Content-Type: application/json
+
+{
+ "policySettings": "region"
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+
+``` http
+HTTP/1.1 204 No Content
+```
v1.0 Cloudpcprovisioningpolicy Applyconfig https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-applyconfig.md
+
+ Title: "cloudPcProvisioningPolicy: applyConfig"
+description: "Update the provisioning policy configuration for a set of Cloud PC devices by their IDs."
+
+ms.localizationpriority: medium
+++
+# cloudPcProvisioningPolicy: applyConfig
+
+Namespace: microsoft.graph
++
+Update the [provisioning policy](../resources/cloudpcprovisioningpolicy.md) configuration for a set of Cloud PC devices by their IDs. This method supports retry and allows you to apply the configuration to a subset of Cloud PCs initially to test.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "cloudpcprovisioningpolicy_applyconfig" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /deviceManagement/virtualEndpoint/provisioningPolicies/applyConfig
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the parameters.
+
+The following table shows the parameters that you can use with this method.
+
+|Parameter|Type|Description|
+|:|:|:|
+|cloudPcIds|String collection|A collection of Cloud PC IDs.|
+|policySettings|cloudPcPolicySettingType|The target property of this apply action. Possible values are: `region`, `singleSignOn`, `unknownFutureValue`. The default value is `region`. This action applies `region` as a value if this parameter is `null`.|
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "cloudpcprovisioningpolicythis.applyconfig"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/applyConfig
+Content-Type: application/json
+
+{
+ "cloudPcIds": [
+ "52aa2645-36ee-47d2-9eb3-b8fbb17c3fc4",
+ "ff117b6c-e3e6-41be-9cae-eb6743249a30"
+ ],
+ "policySettings": "region"
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
v1.0 Cloudpcprovisioningpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-get.md
Content-Type: application/json
"@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",
- "domainJoinConfiguration": {
- "domainJoinType": "hybridAzureADJoin",
- "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
"imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType": "custom",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
Content-Type: application/json
"@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "description": "Description value", "displayName": "Display Name value",
- "domainJoinConfiguration": {
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "regionName": null,
- "type": "hybridAzureADJoin"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
"imageDisplayName": "Image Display Name value", "imageId": "Image ID value", "imageType": "custom",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
The following example shows a request.
--> ``` http
-GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfiguration,imageDisplayName,imageId,imageType,onPremisesConnectionId,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl
+GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/60b94f83-3e22-430e-a69d-440f65b922d6?$select=id,description,displayName,domainJoinConfigurations,imageDisplayName,imageId,imageType,windowsSetting,managedBy,cloudPcGroupDisplayName,gracePeriodInHours,localAdminEnabled,alternateResourceUrl
``` # [C#](#tab/csharp)
Content-Type: application/json
"cloudPcGroupDisplayName": "MyCloudPcGroup", "description": "The ProvisioningPolicy for West US employees.", "displayName": "WestUsPolicy",
- "domainJoinConfiguration": {
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "regionName": null,
- "type": "hybridAzureADJoin"
- },
"domainJoinConfigurations": [ { "onPremisesConnectionId": "16ee6c71-fc10-438b-88ac-daa1ccafffff",
Content-Type: application/json
"imageType": "custom", "localAdminEnabled": true, "managedBy": "windows365",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
- "windowsSettings": {
- "language": "en-US"
- },
"windowsSetting": { "locale": "en-US" },
v1.0 Cloudpcprovisioningpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-update.md
The following table shows the properties that can be updated for the [cloudPcPro
|imageId|String|The ID of the OS image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows: <ul><li>publisher: Microsoftwindowsdesktop.</li> <li>offer: windows-ent-cpc.</li> <li>sku: 21h1-ent-cpc-m365, 21h1-ent-cpc-os, 20h2-ent-cpc-m365, 20h2-ent-cpc-os, 20h1-ent-cpc-m365, 20h1-ent-cpc-os, 19h2-ent-cpc-m365 and 19h2-ent-cpc-os.</li></ul>| |imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.| |windowsSetting|[cloudPcWindowsSettings](../resources/cloudpcwindowssetting.md)|Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. |
-|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID.|
-|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service.|
+|domainJoinConfiguration (deprecated)|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md)|Specifies how Cloud PCs join Microsoft Entra ID. The **domainJoinConfiguration** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
+|onPremisesConnectionId (deprecated)|String|The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network thatΓÇÖs validated by the Cloud PC service. The **onPremisesConnectionId** property is deprecated and will stop returning data on May 31, 2024. Going forward, use the **domainJoinConfigurations** property.|
|windowsSettings (deprecated)|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports `$select`. The **windowsSettings** property is deprecated and will stop returning data on January 31, 2024. Going forward, use the **windowsSetting** property.| ## Response
v1.0 Cloudpcreports Getdailyaggregatedremoteconnectionreports https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getdailyaggregatedremoteconnectionreports.md
Namespace: microsoft.graph
Get the daily aggregated remote connection reports, such as round trip time, available bandwidth, and so on, in a given period. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudpcreports Getrawremoteconnectionreports https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getrawremoteconnectionreports.md
Namespace: microsoft.graph
Get the raw real-time remote connection report for a Cloud PC without any calculation, such as roundTripTime or available bandwidth, which are aggregated hourly from the raw event data. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudpcreports Getrealtimeremoteconnectionlatency https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getrealtimeremoteconnectionlatency.md
Namespace: microsoft.graph
Get the real-time connection latency information for a Cloud PC. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudpcreports Getrealtimeremoteconnectionstatus https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getrealtimeremoteconnectionstatus.md
Namespace: microsoft.graph
Get the real-time connection status information, such as **signInStatus** or **daysSinceLastUse**, for a Cloud PC. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudpcreports Getremoteconnectionhistoricalreports https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getremoteconnectionhistoricalreports.md
Namespace: microsoft.graph
Get the remote connection history records of a Cloud PC during a given period. This report contains data such as signInDateTime, signOutDateTime, usageInHour, remoteSignInTimeInSec and roundTripTimeInMsP50, and so on. This data is aggregated hourly for a specified time period, such as the last seven days. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
The following table shows the parameters that can be used with this action.
|Parameter|Type|Description| |:|:|:|
-|filter|String|OData filter syntax. Supported filters include `and`, `or`, `lt`, `le`, `gt`, `ge` and `eq`.|
+|filter|String|OData filter syntax. Supported filters include `and`, `or`, `lt`, `le`, `gt`, `ge` and `eq`. The `CloudPcId` filter is required; for example: `CloudPcId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. If this filter is missing, malformed, or invalid, a query config will be thrown.|
|select|String collection|OData select syntax. The columns to include in the report.| |search|String|The string to search for.| |groupBy|String collection|A list of columns that describe how to group the data in the report.|
Content-length: 199
"UsageInHour", "RoundTripTimeInMsP50", "AvailableBandwidthInMBpsP50",
- "RemoteSignInTimeInSec",
+ "RemoteSignInTimeInSec"
], "top": 25,
- "skip": 0,
+ "skip": 0
} ```
v1.0 Cloudpcreports Gettotalaggregatedremoteconnectionreports https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md
Namespace: microsoft.graph
Get the total aggregated remote connection usage of a Cloud PC during a given time span. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Cloudpcreports Post Exportjobs https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-post-exportjobs.md
Namespace: microsoft.graph
Create a new [cloudPcExportJob](../resources/cloudpcexportjob.md) resource to initiate downloading the entire or specified portion of a report.
-Use the [GET cloudPcExportJob](cloudpcexportjob-get.md) operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. When the property result is `completed`, the report has finished downloading to the location specified by the **exportUrl** property.
+Use the [GET cloudPcExportJob](cloudpcexportjob-get.md) operation to verify the **exportJobStatus** property of the **cloudPcExportJob** resource. When the property result is `completed`, the report finishes downloading to the location specified by the **exportUrl** property.
## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
POST /deviceManagement/virtualEndpoint/reports/exportJobs
## Request body In the request body, supply a JSON representation of the [cloudPcExportJob](../resources/cloudpcexportjob.md) object.
-You can specify the following properties when creating a **cloudPcExportJob**.
+You can specify the following properties when you create a **cloudPcExportJob**.
|Property|Type|Description| |:|:|:| |filter|String|The filter applied on the report. Optional.|
-|format|String|The format of the exported report. Optional.|
-|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`. 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): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `inaccessibleCloudPcReports`.|
+|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `inaccessibleCloudPcReports`.|
|select|String collection|The selected columns of the report. Optional.| ## Response
v1.0 Conditionalaccesspolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccesspolicy-update.md
PATCH /identity/conditionalAccess/policies/{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 maintain 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.
For the list of properties, see [conditionalAccessPolicy](../resources/conditionalaccesspolicy.md).
Content-type: application/json
"signInRiskLevels": [ "high", "medium",
- "low",
+ "low"
] } }
v1.0 Customclaimspolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customclaimspolicy-get.md
+
+ Title: "Get customClaimsPolicy"
+description: "Get the properties and relationships of a custom claims policy object."
+
+ms.localizationpriority: medium
+++
+# Get customClaimsPolicy
+
+Namespace: microsoft.graph
++
+Get the properties and relationships of a [customClaimsPolicy](../resources/customclaimspolicy.md) object.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "customclaimspolicy_get" } -->
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /servicePrincipals/{servicePrincipalsId}/claimsPolicy
+```
+
+## Optional query parameters
+
+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [customClaimsPolicy](../resources/customclaimspolicy.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_customclaimspolicy"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.customClaimsPolicy)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.customClaimsPolicy",
+ "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689",
+ "includeBasicClaimSet": "Boolean",
+ "includeApplicationIdInIssuer": "Boolean",
+ "audienceOverride": "String",
+ "claims": [
+ {
+ "@odata.type": "microsoft.graph.customClaim"
+ }
+ ]
+ }
+ ]
+}
+```
v1.0 Customclaimspolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customclaimspolicy-update.md
+
+ Title: "Update customClaimsPolicy"
+description: "Update a custom claims policy object."
+
+ms.localizationpriority: medium
+++
+# Update customClaimsPolicy
+
+Namespace: microsoft.graph
++
+Update a [customClaimsPolicy](../resources/customclaimspolicy.md) object.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "customclaimspolicy_update" } -->
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /servicePrincipals/{servicePrincipalsId}/claimsPolicy
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [customClaimsPolicy](../resources/customclaimspolicy.md) object.
+
+You can specify the following properties when creating a **customClaimsPolicy**.
+
+|Property|Type|Description|
+|:|:|:|
+|includeBasicClaimSet|Boolean|Determines whether the basic claim set is included in tokens affected by this policy. If set to `true`, all claims in the basic claim set are emitted in tokens affected by the policy. By default the basic claim set isn't in the tokens, unless they're explicitly configured in this policy. Optional.|
+|includeApplicationIdInIssuer|Boolean|Indicates whether the application ID is added to the claim. It is relevant only for SAML2.0 and if a custom signing key is used. the default value is `true`. Optional.|
+|audienceOverride|String|If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols. A custom signing key must be used for audienceOverride to be applied, otherwise audienceOverride value is ignored. The value provided must be in the format of an absolute URI. Optional.|
+|claims|[customClaimBase](../resources/customclaimbase.md) collection|Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Optional.|
+
+## Response
+
+If successful, this method returns a `201 Created` response code and a [customClaimsPolicy](../resources/customclaimspolicy.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_customclaimspolicy_from_"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.customClaimsPolicy",
+ "includeBasicClaimSet": "Boolean",
+ "includeApplicationIdInIssuer": "Boolean",
+ "audienceOverride": "String",
+ "claims": [
+ {
+ "@odata.type": "microsoft.graph.customClaim"
+ }
+ ]
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.customClaimsPolicy"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.customClaimsPolicy",
+ "id": "f914f36d-167e-3fa7-cfa2-355cc5a36689",
+ "includeBasicClaimSet": "Boolean",
+ "includeApplicationIdInIssuer": "Boolean",
+ "audienceOverride": "String",
+ "claims": [
+ {
+ "@odata.type": "microsoft.graph.customClaim"
+ }
+ ]
+}
+```
v1.0 Dailyuserinsightmetricsroot List Activeusersbreakdown https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/dailyuserinsightmetricsroot-list-activeusersbreakdown.md
- Title: "List daily activeUsersBreakdown (deprecated)"
-description: "Get a list of daily activeUsersBreakdown objects on apps registered in your tenant configured for Microsoft Entra External ID for customers."
--
-doc_type: apiPageType
--
-# List daily activeUsersBreakdown (deprecated)
-Namespace: microsoft.graph
--
-> [!CAUTION]
-> This API is deprecated and will stop returning data on March 9, 2024. Use the [List monthly activeUsers](../api/monthlyuserinsightmetricsroot-list-activeusers.md) API instead.
-
-Get a list of daily [activeUsersBreakdown](../resources/activeusersbreakdownmetric.md) objects on apps registered in your tenant configured for Microsoft Entra External ID for customers.
--
-## Permissions
-Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
-
-<!-- { "blockType": "permissions", "name": "dailyuserinsightmetricsroot_list_activeusersbreakdown" } -->
--
-## HTTP request
-<!-- {
- "blockType": "ignored"
-}
>
-``` http
-GET /reports/userInsights/daily/activeUsersBreakdown
-```
-
-## Optional query parameters
-This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
-
-## Request headers
-|Name|Description|
-|:|:|
-|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
-
-## Request body
-Don't supply a request body for this method.
-
-## Response
-
-If successful, this method returns a `200 OK` response code and a collection of [activeUsersBreakdownMetric](../resources/activeusersbreakdownmetric.md) objects in the response body.
-
-## Examples
-
-### Request
-The following example shows a request.
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "list_dailyactiveusersbreakdownmetric"
-}
>
-``` http
-GET https://graph.microsoft.com/beta/reports/userInsights/daily/activeUsersBreakdown
-```
-
-# [C#](#tab/csharp)
-
-# [CLI](#tab/cli)
-
-# [Go](#tab/go)
-
-# [Java](#tab/java)
-
-# [JavaScript](#tab/javascript)
-
-# [PHP](#tab/php)
-
-# [PowerShell](#tab/powershell)
-
-# [Python](#tab/python)
---
-### Response
-The following example shows the response.
->**Note:** The response object shown here might be shortened for readability.
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "Collection(microsoft.graph.activeUsersBreakdownMetric)"
-}
>
-``` http
-HTTP/1.1 200 OK
-Content-Type: application/json
-
-{
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.activeUsersBreakdownMetric)",
- "value": [
- {
- "id": "2",
- "appId": "7a30b8ef-42h3-4d1e-84ad-17d4ca3c9a52",
- "appName": "Bank",
- "count": 1,
- "factDate": "2023-09-28",
- "os": "Windows"
- },
- {
- "id": "1",
- "appId": "65e59557-d9d1-485f-87c5-80b92a99dfda",
- "appName": "Kiosk",
- "count": 1,
- "factDate": "2023-09-20",
- "os": "Ios"
- }
- ]
-}
-```
v1.0 Delegatedadminrelationship Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/delegatedadminrelationship-update.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. You can only update a relationship when it's in the `created` **status**. However, you can update the **autoExtendDuration** property when the relationship is in either the `created` or `active` **status**.
+Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object.
+
+The following restrictions apply:
+- You can update this relationship when its **status** property is `created`.
+- You can update the **autoExtendDuration** property when **status** is either `created` or `active`.
+- You can only remove the Microsoft Entra Global Administrator role when the **status** property is `active`, which indicates a long-running operation.
+ [!INCLUDE [national-cloud-support](../../includes/global-only.md)]
PATCH /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationsh
## Response
-If successful, this method returns a `200 OK` response code and an updated [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object in the response body.
+If successful, this method returns either a `200 OK` or a `202 Accepted` response code. The response body contains a
+ [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object when the response is `200 OK`.
+
+### Response headers
+|Name|Description|
+|:|:|
+|Content-Type|application/json.|
+|Location|The location of the long-running operation.|
+|Retry-After|The time after which a subsequent API call can be made to the Location URL to check the status of the long-running operation.|
+
+This method returns a `202 Accepted` response if you remove the Microsoft Entra Global Administrator role from the relationship while its **status** property is `active`. The response includes a URL in the Location header that you can use to monitor the operation's progress.
+
+If you don't supply the template ID that corresponds to the Microsoft Entra Global Administrator role in the `unifiedRoles` array in the `accessDetails` property of the request body, then the API returns `200 OK` and the original [delegatedAdminRelationship](../resources/delegatedAdminRelationship.md) object in the response body.
## Examples ### Request
+The following example shows the request.
# [HTTP](#tab/http) <!-- {
Content-Type: application/json
### Response
+The following example shows the response.
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
} ```
+The following is an example response that returns a `202 Accepted` response code along with **Location** and **Retry-After** headers.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminRelationship"
+}
+-->
+
+``` http
+HTTP/1.1 202 Accepted
+Location: https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5e5594d3-6f82-458b-b567-77db4811f0cd-00000000-0000-0000-0000-000000001234/operations/d8dbb27b-7fe7-4523-a3df-f766355fe0f2
+Retry-After: 10
+Content-Type: application/json
+
+{
+}
+```
+
v1.0 Device Delete Registeredusers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-delete-registeredusers.md
Choose the permission or permissions marked as least privileged for this API. Us
[!INCLUDE [limited-info](../../includes/limited-info.md)]
-The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*.
+The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator* or *Windows 365 Administrator*.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Device Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "device_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/device-delete-permissions.md)]
-The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, *Windows 365 Administrator*, or *Cloud Device Administrator*.
+The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator*, *Windows 365 Administrator*, or *Cloud Device Administrator*.
## HTTP request
v1.0 Device Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "device_get" } --> [!INCLUDE [permissions-table](../includes/permissions/device-get-permissions.md)]
-The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
+The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-* Global Administrator
* Users * Directory Readers * Directory Writers
v1.0 Device List Registeredusers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list-registeredusers.md
Choose the permission or permissions marked as least privileged for this API. Us
[!INCLUDE [limited-info](../../includes/limited-info.md)]
-The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
+The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-* Global Administrator
* Users * Directory Readers * Directory Writers
v1.0 Device List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list.md
Choose the permission or permissions marked as least privileged for this API. Us
The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-* Global Administrator
* Users * Directory Readers * Directory Writers
v1.0 Device Post Devices https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-post-devices.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "device_post_devices" } --> [!INCLUDE [permissions-table](../includes/permissions/device-post-devices-permissions.md)]
-The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*.
+The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator* or *Windows 365 Administrator*.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Device Post Registeredusers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-post-registeredusers.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "device_post_registeredusers" } --> [!INCLUDE [permissions-table](../includes/permissions/device-post-registeredusers-permissions.md)]
-The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*, or *Windows 365 Administrator*.
+The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator* or *Windows 365 Administrator*.
## HTTP request
v1.0 Device Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-update.md
Choose the permission or permissions marked as least privileged for this API. Us
In application-only scenarios and for non-Windows devices, that is, where the **operatingSystem** property is not `Windows`, the app can update only the **extensionAttributes** property.
-In delegated scenarios, the calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Global Administrator*, *Intune Administrator*. A calling user in the *Cloud Device Administrator* role can only enable or disable devices using this API and a user with the *Windows 365 Administrator* role can only update basic device properties.
+The calling user must also be in at least the *Intune Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). A calling user in the *Cloud Device Administrator* role can only enable or disable devices and a user with the *Windows 365 Administrator* role can only update basic device properties.
## HTTP request
In the request body, supply the values for the [device](../resources/device.md)
| Property | Type |Description| |:|:--|:-|
-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers in Global Administrator and Cloud Device Administrator roles can update this property. |
+|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. Only callers with at least the *Cloud Device Administrator* role can update this property. |
|operatingSystem|String|The type of operating system on the device.| |operatingSystemVersion|String|The version of the operating system on the device| |displayName|String|The display name for the device.|
v1.0 Devicemanagement Alertrecord Changealertrecordsportalnotificationassent https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/devicemanagement-alertrecord-changealertrecordsportalnotificationassent.md
+
+ Title: "alertRecord: changeAlertRecordsPortalNotificationAsSent"
+description: "Change the isPortalNotificationSent property to true for a list of alert records for the current user."
+
+ms.localizationpriority: medium
+++
+# alertRecord: changeAlertRecordsPortalNotificationAsSent
+
+Namespace: microsoft.graph.deviceManagement
++
+Set the **isPortalNotificationSent** property of all [portal notification](../resources/devicemanagement-portalnotification.md) resources associated with the specified [alertRecord](../resources/devicemanagement-alertrecord.md) to `true`, marking them as sent. A maximum of 100 [alertRecord](../resources/devicemanagement-alertrecord.md) IDs can be received at one time, and a maximum of 100 **portal notification** resources can be changed in the **isPortalNotificationSent** property status.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- { "blockType": "permissions", "name": "devicemanagement_alertrecord_changealertrecordsportalnotificationassent" } -->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /deviceManagement/monitoring/alertRecords/changeAlertRecordsPortalNotificationAsSent
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+|Property|Type|Description|
+|:|:|:|
+|alertRecordIds| String collection | A list of up to 100 [alertRecord](../resources/devicemanagement-alertrecord.md) IDs.|
+
+## Response
+
+If successful, this action returns a `202 Accepted` response code.
+
+## Example
+
+### Request
+
+The following example shows a request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "alertrecordthis.changeAlertRecordsPortalNotificationAsSent"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/deviceManagement/monitoring/alertRecords/changeAlertRecordsPortalNotificationAsSent
+
+{
+ "alertRecordIds": [
+ "1d2b92e3-539a-481f-b38a-c2c050b422ad",
+ "4bf624c4-a801-4631-989c-7f1a3a0d1d83",
+ ]
+
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
++++
+### Response
+
+The following example shows the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 202 ACCEPTED
+```
v1.0 Directory Delete Externaluserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-externaluserprofiles.md
DELETE https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
[!INCLUDE [sample-code](../includes/snippets/php/delete-externaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory Delete Pendingexternaluserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-pendingexternaluserprofiles.md
description: "Delete a pendingExternalUserProfile object."
ms.localizationpriority: medium doc_type: apiPageType +
DELETE https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles/{i
[!INCLUDE [sample-code](../includes/snippets/php/delete-pendingexternaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory Deleteditems List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-deleteditems-list.md
ConsistencyLevel: eventual
This example requires the **ConsistencyLevel** header because the `$orderby` and `$count` query parameters are used in the query.
-### Examples using the $orderby OData query parameter
+### $orderby OData query parameter examples
-The `$orderby` OData query parameter is supported on the **deletedDateTime**, **displayName**, and **userPrincipalName** properties of the deleted object types. On the **deletedDateTime** property, the query requires adding the [advanced query parameters](/graph/aad-advanced-queries) (**ConsistencyLevel** header set to `true` and `$count=true` query string).
+The `$orderby` OData query parameter is supported on the **deletedDateTime**, **displayName**, and **userPrincipalName** properties of the deleted object types. On the **deletedDateTime** property, the query requires adding the [advanced query parameters](/graph/aad-advanced-queries) (**ConsistencyLevel** header set to `eventual` and `$count=true` query string).
| OData cast | Properties supporting $orderby | Example | | : | : | : |
v1.0 Directory List Externaluserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-externaluserprofiles.md
GET https://graph.microsoft.com/beta/directory/externalUserProfiles
[!INCLUDE [sample-code](../includes/snippets/php/list-externaluserprofiles-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-externaluserprofiles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory List Inboundshareduserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-inboundshareduserprofiles.md
Title: "List inboundSharedUserProfiles" description: "Retrieve the properties of an inboundSharedUserProfiles."-++ ms.localizationpriority: medium doc_type: apiPageType
v1.0 Directory List Outboundshareduserprofiles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-outboundshareduserprofiles.md
Title: "List outboundSharedUserProfiles" description: "Retrieve the properties of all outboundSharedUserProfiles."-++ ms.localizationpriority: medium doc_type: apiPageType
v1.0 Directory List Pendingexternaluserprofile https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-pendingexternaluserprofile.md
description: "List all pendingExternalUserProfile objects."
ms.localizationpriority: medium doc_type: apiPageType +
GET https://graph.microsoft.com/beta/directory/pendingExternalUserProfiles
[!INCLUDE [sample-code](../includes/snippets/php/list-pendingexternaluserprofiles-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/list-pendingexternaluserprofiles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directory Post Administrativeunits https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-administrativeunits.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "directory_post_administrativeunits" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-post-administrativeunits-permissions.md)]
-To create an administrative unit, the calling principal must be assigned one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-
-* Privileged Role Administrator
-* Global Administrator
+To create an administrative unit, the calling principal must be assigned at least the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Directory Post Attributesets https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-attributesets.md
The following table shows the properties that you can configure when you create
|Property|Type|Description| |:|:|:| |description|String|Description of the attribute set. Can be up to 128 characters long and include Unicode characters. Can be changed later. Optional.|
-|id|String|Identifier for the attribute set that is unique within a tenant. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case insensitive. Required.|
+|id|String|Identifier for the attribute set that is unique within a tenant. Can be up to 32 characters long and include Unicode characters. Cannot contain spaces or special characters. Cannot be changed later. Case sensitive. Required.|
|maxAttributesPerSet|Int32|Maximum number of custom security attributes that can be defined in this attribute set. Default value is `null`. If not specified, the administrator can add up to the maximum of 500 active attributes per tenant. Can be changed later. Optional.| ## Response
v1.0 Directory Post Customsecurityattributedefinitions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-customsecurityattributedefinitions.md
The following table shows the properties that you can configure when you create
|Property|Type|Description| |:|:|:|
-|attributeSet|String|Name of the attribute set. Case insensitive. Required.|
+|attributeSet|String|Name of the attribute set. Case sensitive. Required.|
|description|String|Description of the custom security attribute. Can be up to 128 characters long and include Unicode characters. Can't contain spaces or special characters. Can be changed later. Optional.| |isCollection|Boolean|Indicates whether multiple values can be assigned to the custom security attribute. Can't be changed later. If **type** is set to `Boolean`, **isCollection** can't be set to `true`. Required.| |isSearchable|Boolean|Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Can't be changed later. Required.|
-|name|String|Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Can't contain spaces or special characters. Can't be changed later. Case insensitive. Required.|
+|name|String|Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Can't contain spaces or special characters. Can't be changed later. Case sensitive. Required.|
|status|String|Specifies whether the custom security attribute is active or deactivated. Acceptable values are `Available` and `Deprecated`. Can be changed later. Required.| |type|String|Data type for the custom security attribute values. Supported types are: `Boolean`, `Integer`, and `String`. Can't be changed later. Required.| |usePreDefinedValuesOnly|Boolean|Indicates whether only predefined values can be assigned to the custom security attribute. If set to `false`, free-form values are allowed. Can later be changed from `true` to `false`, but can't be changed from `false` to `true`. If **type** is set to `Boolean`, **usePreDefinedValuesOnly** can't be set to `true`. Required.|
v1.0 Directory Post Pendingexternaluserprofile https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-pendingexternaluserprofile.md
description: "Create a new pendingExternalUserProfile object."
ms.localizationpriority: medium doc_type: apiPageType +
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/create-pendingexternaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/create-pendingexternaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Directoryobject Checkmemberobjects https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryobject-checkmemberobjects.md
description: "Check for membership in a list of groups, administrative units, or
ms.localizationpriority: medium + doc_type: "apiPageType"
v1.0 Directoryrole List Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "directoryrole_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-list-members-permissions.md)] - [!INCLUDE [limited-info](../../includes/limited-info.md)] + ## HTTP request You can address the directory role using either its **id** or **roleTemplateId**.
v1.0 Domain Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-delete.md
Title: "Delete domain"
-description: "Deletes a domain from a tenant."
-
+description: "Delete a domain from a tenant."
+ ms.localizationpriority: medium doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Deletes a domain from a tenant.
+Delete a domain from a tenant.
> **Important:** > Deleted domains are not recoverable.
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-delete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
+The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Domain Forcedelete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-forcedelete.md
Title: "domain: forceDelete"
-description: "Deletes a domain using an asynchronous operation."
-
+description: "Delete a domain using an asynchronous operation."
+ ms.localizationpriority: medium doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Deletes a domain using an asynchronous operation.
+Delete a domain using an asynchronous operation.
-Prior to calling [forceDelete](domain-forcedelete.md), you must update or remove any references to **Exchange** as the provisioning service.
+Before performing this operation, you must update or remove any references to **Exchange** as the provisioning service.
The following actions are performed as part of this operation:
The following actions are performed as part of this operation:
* If the number of objects to be renamed is greater than 1,000, an error is returned.
-* If one of the applications to be renamed is a multi-tenant app, an error is returned.
+* If one of the applications to be renamed is a multitenant app, an error is returned.
-After the domain deletion completes, API operations for the deleted domain will return a 404 HTTP response code. To verify deletion of a domain, you can perform a [get domain](domain-get.md). If the domain was successfully deleted, a 404 HTTP response code will be returned in the response.
+After the domain deletion completes, API operations for the deleted domain return a 404 HTTP response code. To verify deletion of a domain, you can perform a [get domain](domain-get.md). If the domain was successfully deleted, a 404 HTTP response code is returned in the response.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_forcedelete" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-forcedelete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
+The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request
In the request body, provide a JSON object with the following parameters.
| Parameter | Type |Description| |:|:--|:-|
-|disableUserAccounts|Boolean| Option to disable renamed user accounts. If a user account is disabled, the user will not be allowed to sign in.<br>*True* (default) - User accounts renamed as part of this operation are disabled.<br>*False* - User accounts renamed as part of this operation are not disabled. |
+|disableUserAccounts|Boolean| Option to disable renamed user accounts. If a user account is disabled, the user isn't allowed to sign in.<br>`true` (default) - User accounts renamed as part of this operation are disabled.<br>`false` - User accounts renamed as part of this operation aren't disabled. |
## Response
v1.0 Domain Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-get.md
Title: "Get domain" description: "Retrieve the properties and relationships of domain object."-+ ms.localizationpriority: medium doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_get" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-get-permissions.md)]
-The work or school account needs to belong to one of the following roles:
+The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
-* Global Administrator
* User Administrator * Helpdesk Administrator * Service Support Administrator
v1.0 Domain List Domainnamereferences https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-domainnamereferences.md
Title: "List domainNameReferences" description: "Retrieve a list of directoryObject with a reference to the domain."-+ ms.localizationpriority: medium doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_list_domainnamereferences" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-domainnamereferences-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
-* Global Reader
- [!INCLUDE [limited-info](../../includes/limited-info.md)]
+The work or school account needs to belong to at least the *Domain Name Administrator* or*Global Reader* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
+ ## HTTP request <!-- { "blockType": "ignored" } --> ```http
v1.0 Domain List Serviceconfigurationrecords https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-serviceconfigurationrecords.md
Title: "List serviceConfigurationRecords" description: "Retrieves a list of domainDnsRecord objects needed to enable services for the domain."-+ ms.localizationpriority: medium doc_type: apiPageType
v1.0 Domain List Verificationdnsrecords https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-verificationdnsrecords.md
Title: "List verificationDnsRecords" description: "Retrieve a list of domainDnsRecord objects."-+ ms.localizationpriority: medium doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_list_verificationdnsrecords" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-verificationdnsrecords-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
-* Global Reader
+The work or school account needs to belong to at least the *Domain Name Administrator* or *Global Reader* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Domain List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list.md
Title: "List domains" description: "Retrieve a list of domain objects."-+ ms.localizationpriority: medium doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_list" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-permissions.md)]
-The work or school account needs to belong to one of the following roles:
+The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-* Global Administrator
* User Administrator * Helpdesk Administrator * Service Support Administrator
v1.0 Domain Post Domains https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-post-domains.md
Title: "Create domain" description: "Adds a domain to the tenant."-+ ms.localizationpriority: medium doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_post_domains" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-domains-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
+The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request
v1.0 Domain Post Federationconfiguration https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-post-federationconfiguration.md
Title: "Create internalDomainFederation"
description: "Create a new internalDomainFederation object." ms.localizationpriority: medium-+ doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_post_federationconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-federationconfiguration-permissions.md)]
+> [!IMPORTANT]
+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=21445) and might require consenting to the *Directory.AccessAsUser.All* permission for delegated scenarios.
+ [!INCLUDE [rbac-domainfederation-apis-write](../includes/rbac-for-apis/rbac-domainfederation-apis-write.md)] ## HTTP request
You can specify the following properties when creating an **internalDomainFedera
|displayName|String|The display name of the federated identity provider.| |issuerUri|String|Issuer URI of the federation server.| |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.|
-|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available.|
+|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available.|
|passiveSignInUri|String|URI that web-based clients are directed to when signing in to Microsoft Entra services.| |preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`.| |activeSignInUri|String|URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the **ActiveLogOnUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.| |isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID signs those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP aren't signed.|
-|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the auto-rollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.|
+|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base 64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the autorollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.|
|signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |federatedIdpMfaBehavior|federatedIdpMfaBehavior|Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. For more information, see [federatedIdpMfaBehavior values](#federatedidpmfabehavior-values).| + ### federatedIdpMfaBehavior values | Member | Description |
You can specify the following properties when creating an **internalDomainFedera
| rejectMfaByFederatedIdp | Microsoft Entra ID always performs MFA and rejects MFA that's performed by the federated identity provider. | **Note:** **federatedIdpMfaBehavior** is an evolved version of the **SupportsMfa** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).
-+ Switching between **federatedIdpMfaBehavior** and **SupportsMfa** is not supported.
++ Switching between **federatedIdpMfaBehavior** and **SupportsMfa** isn't supported. + Once **federatedIdpMfaBehavior** property is set, Microsoft Entra ID ignores the **SupportsMfa** setting. + If the **federatedIdpMfaBehavior** property is never set, Microsoft Entra ID continues to honor the **SupportsMfa** setting. + If neither **federatedIdpMfaBehavior** nor **SupportsMfa** is set, Microsoft Entra ID defaults to `acceptIfMfaDoneByFederatedIdp` behavior.
Content-Type: application/json
"federatedIdpMfaBehavior": "rejectMfaByFederatedIdp" } ```+
+<!--
+{
+ "type": "#page.annotation",
+ "description": "",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ "Error: /api/domain-post-federationconfiguration.md:
+ Exception processing links.
+ Link Definition was null. Link text: !INCLUDE Azure AD PowerShell deprecation note (Parameter 'Definition')"
+ ]
+}
+-->
v1.0 Domain Promote https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-promote.md
Title: "domain: promote" description: "Promote a verified subdomain to the root domain."-+ ms.localizationpriority: medium doc_type: apiPageType
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_promote" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-promote-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
+The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request
v1.0 Domain Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-update.md
Title: "Update domain" description: "Update the properties of domain object."-+ ms.localizationpriority: medium doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Update the properties of domain object.
-
-> **Important:**
-> Only verified domains can be updated.
+Update the properties of [domain](../resources/domain.md) object. Only verified domains can be updated.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_update" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
+The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-* Global Administrator
* Domain Name Administrator * Security Administrator * External Identity Provider Administrator
v1.0 Domain Verify https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-verify.md
Title: "domain: verify"
-description: "Validates the ownership of the domain."
-
+description: "Validate the ownership of a domain."
+ ms.localizationpriority: medium doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Validates the ownership of the domain.
+Validate the ownership of a domain.
> **Important:** > Only applies to an unverified domain. For an unverified domain, the isVerified property of the [domain](../resources/domain.md) is false.
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "domain_verify" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-verify-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* Domain Name Administrator
+The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request
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 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).
+This API is part of the 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.
> [!NOTE]
-> This is a metered API and some charges for use may apply. For details, see [Overview of metered Microsoft 365 APIs in Microsoft Graph](/graph/metered-api-overview).
+> This is a metered API and some charges for use may apply. For details, see [Overview of metered Microsoft 365 APIs in Microsoft Graph](/graph/metered-api-overview). Before you call this API, you must [Enable metered APIs and services in Microsoft Graph](/graph/metered-api-setup?tabs=azurecloudshell).
+
+This API applies sensitivity labels to files at rest. Office clients don't apply watermarks, headers, or footers to files that contain the label information. 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).
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
v1.0 Driveitem Delta https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-delta.md
This method supports the `$select`, `$expand`, and `$top` [OData query parameter
|Name|Description| |:|:| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|deltaExcludeParent| String. If this request header is included, the response includes the items that have changed, and not the parent items in the hierarchy.|
## Request body
v1.0 Driveitem Get Contentstream https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-get-contentstream.md
Namespace: microsoft.graph
Download the contents of the primary stream (file) of a [driveItem](../resources/driveitem.md). Only **driveItem** objects with the **file** property can be downloaded. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
The following example shows how to download a file.
GET https://graph.microsoft.com/beta/drives/b!fMInbiL5dkK51VbATG0ddrCg6AJpEj9Lm4uGj5HgEi4guyuYp4W5SbH4dPfXTbCF/items/014Y52UITTNSVUQI43PZBJMKLAY6LJBUVE/contentStream ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/download-item-content-stream-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+ #### Response
GET https://graph.microsoft.com/beta/drives/b!fMInbiL5dkK51VbATG0ddrCg6AJpEj9Lm4
Range: bytes=0-1023 ```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/download-item-partial-stream-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+ #### Response
v1.0 Educationassignment Post Resources https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-post-resources.md
Content-type: application/json
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
* [Upload files for education assignments and submissions](/graph/education-upload-resource-overview) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Educationassignment Publish https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-publish.md
Title: "educationAssignment: publish"
-description: "Change the state of an educationAssignment from its original draft status to the published status."
+description: "Change the status of an educationAssignment from its original draft status to the published status."
ms.localizationpriority: medium
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Change the state of an [educationAssignment](../resources/educationassignment.md) from its original `draft` status to the `published` status.
+Change the status of an [educationAssignment](../resources/educationassignment.md) from its original `draft` status to the `published` status.
-You can change the state from `draft` to `scheduled` if the **assignment** is scheduled for a future date.
+You can change the status from `draft` to `scheduled` if the **assignment** is scheduled for a future date.
Only a teacher in the class can make this call. When an **assignment** is in draft status, students will not see the **assignment**, nor will there be any submission objects. When you call this API, [educationSubmission](../resources/educationsubmission.md) objects are created and the assignment appears in the student's list.
-The state of the **assignment** goes back to `draft` if there is any backend failure during publish process.
+The status of the **assignment** goes back to `draft` if there is any backend failure during publish process.
To update the properties of a published **assignment**, see [update an assignment](../api/educationassignment-update.md).
HTTP/1.1 200 Ok
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Educationassignment Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-update.md
In the request body, supply the values for relevant fields that should be update
| 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`. Can't 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`, `unknownFutureValue`. Default value is `none`. Can't be modified when the assignment is in `published` status. |
|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. Can't be edited after the assignment has been published. |
+|assignDateTime|DateTimeOffset| Date the assignment should be published to students. Can't be edited when the assignment is published. |
|assignTo|[educationAssignmentRecipient](../resources/educationassignmentrecipient.md)| Students who get the assignment.| |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. |
Content-type: application/json
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
* [Specify the default channel for education assignment notifications](/graph/education-build-notificationchannelurl) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Educationclass Delete Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationclass-delete-members.md
The following example shows a request.
"sampleKeys": ["11003", "14008"] }--> ```http
-DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008
+DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008/$ref
```
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+ # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/create-educationclass-from-educationschool-1-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+ ### Response
v1.0 Educationclass Post Assignments https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationclass-post-assignments.md
Namespace: microsoft.graph
Create a new assignment.
-Only teachers in a class can create an assignment. Assignments start in the Draft state, which means that students will not see the assignment until publication.
+Only teachers in a class can create an assignment. Assignments start in draft status, which means that students can't see the assignment until it's published.
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
Content-type: application/json
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Educationgradingscheme Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-delete.md
Namespace: microsoft.graph
Delete an [educationGradingScheme](../resources/educationgradingscheme.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
DELETE https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-856
[!INCLUDE [sample-code](../includes/snippets/php/delete-educationgradingscheme-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/delete-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Educationgradingscheme Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-get.md
Namespace: microsoft.graph
Read the properties and relationships of an [educationGradingScheme](../resources/educationgradingscheme.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
GET https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f
[!INCLUDE [sample-code](../includes/snippets/php/get-educationgradingscheme-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Educationgradingscheme Post https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-post.md
Namespace: microsoft.graph
Create a new [educationGradingScheme](../resources/educationgradingscheme.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Educationgradingscheme Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationgradingscheme-update.md
Namespace: microsoft.graph
Update the properties of an [educationGradingScheme](../resources/educationgradingscheme.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-educationgradingscheme-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-educationgradingscheme-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-Type: application/json
[!INCLUDE [snippet-not-available](../includes/snippets/snippet-not-available.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [snippet-not-available](../includes/snippets/snippet-not-available.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Educationsubmission Excuse https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-excuse.md
HTTP/1.1 200 Ok
``` ## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Educationsubmission Post Resources https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-post-resources.md
Content-type: application/json
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
* [Upload files for education assignments and submissions](/graph/education-upload-resource-overview) <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Educationsubmission Reassign https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-reassign.md
HTTP/1.1 200 OK
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Educationsubmission Return https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-return.md
HTTP/1.1 200 Ok
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Educationsubmission Submit https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-submit.md
HTTP/1.1 200 Ok
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Educationsubmission Unsubmit https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-unsubmit.md
HTTP/1.1 200 Ok
## Related content
-* [States, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-states-transition)
+* [Status, transitions, and limitations for assignments and submissions](/graph/assignments-submissions-status-transition)
<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC -->
v1.0 Encryptedawsstoragebucketfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedawsstoragebucketfinding-get.md
description: "Read the properties and relationships of an encryptedAwsStorageBuc
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Encryptedawsstoragebucketfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedawsstoragebucketfinding-list.md
description: "Get a list of the encryptedAwsStorageBucketFinding objects and the
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Encryptedazurestorageaccountfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedazurestorageaccountfinding-get.md
description: "Read the properties and relationships of an encryptedAzureStorageA
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Encryptedazurestorageaccountfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedazurestorageaccountfinding-list.md
description: "Get a list of the encryptedAzureStorageAccountFinding objects and
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Encryptedgcpstoragebucketfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedgcpstoragebucketfinding-get.md
description: "Read the properties and relationships of an encryptedGcpStorageBuc
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Encryptedgcpstoragebucketfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/encryptedgcpstoragebucketfinding-list.md
description: "Get a list of the encryptedGcpStorageBucketFinding objects and the
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Entitlementmanagement Post Accesspackageassignmentrequests https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageassignmentrequests.md
If successful, this method returns a 200-series response code and a new [accessP
If this is an `AdminAdd` request, then subsequently an [accessPackageAssignment](../resources/accesspackageassignment.md) and, if needed, an [accessPackageSubject](../resources/accesspackagesubject.md) are also created. You can locate those using the query parameters when [listing accessPackageAssignments](entitlementmanagement-list-accesspackageassignments.md). ## Examples+ ### Example 1: Admin requests a direct assignment for a user already in the directory+ #### Request
-The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
-
+The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
# [HTTP](#tab/http) <!-- {
HTTP/1.1 201 Created
Content-type: application/json {- "id": "7e382d02-4454-436b-b700-59c7dd77f466", "requestType": "AdminAdd", "requestState": "Submitted",
Content-type: application/json
} ```
-### Example 2: User requests a package and answers questions for approval
+### Example 2: Remove an assignment
+
+To remove assignments, create a new accessPackageAssignmentRequest object with the following settings:
+
+* The value of the **requestType** property set to `AdminRemove`.
+* In the **accessPackageAssignment** property, include an object with the identifier of the **accessPackageAssignment** objects to delete.
+ #### Request
+The following example shows how to remove an assignment.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_remove_assignment"
+}-->
+
+```http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests
+Content-type: application/json
+
+{
+ "requestType": "AdminRemove",
+ "accessPackageAssignment":{
+ "id": "a6bb6942-3ae1-4259-9908-0133aaee9377"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequest"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",
+
+ "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379",
+ "requestType": "AdminRemove",
+ "requestState": "Submitted",
+ "requestStatus": "Accepted"
+}
+```
+
+### Example 3: Request an assignment by providing answers to questions
+ The following example shows a request where the requestor provided answers to the approver to help them make their decision.
-
+#### Request
+The following example shows a request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
] } ```
-### Example 3: Request a package and provide a justification
-#### Request
+
+### Example 4: Request a package and provide a justification
The following example shows how to request an access package and provide justification to the approver.
-
+#### Request
+The following example shows a request.
# [HTTP](#tab/http) <!-- {
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
<!-- { "blockType": "response",
Content-type: application/json
} ```
-### Example 4: Remove an assignment
-
-To remove assignments, create a new accessPackageAssignmentRequest object with the following settings:
-
-+ The value of the **requestType** property set to `AdminRemove`.
-+ In the accessPackageAssignment property, include an object with the identifier of the accessPackageAssignment objects to delete.
+### Example 5: Admin requests a direct assignment for a user not yet in the directory
#### Request
-The following example shows how to remove an assignment.
--
+The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user who doesn't exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_remove_assignment"
+ "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_direct_assignment"
}--> ```http
POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/a
Content-type: application/json {
- "requestType": "AdminRemove",
- "accessPackageAssignment":{
- "id": "a6bb6942-3ae1-4259-9908-0133aaee9377"
- }
+ "requestType": "AdminAdd",
+ "accessPackageAssignment":{
+ "target": {
+ "email": "user@contoso.com"
+ },
+ "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8",
+ "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b"
+ }
} ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
HTTP/1.1 201 Created
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",
-
- "id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379",
- "requestType": "AdminRemove",
- "requestState": "Submitted",
- "requestStatus": "Accepted"
+ "id": "7e382d02-4454-436b-b700-59c7dd77f466",
+ "requestType": "AdminAdd",
+ "requestState": "Submitted",
+ "requestStatus": "Accepted",
+ "isValidationOnly": false
} ```
-### Example 5: Admin requests a direct assignment for a user not yet in the directory
-#### Request
+### Example 6: Request an update to answers for an assignment
-The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user, for a user who does not exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
+The following example shows how an admin can request updates to an assignment to edit their responses to questions that were answered during the request for the assignment.
+#### Request
+
+The following example shows a request.
# [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_direct_assignment"
+ "name": "update_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_to_approver"
}-->- ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests Content-type: application/json {
- "requestType": "AdminAdd",
- "accessPackageAssignment":{
- "target": {
- "email": "user@contoso.com"
- },
- "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8",
- "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b"
- }
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest",
+ "id": "7a6ab703-0780-4b37-8445-81f679b2d75c",
+ "requestType": "adminUpdate",
+ "answers": [
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "UpdatedAnswerValue",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
+ "id": "8fe745e7-80b2-490d-bd22-4e708c77288c"
+ }
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "My updated answer.",
+ "displayValue": "This is my updated answer to the question.",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
+ "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6"
+ }
+ }
+ ],
+ "assignment": {
+ "id": "44c741c1-2cf4-40db-83b6-e0112f8e5a83"
+ }
} ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
<!-- { "blockType": "response",
HTTP/1.1 201 Created
Content-type: application/json {-
- "id": "7e382d02-4454-436b-b700-59c7dd77f466",
- "requestType": "AdminAdd",
- "requestState": "Submitted",
- "requestStatus": "Accepted",
- "isValidationOnly": false
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",
+ "id": "0c471116-e439-40a6-8441-fe739dd48dab",
+ "requestType": "adminUpdate",
+ "state": "submitted",
+ "status": "Accepted",
+ "createdDateTime": null,
+ "completedDateTime": null,
+ "schedule": {
+ "startDateTime": null,
+ "recurrence": null,
+ "expiration": {
+ "endDateTime": null,
+ "duration": null,
+ "type": "notSpecified"
+ }
+ },
+ "answers": [
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "UpdatedAnswerValue",
+ "displayValue": "This is the answer to a multiple choice question",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
+ "id": "8fe745e7-80b2-490d-bd22-4e708c77288c"
+ }
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "My updated answer.",
+ "displayValue": "This is my updated answer to the question.",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
+ "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6"
+ }
+ }
+ ]
} ``` - <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- {
v1.0 Entitlementmanagement Post Assignmentrequests https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-assignmentrequests.md
If this is an `adminAdd` request, then subsequently an [accessPackageAssignment]
## Examples ### Example 1: Admin requests a direct assignment for a user already in the directory+ #### Request
-The following example shows a request for a direct assignment, in which the administrator is requesting the creation of an assignment for the user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
+The following example shows a request for a direct assignment, in which the administrator requests the creation of an assignment for a user. Because the [accessPackageSubject](../resources/accesspackagesubject.md) might not yet exist, the value of the **targetID** is the object ID of the user being assigned, the value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
# [HTTP](#tab/http) <!-- {
HTTP/1.1 201 Created
Content-type: application/json {-
- "id": "7e382d02-4454-436b-b700-59c7dd77f466",
+ "id": "46184453-e63b-4f20-86c2-c557ed5d5df9",
"requestType": "adminAdd", "requestState": "Submitted", "requestStatus": "Accepted"
Content-type: application/json
### Example 2: Remove an assignment
-To remove assignments, create a new accessPackageAssignmentRequest object with the following settings:
+To remove assignments, create a new **accessPackageAssignmentRequest** object with the following settings:
-+ The value of the **requestType** property set to `adminRemove`.
-+ In the assignment property, include an object with the identifier of the accessPackageAssignment object to delete.
+* The value of the **requestType** property set to `adminRemove`.
+* In the **assignment** property, include an object with the identifier of the **accessPackageAssignment** object to delete.
#### Request
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
<!-- { "blockType": "response",
HTTP/1.1 201 Created
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity",
-
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",
"id": "78eaee8c-e6cf-48c9-8f99-aae44c35e379", "requestType": "adminRemove", "requestState": "Submitted",
Content-type: application/json
} ```
-### Example 3: Request an assignment
+### Example 3: Request an assignment by providing answers to questions
-The following example shows how a user can request an access package assignment for themselves.
+The following example shows how a user can request an access package assignment for themselves by answering questions required by the policy during the request process.
#### Request
+The following example shows a request.
+ # [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_packageID"
+ "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_approver"
}-->+ ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests Content-type: application/json {
+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest",
"requestType": "userAdd",
+ "answers": [
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "displayValue": "This is the answer to a multiple choice question",
+ "value": "MultipleChoiceAnswerValue",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
+ "id": "8fe745e7-80b2-490d-bd22-4e708c77288c"
+ }
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "This is my answer to a text input question.",
+ "displayValue": "This is my answer.",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
+ "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6"
+ }
+ }
+ ],
"assignment": {
- "accessPackageId": "d7be3253-b9c6-4fab-adef-30d30de8da2b"
+ "accessPackageId": "977c7ff4-ef8f-4910-9d31-49048ddf3120"
} } ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
<!-- { "blockType": "response",
HTTP/1.1 201 Created
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity",
- "id": "724bc62d-90ff-48f3-903f-b59ec8453343",
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",
+ "id": "7a6ab703-0780-4b37-8445-81f679b2d75c",
"requestType": "userAdd",
- "state": "submitted"
+ "state": "submitted",
+ "status": "Accepted",
+ "createdDateTime": null,
+ "completedDateTime": null,
+ "schedule": {
+ "startDateTime": null,
+ "recurrence": null,
+ "expiration": {
+ "endDateTime": null,
+ "duration": null,
+ "type": "notSpecified"
+ }
+ },
+ "answers": [
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "MultipleChoiceAnswerValue",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
+ "id": "8fe745e7-80b2-490d-bd22-4e708c77288c"
+ },
+ "displayValue": "This is the answer to a multiple choice question"
+ },
+ {
+ "@odata.type": "#microsoft.graph.accessPackageAnswerString",
+ "value": "This is my answer to a text input question.",
+ "answeredQuestion": {
+ "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
+ "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6"
+ },
+ "displayValue": "This is my answer."
+ }
+ ]
} ```
-### Example 4: Request an assignment by providing answers to questions
+### Example 4: Request a package and provide a justification
-The following example shows how a user can request an access package assignment for themselves by answering questions required by the policy while making the request.
+The following example shows how to request an access package and provide justification to the approver.
#### Request
+The following example shows a request.
+ # [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "create_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_approver"
+ "name": "create_assignmentrequests_from_assignmentrequests_justification_provided"
}--> ```http
POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/a
Content-type: application/json {
- "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest",
- "requestType": "userAdd",
- "answers": [
- {
- "@odata.type": "#microsoft.graph.accessPackageAnswerString",
- "displayValue": "This is the answer to a multiple choice question",
- "value": "MultipleChoiceAnswerValue",
- "answeredQuestion": {
- "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
- "id": "8fe745e7-80b2-490d-bd22-4e708c77288c"
- }
- },
- {
- "@odata.type": "#microsoft.graph.accessPackageAnswerString",
- "value": "This is my answer to a text input question.",
- "displayValue": "This is my answer.",
- "answeredQuestion": {
- "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
- "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6"
- }
- }
- ],
- "assignment": {
- "accessPackageId": "977c7ff4-ef8f-4910-9d31-49048ddf3120"
- }
+ "requestType": "UserAdd",
+ "accessPackageAssignment": {
+ "accessPackageId": "a914b616-e04e-476b-aa37-91038f0b165b"
+ },
+ "justification":"Need access to New Hire access package"
} ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
<!-- { "blockType": "response",
HTTP/1.1 201 Created
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity",
- "id": "7a6ab703-0780-4b37-8445-81f679b2d75c",
- "requestType": "userAdd",
- "state": "submitted",
- "status": "Accepted",
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity",
+ "id": "9c1e258d-7723-43b1-ae21-e6eeeb324fe5",
+ "requestType": "UserAdd",
+ "requestState": "Submitted",
+ "requestStatus": "Accepted",
"createdDateTime": null,
- "completedDateTime": null,
+ "completedDate": null,
+ "justification": "Need access to New Hire access package",
+ "isValidationOnly": false,
"schedule": { "startDateTime": null, "recurrence": null,
Content-type: application/json
"type": "notSpecified" } },
- "answers": [
- {
- "@odata.type": "#microsoft.graph.accessPackageAnswerString",
- "value": "MultipleChoiceAnswerValue",
- "answeredQuestion": {
- "@odata.type": "#microsoft.graph.accessPackageMultipleChoiceQuestion",
- "id": "8fe745e7-80b2-490d-bd22-4e708c77288c"
- },
- "displayValue": "This is the answer to a multiple choice question"
- },
- {
- "@odata.type": "#microsoft.graph.accessPackageAnswerString",
- "value": "This is my answer to a text input question.",
- "answeredQuestion": {
- "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion",
- "id": "7aaa18c9-8e4f-440f-bd5a-3a7ce312cbe6"
- },
- "displayValue": "This is my answer."
+ "answers": [],
+ "verifiedCredentialsData": [],
+ "customExtensionHandlerInstances": [],
+ "customExtensionCalloutInstances": []
+}
+```
+
+### Example 5: Admin requests a direct assignment for a user not yet in the directory
+
+#### Request
+
+The following example shows a request for a direct assignment, in which the administrator is requests the creation of an assignment for a user who doesn't exist in the directory. The value of the **accessPackageId** is the desired access package for that user, and the value of **assignmentPolicyId** is a direct assignment policy in that access package.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_assignmentrequest_from_assignmentrequests_direct_assignment"
+}-->
+
+```http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests
+Content-type: application/json
+
+{
+ "requestType": "AdminAdd",
+ "accessPackageAssignment":{
+ "target": {
+ "email": "user@contoso.com"
+ },
+ "assignmentPolicyId":"2264bf65-76ba-417b-a27d-54d291f0cbc8",
+ "accessPackageId":"a914b616-e04e-476b-aa37-91038f0b165b"
+ }
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
+
+The following example shows the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentRequest"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity",
+ "id": "cb32aef9-2976-496d-9804-eb432fd894a7",
+ "requestType": "AdminAdd",
+ "requestState": "Submitted",
+ "requestStatus": "Accepted",
+ "createdDateTime": null,
+ "completedDate": null,
+ "justification": null,
+ "isValidationOnly": false,
+ "schedule": {
+ "startDateTime": null,
+ "recurrence": null,
+ "expiration": {
+ "endDateTime": null,
+ "duration": null,
+ "type": "notSpecified"
}
- ]
+ },
+ "answers": [],
+ "verifiedCredentialsData": [],
+ "customExtensionHandlerInstances": [],
+ "customExtensionCalloutInstances": []
} ```
-### Example 5: Request an update to answers for an assignment
+### Example 6: Request an update to answers for an assignment
-The following example shows how an admin can request updates to an assignment to edit their responses to questions that were answered while requesting the assignment.
+The following example shows how an admin can request updates to an assignment to edit their responses to questions that were answered during the request for the assignment.
#### Request
+The following example shows a request.
+ # [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "update_accesspackageassignmentrequest_from_accesspackageassignmentrequests_requestor_answer_to_approver"
+ "name": "update_accesspackageassignmentrequest_from_assignmentrequests_requestor_answer_to_approver"
}--> ```http POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests
Content-type: application/json
``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
The following example shows the response.
-> **Note:** The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
+> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call.
<!-- { "blockType": "response",
HTTP/1.1 201 Created
Content-type: application/json {
- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#accessPackageAssignmentRequests/$entity",
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#accessPackageAssignmentRequests/$entity",
"id": "0c471116-e439-40a6-8441-fe739dd48dab", "requestType": "adminUpdate", "state": "submitted",
Content-type: application/json
] } ```+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Create accessPackageAssignmentRequest",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
v1.0 Extensionproperty Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/extensionproperty-delete.md
Title: "Delete extensionProperty (directory extension)"
description: "Delete a directory extension definition." ms.localizationpriority: medium + doc_type: "apiPageType"
v1.0 Extensionproperty Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/extensionproperty-get.md
Title: "Get extensionProperty (directory extension)"
description: "Read a directory extension definition." ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externalauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-delete.md
+
+ Title: "Delete externalAuthenticationMethodConfiguration"
+description: "Delete an externalAuthenticationMethodConfiguration object."
+
+ms.localizationpriority: medium
+++
+# Delete externalAuthenticationMethodConfiguration
+
+Namespace: microsoft.graph
++
+Delete an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "externalauthenticationmethodconfiguration-delete-permissions"
+}
+-->
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_externalauthenticationmethodconfiguration"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b3107ab7-68c7-4553-a167-48c1e9c24d52
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Externalauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-get.md
+
+ Title: "Get externalAuthenticationMethodConfiguration"
+description: "Read the properties and relationships of an externalAuthenticationMethodConfiguration object."
+
+ms.localizationpriority: medium
+++
+# Get externalAuthenticationMethodConfiguration
+
+Namespace: microsoft.graph
++
+Read the properties and relationships of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "externalauthenticationmethodconfiguration-get-permissions"
+}
+-->
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}
+```
+
+## Optional query parameters
+
+This method does not support OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_externalauthenticationmethodconfiguration"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b3107ab7-68c7-4553-a167-48c1e9c24d52
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.externalAuthenticationMethodConfiguration"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration",
+ "id": "b3107ab7-68c7-4553-a167-48c1e9c24d52",
+ "displayName": "Adatum",
+ "appId": "fb262304-618c-4ffb-878a-114490bdf200",
+ "openIdConnectSetting": {
+ "clientId": "06a011bd-ec92-4404-80fb-db6d5ada8ee2",
+ "discoveryUrl": "https//Adatum.com/.well-known/openid-configuration"
+ },
+ "state": "disabled",
+ "excludeTargets": [],
+ "includeTargets": []
+}
+```
+
v1.0 Externalauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-update.md
+
+ Title: "Update externalAuthenticationMethodConfiguration"
+description: "Update the properties of an externalAuthenticationMethodConfiguration object."
+
+ms.localizationpriority: medium
+++
+# Update externalAuthenticationMethodConfiguration
+
+Namespace: microsoft.graph
++
+Update the properties of an [externalAuthenticationMethodConfiguration](../resources/externalauthenticationmethodconfiguration.md) object.
++
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "externalauthenticationmethodconfiguration-update-permissions"
+}
+-->
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{id}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+++
+|Property|Type|Description|
+|:|:|:|
+|appId|String|**appId** for the app registration in Microsoft Entra ID representing the integration with the external provider.|
+|excludeTargets|[excludeTarget](../resources/excludetarget.md) collection|Groups representing the users that should be excluded from the policy. |
+|includeTargets|[authenticationMethodTarget](../resources/authenticationMethodTarget.md) collection|Groups representing the users that are included in the policy and that can use the external authentication method. |
+|state|authenticationMethodState|The state of the method in the policy. The possible values are: `enabled`, `disabled`. |
+|openIdConnectSetting|[openIdConnectSetting](../resources/openidconnectsetting.md)|Object representing the required settings for the OIDC request to the external provider.|
+++
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_externalauthenticationmethodconfiguration"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/b183b746-e7db-4fa2-bafc-69ecf18850dd
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.externalAuthenticationMethodConfiguration",
+ "includeTargets": [
+ {
+ "targetType": "group",
+ "id": "b183b746-e7db-4fa2-bafc-69ecf18850dd",
+ "isRegistrationRequired": false,
+ }
+ ],
+ "state": "enabled"
+}
+
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Externalconnectors External List Authorizationsystems https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalconnectors-external-list-authorizationsystems.md
description: "List the authorizationSystem objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externallyaccessibleawsstoragebucketfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleawsstoragebucketfinding-get.md
description: "Read the properties and relationships of an externallyAccessibleAw
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externallyaccessibleawsstoragebucketfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleawsstoragebucketfinding-list.md
description: "Get a list of the externallyAccessibleAwsStorageBucketFinding obje
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externallyaccessibleazureblobcontainerfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleazureblobcontainerfinding-get.md
description: "Read the properties and relationships of an externallyAccessibleAz
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externallyaccessibleazureblobcontainerfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessibleazureblobcontainerfinding-list.md
description: "Get a list of the externallyAccessibleAzureBlobContainerFinding ob
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externallyaccessiblegcpstoragebucketfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessiblegcpstoragebucketfinding-get.md
description: "Read the properties and relationships of an externallyAccessibleGc
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externallyaccessiblegcpstoragebucketfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externallyaccessiblegcpstoragebucketfinding-list.md
description: "Get a list of the externallyAccessibleGcpStorageBucketFinding obje
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Externaluserprofile Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-get.md
GET https://graph.microsoft.com/beta/directory/externalUserProfiles/{id}
[!INCLUDE [sample-code](../includes/snippets/php/get-externaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Externaluserprofile Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/php/update-externaluserprofile-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/update-externaluserprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
v1.0 Federatedidentitycredential Upsert https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedidentitycredential-upsert.md
Namespace: microsoft.graph
Create a new [federatedIdentityCredential](../resources/federatedidentitycredential.md) object for an application if it does exist, or update the properties of an existing [federatedIdentityCredential](../resources/federatedidentitycredential.md) object. By [configuring a trust relationship](/azure/active-directory/develop/workload-identity-federation-create-trust) between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
v1.0 Federatedtokenvalidationpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedtokenvalidationpolicy-get.md
Namespace: microsoft.graph
Read the properties and relationships of a [federatedTokenValidationPolicy](../resources/federatedtokenvalidationpolicy.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
Choose the permission or permissions marked as least privileged for this API. Us
--> [!INCLUDE [permissions-table](../includes/permissions/federatedtokenvalidationpolicy-get-permissions.md)] + ## HTTP request <!-- {
v1.0 Federatedtokenvalidationpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/federatedtokenvalidationpolicy-update.md
Choose the permission or permissions marked as least privileged for this API. Us
--> [!INCLUDE [permissions-table](../includes/permissions/federatedtokenvalidationpolicy-update-permissions.md)] + ## HTTP request <!-- {
v1.0 Filestorage Delete Containers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-delete-containers.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object. This method moves the **fileStorageContainer** to the recycle bin; it doesn't permanently delete it.
+
+Delete a [fileStorageContainer](../resources/filestoragecontainer.md) object. Deleting a file storage container with this API moves it to the deleted container collection, so that it can be restored later.
## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -
-<!-- { "blockType": "permissions", "name": "filestorage_delete_containers" } -->
+<!-- {
+ "blockType": "permissions",
+ "name": "filestorage-delete-containers-permissions"
+}
+-->
[!INCLUDE [permissions-table](../includes/permissions/filestorage-delete-containers-permissions.md)] + ## HTTP request <!-- {
The following example shows a request.
} --> ``` http
-DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}
+DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z
``` - ### Response The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true
The following example shows the response.
``` http HTTP/1.1 204 No Content ```-
v1.0 Filestorage Delete Deletedcontainers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-delete-deletedcontainers.md
+
+ Title: "Remove deleted fileStorageContainer"
+description: "Remove a deleted fileStorageContainer object."
+
+ms.localizationpriority: medium
+++
+# Remove deleted fileStorageContainer
+
+Namespace: microsoft.graph
++
+Permanently remove a [fileStorageContainer](../resources/filestoragecontainer.md) from the deleted container collection. Removing a file storage container with this API permanently removes it from the deleted container collection. Therefore, it can't be restored later.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestorage-delete-deletedcontainers-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /deletedStorageContainers/{containerId}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "remove_deleted_filestoragecontainer"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z
+```
++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Filestorage Get Deletedcontainers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-get-deletedcontainers.md
+
+ Title: "Get deleted fileStorageContainer"
+description: "Get a deleted fileStorageContainer resource."
+
+ms.localizationpriority: medium
+++
+# Get deleted fileStorageContainer
+
+Namespace: microsoft.graph
++
+Retrieve the properties of a deleted [fileStorageContainer](../resources/filestoragecontainer.md) from the deleted container collection.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestorage-get-deletedcontainers-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /deletedStorageContainers/{containerId}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_deleted_filestoragecontainer"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z?$select=*,members
+```
++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.fileStorageContainer"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.fileStorageContainer",
+ "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z",
+ "displayName": "My Application Storage Container",
+ "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73",
+ "createdDateTime": "2021-11-24T15:41:52.347Z",
+ "deletedDateTime": "2022-08-11T12:35:16.300Z",
+ "expiryDateTime": "2022-11-09T12:35:16.300Z",
+ "members": [
+ {
+ "id": "EBA7DBE0-B42F-4BC8-AEF6-97B66EFC77D0"
+ },
+ {
+ "id": "ABE7DBE0-B42F-4BC8-AEF6-97B66EFC0000"
+ }
+ ]
+}
+```
+
v1.0 Filestorage List Deletedcontainers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-list-deletedcontainers.md
+
+ Title: "List deleted fileStoageContainers"
+description: "Get a list of deleted fileStorageContainers."
+
+ms.localizationpriority: medium
+++
+# List deletedContainers
+
+Namespace: microsoft.graph
++
+Retrieve the list of [fileStorageContainer](../resources/filestoragecontainer.md) objects from the deleted container collection.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestorage-list-deletedcontainers-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /deletedStorageContainers?$filter=containerTypeId eq {containerTypeId}
+```
+
+## Query parameters
+This method requires the `containerTypeId` parameter. It supports OData skip-top paging and the `$orderBy` and `$filter` query parameters, but doesn't support the `$expand` query parameter.
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [fileStorageContainer](../resources/filestoragecontainer.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "list_deleted_filestoragecontainer"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/deletedStorageContainers?$filter=containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082
+```
++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.fileStorageContainer)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.fileStorageContainer",
+ "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z",
+ "displayName": "My File Storage Container",
+ "createdDateTime": "2021-11-24T15:41:52.347Z",
+ "deletedDateTime": "2022-08-11T12:35:16.300Z"
+ }
+ ]
+}
+```
+
v1.0 Filestoragecontainer Activate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-activate.md
doc_type: apiPageType
-# fileStorageContainer: activate
+# fileStorageContainer: activate
Namespace: microsoft.graph
Namespace: microsoft.graph
Activate a [fileStorageContainer](../resources/filestoragecontainer.md) object.
-A **fileStorageContainer** object is created in an inactive state, as indicated by the **status** property. A container must be activated within 24 hours after creation, or it is automatically deleted. Upon activation, the value of the status property changes from `inactive` to `active`.
-
-A **fileStorageContainer** can be activated by calling the activate API or any API that updates or modifies the **fileStorageContainer** or its content. For example, uploading a file to a **fileStorageContainer**, adding permission to a **fileStorageContainer**, creating a custom property on a **fileStorageContainer**, or updating the properties of a **fileStorageContainer** can activate it.
+A **fileStorageContainer** object is created in an inactive state, as indicated by the **status** property. A container that isn't activated within 24 hours after creation is automatically deleted. Upon activation, the value of the status property changes from `inactive` to `active`.
+A file storage container can be activated by calling this API or any API that updates or modifies it or its content. For example, uploading a file to a file storage container activates it. It's also activated when you add permissions to it or update them, or create a custom property on it.
## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). - <!-- { "blockType": "permissions", "name": "filestoragecontainer_activate" } --> [!INCLUDE [permissions-table](../includes/permissions/filestoragecontainer-activate-permissions.md)]
v1.0 Filestoragecontainer Delete Column https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-delete-column.md
+
+ Title: "Delete column"
+description: "Delete a columnDefinition from a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# Delete column
+
+Namespace: microsoft.graph
++
+Delete a [columnDefinition](../resources/columndefinition.md) from a [fileStorageContainer](../resources/filestoragecontainer.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-delete-columns-permissions"
+}
+-->
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /storageContainers/{containerId}/columns/{column-id}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "delete_columndefinition_for_fileStorageContainer"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/bet/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/99ddcf45-e2f7-4f17-82b0-6fba34445103
+Content-Type: application/json
+
+{
+ "description": "test",
+ "enforceUniqueValues": false,
+ "hidden": false,
+ "indexed": false,
+ "name": "Title",
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+}
+```
++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Filestoragecontainer Delete Recyclebin Items https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-delete-recyclebin-items.md
+
+ Title: "Delete recycleBin items"
+description: "Delete items from fileStorageContainer recycleBin."
+
+ms.localizationpriority: medium
+++
+# Delete recycle bin items
+
+Namespace: microsoft.graph
++
+Permanently delete [recycleBinItem](../resources/recyclebinitem.md) objects from the [recycleBin](../resources/recyclebin.md) of a [fileStorageContainer](../resources/filestoragecontainer.md). Items deleted by this method can't be restored.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-delete-recyclebin-items-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /storageContainers/{containerId}/recycleBin/items/delete
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [recycleBinItem](../resources/recyclebinitem.md) objects to delete.
++
+## Response
+
+If successful, this method returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "delete_filestoragecontainer_recyclebin_items",
+ "@odata.type": "Collection(microsoft.graph.recyclebinitem)"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/delete
+Content-Type: application/json
+
+{
+ "ids": ["5d625d33-338c-4a77-a98a-3e287116440c", "73133853-48f2-4956-bc4a-03f8d1675042"]
+}
+```
+
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Filestoragecontainer Get Column https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-get-column.md
+
+ Title: "Get column"
+description: "Get a column from a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# Get column
+
+Namespace: microsoft.graph
++
+Get the properties of a column represented as a [columnDefinition](../resources/columndefinition.md) in a [fileStorageContainer](../resources/filestoragecontainer.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-get-columns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /storageContainers/{containerId}/columns/{column-id}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
++
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [columnDefinition](../resources/columndefinition.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "get_columndefinition_for_fileStorageContainer"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/99ddcf45-e2f7-4f17-82b0-6fba34445103
+```
++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.columnDefinition"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "description": "test",
+ "displayName": "Title",
+ "enforceUniqueValues": false,
+ "hidden": false,
+ "id": "99ddcf45-e2f7-4f17-82b0-6fba34445103",
+ "indexed": false,
+ "name": "Title",
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+}
+```
+
v1.0 Filestoragecontainer List Columns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-columns.md
+
+ Title: "List columns"
+description: "List columns in a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# List columns
+
+Namespace: microsoft.graph
++
+Get the collection of columns represented as [columnDefinition](../resources/columndefinition.md) resources in a [fileStorageContainer](../resources/filestoragecontainer.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-list-columns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+GET /storageContainers/{containerId}/columns
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [columnDefinition](../resources/columndefinition.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+<!-- {
+ "blockType": "request",
+ "name": "list_columndefinition"
+}
+-->
+
+``` http
+GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns
+```
++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.columnDefinition)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "description": "",
+ "displayName": "Title",
+ "hidden": false,
+ "id": "99ddcf45-e2f7-4f17-82b0-6fba34445103",
+ "indexed": false,
+ "name": "Title",
+ "readOnly": false,
+ "required": false,
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+ },
+ {
+ "description": "",
+ "displayName": "Address",
+ "id": "11dfef35-e2f7-4f17-82b0-6fba34445103",
+ "indexed": false,
+ "name": "Address",
+ "readOnly": false,
+ "required": false,
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+ }
+ ]
+}
+```
+
v1.0 Filestoragecontainer List Recyclebin Items https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-recyclebin-items.md
+
+ Title: "List recycleBin items"
+description: "Get a list of recycle bin items from a fileStorageContainer recycleBin."
+
+ms.localizationpriority: medium
+++
+# List recycleBin items
+
+Namespace: microsoft.graph
++
+Get a list of [recycleBinItem](../resources/recyclebinitem.md) objects from the [recycleBin](../resources/recyclebin.md) of a [fileStorageContainer](../resources/filestoragecontainer.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-list-recyclebin-items-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+GET /storageContainers/{containerId}/recycleBin/items
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a collection of [recycleBinItem](../resources/recyclebinitem.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "list_recyclebin_items"
+}
+-->
+
+``` http
+GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items
+```
++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.recycleBinItem)"
+}
+-->
+
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "id": "5d625d33-338c-4a77-a98a-3e287116440c",
+ "name": "document.docx",
+ "size": 1024,
+ "deletedDateTime": "2022-04-25T20:11:51Z",
+ "title": "my document",
+ "deletedBy": {
+ "user": {
+ "displayName": "Tenant Admin User",
+ "id": "EBA7DBE0-B42F-4BC8-AEF6-97B66EFC77D0",
+ "userPrincipalName": "jhan@contoso.com"
+ }
+ }
+ }
+ ]
+}
+```
+
v1.0 Filestoragecontainer Permanentdelete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-permanentdelete.md
+
+ Title: "fileStorageContainer: permanentDelete"
+description: "Permanently delete a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# fileStorageContainer: permanentDelete
+
+Namespace: microsoft.graph
++
+Permanently delete a [fileStorageContainer](../resources/filestoragecontainer.md). Deleting a file storage container with this method permanently removes it. It isn't sent to the deleted container collection. Therefore, it can't be restored later.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-permanentdelete-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /storageContainers/{containerId}/permanentDelete
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this action returns a `204 No Content` response code.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "filestoragecontainerthis.permanentdelete"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permanentDelete
+```
++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Filestoragecontainer Post Columns https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-columns.md
+
+ Title: "Create column"
+description: "Create a columnDefinition in a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# Create column
+
+Namespace: microsoft.graph
++
+Create a column for a [fileStorageContainer](../resources/filestoragecontainer.md) that specifies a [columnDefinition](../resources/columndefinition.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-post-columns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /storageContainers/{containerId}/columns
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [columnDefinition](../resources/columndefinition.md) object.
+
+Only the following type-related properties are supported and they're mutually exclusive; a column can only have one of them specified at a time.
+
+|Property|Type|Description|
+|:|:|:|
+|boolean|[booleanColumn](../resources/booleancolumn.md)|This column stores boolean values.|
+|choice|[choiceColumn](../resources/choicecolumn.md)|This column stores data from a list of choices.|
+|currency|[currencyColumn](../resources/currencycolumn.md)|This column stores currency values.|
+|dateTime|[dateTimeColumn](../resources/datetimecolumn.md)|This column stores DateTime values.|
+|hyperlinkOrPicture|[hyperlinkOrPictureColumn](../resources/hyperlinkorpicturecolumn.md)|This column stores hyperlink or picture values.|
+|number|[numberColumn](../resources/numbercolumn.md)|This column stores number values.|
+|personOrGroup|[personOrGroupColumn](../resources/personorgroupcolumn.md)|This column stores Person or Group values.|
+|text|[textColumn](../resources/textcolumn.md)|This column stores text values.|
+
+## Response
+
+If successful, this method returns a `201 Created` response code and a [columnDefinition](../resources/columndefinition.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "create_columndefinition_for_fileStorageContainer"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns
+Content-Type: application/json
+
+{
+ "description": "test",
+ "enforceUniqueValues": false,
+ "hidden": false,
+ "indexed": false,
+ "name": "Title",
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+}
+```
++
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.columnDefinition"
+}
+-->
+
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "description": "test",
+ "displayName": "Title",
+ "enforceUniqueValues": false,
+ "hidden": false,
+ "id": "99ddcf45-e2f7-4f17-82b0-6fba34445103",
+ "indexed": false,
+ "name": "Title",
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+}
+```
+
v1.0 Filestoragecontainer Post Customproperty https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-customproperty.md
You can specify the following properties when you create a custom property.
## Response
-If successful, this method returns either a `200 Created` or `201 Created` response code.
+If successful, this method returns a `200 Created` response code.
## Examples
-### Request
+### Example 1: Create a custom property
+
+#### Request
The following example shows how to create a custom property called `clientUniqueId` for a container. <!-- { "blockType": "request",
Content-Type: application/json
} ```
-### Response
+#### Response
The following example shows the response. By default, the property isn't searchable. <!-- { "blockType": "response",
The following example shows the response. By default, the property isn't searcha
``` http HTTP/1.1 200 Created ```
+### Example 2: Create a custom searchable property
-### Request
+#### Request
The following example shows how to create a searchable custom property called `clientUniqueId` for a container. <!-- { "blockType": "request",
Content-Type: application/json
} } ```
-### Response
+#### Response
The following example shows the response. <!-- { "blockType": "response",
The following example shows the response.
HTTP/1.1 200 Created ```
-### Request
-The following example shows how to create multiple custom properties for a container.
-<!-- {
- "blockType": "request",
- "name": "post_filestoragecontainer_customproperty_3"
-}
>
-``` http
-PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties
-Content-Type: application/json
-
-{
- "property1": {
- "value": "valueOfProperty1",
- "isSearchable": true
- },
- "property2": {
- "value": "valueOfProperty2",
- "isSearchable": false
- }
-}
-```
-
-### Response
-The following example shows the response.
-<!-- {
- "blockType": "response",
- "truncated": true
-}
>
-``` http
-HTTP/1.1 201 Created
-```
v1.0 Filestoragecontainer Restore Recyclebin Items https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-restore-recyclebin-items.md
+
+ Title: "Restore recycleBin items"
+description: "Restore recycleBin items to a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# Restore recycle bin items
+
+Namespace: microsoft.graph
++
+Restore [recycleBinItem](../resources/recyclebinitem.md) objects from the [recycleBin](../resources/recyclebin.md) of a [fileStorageContainer](../resources/filestoragecontainer.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-restore-recyclebin-items-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+
+``` http
+POST /storageContainers/{containerId}/recycleBin/items/restore
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [recycleBinItem](../resources/recyclebinitem.md) objects to restore.
+
+## Response
+
+If successful, this method returns a `207 Multi-Status` response code and the set of restored [recycleBinItem](../resources/recyclebinitem.md) objects in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "restore_filestoragecontainer_recyclebin_items",
+ "@odata.type": "Collection(microsoft.graph.recycleBinItem)"
+}
+-->
+
+``` http
+POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/restore
+Content-Type: application/json
+
+{
+ "ids": ["5d625d33-338c-4a77-a98a-3e287116440c", "73133853-48f2-4956-bc4a-03f8d1675042"]
+}
+```
+
+### Response
+
+The following example shows the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.recycleBinItem)"
+}
+-->
+
+``` http
+HTTP/1.1 207 Multi-Status
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "id": "5d625d33-338c-4a77-a98a-3e287116440c"
+ },
+ {
+ "id": "73133853-48f2-4956-bc4a-03f8d1675042"
+ }
+ ]
+}
+```
+
v1.0 Filestoragecontainer Restore https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-restore.md
+
+ Title: "Restore deleted fileStorageContainer"
+description: "Restore deleted fileStorageContainer from the deleted container collection."
+
+ms.localizationpriority: medium
+++
+# fileStorageContainer: restore
+
+Namespace: microsoft.graph
++
+Restore a deleted [fileStorageContainer](../resources/filestoragecontainer.md) from the deleted container collection.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-restore-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /deletedStorageContainers/{containerId}/restore
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this action returns a `200 OK` response code and a [fileStorageContainer](../resources/filestoragecontainer.md) in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "filestoragecontainerthis.restore"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/restore
+```
++
+### Response
+
+The following example shows the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.fileStorageContainer"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "microsoft.graph.fileStorageContainer",
+ "id": "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z",
+ "displayName": "My Application Storage Container",
+ "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73",
+ "createdDateTime": "2021-11-24T15:41:52.347Z",
+ "deletedDateTime": "2022-08-11T12:35:16.300Z"
+}
+```
+
v1.0 Filestoragecontainer Update Column https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update-column.md
+
+ Title: "Update column"
+description: "Update a columnDefinition in a fileStorageContainer."
+
+ms.localizationpriority: medium
+++
+# Update column
+
+Namespace: microsoft.graph
++
+Update an existing column represented as a [columnDefinition](../resources/columndefinition.md) in a [fileStorageContainer](../resources/filestoragecontainer.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "filestoragecontainer-update-columns-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /storageContainers/{containerId}/columns/{column-id}
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+In the request body, supply a JSON representation of the [columnDefinition](../resources/columndefinition.md) object with the properties to update. The `id` property can't be changed. Existing properties not included in the request body maintain their previous values. To optimize performance, don't include existing values that didn't change.
+
+## Response
+
+If successful, this method returns a `200 OK` response code and a [columnDefinition](../resources/columndefinition.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+
+<!-- {
+ "blockType": "request",
+ "name": "update_columndefinition_for_fileStorageContainer"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/11dfef35-e2f7-4f17-82b0-6fba34445103
+Content-Type: application/json
+
+{
+ "required": true,
+ "hidden": false
+}
+```
++
+### Response
+
+The following example shows the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.columnDefinition"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "description": "",
+ "displayName": "Custom Column",
+ "enforceUniqueValues": false,
+ "hidden": false,
+ "id": "11dfef35-e2f7-4f17-82b0-6fba34445103",
+ "indexed": false,
+ "name": "Custom Column",
+ "readOnly": false,
+ "required": true,
+ "text": {
+ "allowMultipleLines": false,
+ "appendChangesToExistingText": false,
+ "linesForEditing": 0,
+ "maxLength": 255
+ }
+}
+```
+
v1.0 Gcpassociatedidentities List All https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpassociatedidentities-list-all.md
description: "Get a list of the gcpIdentity objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpassociatedidentities List Serviceaccounts https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpassociatedidentities-list-serviceaccounts.md
description: "Get a list of the gcpServiceAccount objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpassociatedidentities List Users https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpassociatedidentities-list-users.md
description: "Get a list of the gcpUser objects and their properties."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystem List Actions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-actions.md
description: "List the gcpAuthorizationSystemTypeAction objects and their proper
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystem List Resources https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-resources.md
description: "List the gcpAuthorizationSystemResource objects and their properti
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystem List Roles https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-roles.md
description: "List all GCP roles in a GCP authorization system."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystem List Services https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list-services.md
description: "Get all services in a GCP authorization system."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystem List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystem-list.md
description: "Get a list of the gcpAuthorizationSystem objects and their propert
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystemresource Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystemresource-get.md
description: "Read the properties and relationships of a gcpAuthorizationSystemR
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpauthorizationsystemtypeaction Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpauthorizationsystemtypeaction-get.md
description: "Read the properties and relationships of a gcpAuthorizationSystemT
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpidentity Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpidentity-get.md
description: "Read the properties and relationships of a gcpIdentity object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcprole Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcprole-get.md
description: "Get a GCP role in a GCP authorization system."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpserviceaccount Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpserviceaccount-get.md
description: "Read the properties and relationships of a gcpServiceAccount objec
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Gcpuser Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/gcpuser-get.md
description: "Read the properties and relationships of a gcpUser object."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Group Assignlicense https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-assignlicense.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "group_assignlicense" } --> [!INCLUDE [permissions-table](../includes/permissions/group-assignlicense-permissions.md)]
-For delegated scenarios, the calling user needs one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
+For delegated scenarios, the calling user needs at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
- Directory Writers - Groups Administrator - License Administrator - User Administrator-- Global Administrator ## HTTP request
v1.0 Group Delete Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delete-members.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "group_delete_members" } --> [!INCLUDE [permissions-table](../includes/permissions/group-delete-members-permissions.md)]
-> [!IMPORTANT]
-> To remove members from a role-assignable group, the calling user must also be assigned the _RoleManagement.ReadWrite.Directory_ permission.
+In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/groups/members/update` role permission. The following least privileged roles are supported for this operation, except for role-assignable groups:
+
+- Group owners
+- Directory Writers
+- Groups Administrator
+- Identity Governance Administrator
+- User Administrator
+- Exchange Administrator - for Microsoft 365 groups only
+- SharePoint Administrator - for Microsoft 365 groups only
+- Teams Administrator - for Microsoft 365 groups only
+- Yammer Administrator - for Microsoft 365 groups only
+- Intune Administrator - for security groups only
+
+To remove members from a role-assignable group, the app must also be assigned the *RoleManagement.ReadWrite.Directory* permission and the calling user must be assigned a supported Microsoft Entra role. *Privileged Role Administrator* is the least privileged role that is supported for this operation.
## HTTP request
v1.0 Group Delete Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delete-owners.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "group_delete_owners" } --> [!INCLUDE [permissions-table](../includes/permissions/group-delete-owners-permissions.md)]
-The signed-in user must also be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-
-| Microsoft Entra role | Limitations |
-|-||
-| User Administrator | Can modify user owners only |
-| Directory Writers | Can modify user owners only |
-| Groups Administrator | Can modify all types of group owners |
-| Exchange Service Administrator | Can modify owners of Microsoft 365 groups only |
-| SharePoint Service Administrator | Can modify owners of Microsoft 365 groups only |
-| Teams Administrator | Can modify owners of Microsoft 365 groups only |
-| Yammer Administrator | Can modify owners of Microsoft 365 groups only |
-| Intune Administrator | Can modify owners of security groups only |
-| Knowledge Administrator | Can modify owners of security groups only |
-| Knowledge Manager | Can modify owners of security groups only |
-| Windows 365 Administrator | Can modify owners of security groups only |
+In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the required role permission. The following least privileged roles are supported for this operation:
+
+| Microsoft Entra role | Limitations | Key role permission |
+|--|--|--|
+| Group owners | Can modify all types of group owners | microsoft.directory/groups/owners/update |
+| User Administrator | Can modify user owners only | microsoft.directory/groups/owners/update |
+| Directory Writers | Can modify user owners only | microsoft.directory/groups/owners/update |
+| Groups Administrator | Can modify all types of group owners | microsoft.directory/groups/owners/update |
+| Exchange Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| SharePoint Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| Teams Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| Yammer Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| Intune Administrator | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
+| Knowledge Administrator | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
+| Knowledge Manager | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
+| Windows 365 Administrator | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
## HTTP request
v1.0 Group Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
[!INCLUDE [permissions-table](../includes/permissions/group-delete-permissions.md)] The following conditions apply for apps to delete role-assignable groups:
-+ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a global administrator or a privileged role administrator.
-+ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Global Administrator or Privileged Role Administrator Microsoft Entra role.
++ For delegated scenarios, the app must be assigned the _RoleManagement.ReadWrite.Directory_ delegated permission, and the calling user must be the creator of the group or a privileged role administrator.++ For app-only scenarios, the calling app must be the owner of the group or be assigned the _RoleManagement.ReadWrite.Directory_ application permission or be assigned the Privileged Role Administrator Microsoft Entra role. ## HTTP request
v1.0 Group List Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-members.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get a list of the group's direct members. A group can have users, contacts, devices, service principals, and other groups as members. This operation is not transitive.
+Get a list of the group's direct members. A group can have users, contacts, devices, service principals, and other groups as members. This operation isn't transitive.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "group_list_members" } --> [!INCLUDE [permissions-table](../includes/permissions/group-list-members-permissions.md)]
-> **Note:** To list the members of a hidden membership group, the Member.Read.Hidden permission is required.
- [!INCLUDE [limited-info](../../includes/limited-info.md)]
+In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/groups/members/read` or `microsoft.directory/groups/members/limitedRead` role permission, or `microsoft.directory/groups/hiddenMembers/read` role permission to read hidden members. The following least privileged roles are supported for this operation:
+
+- Group owners
+- "Member" users
+- "Guest" users - have [limited read permissions](/entra/fundamentals/users-default-permissions?context=graph/context#compare-member-and-guest-default-permissions)
+- Directory Readers
+- Directory Writers
+- Groups Administrator
+- User Administrator - Including hidden members
+- Exchange Administrator - Including hidden members
+- SharePoint Administrator - Including hidden members
+- Intune Administrator - Including hidden members
+- Teams Administrator - Including hidden members
+- Yammer Administrator - Including hidden members
+
+To list the members of a hidden membership group, the *Member.Read.Hidden* permission is also required.
+ ## HTTP request <!-- { "blockType": "ignored" } -->
GET /groups/{id}/members
This method supports the `$filter`, `$count`, `$select`, `$search`, `$top`, `$search`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. The default and maximum page sizes are 100 and 999 group objects respectively. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on directory objects](/graph/aad-advanced-queries).
-OData cast is also enabled. For example, `/groups/{id}}/members/microsoft.graph.user` retrives group members that are users.
+OData cast is also enabled. For example, `/groups/{id}}/members/microsoft.graph.user` retrieves group members that are users.
## Request headers
Don't supply a request body for this method.
If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body.
-An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. For example, `/groups/{id}}/members/microsoft.graph.group` when the group is a Microsoft 365 group will return this error, because Microsoft 365 groups cannot have other groups as members.
+An attempt to filter by an OData cast that represents an unsupported member type returns a `400 Bad Request` error with the `Request_UnsupportedQuery` code. For example, `/groups/{id}}/members/microsoft.graph.group` when the group is a Microsoft 365 group returns this error, because Microsoft 365 groups can't have other groups as members.
## Examples
v1.0 Group List Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-owners.md
Choose the permission or permissions marked as least privileged for this API. Us
[!INCLUDE [limited-info](../../includes/limited-info.md)]
+In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/groups/owners/read` role permission. The following least privileged roles are supported for this operation:
+
+- Group owners
+- "Member" users
+- "Guest" users - have [limited read permissions](/entra/fundamentals/users-default-permissions?context=graph/context#compare-member-and-guest-default-permissions)
+- Directory Readers
+- Directory Writers
+- Groups Administrator
+- User Administrator
+- Exchange Administrator - for Microsoft 365 groups only
+- SharePoint Administrator - for Microsoft 365 groups only
+- Teams Administrator - for Microsoft 365 groups only
+- Yammer Administrator - for Microsoft 365 groups only
+- Intune Administrator - for security groups only
+ ## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Group List Transitivemembers https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-transitivemembers.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "group_list_transitivemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/group-list-transitivemembers-permissions.md)]
-> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required.
- [!INCLUDE [limited-info](../../includes/limited-info.md)]
+> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required.
+ ## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Group List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list.md
GET /groups
This method supports the `$count`, `$expand`, `$filter`, `$orderby`, `$search`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. `$skip` isn't supported. The default and maximum page sizes are 100 and 999 group objects respectively. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on directory objects](/graph/aad-advanced-queries).
-To list only Microsoft 365 groups (aka unified groups), apply a filter on **groupTypes**:
+To list only Microsoft 365 groups (unified groups), apply a filter on **groupTypes**:
<!-- { "blockType": "ignored" } -->
Extension properties also support query parameters as follows:
For more information on OData query options, see [OData query parameters](/graph/query-parameters). For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on directory objects](/graph/aad-advanced-queries).
+### Filter by group types
+
+| Group type | API request |
+|--|-|
+| Microsoft 365 (unified) groups | [GET](https://developer.microsoft.com/en-us/graph/graph-explorer?request=groups%3F%24filter%3DgroupTypes%2Fany(c%3Ac%2Beq%2B'Unified')&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) `/groups?$filter=groupTypes/any(c:c+eq+'Unified')` |
+| Security groups | [GET](https://developer.microsoft.com/en-us/graph/graph-explorer?request=groups%3F%24filter%3DmailEnabled%2Beq%2Bfalse%26securityEnabled%2Beq%2Btrue&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) `/groups?$filter=mailEnabled eq false&securityEnabled eq true` |
+| Mail-enabled security groups | [GET](https://developer.microsoft.com/en-us/graph/graph-explorer?request=groups%3F%24filter%3DNOT%2BgroupTypes%2Fany(c%3Ac%2Beq%2B'Unified')%2Band%2BmailEnabled%2Beq%2Btrue%2Band%2BsecurityEnabled%2Beq%2Btrue%26%24count%3Dtrue&method=GET&version=beta&GraphUrl=https://graph.microsoft.com&headers=W3sibmFtZSI6IkNvbnNpc3RlbmN5TGV2ZWwiLCJ2YWx1ZSI6ImV2ZW50dWFsIn1d) `/groups?$filter=NOT groupTypes/any(c:c eq 'Unified') and mailEnabled eq true and securityEnabled eq true&$count=true` <sup> ** </sup> |
+| Distribution groups | [GET](https://developer.microsoft.com/en-us/graph/graph-explorer?request=groups%3F%24filter%3DNOT%2BgroupTypes%2Fany(c%3Ac%2Beq%2B'Unified')%2Band%2BmailEnabled%2Beq%2Btrue%2Band%2BsecurityEnabled%2Beq%2Bfalse%26%24count%3Dtrue&method=GET&version=beta&GraphUrl=https://graph.microsoft.com&headers=W3sibmFtZSI6IkNvbnNpc3RlbmN5TGV2ZWwiLCJ2YWx1ZSI6ImV2ZW50dWFsIn1d) `/groups?$filter=NOT groupTypes/any(c:c eq 'Unified') and mailEnabled eq true and securityEnabled eq false&$count=true` <sup> ** </sup> |
+
+** : This example is only supported with [advanced query capabilities](/graph/aad-advanced-queries).
+ ## Request headers | Name | Description |
v1.0 Group Post Members https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-members.md
The following table shows the least privileged permission that's required by eac
| [servicePrincipal](../resources/group.md) | GroupMember.ReadWrite.All and Application.ReadWrite.All | Not supported. | GroupMember.ReadWrite.All and Application.ReadWrite.All | | [user](../resources/user.md) | GroupMember.ReadWrite.All | Not supported. | GroupMember.ReadWrite.All |
-> [!IMPORTANT]
-> To add members to a role-assignable group, the caller must also be assigned the _RoleManagement.ReadWrite.Directory_ permission.
+In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/groups/members/update` role permission. The following roles are the least privileged roles that are supported for this operation, except for role-assignable groups:
+
+- Group owners
+- Directory Writers
+- Groups Administrator
+- Identity Governance Administrator
+- User Administrator
+- Exchange Administrator - only for Microsoft 365 groups
+- SharePoint Administrator - only for Microsoft 365 groups
+- Teams Administrator - only for Microsoft 365 groups
+- Yammer Administrator - only for Microsoft 365 groups
+- Intune Administrator - only for security groups
+
+To add members to a role-assignable group, the app must also be assigned the *RoleManagement.ReadWrite.Directory* permission and the calling user must be assigned a supported Microsoft Entra role. *Privileged Role Administrator* is the least privileged role that is supported for this operation.
## HTTP request
POST /groups/{group-id}/members/$ref
## Request body
-In the request body, supply a JSON representation of a [directoryObject](../resources/directoryobject.md), [user](../resources/user.md) or [group](../resources/group.md) object to be added.
+In the request body, supply a JSON representation of a [directoryObject](../resources/directoryobject.md), [user](../resources/user.md), or [group](../resources/group.md) object to be added.
## Response
v1.0 Group Post Owners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-owners.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "group_post_owners" } --> [!INCLUDE [permissions-table](../includes/permissions/group-post-owners-permissions.md)]
-The signed-in user must also be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
-
-| Microsoft Entra role | Limitations |
-|-||
-| User Administrator | Can modify user owners only |
-| Directory Writers | Can modify user owners only |
-| Groups Administrator | Can modify all types of group owners |
-| Exchange Service Administrator | Can modify owners of Microsoft 365 groups only |
-| SharePoint Service Administrator | Can modify owners of Microsoft 365 groups only |
-| Teams Administrator | Can modify owners of Microsoft 365 groups only |
-| Yammer Administrator | Can modify owners of Microsoft 365 groups only |
-| Intune Administrator | Can modify owners of security groups only |
-| Knowledge Administrator | Can modify owners of security groups only |
-| Knowledge Manager | Can modify owners of security groups only |
-| Windows 365 Administrator | Can modify owners of security groups only |
+In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the required role permission. The following least privileged roles are supported for this operation:
+
+| Microsoft Entra role | Limitations | Key role permission |
+|--|--|--|
+| Group owners | Can modify all types of group owners | microsoft.directory/groups/owners/update |
+| User Administrator | Can modify user owners only | microsoft.directory/groups/owners/update |
+| Directory Writers | Can modify user owners only | microsoft.directory/groups/owners/update |
+| Groups Administrator | Can modify all types of group owners | microsoft.directory/groups/owners/update |
+| Exchange Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| SharePoint Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| Teams Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| Yammer Administrator | Can modify owners of Microsoft 365 groups only | microsoft.directory/groups.unified/owners/update |
+| Intune Administrator | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
+| Knowledge Administrator | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
+| Knowledge Manager | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
+| Windows 365 Administrator | Can modify owners of security groups only | microsoft.directory/groups.security/owners/update |
## HTTP request
v1.0 Group Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-update.md
The following table specifies the properties that can be updated.
| description | String | An optional description for the group. | | displayName | String | The display name for the group. This property is required when a group is created and it cannot be cleared during updates. | | 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`. |
-| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. To update this property, the calling user must be assigned one of the following Microsoft Entra roles: <br><ul><li> Global Administrator <li> User Account Administrator <li> Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul> <br/>For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). |
+| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. To update this property, the calling user must be assigned at least one of the following Microsoft Entra roles: <br><ul><li> User Account Administrator <li> Directory Writer <li> Exchange Administrator <li> SharePoint Administrator </ul> <br/>For more information about this property, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction). |
| securityEnabled | Boolean | Specifies whether the group is a security group, including Microsoft 365 groups. |
+| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Can updated only if `null` and is immutable once set. |
| visibility | String | Specifies the visibility of a Microsoft 365 group. Possible values are: **Private**, **Public**, or empty (which is interpreted as **Public**). | | writebackConfiguration | [groupWritebackConfiguration](../resources/groupwritebackconfiguration.md) | Specifies whether or not a group is configured to write back group object properties to on-premise Active Directory. These properties are used when group writeback is configured in the [Microsoft Entra Connect](/azure/active-directory/hybrid/how-to-connect-group-writeback-v2) sync client.|
v1.0 Group Upsert https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-upsert.md
You can create or update the following types of group:
- Microsoft 365 group (unified group) - Security group
- By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see thethe [Properties](../resources/group.md#properties) section of the [group](../resources/group.md) resource. To get properties that are _not_ returned by default, do a [GET operation](group-get.md) and specify the properties in a `$select` OData query option.
+ By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the [Properties](../resources/group.md#properties) section of the [group](../resources/group.md) resource. To get properties that are _not_ returned by default, do a [GET operation](group-get.md) and specify the properties in a `$select` OData query option.
-**Note**: To create a [team](../resources/team.md), first create a group then add a team to it, see [create team](../api/team-put-teams.md).
+> **Note**: To create a [team](../resources/team.md), first create a group, and then add a team to it. For more information, see [Create team](../api/team-put-teams.md).
## Permissions
The following table lists the properties that are required when you create the [
| Property | Type | Description | | :-- | : | :-- |
-| 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 Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. |
+| 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 Entra admin center or the Azure portal always have **securityEnabled** initially set to `true`. |
> [!IMPORTANT]
->
> - Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group.
->
> - Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken.
->
-> - To following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**.
+> - The following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**.
Because the **group** resource supports [extensions](/graph/extensibility-overview), you can add custom properties with your own data to the group while creating it.
Content-type: application/json
### Example 2: Create a security group with an owner and members if it doesn't exist
-The following example creates a security group with an owner and members specified because a group with the specified **uniqueName** value does not exist. Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. You can subsequently add multiple additional members by using [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching.
+The following example creates a security group with an owner and members specified because a group with the specified **uniqueName** value does not exist. Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. You can subsequently add multiple additional members by using the [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching.
#### Request
The following example shows the response. The value of the **preferredDataLocati
HTTP/1.1 204 No Content ```
-## See also
+## Related content
- [Add custom data to resources using extensions](/graph/extensibility-overview) - [Add custom data to users using open extensions (preview)](/graph/extensibility-open-users)
v1.0 Horizontalsection Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-delete.md
DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/ho
## Request body
-Do not supply a request body with this method.
+Don't supply a request body with this method.
## Response
If the target horizontal section is not found, this method returns `404 Not Foun
<!-- { "blockType": "ignored" } --> ``` http
-DELETE https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}
+DELETE https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1
```
-ve
### Response <!-- { "blockType": "response" } -->
v1.0 Horizontalsection Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-get.md
The following example shows a request.
<!-- { "blockType": "ignored" } --> ``` http
-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}
+GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1
``` #### Response
Content-Type: application/json
### Example 2: Get a horizontalSection object using select and expand #### Request
-With `select` and `expand` statements, you can retrieve horizontalSection metadata and column information in a single request.
+With `$select` and `$expand` statements, you can retrieve horizontalSection metadata and column information in a single request.
<!-- { "blockType": "ignored" } --> ``` http
-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}?select=id,expand=columns
+GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1?$select=id&$expand=columns
``` #### Response
v1.0 Horizontalsection List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-list.md
The following example shows a request.
<!-- { "blockType": "ignored" } --> ``` http
-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections
+GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections
``` ### Response
v1.0 Horizontalsection Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsection-update.md
The following example shows a request.
<!-- { "blockType": "ignored" } --> ``` http
-PATCH https://graph.microsoft.com/beta/sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}
+PATCH https://graph.microsoft.com/beta/sites/a69edae4-9208-4f60-9aa3-cd0911ff0ce1/pages/7f7a2740-2d74-47ba-af0c-71ed3a3384ca/microsoft.graph.sitePage/canvasLayout/horizontalSections/1
Content-Type: application/json
v1.0 Horizontalsectioncolumn Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/horizontalsectioncolumn-get.md
The following example shows a request.
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}
+GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1
``` #### Response
Content-Type: application/json
### Example 2: Get a horizontalSectionColumn using select and expand #### Request
-With `select` and `expand` statements, you can retrieve horizontalSectionColumn metadata and associated webParts in a single request.
+With `$select` and `$expand` statements, you can retrieve horizontalSectionColumn metadata and associated webParts in a single request.
<!-- { "blockType": "ignored" } --> ```http
-GET https://graph.microsoft.com/beta/sites/{sitesId}/pages/{sitePageId}/microsoft.graph.sitePage/canvasLayout/horizontalSections/{horizontalSectionId}/columns/{horizontalSectionColumnId}?select=id,expand=webparts
+GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pages/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.sitePage/canvasLayout/horizontalSections/1/columns/1?$select=id&$expand=webparts
``` #### Response
v1.0 Identityapiconnector Create https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-create.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityapiconnector_create" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-create-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identityapiconnector Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityapiconnector_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-delete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identityapiconnector Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityapiconnector_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-get-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identityapiconnector List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-list.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityapiconnector_list" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-list-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identityapiconnector Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityapiconnector_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identityapiconnector Uploadclientcertificate https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityapiconnector-uploadclientcertificate.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityapiconnector_uploadclientcertificate" } --> [!INCLUDE [permissions-table](../includes/permissions/identityapiconnector-uploadclientcertificate-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identitycontainer List B2cuserflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-b2cuserflows.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identitycontainer_list_b2cuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-b2cuserflows-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identitycontainer List B2xuserflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-b2xuserflows.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identitycontainer_list_b2xuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-b2xuserflows-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identitycontainer List Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identitycontainer_list_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
-* External ID user flow administrator
## HTTP request
v1.0 Identitycontainer Post Authenticationeventlisteners https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventlisteners.md
Create a new [authenticationEventListener](../resources/authenticationeventliste
- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) - [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)
+> [!NOTE]
+>
+> You can have a maximum of 250 event listeners.
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
v1.0 Identitycontainer Post Authenticationeventsflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventsflows.md
If successful, this method returns a `201 Created` response code and a JSON repr
## Examples
-<a name='example-1-create-a-basic-external-identities-sign-up-and-sign-in-user-flow-on-an-azure-ad-customer-tenant'></a>
-
-### Example 1: Create a basic External Identities sign-up and sign-in user flow on a Microsoft Entra customer tenant
+### Example 1: Create a basic External Identities sign-up and sign-in user flow in an external tenant
#### Request The following example shows a request. In this example, you create a user flow named "Woodgrove User Flow" with the following configuration.
Content-Type: application/json
} ```
-<a name='example-2-create-a-basic-external-identities-sign-up-and-sign-in-user-flow-with-an-attached-application-on-an-azure-ad-customer-tenant'></a>
-
-### Example 2: Create a basic external identities sign-up and sign-in user flow with an attached application on a Microsoft Entra customer tenant
+### Example 2: Create a basic external identities sign-up and sign-in user flow with an attached application in an external tenant
#### Request The following example shows a request. In this example, you create a user flow named "Woodgrove User Flow" with the following configuration.
v1.0 Identitycontainer Post B2cuserflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-b2cuserflows.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identitycontainer_post_b2cuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-b2cuserflows-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identitycontainer Post B2xuserflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-b2xuserflows.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identitycontainer_post_b2xuserflows" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-b2xuserflows-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity User Flow administrator
## HTTP request
v1.0 Identitycontainer Post Customauthenticationextensions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-customauthenticationextensions.md
Create a new [customAuthenticationExtension](../resources/customauthenticationex
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type. - [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
+> [!NOTE]
+>
+> You can have a maximum of 100 custom extension policies.
+ [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions
v1.0 Identitycontainer Post Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identitycontainer_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identitygovernance Insights Toptasksprocessedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-toptasksprocessedsummary.md
+
+ Title: "insights: topTasksProcessedSummary"
+description: "Get a summary of the most processed tasks by Lifecycle Workflows in a tenant."
+
+ms.localizationpriority: medium
+++
+# insights: topTasksProcessedSummary
+
+Namespace: microsoft.graph.identityGovernance
++
+Provide a summary of the most processed tasks, known as top tasks, for a specified time period in a tenant. The task definition is provided, along with numerical counts of total, successful, and failed runs. For information about workflows processed, see [insights: topWorkflowsProcessedSummary](identitygovernance-insights-topworkflowsprocessedsummary.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "identitygovernance-insights-toptasksprocessedsummary-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary
+```
+
+## Function parameters
+
+In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function.
+
+|Parameter|Type|Description|
+|:|:|:|
+|startDateTime|DateTimeOffset|The start date, and time, of the insight summary for most tasks processed in a tenant.|
+|endDateTime|DateTimeOffset|The end date, and time, of the insight summary for most tasks processed in a tenant.|
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [microsoft.graph.identityGovernance.topTasksInsightsSummary](../resources/identitygovernance-toptasksinsightssummary.md) collection in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "insightsthis.toptasksprocessedsummary"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z)
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.identityGovernance.topTasksInsightsSummary)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.identityGovernance.topTasksInsightsSummary)",
+"value": [
+ {
+ "taskDefinitionId" : "gbc28c8e-f522-43b1-9d30-ee62b4ee941c",
+ "taskDefinitionDisplayName" : "Disable User Account",
+ "totalTasks" : 32,
+ "successfulTasks" : 15,
+ "failedTasks" : 17,
+ "totalUsers" : 46 ,
+ "successfulUsers" : 25 ,
+ "failedUsers" : 21
+ },
+ {
+ "taskDefinitionId" : "afg23h8e-a522-53b1-5d30-ft62b4ee941d",
+ "taskDefinitionDisplayName" : "Add user to groups",
+ "totalProcessedTasks" : 30,
+ "successfulTasks" : 14,
+ "failedTasks" : 16,
+ "totalUsers" : 36 ,
+ "successfulUsers" : 25 ,
+ "failedUsers" : 11
+ },
+ {
+ "taskDefinitionId" : "mcd28c8e-t523-83b1-3d70-jl62b4hh944g",
+ "taskDefinitionDisplayName" : "Send onboarding reminder email",
+ "totalProcessedTasks" : 28,
+ "successfulTasks" : 13,
+ "failedTasks" : 15,
+ "totalUsers" : 37 ,
+ "successfulUsers" : 23 ,
+ "failedUsers" : 14
+ },
+ {
+ "taskDefinitionId" : "beg28c8e-h23-53b1-8f60-kv62b4ee941c",
+ "taskDefinitionDisplayName" : "Generate TAP and Send Email",
+ "totalProcessedTasks" : 30,
+ "successfulTasks" : 18,
+ "failedTasks" : 12,
+ "totalUsers" : 35 ,
+ "successfulUsers" : 24 ,
+ "failedUsers" : 11
+ },
+ {
+ "taskDefinitionId" : "efc28c8e-j322-73b1-9e30-fh62b4ee941d",
+ "taskDefinitionDisplayName" : "Run a custom task extension",
+ "totalProcessedTasks" : 25,
+ "successfulTasks" : 15,
+ "failedTasks" : 10,
+ "totalUsers" : 26 ,
+ "successfulUsers" : 17 ,
+ "failedUsers" : 9
+ },
+ {
+ "taskDefinitionId" : "nmd28c8e-k822-53b1-3d30-ee62b4ee941e",
+ "taskDefinitionDisplayName" : "Request user access package assignment",
+ "totalProcessedTasks" : 26,
+ "successfulTasks" : 18,
+ "failedTasks" : 8,
+ "totalUsers" : 32,
+ "successfulUsers" : 24 ,
+ "failedUsers" : 8
+ },
+ {
+ "taskDefinitionId" : "qbc28c8e-f522-43b1-9d30-ee62b4ee941c",
+ "taskDefinitionDisplayName" : "Send Welcome Email",
+ "totalProcessedTasks" : 25,
+ "successfulTasks" : 20,
+ "failedTasks" : 5,
+ "totalUsers" : 28 ,
+ "successfulUsers" : 22 ,
+ "failedUsers" : 6
+ },
+ ]
+}
+```
v1.0 Identitygovernance Insights Topworkflowsprocessedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-topworkflowsprocessedsummary.md
+
+ Title: "insights: topWorkflowsProcessedSummary"
+description: "Get a summary of the most processed workflows by Lifecycle Workflows in a tenant."
+
+ms.localizationpriority: medium
+++
+# insights: topWorkflowsProcessedSummary
+
+Namespace: microsoft.graph.identityGovernance
++
+Provide a summary of the workflows processed the most, known as top workflows, for a specified period in a tenant. Workflow basic details are given, along with run information. For information about tasks processed, see [insights: topTasksProcessedSummary](identitygovernance-insights-toptasksprocessedsummary.md).
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "identitygovernance-insights-topworkflowsprocessedsummary-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary
+```
+
+## Function parameters
+
+In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function.
+
+|Parameter|Type|Description|
+|:|:|:|
+|startDateTime|DateTimeOffset|The start date, and time, of the summary of the most workflows processed in a tenant.|
+|endDateTime|DateTimeOffset|The end date, and time, of the summary of the most workflows processed in a tenant.|
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [microsoft.graph.identityGovernance.topWorkflowsInsightsSummary](../resources/identitygovernance-topworkflowsinsightssummary.md) collection in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "insightsthis.topworkflowsprocessedsummary"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z)
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.identityGovernance.topWorkflowsInsightsSummary)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.identityGovernance.topWorkflowsInsightsSummary)",
+ "value": [
+ {
+ "workflowId" : "6a98cceb-503b-709c-996c-3cg0f24481eb",
+ "workflowDisplayName" : "Pre-hire workflow",
+ "workflowCategory" : "Joiner",
+ "totalRuns" : 30 ,
+ "successfulRuns" : 28 ,
+ "failedRuns" : 2 ,
+ "scheduledRuns" : 26,
+ "onDemandRuns" : 4,
+ "totalUsers" : 45,
+ "successfulUsers" : 38,
+ "failedUsers": 7,
+ "workflowVersion" : 3
+ },
+ {
+ "workflowId" : "8b67ddeb-603b-609c-293f-4dg0f28481ek",
+ "workflowDisplayName" : "Pre-Hire workflow",
+ "workflowCategory" : "Joiner",
+ "totalRuns" : 35 ,
+ "successfulRuns" : 26 ,
+ "failedUsers" : 9,
+ "scheduledRuns" : 30,
+ "onDemandRuns" : 5,
+ "totalUsers" : 56,
+ "successfulUsers" : 47 ,
+ "failedUsers": 9,
+ "workflowVersion" : 1
+ },
+ {
+ "workflowId" : "1f67cceb-203b-909c-096f-6cg0f28481fg",
+ "workflowDisplayName" : "Post-Hire Workflow",
+ "workflowCategory" : "Jeaver",
+ "totalRuns" : 32 ,
+ "successfulRuns" : 25 ,
+ "failedRuns" : 7 ,
+ "scheduldedRuns" : 15,
+ "onDemandRuns" : 17,
+ "totalUsers": 53,
+ "successfulUsers" : 45,
+ "failedUsers" : 8,
+ "workflowVersion" : 2
+ },
+ {
+ "workflowId" : "2s67ddeb-303b-709c-896f-4cg0f28481ed",
+ "workflowDisplayName" : "Pre-Hire Workflow",
+ "workflowCategory" :"Joiner" ,
+ "totalRuns" : 28 ,
+ "successfulRuns" : 23,
+ "failedRuns" : 5,
+ "scheduldedRuns" : 20,
+ "onDemandRuns" : 8,
+ "totalUsers" : 40,
+ "successfulUsers" : 32 ,
+ "failedUsers" : 8,
+ "workflowVersion" : 2
+ },
+ {
+ "workflowId" : "7a67ddeb-503b-909d-995f-3cg0f26481eh",
+ "workflowDisplayName" : "Post-Hire Workflow",
+ "workflowCategory" : "Leaver",
+ "totalRuns" : 26 ,
+ "successfulRuns" : 20 ,
+ "failedRuns" : 6 ,
+ "scheduldedRuns" : 12,
+ "onDemandRuns" : 14,
+ "totalUsers" : 34,
+ "successfulUsers" : 23,
+ "failedUsers" : 11,
+ "workflowVersion" : 1
+ },
+ ]
+}
+```
v1.0 Identitygovernance Insights Workflowsprocessedbycategory https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-workflowsprocessedbycategory.md
+
+ Title: "insights: workflowsProcessedByCategory"
+description: "Provide a summary of workflows processed in a tenant by the workflow category."
+
+ms.localizationpriority: medium
+++
+# insights: workflowsProcessedByCategory
+
+Namespace: microsoft.graph.identityGovernance
++
+Provide a summary of workflows processed, by category, in a tenant. This allows you to quickly get category information, by numerical value, bypassing other information found in the [WorkflowsProcessedSummary](identitygovernance-insights-workflowsprocessedsummary.md) call.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "identitygovernance-insights-workflowsprocessedbycategory-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory
+```
+
+## Function parameters
+
+In the request URL, provide the following query parameters with values.
+The following table lists the parameters that are required when you call this function.
+
+|Parameter|Type|Description|
+|:|:|:|
+|startDateTime|DateTimeOffset|The start date, and time, of the insight summary for workflows processed by category in a tenant.|
+|endDateTime|DateTimeOffset|The end date, and time, of the insight summary for workflows processed by category in a tenant.|
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [workflowsInsightsByCategory](../resources/identitygovernance-workflowsinsightsbycategory.md) in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "insightsthis.workflowsprocessedbycategory"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z)
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
++++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.identityGovernance.workflowsInsightsByCategory"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "totalJoinerRuns" : 136,
+ "successfulJoinerRuns" : 112,
+ "failedJoinerRuns" : 24,
+ "totalMoverRuns" : 97,
+ "successfulMoverRuns" : 79,
+ "failedMoverRuns" : 18,
+ "totalLeaverRuns" : 103,
+ "successfulLeaverRuns" : 96,
+ "failedLeaverRuns" : 7,
+}
+```
v1.0 Identitygovernance Insights Workflowsprocessedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-workflowsprocessedsummary.md
+
+ Title: "insights: workflowsProcessedSummary"
+description: "Get the summary of workflows processed by Lifecycle Workflows within a tenant."
+
+ms.localizationpriority: medium
+++
+# insights: workflowsProcessedSummary
+
+Namespace: microsoft.graph.identityGovernance
++
+Provide a summary of all workflows processed within a tenant for a specified period. Because the amount of results for listed workflows as returned by the [List workflows](../api/identitygovernance-lifecycleworkflowscontainer-list-workflows.md) does not tell you which workflows were processed from the list of created workflows, this summary gives you a quick overview of processed status based on counts.
+
+## Permissions
+
+Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
+
+<!-- {
+ "blockType": "permissions",
+ "name": "identitygovernance-insights-workflowsprocessedsummary-permissions"
+}
+-->
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary
+```
+
+## Function parameters
+
+In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function.
+
+|Parameter|Type|Description|
+|:|:|:|
+|startDateTime|DateTimeOffset|The start date, and time, of the summary report of workflows processed in a tenant.|
+|endDateTime|DateTimeOffset|The end date, time, of the summary report of workflows processed in a tenant.|
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
+
+## Request body
+
+Don't supply a request body for this method.
+
+## Response
+
+If successful, this function returns a `200 OK` response code and a [workflowsInsightsSummary](../resources/identitygovernance-workflowsinsightssummary.md) in the response body.
+
+## Examples
+
+### Request
+
+The following example shows a request.
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "insightsthis.workflowsprocessedsummary"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z)
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [Python](#tab/python)
+++
+### Response
+
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.identityGovernance.workflowsInsightsSummary"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context":"https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.workflowsInsightsSummary",
+ "totalRuns" : 106,
+ "successfulRuns" : 71,
+ "failedRuns": 35,
+ "totalUsers" : 150,
+ "successfulUsers" : 112,
+ "failedUsers" : 38 ,
+ "totalTasks" : 75,
+ "successfulTasks" : 56,
+ "failedTasks" :19 ,
+}
+```
v1.0 Identitygovernance Lifecycleworkflowscontainer List Taskdefinitions https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md
Content-Type: application/json
{ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",
- "@odata.count": 16,
+ "@odata.count": 25,
"value": [ {
- "category": "joiner,leaver",
+ "category": "joiner,leaver,mover",
"description": "Add user to selected groups",
- "displayName": "Add User To Groups",
+ "displayName": "Add user to groups",
"id": "22085229-5809-45e8-97fd-270d28d66910", "version": 1, "parameters": [
Content-Type: application/json
{ "category": "joiner,leaver", "description": "Disable user account in the directory",
- "displayName": "Disable User Account",
+ "displayName": "Disable user account",
"id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950", "version": 1,
- "parameters": []
+ "parameters": [
+ {
+ "name": "disableOnPremisesAccount",
+ "values": [
+ "true",
+ "false"
+ ],
+ "valueType": "enum"
+ }
+ ]
}, { "category": "joiner,leaver", "description": "Enable user account in the directory",
- "displayName": "Enable User Account",
+ "displayName": "Enable user account",
"id": "6fc52c9d-398b-4305-9763-15f42c1676fc", "version": 1,
- "parameters": []
+ "parameters": [
+ {
+ "name": "enableOnPremisesAccount",
+ "values": [
+ "true",
+ "false"
+ ],
+ "valueType": "enum"
+ }
+ ]
}, {
- "category": "joiner,leaver",
+ "category": "joiner,leaver,mover",
"description": "Remove user from membership of selected Azure AD groups", "displayName": "Remove user from selected groups", "id": "1953a66c-751c-45e5-8bfe-01462c70da3c",
Content-Type: application/json
{ "category": "joiner", "description": "Generate Temporary Access Pass and send via email to user's manager",
- "displayName": "Generate TAP And Send Email",
+ "displayName": "Generate TAP and send email",
"id": "1b555e50-7f65-41d5-b514-5894a026d10d", "version": 1, "parameters": [
Content-Type: application/json
"false" ], "valueType": "enum"
+ },
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
} ] }, { "category": "joiner", "description": "Send welcome email to new hire",
- "displayName": "Send Welcome Email",
+ "displayName": "Send welcome email",
"id": "70b29d51-b59a-4773-9280-8841dfd3f2ea", "version": 1,
- "parameters": []
+ "parameters": [
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
}, {
- "category": "joiner,leaver",
- "description": "Add user to selected teams",
- "displayName": "Add User To Teams",
+ "category": "joiner,leaver,mover",
+ "description": "Add user to selected Teams",
+ "displayName": "Add user to Teams",
"id": "e440ed8d-25a1-4618-84ce-091ed5be5594", "version": 1, "parameters": [
Content-Type: application/json
{ "category": "leaver", "description": "Delete user account in Azure AD",
- "displayName": "Delete User Account",
+ "displayName": "Delete user account",
"id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff", "version": 1,
- "parameters": []
+ "parameters": [
+ {
+ "name": "deleteOnPremisesAccount",
+ "values": [
+ "true",
+ "false"
+ ],
+ "valueType": "enum"
+ }
+ ]
}, {
- "category": "joiner,leaver",
+ "category": "joiner,leaver,mover",
"description": "Remove user from membership of selected Teams", "displayName": "Remove user from selected Teams", "id": "06aa7acb-01af-4824-8899-b14e5ed788d6",
Content-Type: application/json
"parameters": [] }, {
- "category": "joiner,leaver",
+ "category": "joiner,leaver,mover",
"description": "Run a Custom Task Extension to callout to an external system.", "displayName": "Run a Custom Task Extension", "id": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
Content-Type: application/json
"displayName": "Send email before userΓÇÖs last day", "id": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935", "version": 1,
- "parameters": []
+ "parameters": [
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
}, { "category": "leaver",
Content-Type: application/json
"displayName": "Send email on userΓÇÖs last day", "id": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411", "version": 1,
- "parameters": []
+ "parameters": [
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
}, { "category": "leaver",
Content-Type: application/json
"displayName": "Send email after userΓÇÖs last day", "id": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce", "version": 1,
+ "parameters": [
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "joiner",
+ "description": "Send onboarding reminder email to userΓÇÖs manager",
+ "displayName": "Send onboarding reminder email",
+ "id": "3C860712-2D37-42A4-928F-5C93935D26A1",
+ "version": 1,
+ "parameters": [
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "joiner,mover",
+ "description": "Request user assignment to selected access package",
+ "displayName": "Request user access package assignment",
+ "id": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be",
+ "version": 1,
+ "parameters": [
+ {
+ "name": "assignmentPolicyId",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "accessPackageId",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "leaver,mover",
+ "description": "Remove user assignment of selected access package",
+ "displayName": "Remove access package assignment for user",
+ "id": "4a0b64f2-c7ec-46ba-b117-18f262946c50",
+ "version": 1,
+ "parameters": [
+ {
+ "name": "accessPackageId",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "leaver",
+ "description": "Remove all access packages assigned to the user",
+ "displayName": "Remove all access package assignments for user",
+ "id": "42ae2956-193d-4f39-be06-691b8ac4fa1d",
+ "version": 1,
+ "parameters": []
+ },
+ {
+ "category": "leaver",
+ "description": "Cancel all pending access packages assignment requests for the user",
+ "displayName": "Cancel pending access package assignment requests for user",
+ "id": "498770d9-bab7-4e4c-b73d-5ded82a1d0b3",
+ "version": 1,
+ "parameters": []
+ },
+ {
+ "category": "mover",
+ "description": "Send email to notify userΓÇÖs manager of user move",
+ "displayName": "Send email to notify manager of user move",
+ "id": "aab41899-9972-422a-9d97-f626014578b7",
+ "version": 1,
+ "parameters": [
+ {
+ "name": "cc",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customSubject",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "customBody",
+ "values": [],
+ "valueType": "string"
+ },
+ {
+ "name": "locale",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "joiner,mover",
+ "description": "Assign selected licenses to the user",
+ "displayName": "Assign licenses to user",
+ "id": "683c87a4-2ad4-420b-97d4-220d90afcd24",
+ "version": 1,
+ "parameters": [
+ {
+ "name": "licenses",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "leaver,mover",
+ "description": "Remove selected licenses assigned to the user",
+ "displayName": "Remove licenses from user",
+ "id": "5fc402a8-daaf-4b7b-9203-da868b05fc5f",
+ "version": 1,
+ "parameters": [
+ {
+ "name": "licenses",
+ "values": [],
+ "valueType": "string"
+ }
+ ]
+ },
+ {
+ "category": "leaver,mover",
+ "description": "Transfer groups the user owned to the user's manager",
+ "displayName": "Transfer group ownership to manager",
+ "id": "dde2a64c-8420-447b-9075-7309449de5cd",
+ "version": 1,
"parameters": [] } ]
v1.0 Identitygovernance Lifecycleworkflowscontainer List Workflowtemplates https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-workflowtemplates.md
Content-Type: application/json
{ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates",
+ "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identityGovernance/lifecycleWorkflows/workflowTemplates?$select=category,description",
"value": [ { "category": "joiner",
Content-Type: application/json
"category": "joiner", "continueOnError": false, "description": "Generate Temporary Access Pass and send via email to user's manager",
- "displayName": "Generate TAP And Send Email",
+ "displayName": "Generate TAP And send email",
"executionSequence": 1, "id": "3e062c24-d219-483d-9258-288f2a039b94", "isEnabled": true,
Content-Type: application/json
"category": "joiner,leaver", "continueOnError": false, "description": "Enable user account in the directory",
- "displayName": "Enable User Account",
+ "displayName": "Enable user account",
"executionSequence": 1, "id": "e18f3208-311c-46a3-a27b-d9c15cd595bc", "isEnabled": true,
Content-Type: application/json
"category": "joiner", "continueOnError": false, "description": "Send welcome email to new hire",
- "displayName": "Send Welcome Email",
+ "displayName": "Send welcome email",
"executionSequence": 2, "id": "e9551045-4302-499f-9108-60b9e23c067a", "isEnabled": true,
Content-Type: application/json
"category": "joiner,leaver", "continueOnError": false, "description": "Add user to selected groups",
- "displayName": "Add User To Groups",
+ "displayName": "Add user to groups",
"executionSequence": 3, "id": "560acd0c-321e-4e7e-9f31-ff8899c55878", "isEnabled": true,
Content-Type: application/json
} ] },
+ {
+ "category": "joiner",
+ "description": "Configure onboarding tasks for an employee after their first day of work.",
+ "displayName": "Post-Onboarding of an employee",
+ "id": "dce038a6-482a-46a2-9ee0-675c5e8477b9",
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
+ "rule": "department eq 'Marketing'"
+ },
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
+ "timeBasedAttribute": "employeeHireDate",
+ "offsetInDays": 7
+ }
+ },
+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('dce038a6-482a-46a2-9ee0-675c5e8477b9')/tasks",
+ "tasks": [
+ {
+ "category": "joiner,leaver",
+ "continueOnError": false,
+ "description": "Add user to selected groups",
+ "displayName": "Add user to groups",
+ "executionSequence": 1,
+ "id": "33350498-4404-487f-94ae-db312e436eda",
+ "isEnabled": true,
+ "taskDefinitionId": "22085229-5809-45e8-97fd-270d28d66910",
+ "arguments": [
+ {
+ "name": "groupID",
+ "value": ""
+ }
+ ]
+ },
+ {
+ "category": "joiner,leaver",
+ "continueOnError": false,
+ "description": "Add user to selected Teams",
+ "displayName": "Add user To Teams",
+ "executionSequence": 2,
+ "id": "6f7925a5-633d-4cd9-9c4b-8f4b2f040e2b",
+ "isEnabled": true,
+ "taskDefinitionId": "e440ed8d-25a1-4618-84ce-091ed5be5594",
+ "arguments": [
+ {
+ "name": "teamID",
+ "value": ""
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "mover",
+ "description": "Execute real-time tasks for employee job changes",
+ "displayName": "Real-time employee job change",
+ "id": "77a82a99-9dfb-471d-a396-107954328b7f",
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.onDemandExecutionOnly"
+ },
+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('77a82a99-9dfb-471d-a396-107954328b7f')/tasks",
+ "tasks": [
+ {
+ "category": "joiner,leaver,mover",
+ "continueOnError": false,
+ "description": "Run a Custom Task Extension to callout to an external system.",
+ "displayName": "Run a Custom Task Extension",
+ "executionSequence": 1,
+ "id": "f187bcde-830a-4f4b-bed0-e2347b418c01",
+ "isEnabled": true,
+ "taskDefinitionId": "4262b724-8dba-4fad-afc3-43fcbb497a0e",
+ "arguments": [
+ {
+ "name": "customTaskExtensionID",
+ "value": ""
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "category": "mover",
+ "description": "Configure mover tasks for employees once their group membership changes",
+ "displayName": "Employee group membership changes",
+ "id": "56da3093-d105-40d4-9886-fccd074f2f2a",
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet",
+ "groups": [
+ {
+ "id": "groupID"
+ }
+ ]
+ },
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger",
+ "changeType": "add"
+ }
+ },
+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('56da3093-d105-40d4-9886-fccd074f2f2a')/tasks",
+ "tasks": [
+ {
+ "category": "leaver,mover",
+ "continueOnError": false,
+ "description": "Remove user assignment of selected access package",
+ "displayName": "Remove access package assignment for user",
+ "executionSequence": 1,
+ "id": "db0500d1-c988-4114-a005-f227649aedfd",
+ "isEnabled": true,
+ "taskDefinitionId": "4a0b64f2-c7ec-46ba-b117-18f262946c50",
+ "arguments": [
+ {
+ "name": "accessPackageId",
+ "value": ""
+ }
+ ]
+ },
+ {
+ "category": "joiner,leaver,mover",
+ "continueOnError": false,
+ "description": "Remove user from membership of selected Teams",
+ "displayName": "Remove user from selected Teams",
+ "executionSequence": 2,
+ "id": "b1049615-0be5-43dc-a919-1f5bf6db967b",
+ "isEnabled": true,
+ "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6",
+ "arguments": [
+ {
+ "name": "teamID",
+ "value": ""
+ }
+ ]
+ },
+ {
+ "category": "mover",
+ "continueOnError": false,
+ "description": "Send email to notify userΓÇÖs manager of user move",
+ "displayName": "Send email to notify manager of user move",
+ "executionSequence": 3,
+ "id": "96c00437-3a06-4710-bd0b-ab57773a9189",
+ "isEnabled": true,
+ "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7",
+ "arguments": []
+ }
+ ]
+ },
+ {
+ "category": "mover",
+ "description": "Configure mover tasks for employees once their job profile changes",
+ "displayName": "Employee job profile change",
+ "id": "16819b2d-74e9-4fb9-9ba7-48b8a26ab11d",
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
+ "rule": "department eq 'Marketing'"
+ },
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger",
+ "triggerAttributes": [
+ {
+ "name": "department"
+ }
+ ]
+ }
+ },
+ "tasks@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflowTemplates('16819b2d-74e9-4fb9-9ba7-48b8a26ab11d')/tasks",
+ "tasks": [
+ {
+ "category": "mover",
+ "continueOnError": false,
+ "description": "Send email to notify userΓÇÖs manager of user move",
+ "displayName": "Send email to notify manager of user move",
+ "executionSequence": 1,
+ "id": "96c00437-3a06-4710-bd0b-ab57773a9189",
+ "isEnabled": true,
+ "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7",
+ "arguments": []
+ },
+ {
+ "category": "joiner,leaver,mover",
+ "continueOnError": false,
+ "description": "Remove user from membership of selected Azure AD groups",
+ "displayName": "Remove user from selected groups",
+ "executionSequence": 2,
+ "id": "e9e641d3-e457-433c-9d6c-78a4f2505aef",
+ "isEnabled": true,
+ "taskDefinitionId": "1953a66c-751c-45e5-8bfe-01462c70da3c",
+ "arguments": [
+ {
+ "name": "groupID",
+ "value": ""
+ }
+ ]
+ },
+ {
+ "category": "joiner,leaver,mover",
+ "continueOnError": false,
+ "description": "Remove user from membership of selected Teams",
+ "displayName": "Remove user from selected Teams",
+ "executionSequence": 3,
+ "id": "b1049615-0be5-43dc-a919-1f5bf6db967b",
+ "isEnabled": true,
+ "taskDefinitionId": "06aa7acb-01af-4824-8899-b14e5ed788d6",
+ "arguments": [
+ {
+ "name": "teamID",
+ "value": ""
+ }
+ ]
+ },
+ {
+ "category": "joiner,mover",
+ "continueOnError": false,
+ "description": "Request user assignment to selected access package",
+ "displayName": "Request user access package assignment",
+ "executionSequence": 4,
+ "id": "8c2c653f-46a1-4042-9b4d-2c3d503a4fcc",
+ "isEnabled": true,
+ "taskDefinitionId": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be",
+ "arguments": [
+ {
+ "name": "assignmentPolicyId",
+ "value": ""
+ },
+ {
+ "name": "accessPackageId",
+ "value": ""
+ }
+ ]
+ }
+ ]
+ },
{ "category": "leaver", "description": "Execute real-time termination tasks for employees on their last day of work",
Content-Type: application/json
"category": "leaver", "continueOnError": false, "description": "Delete user account in Azure AD",
- "displayName": "Delete User Account",
+ "displayName": "Delete user account",
"executionSequence": 3, "id": "adbd4f05-99f0-4260-a155-7657623ca071", "isEnabled": true,
Content-Type: application/json
"category": "joiner,leaver", "continueOnError": false, "description": "Disable user account in the directory",
- "displayName": "Disable User Account",
+ "displayName": "Disable user account",
"executionSequence": 1, "id": "8d9eab35-6c32-4b76-acbd-6a22cb07aa6a", "isEnabled": true,
Content-Type: application/json
"category": "leaver", "continueOnError": false, "description": "Delete user account in Azure AD",
- "displayName": "Delete User Account",
+ "displayName": "Delete user account",
"executionSequence": 3, "id": "46849618-30e7-4b67-abf0-f8c7f0d54b95", "isEnabled": true,
Content-Type: application/json
The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request",
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workf
++ #### Response <!-- {
v1.0 Identitygovernance Lifecycleworkflowscontainer Post Workflows https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-post-workflows.md
Title: "Create workflow"
-description: "Create a new workflow object. You can create up to 50 workflows in a tenant."
+description: "Create a new workflow object. You can create up to 100 workflows in a tenant."
ms.localizationpriority: medium
Namespace: microsoft.graph.identityGovernance
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 50 workflows in a tenant.
+Create a new [workflow](../resources/identitygovernance-workflow.md) object. You can create up to 100 workflows in a tenant.
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
You can specify the following properties when creating a **workflow**.
|Property|Type|Description| |:|:|:|
-|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. Can be only one value. Required.|
+|category|[microsoft.graph.identityGovernance.lifecycleWorkflowCategory](../resources/identitygovernance-workflow.md)|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`. It can be only one value. Required.|
|description|String|A string that describes the purpose of the workflow for administrative use.| |displayName|String|A unique string that identifies the workflow. Required.|
-|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow will run. Required. |
+|executionConditions|[microsoft.graph.identityGovernance.workflowExecutionConditions](../resources/identitygovernance-workflowexecutionconditions.md)|Defines for who and when a workflow runs. Required. |
|id|String|Identifier used for individually addressing a specific workflow.| |isEnabled|Boolean|A Boolean value that denotes whether the workflow is set to run or not.| |isSchedulingEnabled|Boolean|A Boolean value that denotes whether scheduling is enabled or not. |
If successful, this method returns a `201 Created` response code and a [microsof
## Examples
-### Example 1: Create a new workflow
+### Example 1: Create a joiner workflow using the time based trigger
#### Request The following example shows a request that creates a workflow with the following configuration:
-+ It's a "joiner" workflow that's enabled and schedule to run.
-+ It runs for new users that are based in Australia, on their employeeHireDate.
++ It's a "joiner" workflow-enabled and scheduled to run.++ It runs for new users based in Australia, on their employeeHireDate using the time-based attribute trigger. + Two tasks are carried out when the workflow runs: the user's account is enabled and a "Welcome" email is sent to the user. # [HTTP](#tab/http)
Content-Type: application/json
} ```
-### Example 2: Create a new version of a task with customized email
+### Example 2: Create a mover workflow using the attribute changes trigger
#### Request
-The following example shows a request.
+The following example shows a request that creates a workflow with the following configuration:
++ It's a "mover" workflow-enabled and scheduled to run.++ It runs for existing users added to the "Sales" department using the attribute changes trigger.++ One task is carried out, which is to send an email to notify the user's manager of the move. # [HTTP](#tab/http) <!-- { "blockType": "request",
- "name": "lifecycleworkflows_create_workflow_from_customemail"
+ "name": "lifecycleworkflows_create_workflow_from_attribute"
} --> ``` http
Content-Type: application/json
Content-length: 631 {
- "category": "joiner",
- "description": "Configure new hire tasks for onboarding employees on their first day",
- "displayName": "custom email marketing API test",
+ "category": "mover",
+ "description": "Configure mover tasks for a user when their job profile changes",
+ "displayName": "Sales contractor moves to full-time employee",
"isEnabled": true,
- "isSchedulingEnabled": false,
+ "isSchedulingEnabled": true,
"executionConditions": { "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions", "scope": { "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
- "rule": "(department eq 'Marketing')"
+ "rule": "(department eq 'Sales')"
}, "trigger": {
- "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
- "timeBasedAttribute": "employeeHireDate",
- "offsetInDays": 0
+ "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger",
+ "triggerAttributes": [
+ {
+ "name": "department"
+ }
+ ]
} }, "tasks": [ { "continueOnError": false,
- "description": "Enable user account in the directory",
- "displayName": "Enable User Account",
+ "description": "Send email to moving employee's manager",
+ "displayName": "Notify manager of move",
"isEnabled": true,
- "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
+ "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7",
"arguments": []
+ }
+ ]
+}
+```
+
+# [C#](#tab/csharp)
+
+# [CLI](#tab/cli)
+
+# [Go](#tab/go)
+
+# [Java](#tab/java)
+
+# [JavaScript](#tab/javascript)
+
+# [PHP](#tab/php)
+
+# [PowerShell](#tab/powershell)
+
+# [Python](#tab/python)
+++
+#### Response
++
+The following example shows the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.identityGovernance.workflow"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "category": "mover",
+ "description": "Configure mover tasks for a user when their job profile changes",
+ "displayName": "Sales contractor moves to full time employee",
+ "isEnabled": true,
+ "isSchedulingEnabled": true,
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
+ "rule": "(department eq 'Sales')"
},
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger",
+ "triggerAttributes": [
+ {
+ "name": "department"
+ }
+ ]
+ }
+ },
+ "tasks": [
{ "continueOnError": false,
- "description": "Send welcome email to new hire",
- "displayName": "Send Welcome Email",
+ "description": "Send email to moving employee's manager",
+ "displayName": "Notify manager of move",
"isEnabled": true,
- "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
- "arguments": [
- {
- "name": "cc",
- "value": "1baa57fa-3c4e-4526-ba5a-db47a9df95f0"
- },
- {
- "name": "customSubject",
- "value": "Welcome to the organization {{userDisplayName}}!"
- },
- {
- "name": "customBody",
- "value": "Welcome to our organization {{userGivenName}}!"
- },
+ "taskDefinitionId": "aab41899-9972-422a-9d97-f626014578b7",
+ "arguments": []
+ }
+ ]
+}
+```
+
+### Example 3: Create a leaver workflow using the group based trigger
+
+#### Request
+
+The following example shows a request that creates a workflow with the following configuration:
++ It's a "leaver" workflow enabled and scheduled to run.++ It runs for users who are removed from the Sales group using the group-based trigger.++ Two tasks are carried out when the workflow runs: Remove user from all Teams, Remove user from all groups.+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "lifecycleworkflows_create_workflow_from_group"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows
+Content-Type: application/json
+
+{
+ "category": "leaver",
+ "description": "Configure offboarding tasks for employees on their last day of work",
+ "displayName": "Offboard an employee",
+ "isEnabled": true,
+ "isSchedulingEnabled": true,
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet",
+ "groups": [
{
- "name": "locale",
- "value": "en-us"
+ "id": "668e7540-7f8e-4ca4-a207-b7dffbb6d038"
} ]
+ },
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger",
+ "changeType": "remove"
+ }
+ },
+ "tasks": [
+ {
+ "category": "leaver",
+ "continueOnError": false,
+ "description": "Remove user from all Teams memberships",
+ "displayName": "Remove user from all Teams",
+ "isEnabled": true,
+ "taskDefinitionId": "81f7b200-2816-4b3b-8c5d-dc556f07b024",
+ "arguments": []
+ },
+ {
+ "category": "leaver",
+ "continueOnError": false,
+ "description": "Remove user from all Azure AD groups memberships",
+ "displayName": "Remove user from all groups",
+ "isEnabled": true,
+ "taskDefinitionId": "b3a31406-2a15-4c9a-b25b-a658fa5f07fc",
+ "arguments": []
} ] } ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] #### Response - The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- {
The following example shows the response.
} --> ``` http
-HTTP/1.1 200 OK
+HTTP/1.1 201 Created
Content-Type: application/json {
- "workflow":{
- "category": "joiner",
- "description": "Configure new hire tasks for onboarding employees on their first day",
- "displayName": "Global onboard new hire employee",
- "isEnabled": true,
- "isSchedulingEnabled": false,
- "executionConditions": {
- "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
- "scope": {
- "@odata.type": "#microsoft.graph.identityGovernance.ruleBasedSubjectSet",
- "rule": "(department eq 'Marketing')"
- },
- "trigger": {
- "@odata.type": "#microsoft.graph.identityGovernance.timeBasedAttributeTrigger",
- "timeBasedAttribute": "employeeHireDate",
- "offsetInDays": 1
- }
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows/$entity",
+ "category": "leaver",
+ "description": "Configure offboarding tasks for employees on their last day of work",
+ "displayName": "Offboard an employee",
+ "isEnabled": true,
+ "isSchedulingEnabled": true,
+ "lastModifiedDateTime": "2024-03-28T20:20:05.6599449Z",
+ "createdDateTime": "2024-03-28T20:20:05.6599142Z",
+ "deletedDateTime": null,
+ "id": "73ed8912-6a04-4f5d-bef8-61fcc94336a7",
+ "nextScheduleRunDateTime": "2024-03-28T20:37:08Z",
+ "version": 1,
+ "executionConditions": {
+ "@odata.type": "#microsoft.graph.identityGovernance.triggerAndScopeBasedConditions",
+ "scope": {
+ "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet"
},
- "tasks": [
- {
- "continueOnError": false,
- "description": "Enable user account in the directory",
- "displayName": "Enable User Account",
- "isEnabled": true,
- "taskDefinitionId": "6fc52c9d-398b-4305-9763-15f42c1676fc",
- "arguments": []
- },
- {
- "continueOnError": false,
- "description": "Send welcome email to new hire",
- "displayName": "Send Welcome Email",
- "isEnabled": true,
- "taskDefinitionId": "70b29d51-b59a-4773-9280-8841dfd3f2ea",
- "arguments": [
- {
- "name": "cc",
- "value": "b47471b9-af8f-4a5a-bfa2-b78e82398f6e, a7a23ce0-909b-40b9-82cf-95d31f0aaca2"
- },
- {
- "name": "customSubject",
- "value": "Welcome to the organization {{userDisplayName}}!"
- },
- {
- "name": "customBody",
- "value": "Welcome to our organization {{userGivenName}} {{userSurname}}. \nFor more information, reach out to your manager {{managerDisplayName}} at {{managerEmail}}."
- },
- {
- "name": "locale",
- "value": "en-us"
- },
- ]
- }
- ]
+ "trigger": {
+ "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger",
+ "changeType": "remove"
+ }
} } ```
v1.0 Identitygovernance Workflow Createnewversion https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-workflow-createnewversion.md
If successful, this action returns a `200 OK` response code and a [microsoft.gra
## Examples
-### Example 1: Create a new version of a workflow
+### Example 1: Create a new version of a joiner workflow with time based trigger
#### Request
v1.0 Identityprovider Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityprovider_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-delete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityprovider Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityprovider_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-get-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global administrator
-* External Identity Provider administrator
## HTTP request
v1.0 Identityprovider List Availableprovidertypes https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-list-availableprovidertypes.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityprovider_list_availableprovidertypes" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-list-availableprovidertypes-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityprovider List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-list.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityprovider_list" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-list-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityprovider Post Identityproviders https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-post-identityproviders.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityprovider_post_identityproviders" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-post-identityproviders-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityprovider Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprovider-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityprovider_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprovider-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityproviderbase Availableprovidertypes https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-availableprovidertypes.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityproviderbase_availableprovidertypes" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-availableprovidertypes-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityproviderbase Delete https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-delete.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityproviderbase_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-delete-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Identityproviderbase Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-get.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityproviderbase_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-get-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
-* External ID user flow administrator
+The work or school account needs to belong to at least the *External Identity Provider Administrator* or *External Identity User Flow administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
## HTTP request
v1.0 Identityproviderbase Update https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityproviderbase-update.md
Choose the permission or permissions marked as least privileged for this API. Us
<!-- { "blockType": "permissions", "name": "identityproviderbase_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityproviderbase-update-permissions.md)]
-The work or school account needs to belong to one of the following roles:
-
-* Global Administrator
-* External Identity Provider Administrator
## HTTP request
v1.0 Inactiveawsresourcefinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsresourcefinding-aggregatedsummary.md
description: View the count of inactive AWS resources for the specified authoriz
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveawsresourcefinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsresourcefinding-get.md
description: "Read the properties and relationships of an inactiveAwsResourceFin
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveawsresourcefinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsresourcefinding-list.md
description: "List the details of inactive AWS resources."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveawsrolefinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsrolefinding-aggregatedsummary.md
description: "Retrieve the raw count of inactive roles relative to the total rol
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveawsrolefinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveawsrolefinding-list.md
description: "List the details of inactive roles in AWS authorization systems on
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveazureserviceprincipalfinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveazureserviceprincipalfinding-aggregatedsummary.md
description: "View the count of inactive Azure service principals for the specif
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveazureserviceprincipalfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveazureserviceprincipalfinding-get.md
description: "Read the properties and relationships of an inactiveAzureServicePr
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveazureserviceprincipalfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveazureserviceprincipalfinding-list.md
description: "Get a list of the inactiveAzureServicePrincipalFinding objects and
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactivegcpserviceaccountfinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegcpserviceaccountfinding-aggregatedsummary.md
description: View the count of inactive GCP service accounts in your authorizati
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactivegcpserviceaccountfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegcpserviceaccountfinding-get.md
description: "Read the properties and relationships of an inactiveGcpServiceAcco
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactivegcpserviceaccountfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegcpserviceaccountfinding-list.md
description: "Get a list of the inactiveGcpServiceAccountFinding objects and the
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactivegroupfinding Get https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegroupfinding-get.md
description: "Get details about an inactive group in AWS, Azure, or GCP environm
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactivegroupfinding List https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactivegroupfinding-list.md
description: "List inactive groups in AWS, Azure and GCP environments."
ms.localizationpriority: medium+ doc_type: apiPageType
v1.0 Inactiveserverlessfunctionfinding Aggregatedsummary https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/inactiveserverlessfunctionfinding-aggregatedsummary.md
description: "A raw count of inactive serverless functions in the specified AWS,
ms.localizationpriority: medium+ doc_type: apiPageType