+ Title: "Remove resourceRoleScope from an access package"

+description: "Remove a resourceRoleScope from an access package."

+ms.localizationpriority: medium

+# Remove resourceRoleScope from an accessPackage

+Namespace: microsoft.graph

+Remove a [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) from an [accessPackage](../resources/accesspackage.md) list of resource role scopes.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+|:|:--|

+| Delegated (work or school account) | EntitlementManagement.ReadWrite.All |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | EntitlementManagement.ReadWrite.All |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+DELETE /identityGovernance/entitlementManagement/accessPackages/{id}/resourceRoleScopes/{id}

+```

+## Request headers

+| Name | Description |

+|:--|:--|

+| Authorization | Bearer \{token\}. Required. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a 200-series response code. It does not return anything in the response body.

+## Examples

+### Request

+The following is an example of the request.

+<!-- {

+ "blockType": "request",

+ "name": "delete_accesspackageresourcerolescope_from_accesspackage"

+}-->

+```http

+DELETE https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackages/{id}/resourceRoleScopes/{id}

+```

+### Response

+The following is an example of the response.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+} -->

+```http

+HTTP/1.1 204 No Content

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+|accessPackageId|String|Identifier of the access package. Required. |

+|displayName|String|The display name of the policy. Required.|

+|description|String|The description of the policy. Required.|

+|canExtend|Boolean|Indicates whether a user can extend the access package assignment duration after approval. Required.|

+|durationInDays|Int32|The number of days in which assignments from this policy last until they are expired. Required.|

+|expirationDateTime|DateTimeOffset|The expiration date for assignments created in this policy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Required.|

+|requestorSettings|[requestorSettings](../resources/requestorsettings.md)|Who can request this access package from this policy. Required.|

+|requestApprovalSettings|[approvalSettings](../resources/approvalsettings.md)|Who must approve requests for access package in this policy. Required.|

+|accessReviewSettings|[assignmentReviewSettings](../resources/assignmentreviewsettings.md)|Who must review, and how often, the assignments to the access package from this policy. This property is null if reviews are not required. Required.|

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ "customExtensionCalloutInstances": [

+ "status": "callbackReceived",

+ "id": "3C49CE50-E02C-4254-81E6-834328DF72DC",

+ "detail": "Request has been allowed"

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+|displayName|String|Required. Display name for the customAccessPackageWorkflowExtension.|

+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Required. The type and details for configuring the endpoint to call the logic app's workflow.|

+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Required. Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.|

+ "@odata.type": "#microsoft.graph.accessPackageAssignmentRequestWorkflowExtension",

+ "displayName": "test_action_0124_email",

+ "description": "this is for graph testing only",

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",

+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",

+ "resourceGroupName": "test",

+ "logicAppWorkflowName": "elm-extension-email"

+ },

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdPopTokenAuthentication"

+ },

+ "callbackConfiguration": {

+ "@odata.type": "microsoft.graph.customExtensionCallbackConfiguration",

+ "durationBeforeTimeout": "PT1H"

+ }

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Get accessPackageSubject"

+description: "Get the properties of an accessPackageSubject object."

+ms.localizationpriority: medium

+# Get accessPackageSubject

+Namespace: microsoft.graph

+Get an existing [accessPackageSubject](../resources/accesspackagesubject.md) object properties.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account) | EntitlementManagement.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | EntitlementManagement.ReadWrite.All |

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+```http

+GET /identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')

+```

+## Request headers

+| Name |Description|

+|:-|:-|

+| Authorization | Bearer \{token\}. Required. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and the requested [accessPackageSubject](../resources/accesspackagesubject.md) object in the response body.

+## Examples

+### Request

+<!-- {

+ "blockType": "request",

+ "name": "get_accesspackagesubject"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')

+```

+### Response

+The following is an example of the response.

+> **Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.accessPackageSubject"

+} -->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/subjects/$entity",

+ "connectedOrganizationId": null,

+ "id": "120fd4a0-95a7-49d2-9389-ed6f3c025c74",

+ "objectId": "a382de66-b7bb-4c30-82b7-306c6ae6a4ae",

+ "altSecId": null,

+ "displayName": "Accessibility Test",

+ "principalName": "accessibility@contosodeb.onmicrosoft.com",

+ "email": "accessibility@contosodeb.onmicrosoft.com",

+ "onPremisesSecurityIdentifier": null,

+ "type": "User",

+ "subjectLifecycle": "governed"

+}

+```

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Get accessPackageSubject",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ ]

+}

+-->

+ Title: "Update accessPackageSubject"

+description: "Update the properties of an accessPackageSubject object."

+ms.localizationpriority: medium

+# Update accessPackageSubject

+Namespace: microsoft.graph

+Update an existing [accessPackageSubject](../resources/accesspackagesubject.md) object to change the subject lifecycle.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account) | EntitlementManagement.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | EntitlementManagement.ReadWrite.All |

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+```http

+PATCH /identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')

+```

+## Request headers

+Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|subjectLifecycle|accessPackageSubjectLifecycle|The lifecycle of the subject user, if a guest. The possible values are: `notDefined`, `notGoverned`, `governed`.|

+## Response

+If successful, this method returns a `204 No Content` response code.

+## Examples

+### Request

+<!-- {

+ "blockType": "request",

+ "name": "update_accesspackagesubject"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/subjects(objectId='{objectIdOfUser}')

+Content-Type: application/json

+{

+ "subjectLifecycle":"governed"

+}

+```

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Update accessPackageSubject",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ ]

+}

+-->

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "accessReviewInstance: stopApplyDecisions"

+description: "Stop the apply decision action on when accessReviewInstance when the decision is in the process of being applied."

+ms.localizationpriority: medium

+# accessReviewInstance: stopApplyDecisions

+Namespace: microsoft.graph

+Stop the apply decision action on a [accessReviewInstance](../resources/accessreviewinstance.md) when the decision is in the process of being applied.

+You can stop the apply decision action only when the review is created with autoapply and autoreview settings, and the remediation option to disable and delete users. When you call this API on a current instance of a recurrence, it will not affect future instances.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account) | AccessReview.ReadWrite.All |

+|Delegated (personal Microsoft account)| Not supported. |

+|Application | AccessReview.ReadWrite.All |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+POST /identityGovernance/accessReviews/definitions/{definition-id}/instances/{instance-id}/stopApplyDecisions

+```

+## Request headers

+None

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `204, No Content` response code. It does not return anything in the response body.

+## Examples

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "stop_applyDecisions"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/2b83cc42-09db-46f6-8c6e-16fec466a82d/instances/5d431f4b-56f2-4a50-938b-fb1e4e2c91b9/stopApplyDecisions

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": false

+} -->

+```http

+HTTP/1.1 204 No Content

+```

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Stop accessReviewInstance",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ ]

+}

+-->

+To update an **accessReviewInstance**, its **status** must be `InProgress`.

+PUT https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/5dcfcc88-da88-4252-8629-a0807b4b076d/instances/720b8ee0-cee4-42ac-b164-894c48703acc

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [PHP](#tab/php)

+# [PHP](#tab/php)

+# [PHP](#tab/php)

+# [PHP](#tab/php)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Get adminAppsAndServices"

+description: "Read the properties and relationships of a Microsoft Graph adminAppsAndServices object."

+ms.localizationpriority: medium

+# Get adminAppsAndServices

+Namespace: microsoft.graph

+Read the properties and relationships of a [adminAppsAndServices](../resources/adminappsandservices.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-AppsAndServices.Read.All, OrgSettings-AppsAndServices.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-AppsAndServices.Read.All, OrgSettings-AppsAndServices.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /admin/appsAndServices

+```

+## Optional query parameters

+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a [adminAppsAndServices](../resources/adminappsandservices.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_adminappsandservices"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/admin/appsAndServices

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.adminAppsAndServices"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "value": {

+ "@odata.type": "#microsoft.graph.adminAppsAndServices",

+ "id": "c079f617-c04e-c14f-0750-cb2f87064342",

+ "settings": {

+ "@odata.type": "microsoft.graph.appsAndServicesSettings",

+ "isOfficeStoreEnabled": false,

+ "isAppAndServicesTrialEnabled": true

+ }

+ }

+}

+```

+ Title: "Update adminAppsAndServices"

+description: "Update the properties of a Microsoft Graph adminAppsAndServices object."

+ms.localizationpriority: medium

+# Update adminAppsAndServices

+Namespace: microsoft.graph

+Update the properties of a [adminAppsAndServices](../resources/adminappsandservices.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-AppsAndServices.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-AppsAndServices.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /admin/appsAndServices

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|settings|[appsAndServicesSettings](../resources/appsandservicessettings.md)|Company-wide settings for apps and services. Required.|

+## Response

+If successful, this method returns a `200 OK` response code and an updated [adminAppsAndServices](../resources/adminappsandservices.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_adminappsandservices"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/admin/appsAndServices

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.adminAppsAndServices",

+ "settings": {

+ "@odata.type": "microsoft.graph.appsAndServicesSettings",

+ "isOfficeStoreEnabled": false,

+ "isAppAndServicesTrialEnabled": false

+ }

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+Content-Type: text/plain

+```

+# [Python](#tab/python)

+ Title: "Get adminDynamics"

+description: "Read the properties and relationships of a Microsoft Graph adminDynamics object."

+ms.localizationpriority: medium

+# Get adminDynamics

+Namespace: microsoft.graph

+Read the properties and relationships of a [adminDynamics](../resources/admindynamics.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-DynamicsVoice.Read.All, OrgSettings-DynamicsVoice.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-DynamicsVoice.Read.All, OrgSettings-DynamicsVoice.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /admin/dynamics

+```

+## Optional query parameters

+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a [adminDynamics](../resources/admindynamics.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_admindynamics"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/admin/dynamics

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.adminDynamics"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "value": {

+ "@odata.type": "#microsoft.graph.adminDynamics",

+ "id": "6099c226-4296-c20b-eb7f-a5f7c648cbed",

+ "customerVoice": {

+ "@odata.type": "microsoft.graph.customerVoiceSettings",

+ "isRestrictedSurveyAccessEnabled": "false",

+ "isRecordIdentityByDefaultEnabled": "true",

+ "isInOrgFormsPhishingScanEnabled": "true"

+ }

+ }

+}

+```

+ Title: "Update adminDynamics"

+description: "Update the properties of a Microsoft Graph adminDynamics object."

+ms.localizationpriority: medium

+# Update adminDynamics

+Namespace: microsoft.graph

+Update the properties of a [adminDynamics](../resources/admindynamics.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-DynamicsVoice.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-DynamicsVoice.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /admin/dynamics

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|customerVoice|[customerVoiceSettings](../resources/customervoicesettings.md)|Company-wide settings for Dynamics customer voice. Required.|

+## Response

+If successful, this method returns a `200 OK` response code and an updated [adminDynamics](../resources/admindynamics.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_admindynamics"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/admin/dynamics

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.adminDynamics",

+ "customerVoice": {

+ "@odata.type": "microsoft.graph.customerVoiceSettings",

+ "isRestrictedSurveyAccessEnabled": "false",

+ "isRecordIdentityByDefaultEnabled": "false",

+ "isInOrgFormsPhishingScanEnabled": "false"

+ }

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+Content-Type: text/plain

+```

+ Title: "Get adminForms"

+description: "Read the properties and relationships of a Microsoft Graph adminForms object."

+ms.localizationpriority: medium

+# Get adminForms

+Namespace: microsoft.graph

+Read the properties and relationships of a [adminForms](../resources/adminforms.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-Forms.Read.All, OrgSettings-Forms.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-Forms.Read.All, OrgSettings-Forms.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /admin/forms

+```

+## Optional query parameters

+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a [adminForms](../resources/adminforms.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_adminforms"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/admin/forms

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.adminForms"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "value": {

+ "@odata.type": "#microsoft.graph.adminForms",

+ "id": "7ef97113-d231-e67c-535d-7c051d9e22be",

+ "settings": {

+ "@odata.type": "microsoft.graph.formsSettings",

+ "isExternalSendFormEnabled": true,

+ "isExternalShareCollaborationEnabled": false,

+ "isExternalShareResultEnabled": false,

+ "isExternalShareTemplateEnabled": true,

+ "isRecordIdentityByDefaultEnabled": true,

+ "isBingImageSearchEnabled": true,

+ "isInOrgFormsPhishingScanEnabled": false

+ }

+ }

+}

+```

+ Title: "Update adminForms"

+description: "Update the properties of a Microsoft Graph adminForms object."

+ms.localizationpriority: medium

+# Update adminForms

+Namespace: microsoft.graph

+Update the properties of a [adminForms](../resources/adminforms.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-Forms.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-Forms.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /admin/forms

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|settings|[formsSettings](../resources/formssettings.md)|Company-wide settings for Microsoft Forms. Required.|

+## Response

+If successful, this method returns a `200 OK` response code and an updated [adminForms](../resources/adminforms.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_adminforms"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/admin/forms

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.adminForms",

+ "settings": {

+ "@odata.type": "microsoft.graph.formsSettings",

+ "isExternalSendFormEnabled": true,

+ "isExternalShareCollaborationEnabled": false,

+ "isExternalShareResultEnabled": false,

+ "isExternalShareTemplateEnabled": false,

+ "isRecordIdentityByDefaultEnabled": true,

+ "isBingImageSearchEnabled": true,

+ "isInOrgFormsPhishingScanEnabled": false

+ }

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+Content-Type: text/plain

+```

+> [!CAUTION]

+> If you don't append `/$ref` to the request and the calling app has permissions to manage the member object, the object will also be deleted from Azure Active Directory (Azure AD); otherwise, a `403 Forbidden` error is returned. You can restore specific objects through the [Restore deleted items API](directory-deleteditems-restore.md).

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [Python](#tab/python)

+## Examples

+### Example 1: Get an administrative unit

+#### Request

+# [Python](#tab/python)

+#### Response

+### Example 2: Get a restricted management administrative unit

+#### Request

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_administrativeunit_restricted"

+}-->

+```msgraph-interactive

+GET https://graph.microsoft.com/beta/administrativeUnits/2sd35b05-ae71-48ab-9e7d-4r41a28te37d

+```

+# [C#](#tab/csharp)

+# [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.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.administrativeUnit"

+} -->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#administrativeUnits/$entity",

+ "id": "2sd35b05-ae71-48ab-9e7d-4r41a28te37d",

+ "deletedDateTime": null,

+ "displayName": "Executive Division",

+ "description": "Executive division administration",

+ "isMemberManagementRestricted": true

+}

+```

+# [Python](#tab/python)

+In the request body, provide the `id` of a [user](../resources/user.md), [group](../resources/group.md), [device](../resources/device.md), or [directoryObject](../resources/directoryobject.md) to be added. If the administrative unit is a restricted management administrative unit (`isMemberManagementRestricted`=true), the group type must be an Azure AD security group. Only non-unified groups that are security enabled, not mail enabled, and not on-premises sync enabled are supported.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+## Examples

+The following example sets a dynamic membership rule on an existing administrative unit to include all users whose country is United States. It also updates the administrative unit display name.

+### Request

+ "displayName": "Executive Division",

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+ Title: "Get adminTodo"

+description: "Read the properties and relationships of a Microsoft Graph adminTodo object."

+ms.localizationpriority: medium

+# Get adminTodo

+Namespace: microsoft.graph

+Read the properties and relationships of a [adminTodo](../resources/admintodo.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-Todo.Read.All, OrgSettings-Todo.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|OrgSettings-Todo.Read.All, OrgSettings-Todo.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /admin/todo

+```

+## Optional query parameters

+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a [adminTodo](../resources/admintodo.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_admintodo"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/admin/todo

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.adminTodo"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "value": {

+ "@odata.type": "#microsoft.graph.adminTodo",

+ "id": "9b13e840-31a8-2ed4-57d8-22f42c130334",

+ "settings": {

+ "@odata.type": "microsoft.graph.todoSettings",

+ "isPushNotificationEnabled": true,

+ "isExternalJoinEnabled": true,

+ "isExternalShareEnabled": true

+ }

+ }

+}

+```

+ Title: "Update adminTodo"

+description: "Update the properties of a Microsoft Graph adminTodo object."

+ms.localizationpriority: medium

+# Update adminTodo

+Namespace: microsoft.graph

+Update the properties of a [adminTodo](../resources/admintodo.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|OrgSettings-Todo.ReadWrite.All|

+|Delegated (personal Microsoft account)|**Not supported.**|

+|Application|**OrgSettings-Todo.ReadWrite.All**|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /admin/todo

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|settings|[todoSettings](../resources/todosettings.md)|Company-wide settings for Microsoft Todo. Required.|

+## Response

+If successful, this method returns a `200 OK` response code and an updated [adminTodo](../resources/admintodo.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_admintodo"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/admin/todo

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.adminTodo",

+ "settings": {

+ "@odata.type": "microsoft.graph.todoSettings",

+ "isPushNotificationEnabled": true,

+ "isExternalJoinEnabled": false,

+ "isExternalShareEnabled": true

+ }

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+Content-Type: text/plain

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "List files (terms of use agreement files)"

+# List files (terms of use agreement files)

+Retrieve all files related to an agreement. This includes the default file and all localized files.

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [Python](#tab/python)

+Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the **Accept-Language** header.

+This method does not support any OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+### Example 1: Get the default agreement file

+#### Request

+# [Python](#tab/python)

+#### Response

+### Example 2: Get the agreement file for a specific language

+#### Request

+The following example shows how to get the agreement file for the `fr-FR` language. If no such agreement file exists, the default agreement file is returned.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "list_agreementfile_fr"

+}

+-->

+```msgraph-interactive

+GET https://graph.microsoft.com/beta/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file

+Accept-Language: fr-FR

+```

+# [C#](#tab/csharp)

+# [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.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.agreementFile"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/$entity",

+ "@odata.type": "#microsoft.graph.agreementFileLocalization",

+ "id": "90d1723c-52c1-40e3-a51a-da99a82c0327",

+ "fileName": "Contoso ToU for guest users (French)",

+ "displayName": "Contoso ToU for guest users (French)",

+ "language": "fr-FR",

+ "isDefault": false,

+ "isMajorVersion": false,

+ "createdDateTime": "2022-03-04T14:38:22.8292386Z",

+ "fileData": null

+}

+```

+ Title: "List agreementFileLocalizations"

+description: "Get a list of the default and localized agreement files."

+ms.localizationpriority: medium

+# List agreementFileLocalizations

+Namespace: microsoft.graph

+Get a list of the default and localized agreement files.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|Agreement.Read.All, Agreement.ReadWrite.All |

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|Not supported.|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /agreements/{agreementsId}/file/localizations

+```

+## 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.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a collection of [agreementFileLocalization](../resources/agreementfilelocalization.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "list_agreementfile_localization"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file/localizations

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "Collection(microsoft.graph.agreementFileLocalization)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/localizations",

+ "value": [

+ {

+ "id": "90d1723c-52c1-40e3-a51a-da99a82c0327",

+ "fileName": "Contoso ToU for guest users (French)",

+ "displayName": "Contoso ToU for guest users (French)",

+ "language": "fr-FR",

+ "isDefault": false,

+ "isMajorVersion": false,

+ "createdDateTime": "2022-03-04T14:38:22.8292386Z",

+ "fileData": null

+ },

+ {

+ "id": "08033369-8972-42a3-8533-90bbd2757a01",

+ "fileName": "TOU.pdf",

+ "displayName": "Contoso ToU for guest users",

+ "language": "en",

+ "isDefault": true,

+ "isMajorVersion": false,

+ "createdDateTime": "2022-03-04T13:14:13.9361722Z",

+ "fileData": null

+ }

+ ]

+}

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+### Request

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+|isActive|Boolean|Indicates whether the predefined value is active or deactivated. If `false`, this predefined value cannot be assigned to any additional supported directory objects. Optional.|

+### Request

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+> [!NOTE]

+> **Note**:

+Using `$expand=AppDefinitions` will return more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app has been approved, rejected, or remains under review.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ "distributionMethod": "Organization",

+ "shortDescription": "Types Of Cards.",

+ "description": "This sample shows the feature where user can send different types of cards using bot.",

+ "lastModifiedDateTime": "2020-11-23T21:36:00.9437445Z",

+ "createdBy": null

+# [Python](#tab/python)

+ "version": "1.0.9",

+ "shortDescription": "quaerat quasi magnam. slight change. 5",

+ "teamsAppId": "30909dee-f7dd-4f89-8b3b-55de2e32489c",

+ "shortDescription": "A conversational smart assistant from MSX that surfaces real-time insights.",

+# [Python](#tab/python)

+# [Python](#tab/python)

+- [Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Get appCredentialSignInActivity"

+description: "Get an appCredentialSignInActivity object that contains recent activity of an application credential."

+ms.localizationpriority: medium

+# Get appCredentialSignInActivity

+Namespace: microsoft.graph

+Get an [appCredentialSignInActivity](../resources/appcredentialsigninactivity.md) object that contains recent activity of an application credential.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+| :- | : |

+| Delegated (work or school account) | AuditLog.Read.All, Directory.Read.All |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | AuditLog.Read.All, Directory.Read.All |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+GET /reports/appCredentialSignInActivities/{appCredentialSignInActivityId}

+```

+## 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. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and an [appCredentialSignInActivity](../resources/appcredentialsigninactivity.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request that shows how to get an **appCredentialSignInActivity** object based on its ID.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_appcredentialsigninactivity_1",

+ "sampleKeys": ["ODNmNDUyOTYtZmI4Zi00YWFhLWEzOTktYWM1MTA4NGUwMmI3fGFwcGxpY2F0aW9u"]

+}-->

+```msgraph-interactive

+GET https://graph.microsoft.com/beta/reports/appCredentialSignInActivities/ODNmNDUyOTYtZmI4Zi00YWFhLWEzOTktYWM1MTA4NGUwMmI3fGFwcGxpY2F0aW9u

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.appCredentialSignInActivity"

+} -->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+Content-length: 211

+{

+ "@odata.type": "#microsoft.graph.appCredentialSignInActivity",

+ "appId": "f4d9654f-0305-4072-878c-8bf266dfe146",

+ "appObjectId": "6920caa5-1cae-4bc8-bf59-9c0b8495d240",

+ "credentialOrigin": "application",

+ "expirationDate": "2021-04-01T21:36:48-8:00",

+ "id": "ODNmNDUyOTYtZmI4Zi00YWFhLWEzOTktYWM1MTA4NGUwMmI3fGFwcGxpY2F0aW9u",

+ "keyId": "83f45296-fb8f-4aaa-a399-ac51084e02b7",

+ "keyType":"certificate",

+ "keyUsage": "sign",

+ "resourceId": "a89dc091-a671-4da4-9fcf-3ef06bdf3ac3",

+ "servicePrincipalObjectId": "cf533854-9fb7-4c01-9c0e-f68922ada8b6",

+ "signInActivity": {

+ "lastSignInDateTime": "2021-04-01T00:00:00-8:00",

+ "lastSignInRequestId": "b0a282a3-68ec-4ec8-aef0-290ed4350271"

+ }

+}

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+DELETE /applications/{applicationObjectId}/tokenLifetimePolicies/{tokenLifetimePolicyId}/$ref

+DELETE /applications(appId='{appId}')/tokenLifetimePolicies/{tokenLifetimePolicyId}/$ref

+DELETE /servicePrincipals/{servicePrincipalObjectId}/tokenLifetimePolicies/{tokenLifetimePolicyId}/$ref

+DELETE /servicePrincipals(appId='{appId}')/tokenLifetimePolicies/{tokenLifetimePolicyId}/$ref

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [HTTP](#tab/http)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+GET /applications(appId='{appId}')/extensionProperties

+# [Python](#tab/python)

+ "isMultiValued": true,

+ "isMultiValued": true,

+# [Python](#tab/python)

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+List the [tokenLifetimePolicy](../resources/tokenlifetimepolicy.md) objects that are assigned to an [application](../resources/application.md) or [servicePrincipal](../resources/servicePrincipal.md). Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application.

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+> **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.

+> - Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent).

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+##### Delta roster disabled (default)

+##### Delta roster enabled

+<!-- {

+ "blockType": "example",

+ "@odata.type": "microsoft.graph.commsNotifications",

+ "truncated": true

+}-->

+```json

+{

+ "@odata.type": "#microsoft.graph.commsNotifications",

+ "value": [

+ {

+ "@odata.type": "#microsoft.graph.commsNotification",

+ "changeType": "updated",

+ "resource": "/app/calls/421f7700-f4ad-4ea9-a3fc-c1d2195675ad/participants",

+ "resourceUrl": "/communications/calls/421f7700-f4ad-4ea9-a3fc-c1d2195675ad/participants",

+ "resourceData": [

+ {

+ "@odata.type": "#microsoft.graph.deltaParticipants",

+ "participants": [

+ {

+ "@odata.type": "#microsoft.graph.participant",

+ "info": {

+ "@odata.type": "#microsoft.graph.participantInfo",

+ "identity": {

+ "@odata.type": "#microsoft.graph.identitySet",

+ "user": {

+ "@odata.type": "#microsoft.graph.identity",

+ "displayName": "John",

+ "id": "112f7296-5fa4-42ca-bae8-6a692b15d4b8"

+ }

+ },

+ "languageId": "en-US"

+ },

+ "mediaStreams": [

+ {

+ "@odata.type": "#microsoft.graph.mediaStream",

+ "mediaType": "audio",

+ "sourceId": "1",

+ "direction": "sendReceive",

+ "serverMuted": false

+ },

+ {

+ "@odata.type": "#microsoft.graph.mediaStream",

+ "mediaType": "video",

+ "sourceId": "2",

+ "direction": "receiveOnly",

+ "serverMuted": false

+ },

+ {

+ "@odata.type": "#microsoft.graph.mediaStream",

+ "mediaType": "videoBasedScreenSharing",

+ "sourceId": "8",

+ "direction": "receiveOnly",

+ "serverMuted": false

+ }

+ ],

+ "isMuted": true,

+ "isInLobby": false,

+ "id": "0d7664b6-6432-43ed-8d27-d9e7adec188c",

+ "rosterSequenceNumber": 1

+ },

+ {

+ "@odata.type": "#microsoft.graph.participant",

+ "info": {

+ "@odata.type": "#microsoft.graph.participantInfo",

+ "identity": {

+ "@odata.type": "#microsoft.graph.identitySet",

+ "application": {

+ "@odata.type": "#microsoft.graph.identity",

+ "displayName": "Calling Bot",

+ "id": "2891555a-92ff-42e6-80fa-6e1300c6b5c6"

+ }

+ }

+ },

+ "mediaStreams": [

+ {

+ "@odata.type": "#microsoft.graph.mediaStream",

+ "mediaType": "audio",

+ "sourceId": "10",

+ "direction": "sendReceive",

+ "serverMuted": false

+ }

+ ],

+ "isMuted": false,

+ "isInLobby": false,

+ "id": "05491616-385f-44a8-9974-18cc5f9933c1",

+ "rosterSequenceNumber": 1,

+ "removedState": {

+ "reason": "Removed from roster"

+ }

+ }

+ ],

+ "sequenceNumber": 1

+ }

+ ]

+ }

+ ]

+}

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+##### Delta roster disabled (default)

+##### Delta roster enabled

+<!-- {

+ "blockType": "example",

+ "@odata.type": "microsoft.graph.commsNotifications",

+ "truncated": true

+}-->

+```json

+{

+ "@odata.type": "#microsoft.graph.commsNotifications",

+ "value": [

+ {

+ "@odata.type": "#microsoft.graph.commsNotification",

+ "changeType": "updated",

+ "resource": "/app/calls/421f7700-f4ad-4ea9-a3fc-c1d2195675ad/participants",

+ "resourceUrl": "/communications/calls/421f7700-f4ad-4ea9-a3fc-c1d2195675ad/participants",

+ "resourceData": [

+ {

+ "@odata.type": "#microsoft.graph.deltaParticipants",

+ "participants": [

+ {

+ "@odata.type": "#microsoft.graph.participant",

+ "info": {

+ "@odata.type": "#microsoft.graph.participantInfo",

+ "identity": {

+ "@odata.type": "#microsoft.graph.identitySet",

+ "guest": {

+ "@odata.type": "#microsoft.graph.identity",

+ "displayName": "Guest User",

+ "id": "d7a3b999-17ac-4bca-9e77-e6a730d2ec2e"

+ }

+ }

+ },

+ "mediaStreams": [

+ {

+ "@odata.type": "#microsoft.graph.mediaStream",

+ "mediaType": "audio",

+ "sourceId": "10",

+ "direction": "sendReceive",

+ "serverMuted": false

+ }

+ ],

+ "isMuted": false,

+ "isInLobby": true,

+ "id": "05491616-385f-44a8-9974-18cc5f9933c1"

+ }

+ ],

+ "sequenceNumber": 2

+ }

+ ]

+ }

+ ]

+}

+```

+> **Note:** The application will not receive the roster for participants in the meeting until its admitted from lobby.

+# [Python](#tab/python)

+# [Python](#tab/python)

+POST /applications(appId='{appId}')/extensionProperties

+|isMultiValued|Boolean| Defines the directory extension as a multi-valued property. When `true`, the directory extension property can store a collection of objects of the **dataType**; for example, a collection of integers. The default value is `false`.|

+ "isMultiValued": true,

+# [Python](#tab/python)

+ "isMultiValued": true,

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+Assign a [tokenLifetimePolicy](../resources/tokenlifetimepolicy.md) to an [application](../resources/application.md) or [servicePrincipal](../resources/servicePrincipal.md). You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per application.

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+# [PHP](#tab/php)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+description: "Retrieve the properties and relationships of an applicationSignInDetailedSummary object."

+Retrieve the properties and relationships of an [applicationSignInDetailedSummary](../resources/applicationsignindetailedsummary.md) object.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+DELETE /applications/{applicationObjectId}/appManagementPolicies/{appManagementPolicyId}/$ref

+DELETE /servicePrincipals/{servicePrincipalObjectId}/appManagementPolicies/{appManagementPolicyId}/$ref

+Do not supply a request body for this method.

+DELETE https://graph.microsoft.com/beta/applications/3ccc9971-9ae7-45d6-8de8-263fd25fe116/appManagementPolicies/15942288-d19b-458c-9be4-20377d0a2435/$ref

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+DELETE https://graph.microsoft.com/beta/servicePrincipals/f284860e-368c-4a1f-8894-77f0a9676fb3/appManagementPolicies/15942288-d19b-458c-9be4-20377d0a2435/$ref

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+ Title: "Delete appManagementPolicy"

+description: "Delete an application management policy."

+ms.localizationpriority: medium

+# Delete appManagementPolicy

+Namespace: microsoft.graph

+Delete an [appManagementPolicy](../resources/appmanagementpolicy.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+| :- | : |

+| Delegated (work or school account) | Policy.ReadWrite.ApplicationConfiguration |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Policy.ReadWrite.ApplicationConfiguration |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+DELETE /policies/appManagementPolicies/{id}

+```

+## Request headers

+| Name | Description |

+| : | :-- |

+| Authorization | Bearer {token}. Required. |

+| Content-Type | application/json. Required. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.

+## Examples

+### Request

+The following is an example of the request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "delete_appManagementPolicy"

+}-->

+```http

+DELETE https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+<!-- {

+ "blockType": "response",

+ "truncated": false

+} -->

+```http

+HTTP/1.1 204 No Content

+```

+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98

+2019-02-04 14:57:30 UTC -->

+<!-- {

+ "type": "#page.annotation",

+ "description": "delete appManagementPolicy",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": ""

+}-->

+# [Python](#tab/python)

+ Title: "List appliesTo"

+description: "List resources assigned to an application management policy."

+ms.localizationpriority: medium

+# List appliesTo

+Namespace: microsoft.graph

+List application and service principal objects assigned an [appManagementPolicy](../resources/appManagementPolicy.md) policy object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+| Permission type | Permissions (from least to most privileged) |

+| :- | :-- |

+| Delegated (work or school account) | Application.Read.All and Policy.Read.All, Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Application.Read.All and Policy.Read.All, Application.Read.All and Policy.ReadWrite.ApplicationConfiguration |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+GET /policies/appManagementPolicies/{id}/appliesTo

+```

+## Optional query parameters

+This method supports the `$select`, `$filter`, and `$top` OData query parameters to help customize the response. You can apply `$filter` on properties of [application](../resources/application.md) or [servicePrincipal](../resources/serviceprincipal.md) objects that support `$filter`. For example, the following query retrieves the **appId** and **displayName** of applications or service principals that are assigned the policy.

+``` http

+https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}/appliesTo?$select=appId,displayName

+```

+For general information, see [OData query parameters](/graph/query-parameters).

+## Request headers

+| Name | Description |

+| : | : |

+| Authorization | Bearer {token}. Required. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a collection of [application](../resources/application.md) or [servicePrincipal](../resources/serviceprincipal.md) objects in the response body.

+## Examples

+### Example 1: Get applications and service principal objects applied to an app management policy

+#### Request

+The following is an example of the request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "list_appManagementPolicyAppliesTo"

+}-->

+```msgraph-interactive

+GET https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}/appliesTo

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.appManagementPolicy"

+} -->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects",

+ "value": [

+ {

+ "@odata.type": "#microsoft.graph.application",

+ "id": "0d77e011-2fc6-438f-8b93-decb4f926929",

+ "appId": "8f527de6-05c9-4032-bca9-b2b56ab2358a",

+ "displayName": "TestApp1",

+ "createdDateTime": "2018-01-24T05:55:37Z"

+ }

+ ]

+}

+```

+### Example 2: Get specific properties of applications and service principal objects applied to an app management policy using $select query option

+#### Request

+The following is an example of the request using $select query option.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "list_appManagementPolicyAppliesTo_select"

+}-->

+```msgraph-interactive

+GET https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}/appliesTo?$select=id,appId,displayName,createdDateTime

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response that returns `id`, `appId`, `displayName` and `createdDateTime` of applications and service principals where the policy is applied.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.appManagementPolicy"

+} -->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects(id,appId,displayName,createdDateTime)",

+ "value": [

+ {

+ "@odata.type": "#microsoft.graph.application",

+ "id": "0d77e011-2fc6-438f-8b93-decb4f926929",

+ "appId": "8f527de6-05c9-4032-bca9-b2b56ab2358a",

+ "displayName": "TestApp1",

+ "createdDateTime": "2018-01-24T05:55:37Z"

+ },

+ {

+ "@odata.type": "#microsoft.graph.servicePrincipal",

+ "id": "0e1fa067-dcc1-4d85-9b4c-e69145dd3efb",

+ "appId": "255912cb-e31d-4dee-bee4-3fa5d774d6b9",

+ "displayName": "TestApp2",

+ "createdDateTime": "2018-01-24T05:55:37Z"

+ }

+ ]

+}

+```

+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98

+2019-02-04 14:57:30 UTC -->

+<!-- {

+ "type": "#page.annotation",

+ "description": "list resources for appManagementPolicies",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": ""

+}-->

+# [Python](#tab/python)

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Update appManagementPolicy"

+description: "Update an application management policy."

+ms.localizationpriority: medium

+# Update appManagementPolicy

+Namespace: microsoft.graph

+Update an [appManagementPolicy](../resources/appmanagementpolicy.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+| :- | : |

+| Delegated (work or school account) | Policy.ReadWrite.ApplicationConfiguration |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Policy.ReadWrite.ApplicationConfiguration |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+PATCH /policies/appManagementPolicies/{id}

+```

+## Request headers

+| Name | Description |

+| : | :-- |

+| Authorization | Bearer {token}. Required. |

+| Content-Type | application/json. Required. |

+## Request body

+| Property | Type | Description |

+| :-- | :-- | : |

+| description | String | The description of the policy. Inherited from [policyBase](../resources/policybase.md). |

+| displayName | String | The display name of the policy. Inherited from [policyBase](../resources/policybase.md). |

+| isEnabled | Boolean | Denotes whether the policy is enabled. |

+| restrictions | [appManagementConfiguration](../resources/appmanagementconfiguration.md) | Restrictions that apply to an application or service principal object. |

+## Response

+If successful, this method returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of the request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_appManagementPolicy"

+}-->

+```http

+PATCH https://graph.microsoft.com/beta/policies/appManagementPolicies/{id}

+{

+ "isEnabled": false

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+<!-- {

+ "blockType": "response",

+ "truncated": true

+} -->

+```http

+HTTP/1.1 204 No Content

+```

+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98

+2019-02-04 14:57:30 UTC -->

+<!-- {

+ "type": "#page.annotation",

+ "description": "update appManagementPolicies",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": ""

+}-->

+ Title: "Get appRoleAssignment"

+description: "Read the properties and relationships of an appRoleAssignment object."

+ms.localizationpriority: medium

+# Get appRoleAssignment

+Namespace: microsoft.graph

+Read the properties and relationships of an [appRoleAssignment](../resources/approleassignment.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+### For client service principals

+|Permission type | Permissions (from least to most privileged) |

+|:--|:|

+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |

+### For resource service principals

+|Permission type | Permissions (from least to most privileged) |

+|:--|:|

+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |

+### For groups

+|Permission type | Permissions (from least to most privileged) |

+|:--|:|

+|Delegated (work or school account) | Group.Read.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | Group.Read.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All |

+### For users

+|Permission type | Permissions (from least to most privileged) |

+|:--|:|

+|Delegated (work or school account) | User.Read, User.ReadBasic.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | Directory.Read.All, AppRoleAssignment.ReadWrite.All |

+## HTTP request

+To get details of an appRole granted to a service principal:

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /servicePrincipals/{client-serviceprincipal-id}/appRoleAssignments/{appRoleAssignment-id}

+GET /servicePrincipals(appId='{client-servicePrincipal-appId}')/appRoleAssignments/{appRoleAssignment-id}

+```

+To get details of an appRole granted to a user, group, or client service principal for the given resource service principal:

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /servicePrincipals(appId='{resource-servicePrincipal-appId}')/appRoleAssignedTo/{appRoleAssignment-id}

+GET /servicePrincipals/{resource-serviceprincipal-id}/appRoleAssignedTo/{appRoleAssignment-id}

+```

+To get details of an appRole granted to a group:

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}

+```

+To get details of an appRole granted to a user:

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /users/{user-id}/appRoleAssignments/{appRoleAssignment-id}

+GET /me/appRoleAssignments/{appRoleAssignment-id}

+```

+## 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.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and an [appRoleAssignment](../resources/approleassignment.md) object in the response body.

+## Examples

+### Example 1: Get details of an app role granted to a user, group, or client service principal for the given resource service principal

+#### Request

+The following request queries the resource service principal to get details of an app role it has granted to a client that can be a user, group, or client service principal in the tenant.

+<!-- {

+ "blockType": "request",

+ "name": "get_approleassignment_beta_e1",

+ "sampleKeys": ["00000003-0000-0000-c000-000000000000", "ep6PKgGvOkGVksMuwOXBpxV3dkHvwM1ElSjMUzZtaIA"]

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/servicePrincipals(appId='00000003-0000-0000-c000-000000000000')/appRoleAssignedTo/ep6PKgGvOkGVksMuwOXBpxV3dkHvwM1ElSjMUzZtaIA

+```

+#### Response

+The following is an example of the response. It shows a client service principal named **Postman** has been granted an app role with the ID **df021288-bdef-4463-88db-98f22de89214** which is the *User.Read.All* application permission, for the resource service principal named **Microsoft Graph**.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.appRoleAssignment"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals('00000003-0000-0000-c000-000000000000')/appRoleAssignedTo/$entity",

+ "id": "ep6PKgGvOkGVksMuwOXBpxV3dkHvwM1ElSjMUzZtaIA",

+ "deletedDateTime": null,

+ "appRoleId": "df021288-bdef-4463-88db-98f22de89214",

+ "createdDateTime": "2023-02-24T17:01:47.0988029Z",

+ "principalDisplayName": "Postman",

+ "principalId": "2a8f9e7a-af01-413a-9592-c32ec0e5c1a7",

+ "principalType": "ServicePrincipal",

+ "resourceDisplayName": "Microsoft Graph",

+ "resourceId": "7408235b-7540-4850-82fe-a5f15ed019e2"

+}

+```

+### Example 2: Get details of an app role granted to a service principal

+#### Request

+The following request queries the client service principal to get details of an app role granted to it. In this instance, the app role represents the application permission.

+<!-- {

+ "blockType": "request",

+ "name": "get_approleassignment_serviceprincipal_beta_e2",

+ "sampleKeys": ["ceb96a54-de95-49a0-b38c-c55263fcf421", "ep6PKgGvOkGVksMuwOXBpxV3dkHvwM1ElSjMUzZtaIA"]

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/servicePrincipals(appId='ceb96a54-de95-49a0-b38c-c55263fcf421')/appRoleAssignments/ep6PKgGvOkGVksMuwOXBpxV3dkHvwM1ElSjMUzZtaIA

+```

+#### Response

+The following is an example of the response. It shows a client service principal named **Postman** has been granted an app role with the ID **df021288-bdef-4463-88db-98f22de89214** which is the *User.Read.All* application permission, for the resource service principal named **Microsoft Graph**.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.appRoleAssignment"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals('ceb96a54-de95-49a0-b38c-c55263fcf421')/appRoleAssignments/$entity",

+ "id": "ep6PKgGvOkGVksMuwOXBpxV3dkHvwM1ElSjMUzZtaIA",

+ "deletedDateTime": null,

+ "appRoleId": "df021288-bdef-4463-88db-98f22de89214",

+ "createdDateTime": "2023-02-24T17:01:47.0988029Z",

+ "principalDisplayName": "Postman",

+ "principalId": "2a8f9e7a-af01-413a-9592-c32ec0e5c1a7",

+ "principalType": "ServicePrincipal",

+ "resourceDisplayName": "Microsoft Graph",

+ "resourceId": "7408235b-7540-4850-82fe-a5f15ed019e2"

+}

+```

+### Example 3: Get details of an app role granted to the signed-in user

+#### Request

+The following request queries the signed-in user's appRoleAssignments.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_approleassignment"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/me/appRoleAssignments/Lo6gEKI-4EyAy9X91LBepo6Aq0Rt6QxBjWRl76txk8I

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response. It shows the signed-in user has the default app role for a resource service principal named *Postman*.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.appRoleAssignment"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('10a08e2e-3ea2-4ce0-80cb-d5fdd4b05ea6')/appRoleAssignments/$entity",

+ "id": "Lo6gEKI-4EyAy9X91LBepo6Aq0Rt6QxBjWRl76txk8I",

+ "deletedDateTime": null,

+ "appRoleId": "00000000-0000-0000-0000-000000000000",

+ "createdDateTime": "2022-09-08T17:43:57.8423817Z",

+ "principalDisplayName": "MOD Administrator",

+ "principalId": "10a08e2e-3ea2-4ce0-80cb-d5fdd4b05ea6",

+ "principalType": "User",

+ "resourceDisplayName": "Postman",

+ "resourceId": "2a8f9e7a-af01-413a-9592-c32ec0e5c1a7"

+}

+```

+Retrieve the properties of an [approval](../resources/approval.md) object. This API request is made by an approver in the following scenarios:

+- In [entitlement management](../resources/entitlementmanagement-overview.md), providing the identifier of the [access package assignment request](../resources/accesspackageassignmentrequest.md).

+- In [PIM for groups](../resources/privilegedidentitymanagement-for-groups-api-overview.md), providing the identifier of the [assignment schedule request](../resources/privilegedaccessgroupassignmentschedulerequest.md).

+### For entitlement management

+### For PIM for groups

+| Permission type | Permissions (from least to most privileged) |

+|:|:--|

+| Delegated (work or school account) | PrivilegedAssignmentSchedule.Read.AzureADGroup, PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Not supported. |

+To get approval objects in entitlement management:

+<!-- { "blockType": "ignored" } -->

+To get approval objects in PIM for groups:

+<!-- { "blockType": "ignored" } -->

+```http

+GET /identityGovernance/privilegedAccess/group/assignmentApprovals/{id}

+```

+# [Python](#tab/python)

+List the [approvalStep](../resources/approvalstep.md) objects associated with an [approval](../resources/approval.md). This API request is made by an approver in the following scenarios:

+- In [entitlement management](../resources/entitlementmanagement-overview.md), providing the identifier of the [access package assignment request](../resources/accesspackageassignmentrequest.md).

+- In [PIM for groups](../resources/privilegedidentitymanagement-for-groups-api-overview.md), providing the identifier of the [assignment schedule request](../resources/privilegedaccessgroupassignmentschedulerequest.md).

+### For entitlement management

+### For PIM for groups

+| Permission type | Permissions (from least to most privileged) |

+|:|:--|

+| Delegated (work or school account) | PrivilegedAssignmentSchedule.Read.AzureADGroup, PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Not supported. |

+To list the approval steps in entitlement management:

+<!-- { "blockType": "ignored" } -->

+To list the approval steps in PIM for groups:

+<!-- { "blockType": "ignored" } -->

+```http

+GET /identityGovernance/privilegedAccess/group/assignmentApprovals/{id}/steps

+```

+# [Python](#tab/python)

+### Permissions required for calling this API for entitlement management

+### Permissions required for calling this API for PIM for groups

+| Permission type | Permissions (from least to most privileged) |

+|:|:--|

+| Delegated (work or school account) | PrivilegedAssignmentSchedule.Read.AzureADGroup, PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Not supported. |

+To get an approval step in entitlement management:

+<!-- { "blockType": "ignored" } -->

+To get an approval step in PIM for groups:

+<!-- { "blockType": "ignored" } -->

+```http

+GET /identityGovernance/privilegedAccess/group/assignmentApprovals/{id}/steps/{id}

+```

+# [Python](#tab/python)

+### Permissions required for calling this API for entitlement management

+### Permissions required for calling this API for PIM for groups

+| Permission type | Permissions (from least to most privileged) |

+|:|:--|

+| Delegated (work or school account) | PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Not supported. |

+To update an approval decision in entitlement management:

+<!-- { "blockType": "ignored" } -->

+To update an approval decision in PIM for groups:

+<!-- { "blockType": "ignored" } -->

+```http

+PATCH /identityGovernance/privilegedAccess/group/assignmentApprovals/{id}/steps/{id}

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+> Be aware of a [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13644) if you're attaching a large file to a message or event in a shared or delegated mailbox.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+> [!NOTE]

+> When certain files are requested, MIME can encode the byte stream output in the response and provide a link to download the file as an email attachment.

+>

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+To get attendance records of a virtual event session's attendance report:

+<!-- {"blockType": "ignored"}-->

+``` http

+GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}/attendanceRecords

+```

+>- `webinarId` is the **id** of an [virtualEventWebinar](../resources/virtualEventWebinar.md) object.

+>- `sessionId` is the **id** of an [virtualEventSession](../resources/virtualEventSession.md) object.

+# [Python](#tab/python)

+# [Python](#tab/python)

+### Example 3: List attendance records of a virtual event session's attendance report

+#### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_virtualeventsession_record"

+}

+-->

+``` http

+GET /solutions/virtualEvents/webinars/{webinarId}/sessions/{sessionId}/attendanceReports/{reportId}/attendancerecords

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "Collection(microsoft.graph.attendanceRecord)"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#solutions/virtualEvents/webinars('336f94f4-3a81-5130-43e9-88f3-fcb3582cde37')/sessions('a0f934c324b7785c')/attendanceReports('2c2454-7613-4d6e-9c7c-4c8')/attendancerecords",

+ "value": [

+ {

+ "emailAddress": "frederick.cormier@contoso.com",

+ "totalAttendanceInSeconds": 322,

+ "role": "Organizer",

+ "registrantId": null,

+ "identity": {

+ "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4623",

+ "displayName": "Frederick Cormier",

+ "tenantId": null

+ },

+ "attendanceIntervals": [

+ {

+ "joinDateTime": "2021-10-05T04:38:27.6027225Z",

+ "leaveDateTime": "2021-10-05T04:43:49.7702391Z",

+ "durationInSeconds": 322

+ }

+ ]

+ },

+ {

+ "emailAddress": "lisa.adkins@contoso.com",

+ "totalAttendanceInSeconds": 314,

+ "role": "Presenter",

+ "registrantId": null,

+ "identity": {

+ "id": "57caaef9-5ed0-48d5-8862-e5abfa71b3e9",

+ "displayName": "Lisa Adkins",

+ "tenantId": null

+ },

+ "attendanceIntervals": [

+ {

+ "joinDateTime": "2021-10-04T23:13:43.3776519Z",

+ "leaveDateTime": "2021-10-04T23:18:57.5639338Z",

+ "durationInSeconds": 314

+ }

+ ]

+ }

+ ]

+}

+```

+This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+### Request

+ "name": "get_attributeset_single",

+ "sampleKeys": ["Engineering"]

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+### Request

+ "name": "update_attributeset",

+ "sampleKeys": ["Engineering"]

+# [Python](#tab/python)

+### Response

+The following is an example of the response.

+### Request

+# [Python](#tab/python)

+### Response

+### Request

+# [Python](#tab/python)

+### Response

+### Request

+# [Python](#tab/python)

+### Response

+ Title: "Get authentication signInPreferences"

+description: "Read the properties of a user's authentication sign in preferences."

+ms.localizationpriority: medium

+# Get authentication signInPreferences

+Namespace: microsoft.graph

+Read the properties and relationships of a [signInPreferences](../resources/signInPreferences.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|UserAuthenticationMethod.Read, UserAuthenticationMethod.ReadWrite|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|UserAuthenticationMethod.Read, UserAuthenticationMethod.ReadWrite|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /users/{id | userPrincipalName}/authentication/signInPreferences

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and a [signInPreferences](../resources/signInPreferences.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_authentication"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/signInPreferences

+```

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.signInPreferences"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "isSystemPreferredAuthenticationMethodEnabled": false,

+ "userPreferredMethodForSecondaryAuthentication": "push"

+}

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+Users cannot add an email authentication method to their own account.

+## HTTP request

+# [Python](#tab/python)

+Users cannot add a phone authentication method to their own account.

+## HTTP request

+ "sampleKeys": ["kim@contoso.com"],

+POST https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Update authentication signInPreferences"

+description: "Update the properties of a user's authentication sign in preferences."

+ms.localizationpriority: medium

+# Update authentication signInPreferences

+Namespace: microsoft.graph

+Update the properties of a [signInPreferences](../resources/signInPreferences.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|UserAuthenticationMethod.ReadWrite|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|UserAuthenticationMethod.ReadWrite|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /users/{id | userPrincipalName}/authentication/signInPreferences

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+|Property|Type|Description|

+|:|:|:|

+|isSystemPreferredAuthenticationMethodEnabled|Boolean|Indicates whether the credential preferences of the system are enabled.|

+|userPreferredMethodForSecondaryAuthentication|userDefaultAuthenticationMethodType|The default second-factor method used by the user when signing in. If a user is enabled for system-preferred authentication, then this value is ignored except for a few scenarios where a user is authenticating via NPS extension or ADFS adapter. Possible values are `push`, `oath`, `voiceMobile`, `voiceAlternateMobile`, `voiceOffice`, `sms`, and `unknownFutureValue`|

+## Response

+If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_authentication"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/signInPreferences

+Content-Type: application/json

+{

+ "userPreferredMethodForSecondaryAuthentication": "oath"

+}

+```

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+### Response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+```http

+HTTP/1.1 204 No Content

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Delete authenticationConditionApplication (from a user flow)"

+description: "Remove an application from an externalUsersSelfServiceSignupEventsFlow."

+ms.localizationpriority: medium

+# Delete authenticationConditionApplication (from a user flow)

+Namespace: microsoft.graph

+Remove or unlink [an application](../resources/authenticationconditionapplication.md) from an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. This disables the authentication experience that's defined by the user flow for the application.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{appId}

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error will be returned with specific details.

+## Examples

+#### Request

+The following is an example of a request. `63856651-13d9-4784-9abf-20758d509e19` representes the **appId** of the application, also known as the client ID, not the object ID.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "delete_includeApplications"

+}

+-->

+``` http

+DELETE https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications/63856651-13d9-4784-9abf-20758d509e19

+```

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+#### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "List includeApplications (for a user flow)"

+description: "List applications for an externalusersselfservicesignupeventsflow."

+ms.localizationpriority: medium

+# List includeApplications (for a user flow)

+Namespace: microsoft.graph

+List the applications linked to an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. These are the applications for which the authentication experience that's defined by the user flow is enabled.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/

+```

+## 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.|

+|Content-Type|application/json. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` and a collection of [identityUserFlowAttribute](../resources/identityuserflowattribute.md) objects in the response body.

+## Examples

+### Request

+The following is an example of a request to retrieve the list of applications associated with a user flow.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_includeApplications"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications/

+```

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.authenticationConditionApplication"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications",

+ "value": [

+ {

+ "appId": "63856651-13d9-4784-9abf-20758d509e19"

+ }

+ ]

+}

+```

+ Title: "Add includeApplication (to a user flow)"

+description: "Add application to an externalusersselfservicesignupeventsflow."

+ms.localizationpriority: medium

+# Add includeApplication (to a user flow)

+Namespace: microsoft.graph

+Add or link an application to an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. This enables the authentication experience that's defined by the user flow to be enabled for the application. An application can only be linked to one user flow.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+In the request body, provide a JSON representation of the **appId** of the application to associate with the user flow.

+## Response

+If successful, this method returns a `201 Created` response code and a new [authenticationConditionApplication](../resources/authenticationconditionapplication.md) object in the response body. If unsuccessful, a `4xx` error will be returned with specific details.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "post_includeapplications"

+}

+-->

+``` http

+POST https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.authenticationConditionApplication",

+ "appId": "63856651-13d9-4784-9abf-20758d509e19"

+}

+```

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "@odata.type": "microsoft.graph.authenticationConditionApplication",

+ "truncated": true,

+}

+-->

+``` http

+HTTP/1.1 201 Created

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity",

+ "appId": "63856651-13d9-4784-9abf-20758d509e19"

+}

+```

+ "name": "delete_authenticationcontextclassreference",

+ "sampleKeys": ["c1"]

+# [Python](#tab/python)

+# [Python](#tab/python)

+> This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13671) and might require consent to multiple permissions.

+# [Python](#tab/python)

+ Title: "Delete authenticationEventListener"

+description: "Deletes an authenticationEventListener object."

+ms.localizationpriority: medium

+# Delete authenticationEventListener

+Namespace: microsoft.graph

+Deletes an [authenticationEventListener](../resources/authenticationeventlistener.md) object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identity/authenticationEventListeners/{authenticationEventListenerId}

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "delete_authenticationeventlistener"

+}

+-->

+``` http

+DELETE https://graph.microsoft.com/beta/identity/authenticationEventListeners/c7a1f2c5-3d36-4b3f-b75c-143af30a5246

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Get authenticationEventListener"

+description: "Read the properties and relationships of an authenticationEventListener object."

+ms.localizationpriority: medium

+# Get authenticationEventListener

+Namespace: microsoft.graph

+Read the properties and relationships of an [authenticationEventListener](../resources/authenticationeventlistener.md) object. The **@odata.type** property in the response object indicates the type of the authenticationEventListener object.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.Read.All, EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported|

+|Application|EventListener.Read.All, EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identity/authenticationEventListeners/{authenticationEventListenerId}

+```

+## 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.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and an [authenticationEventListener](../resources/authenticationeventlistener.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_authenticationeventlistener"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.authenticationEventListener"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/customAuthenticationExtensions/$entity",

+ "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",

+ "id": "6fc5012e-7665-43d6-9708-4370863f4e6e",

+ "displayName": "onTokenIssuanceStartCustomExtension",

+ "description": "Fetch additional claims from custom user store",

+ "clientConfiguration": null,

+ "behaviorOnError": null,

+ "authenticationConfiguration": {

+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",

+ "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"

+ },

+ "endpointConfiguration": {

+ "@odata.type": "#microsoft.graph.httpRequestEndpoint",

+ "targetUrl": "https://authenticationeventsAPI.contoso.com"

+ },

+ "claimsForTokenConfiguration": [

+ {

+ "claimIdInApiResponse": "DateOfBirth"

+ },

+ {

+ "claimIdInApiResponse": "CustomRoles"

+ }

+ ]

+}

+```

+ Title: "Update authenticationEventListener"

+description: "Update the properties of an authenticationEventListener object."

+ms.localizationpriority: medium

+# Update authenticationEventListener

+Namespace: microsoft.graph

+Update the properties of an [authenticationEventListener](../resources/authenticationeventlistener.md) object. You must specify the **@odata.type** property and the value of the [authenticationEventListener](../resources/authenticationeventlistener.md) object type to update.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /identity/authenticationEventListeners/{authenticationEventListenerId}

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+You must specify the **@odata.type** property and the value of the [authenticationEventListener](../resources/authenticationeventlistener.md) object type to update. For example, `"@odata.type": "#microsoft.graph.onTokenIssuanceStartListener"`.

+|Property|Type|Description|

+|:|:|:|

+|authenticationEventsFlowId|String|The identifier of the authentication events flow. Optional.|

+|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions on which this authenticationEventListener should trigger. Optional.|

+|handler|[onAttributeCollectionHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onAttributeCollectionListener** listener type.|

+|handler|[onAuthenticationMethodLoadStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onAuthenticationMethodLoadStartListener** listener type.|

+|handler|[onInteractiveAuthFlowStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onInteractiveAuthFlowStartListener** listener type.|

+|handler|[onTokenIssuanceStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onTokenIssuanceStartListener** listener type.|

+|handler|[onUserCreateStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onUserCreateStartListener** listener type.|

+|priority|Int32|The priority of this handler. Between 0 (lower priority) and 1000 (higher priority). Required.|

+## Response

+If successful, this method returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request to update an authentication event listener's trigger conditions or priority:

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_authenticationeventlistener"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identity/authenticationEventListeners/990d94e5-cc8f-4c4b-97b4-27e2678aac28

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",

+ "conditions": {

+ "applications": {

+ "includeAllApplications": false

+ }

+ },

+ "priority": 500

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Delete authenticationEventsFlow"

+description: "Delete an authenticationEventsFlow object."

+ms.localizationpriority: medium

+# Delete authenticationEventsFlow

+Namespace: microsoft.graph

+Delete a specific [authenticationEventsFlow](../resources/authenticationeventsflow.md) resource by ID. Only [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object types are available.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+DELETE /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `204 No Content` response code.

+## Examples

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "delete_authenticationeventsflow"

+}

+-->

+``` http

+DELETE https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+ Title: "Get authenticationEventsFlow"

+description: "Read the properties and relationships of an authenticationEventsFlow object."

+ms.localizationpriority: medium

+# Get authenticationEventsFlow

+Namespace: microsoft.graph

+Retrieve the properties and relationships of a specific [authenticationEventsFlow](../resources/authenticationeventsflow.md) object by ID. Only [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object types are available.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.Read.All, EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.Read.All, EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

+```

+## Optional query parameters

+This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object in the response body.

+## Examples

+### Request

+The following is an example of a request to retrieve a specific External Identities user flow.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_authenticationeventsflow"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response. In this example, the user flow retrieved is named "Woodgrove Drive Users Flow" and is set up to:

+- Allow users to create a local email with password account, or sign up with their Google or Facebook identity

+- Collect **Display Name** and **Favorite Color**

+- Create a "Member" user type.

+>**Note:** The response object shown here might be shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.authenticationEventsFlow"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "value": {

+ "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",

+ "id": "0313cc37-d421-421d-857b-87804d61e33e",

+ "displayName": "Woodgrove Drive User Flow",

+ "description": "For onboarding consumers to the Woodgrove Drive application",

+ "priority": 50,

+ "onAttributeCollectionStart": null,

+ "onAttributeCollectionSubmit": null,

+ "conditions": {

+ "applications": {

+ "includeAllApplications": false,

+ "includeApplications@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventsFlows('0313cc37-d421-421d-857b-87804d61e33e')/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications",

+ "includeApplications": []

+ }

+ },

+ "onInteractiveAuthFlowStart": {

+ "@odata.type": "#microsoft.graph.onInteractiveAuthFlowStartExternalUsersSelfServiceSignUp",

+ "isSignUpAllowed": true

+ },

+ "onAuthenticationMethodLoadStart": {

+ "@odata.type": "#microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp",

+ "identityProviders": [

+ {

+ "@odata.type": "#microsoft.graph.builtInIdentityProvider",

+ "id": "EmailPassword-OAUTH",

+ "displayName": "Email with password",

+ "identityProviderType": "EmailPassword",

+ "state": null

+ },

+ {

+ "@odata.type": "#microsoft.graph.socialIdentityProvider",

+ "id": "Google-OAUTH",

+ "displayName": "Google",

+ "identityProviderType": "Google",

+ "clientId": "137004260525-q8j2cp9hqceqa6hpvaa346e04g92tn8m.apps.googleusercontent.com",

+ "clientSecret": "******"

+ },

+ {

+ "@odata.type": "#microsoft.graph.socialIdentityProvider",

+ "id": "Facebook-OAUTH",

+ "displayName": "Facebook",

+ "identityProviderType": "Facebook",

+ "clientId": "236028191057849",

+ "clientSecret": "******"

+ }

+ ]

+ },

+ "onAttributeCollection": {

+ "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",

+ "accessPackages": [],

+ "attributeCollectionPage": {

+ "customStringsFileId": null,

+ "views": [

+ {

+ "title": null,

+ "description": null,

+ "inputs": [

+ {

+ "attribute": "email",

+ "label": "Email Address",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": true,

+ "editable": false,

+ "writeToDirectory": true,

+ "required": true,

+ "validationRegEx": "^[a-zA-Z0-9.!#$%&amp;&#8217;'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",

+ "options": []

+ },

+ {

+ "attribute": "displayName",

+ "label": "Display Name",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",

+ "options": []

+ },

+ {

+ "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",

+ "label": "Favorite color",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^.*",

+ "options": []

+ }

+ ]

+ }

+ ]

+ },

+ "attributes": [

+ {

+ "id": "email",

+ "displayName": "Email Address",

+ "description": "Email address of the user",

+ "userFlowAttributeType": "builtIn",

+ "dataType": "string"

+ },

+ {

+ "id": "displayName",

+ "displayName": "Display Name",

+ "description": "Display Name of the User.",

+ "userFlowAttributeType": "builtIn",

+ "dataType": "string"

+ },

+ {

+ "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",

+ "displayName": "Favorite color",

+ "description": "what is your favorite color",

+ "userFlowAttributeType": "custom",

+ "dataType": "string"

+ }

+ ]

+ },

+ "onUserCreateStart": {

+ "@odata.type": "#microsoft.graph.onUserCreateStartExternalUsersSelfServiceSignUp",

+ "userTypeToCreate": "member",

+ "accessPackages": []

+ }

+ }

+}

+```

+ Title: "Update authenticationEventsFlow"

+description: "Update the properties of an authenticationEventsFlow object."

+ms.localizationpriority: medium

+# Update authenticationEventsFlow

+Namespace: microsoft.graph

+Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only the [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type is supported.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+|Permission type|Permissions (from least to most privileged)|

+|:|:|

+|Delegated (work or school account)|EventListener.ReadWrite.All|

+|Delegated (personal Microsoft account)|Not supported.|

+|Application|EventListener.ReadWrite.All|

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

+```

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+|Content-Type|application/json. Required.|

+## Request body

+You must include the **@odata.type** property with a value of the specific user flow type in the body. For example, `"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow"`.

+|Property|Type|Description|

+|:|:|:|

+|id|String|The unique identifier for the entity. Read-only. |

+|displayName|String|The display name for the events policy. |

+|description|String|The description of the events policy.|

+|conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions representing the context of the authentication request which is used to decide whether the events policy is invoked. |

+|priority|Int32|The priority to use for each individual event of the events policy. If multiple competing listeners for an event have the same priority, one is chosen and an error is silently logged. |

+|onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|The configuration for what to invoke for the onInteractiveAuthFlowStart event. |

+|onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|The configuration for what to invoke for the onAuthenticationMethodLoadStart event. Must have at least one identity provider linked.|

+|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke for the onAttributeCollection event.|

+|onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|The configuration for what to invoke for the onUserCreateStart event.|

+## Response

+If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error will be returned with specific details.

+## Examples

+### Example 1: Update the display name and priority of an authenticationEventsFlow

+#### Request

+The following is an example of a request that updates the display name of a specific external identities user flow ( an authentication event type), as well as the priority for all the listeners associated with the policy.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "authenticationeventsflow_update_beta_e1"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",

+ "displayName": "New user flow description",

+ "priority": 200

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+### Example 2: Update the onAttributeCollection event of a self-service sign up user flow

+Add city (built-in attribute) as an attribute to be collected during the attribute collection step of a self-service sign up user flow. You must specify in the **inputs** object all attributes that you want to retain, otherwise they are removed from the user flow.

+#### Request

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_authenticationeventsflow_onattributecollection_beta_e2"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",

+ "onAttributeCollection": {

+ "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",

+ "attributeCollectionPage": {

+ "customStringsFileId": null,

+ "views": [

+ {

+ "title": null,

+ "description": null,

+ "inputs": [

+ {

+ "attribute": "email",

+ "label": "Email Address",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": true,

+ "editable": false,

+ "writeToDirectory": true,

+ "required": true,

+ "validationRegEx": "^[a-zA-Z0-9.!#$%&amp;&#8217;'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",

+ "options": []

+ },

+ {

+ "attribute": "displayName",

+ "label": "Display Name",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",

+ "options": []

+ },

+ {

+ "attribute": "city",

+ "label": "City",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",

+ "options": []

+ },

+ {

+ "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",

+ "label": "Favorite color",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^.*",

+ "options": []

+ }

+ ]

+ }

+ ]

+ }

+ }

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+### Example 3: Remove an attribute collected during a self-service sign up user flow

+Remove city as an attribute to be collected during the attribute collection step of a self-service sign up user flow. By excluding the city attribute from the request body, the attribute will be removed from the user flow.

+#### Request

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "update_authenticationeventsflow_onattributecollection_beta_e3"

+}

+-->

+``` http

+PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e

+Content-Type: application/json

+{

+ "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",

+ "onAttributeCollection": {

+ "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",

+ "attributeCollectionPage": {

+ "customStringsFileId": null,

+ "views": [

+ {

+ "title": null,

+ "description": null,

+ "inputs": [

+ {

+ "attribute": "email",

+ "label": "Email Address",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": true,

+ "editable": false,

+ "writeToDirectory": true,

+ "required": true,

+ "validationRegEx": "^[a-zA-Z0-9.!#$%&amp;&#8217;'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",

+ "options": []

+ },

+ {

+ "attribute": "displayName",

+ "label": "Display Name",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",

+ "options": []

+ },

+ {

+ "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",

+ "label": "Favorite color",

+ "inputType": "text",

+ "defaultValue": null,

+ "hidden": false,

+ "editable": true,

+ "writeToDirectory": true,

+ "required": false,

+ "validationRegEx": "^.*",

+ "options": []

+ }

+ ]

+ }

+ ]

+ }

+ }

+}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+#### Response

+The following is an example of the response

+<!-- {

+ "blockType": "response",

+ "truncated": true

+}

+-->

+``` http

+HTTP/1.1 204 No Content

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ "reportSuspiciousActivitySettings": {

+ "@odata.type": "#microsoft.graph.reportSuspiciousActivitySettings",

+ "state": "enabled",

+ "includeTarget": {

+ "targetType": "group",

+ "id": "all_users",

+ },

+ "voiceReportingCode": 0,

+ },

+

+|reportSuspiciousActivitySettings|[reportSuspiciousActivitySettings](../resources/reportsuspiciousactivitysettings.md)|Enable users to report voice or phone app multi-factor authentication notifications as suspicious.|

+ },

+ "reportSuspiciousActivitySettings": {

+ "state": "enabled",

+ "includeTarget": {

+ "targetType": "group",

+ "id": "all_users"

+ },

+ "voiceReportingCode": 0

+# [Python](#tab/python)

+ },

+ "reportSuspiciousActivitySettings": {

+ "state": "enabled",

+ "includeTarget": {

+ "targetType": "group",

+ "id": "all_users"

+ },

+ "voiceReportingCode": 0

+description: "Get a list of the authentication methods registered for a user as defined in the userRegistrationDetails object."

+Get a list of the authentication methods registered for a user as defined in the [userRegistrationDetails](../resources/userregistrationdetails.md) object.

+<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. -->

+|Delegated (work or school account)|AuditLog.Read.All|

+|Application|AuditLog.Read.All|

+The following is an example of the request.

+# [Python](#tab/python)

+The following is an example of the response.

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/authenticationMethods/userRegistrationDetails",

+ "value": [

+ {

+ "id": "86462606-fde0-4fc4-9e0c-a20eb73e54c6",

+ "userPrincipalName": "AlexW@Contoso.com",

+ "userDisplayName": "Alex Wilber",

+ "isAdmin": false,

+ "isSsprRegistered": false,

+ "isSsprEnabled": false,

+ "isSsprCapable": false,

+ "isMfaRegistered": true,

+ "isMfaCapable": true,

+ "isPasswordlessCapable": false,

+ "lastUpdatedDateTime": "2023-03-13T19:15:41.6195833Z",

+ "methodsRegistered": [

+ "microsoftAuthenticatorPush",

+ "softwareOneTimePasscode"

+ ],

+ "defaultMfaMethod": "microsoftAuthenticatorPush",

+ "isSystemPreferredAuthenticationMethodEnabled": true,

+ "systemPreferredAuthenticationMethods": [

+ "push"

+ ],

+ "userPreferredMethodForSecondaryAuthentication": "push",

+ "userType": "member"

+ },

+ {

+ "id": "c6ad1942-4afa-47f8-8d48-afb5d8d69d2f",

+ "userPrincipalName": "AllanD@Contoso.com",

+ "userDisplayName": "Allan Deyoung",

+ "isAdmin": false,

+ "isSsprRegistered": false,

+ "isSsprEnabled": false,

+ "isSsprCapable": false,

+ "isMfaRegistered": false,

+ "isMfaCapable": false,

+ "isPasswordlessCapable": false,

+ "lastUpdatedDateTime": "2023-03-13T19:15:41.6195833Z",

+ "methodsRegistered": [],

+ "defaultMfaMethod": "",

+ "isSystemPreferredAuthenticationMethodEnabled": true,

+ "systemPreferredAuthenticationMethods": [],

+ "userPreferredMethodForSecondaryAuthentication": "",

+ "userType": "guest"

+ },

+ {

+ "id": "c8096958-797c-44fa-8fde-a6fb62567cf0",

+ "userPrincipalName": "BiancaP@Contoso.com",

+ "userDisplayName": "Bianca Pisani",

+ "isAdmin": false,

+ "isSsprRegistered": true,

+ "isSsprEnabled": false,

+ "isSsprCapable": false,

+ "isMfaRegistered": true,

+ "isMfaCapable": true,

+ "isPasswordlessCapable": false,

+ "lastUpdatedDateTime": "2023-03-13T19:15:41.6195833Z",

+ "methodsRegistered": [

+ "mobilePhone",

+ "microsoftAuthenticatorPush",

+ "softwareOneTimePasscode"

+ ],

+ "defaultMfaMethod": "mobilePhone",

+ "isSystemPreferredAuthenticationMethodEnabled": true,

+ "systemPreferredAuthenticationMethods": [

+ "push"

+ ],

+ "userPreferredMethodForSecondaryAuthentication": "voiceMobile",

+ "userType": "member"

+ }

+ ]

+To access the API, [one of the following roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles) is required:

+* Reports Reader

+* Security Reader

+* Security Administrator

+* Global Reader

+* Global Administrator

+|includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.|

+* Global Administrator

+* Security Administrator

+* Conditional Access Administrator

+* Exchange Administrator

+* SharePoint Administrator

+* Helpdesk Administrator

+* Billing Administrator

+* User Administrator

+* Authentication Administrator

+The value `admin` includes all Azure Active Director admin roles.

+The following is an example of the request.

+# [PowerShell](#tab/powershell)

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+ "@odata.type": "#microsoft.graph.userRegistrationFeatureSummary",

+ "totalUserCount": 23123,

+ "userTypes": "all",

+ "userRoles": "all",

+ "userRegistrationFeatureCounts": [

+ {

+ "feature": "ssprRegistered",

+ "userCount": 23423

+ },

+ {

+ "feature": "ssprEnabled",

+ "userCount": 4234

+ },

+ {

+ "feature": "ssprCapable",

+ "userCount": 4234

+ },

+ {

+ "feature": "passwordlessCapable",

+ "userCount": 323

+ },

+ {

+ "feature": "mfaCapable",

+ "userCount": 3345

+ }

+ ]

+To access the API, [one of the following roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles) is required:

+* Reports Reader

+* Security Reader

+* Security Administrator

+* Global Reader

+* Global Administrator

+|includedUserRoles|includedUserRoles|The role type for the user. Possible values are: `all`, `privilegedAdmin`, `admin`, `user`.|

+* Global Administrator

+* Security Administrator

+* Conditional Access Administrator

+* Exchange Administrator

+* SharePoint Administrator

+* Helpdesk Administrator

+* Billing Administrator

+* User Administrator

+* Authentication Administrator

+The value `admin` includes all Azure Active Directory admin roles.

+The following is an example of the request.

+The following is an example of the response.

+>**Note:** The response object shown here might be shortened for readability.

+ "@odata.type": "#microsoft.graph.userRegistrationMethodSummary",

+ "userTypes": "all",

+ "userRoles": "all",

+ "userRegistrationMethodCounts": [

+ {

+ "authenticationMethod": "password",

+ "userCount": 12209

+ },

+ {

+ "authenticationMethod": "windowsHelloForBusiness",

+ "userCount": 223

+ },

+ {

+ "authenticationMethod": "mobilePhone",

+ "userCount": 4234

+ }

+ ]

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [HTTP](#tab/http)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+```

+# [Python](#tab/python)

+When calling on behalf of a user, the user needs to have the *Privileged Role Administrator* [Azure AD role](/azure/active-directory/roles/permissions-reference).

+|allowUserConsentForRiskyApps|Boolean| Indicates whether [user consent for risky apps](/azure/active-directory/manage-apps/configure-risk-based-step-up-consent) is allowed. Default value is `false`. We recommend that you keep the value set to `false`.|

+|allowedToSignUpEmailBasedSubscriptions|Boolean| Indicates whether users can sign up for email-based subscriptions. |

+|allowedToUseSSPR|Boolean| Indicates whether users can use the Self-Serve Password Reset feature on the tenant. |

+|blockMsolPowerShell|Boolean| To disable the use of MSOL PowerShell, set this property to `true`. This also disables user-based access to the legacy service endpoint used by MSOL PowerShell. This does not affect Azure Active Directory Connect or Microsoft Graph. |

+|enabledPreviewFeatures|String collection| List of features enabled for private preview on the tenant. |

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+ Title: "Get azureADAuthentication"

+description: "Read the properties and relationships of an azureADAuthentication object to find Azure AD SLA attainment for your tenant."

+ms.localizationpriority: medium

+# Get azureADAuthentication

+Namespace: microsoft.graph

+Read the properties and relationships of an [azureADAuthentication](../resources/azureadauthentication.md) object to find the level of Azure AD authentication availability for your tenant. The Azure AD Service Level Agreement (SLA) commits to at least 99.99% authentication availability, as described in [Azure Active Directory 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.

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+|:|:--|

+| Delegated (work or school account) | Reports.Read.All |

+| Application | Reports.Read.All |

+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 [Azure AD built-in roles](/azure/active-directory/roles/permissions-reference):

+## HTTP request

+<!-- {

+ "blockType": "ignored"

+}

+-->

+``` http

+GET /reports/sla/azureADAuthentication

+```

+## Optional query parameters

+This method doesn't take any parameters.

+## Request headers

+|Name|Description|

+|:|:|

+|Authorization|Bearer {token}. Required.|

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200 OK` response code and 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

+### Request

+The following is an example of a request.

+# [HTTP](#tab/http)

+<!-- {

+ "blockType": "request",

+ "name": "get_azureadauthentication"

+}

+-->

+``` http

+GET https://graph.microsoft.com/beta/reports/sla/azureADAuthentication

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+### Response

+The following is an example of the response

+>**Note:** The response object shown here is shortened for readability.

+<!-- {

+ "blockType": "response",

+ "truncated": true,

+ "@odata.type": "microsoft.graph.azureADAuthentication"

+}

+-->

+``` http

+HTTP/1.1 200 OK

+Content-Type: application/json

+{

+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/sla/azureADAuthentication/$entity",

+ "attainments": [

+ {

+ "startDate": "2023-05-01",

+ "endDate": "2023-05-31",

+ "score": 99.999

+ },

+ {

+ "startDate": "2023-04-01",

+ "endDate": "2023-04-30",

+ "score": 99.999

+ },

+ {

+ "startDate": "2023-03-01",

+ "endDate": "2023-03-31",

+ "score": 99.999

+ },

+ {

+ "startDate": "2023-02-01",

+ "endDate": "2023-02-28",

+ "score": 99.999

+ },

+ {

+ "startDate": "2023-01-01",

+ "endDate": "2023-01-31",

+ "score": 99.998

+ },

+ {

+ "startDate": "2022-12-01",

+ "endDate": "2022-12-31",

+ "score": 99.999

+ },

+ ]

+}

+```

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+If successful, this method returns a `200 OK` response code and a [b2cIdentityUserFlow](../resources/b2cidentityuserflow.md) object in the response body.

+# [Python](#tab/python)

+If successful, this method returns a `200 OK` response code and a collection of [identityProvider](../resources/identityprovider.md) objects in the response body.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+If successful, this method returns a `200 OK` response code and a collection of [identityProviderBase](../resources/identityproviderbase.md) objects in the response body.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+DELETE /identity/b2xUserFlows/{userflow-id}/userflowIdentityProviders/{id}/$ref

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+If successful, this method returns a `200 OK` response code and a [b2xIdentityUserFlow](../resources/b2xidentityuserflow.md) object in the response body.

+# [Python](#tab/python)

+If successful, this method returns a `200 OK` response code and a collection of [identityProvider](../resources/identityprovider.md) objects in the response body.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+If successful, this method returns a `200 OK` response code and a collection of [identityProviderBase](../resources/identityproviderbase.md) objects in the response body.

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+description: "Delete a sitePage from the site pages list in a site."

+ Title: "Delete baseSitePage"

+ms.localizationpriority: medium

+# Delete baseSitePage

+Namespace: microsoft.graph

+Delete a [baseSitePage][] from the site pages [list][] in a [site][].

+[baseSitePage]: ../resources/basesitepage.md

+[list]: ../resources/list.md

+[site]: ../resources/site.md

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+>**Note:** To delete an item, the user must have granted the application write access to the item to be deleted.

+|Permission type | Permissions (from least to most privileged) |

+|:--|:|

+|Delegated (work or school account) | Sites.ReadWrite.All |

+|Delegated (personal Microsoft account) | Not supported. |

+|Application | Sites.ReadWrite.All |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+DELETE /sites/{site-id}/pages/{page-id}

+```

+## Request headers

+| Name | Value | Description

+|:--|:|:--

+|Authorization|Bearer {token}.| Required|

+| _if-match_ | etag | If this request header is included and the eTag provided does not match the current tag on the item, a `412 Precondition Failed` response is returned and the item will not be deleted.

+## Request body

+Do not supply a request body with this method.

+## Response

+If successful, this method returns a `204 No Content`. It does not return anything in the response body.

+## Example

+<!-- { "blockType": "request", "name": "delete-page", "scopes": "files.readwrite sites.readwrite.all" } -->

+### Request

+The following is an example of the request.

+```http

+DELETE /sites/{site-id}/pages/{page-id}

+```

+### Response

+The following is an example of the response.

+<!-- { "blockType": "response" } -->

+```http

+HTTP/1.1 204 No Content

+```

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Delete a page in the SitePages list in a site.",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "Pages/Delete",

+ "suppressions": []

+}

+-->

+description: "Read the properties and relationships of a baseSitePage object."

+ Title: Get baseSitePage

+ms.localizationpriority: medium

+# Get baseSitePage

+Namespace: microsoft.graph

+Get the metadata for a [baseSitePage][] in the site pages [list][] in a [site][].

+[baseSitePage]: ../resources/baseSitePage.md

+[list]: ../resources/list.md

+[site]: ../resources/site.md

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+| :- | : |

+| Delegated (work or school account) | Sites.Read.All, Sites.ReadWrite.All |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Sites.Read.All, Sites.ReadWrite.All |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+GET /sites/{site-id}/pages/{page-id}

+```

+## Optional query parameters

+This method supports the `$count`, `$expand`, `$filter`, `$orderBy`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response.

+## Request headers

+| Name | Description |

+| : | :-- |

+| Authorization | Bearer {token}. Required. |

+| Content-Type | application/json. Required. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200` and a [baseSitePage](../resources/baseSitePage.md) object in the response body.

+## Example

+### Request

+# [HTTP](#tab/http)

+<!--{

+ "blockType": "request",

+ "name": "get-basesitepage",

+ "scopes": "sites.read.all",

+ "tags": "service.sharepoint"

+}

+-->

+```msgraph-interactive

+GET /sites/{site-id}/pages/{page-id}

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+> **Note:** The response object shown here might be shortened for readability.

+<!--

+{

+ "blockType": "response",

+ "@odata.type": "microsoft.graph.baseSitePage",

+ "truncated": true,

+ "isCollection":false

+}

+-->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+{

+ "@odata.type": "#microsoft.graph.sitePage",

+ "@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",

+ "description": "Reiciendis placeat dolores.Mollitia veniam tempora tempora quidem voluptatum.Quos animi maiores facilis.Dolores officiis consequatur provident beatae deleniti accusamus magni quam tenetur.",

+ "eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"",

+ "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45",

+ "lastModifiedDateTime": "2023-04-16T10:01:41Z",

+ "name": "Electronic Convertible.aspx",

+ "webUrl": "SitePages/Electronic Convertible.aspx",

+ "title": "Electronic Convertible",

+ "pageLayout": "article",

+ "thumbnailWebUrl": "https://media.akamai.odsp.cdn.office.net/_layouts/15/images/sitepagethumbnail.png",

+ "promotionKind": "page",

+ "showComments": false,

+ "showRecommendedPages": true,

+ "contentType": {

+ "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",

+ "name": "Site Page"

+ },

+ "createdBy": {

+ "user": {

+ "displayName": "admin_contoso",

+ "email": "admin@contoso.onmicrosoft.com"

+ }

+ },

+ "lastModifiedBy": {

+ "user": {

+ "displayName": "admin_contoso",

+ "email": "admin@contoso.onmicrosoft.com"

+ }

+ },

+ "parentReference": {

+ "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"

+ },

+ "publishingState": {

+ "level": "draft",

+ "versionId": "0.4"

+ },

+ "reactions": {}

+}

+```

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Get a page in a site",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "Pages/Get",

+ "suppressions": [

+ ]

+}

+-->

+description: 'Get the collection of baseSitePage objects from the site pages [list] in a site. All pages in the site are returned (with pagination).'

+ Title: List baseSitePage

+ms.localizationpriority: medium

+# List baseSitePage

+Namespace: microsoft.graph

+Get the collection of [baseSitePage][] objects from the site pages [list][] in a [site][]. All pages in the site are returned (with pagination). Sort alphabetically by `name` in ascending order.

+> **Note:** The [baseSitePage][] specified is a parent type and does not have any instance. As a result, the returned data will only consist of available subtypes, which will be provided as a list.

+**The following table lists the available subtypes.**

+| Entity name | Description |

+| :-- | : |

+| [sitePage][] | Represents a regular page |

+[basesitepage]: ../resources/baseSitePage.md

+[sitepage]: ../resources/sitePage.md

+[list]: ../resources/list.md

+[site]: ../resources/site.md

+## Permissions

+One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference).

+| Permission type | Permissions (from least to most privileged) |

+| :- | : |

+| Delegated (work or school account) | Sites.Read.All, Sites.ReadWrite.All |

+| Delegated (personal Microsoft account) | Not supported. |

+| Application | Sites.Read.All, Sites.ReadWrite.All |

+## HTTP request

+<!-- { "blockType": "ignored" } -->

+```http

+GET /sites/{site-id}/pages

+```

+## Optional query parameters

+This method supports the `$count`, `$expand`, `$filter`, `$orderBy`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response.

+## Request headers

+| Name | Description |

+| : | :-- |

+| Authorization | Bearer {token}. Required. |

+| Content-Type | application/json. Required. |

+## Request body

+Do not supply a request body for this method.

+## Response

+If successful, this method returns a `200` and a list of [baseSitePage](../resources/baseSitePage.md) object in the response body.

+## Example

+### Request

+# [HTTP](#tab/http)

+<!--{

+ "blockType": "request",

+ "name": "get-basesitepages",

+ "scopes": "sites.read.all",

+ "tags": "service.sharepoint"

+}

+-->

+```msgraph-interactive

+GET /sites/{site-id}/pages

+```

+# [C#](#tab/csharp)

+# [Go](#tab/go)

+# [Java](#tab/java)

+# [JavaScript](#tab/javascript)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+### Response

+<!--

+{

+ "blockType": "response",

+ "@odata.type": "microsoft.graph.baseSitePage",

+ "truncated": true,

+ "isCollection":true

+}

+-->

+```http

+HTTP/1.1 200 OK

+Content-type: application/json

+{

+ "value": [

+ {

+ "@odata.type": "#microsoft.graph.sitePage",

+ "@odata.etag": "\"{5FA48F95-2FDF-40E8-A28C-6D0D8345BCD2},8\"",

+ "description": "Placeat porro perspiciatis maxime esse nobis illo.Voluptate vitae maxime totam consectetur fugit sit quos.Saepe ea veniam voluptate tempore quod deleniti necessitatibus repellat.",

+ "eTag": "\"{5FA48F95-2FDF-40E8-A28C-6D0D8345BCD2},8\"",

+ "id": "5fa48f95-2fdf-40e8-a28c-6d0d8345bcd2",

+ "lastModifiedDateTime": "2023-04-16T08:37:51Z",

+ "name": "Account holistic.aspx",

+ "webUrl": "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",

+ "promotionKind": "page",

+ "showComments": false,

+ "showRecommendedPages": false,

+ "contentType": {

+ "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",

+ "name": "Site Page"

+ },

+ "createdBy": {

+ "user": {

+ "displayName": "admin_contoso",

+ "email": "admin@contoso.onmicrosoft.com"

+ }

+ },

+ "lastModifiedBy": {

+ "user": {

+ "displayName": "admin_contoso",

+ "email": "admin@contoso.onmicrosoft.com"

+ }

+ },

+ "parentReference": {

+ "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"

+ },

+ "publishingState": {

+ "level": "draft",

+ "versionId": "0.4"

+ },

+ "reactions": {}

+ },

+ {

+ "@odata.type": "#microsoft.graph.sitePage",

+ "@odata.etag": "\"{DA0F67BE-977E-4D09-88AC-506A1002E678},5\"",

+ "eTag": "\"{DA0F67BE-977E-4D09-88AC-506A1002E678},5\"",

+ "id": "da0f67be-977e-4d09-88ac-506a1002e678",

+ "lastModifiedDateTime": "2023-04-16T06:39:30Z",

+ "name": "Analyst Fresh.aspx",

+ "webUrl": "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",

+ "promotionKind": "page",

+ "showComments": false,

+ "showRecommendedPages": false,

+ "contentType": {

+ "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A",

+ "name": "Site Page"

+ },

+ "createdBy": {

+ "user": {

+ "displayName": "admin_contoso",

+ "email": "admin@contoso.onmicrosoft.com"

+ }

+ },

+ "lastModifiedBy": {

+ "user": {

+ "displayName": "admin_contoso",

+ "email": "admin@contoso.onmicrosoft.com"

+ }

+ },

+ "parentReference": {

+ "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3"

+ },

+ "publishingState": {

+ "level": "draft",

+ "versionId": "0.1"

+ },

+ "reactions": {},

+ "titleArea": {

+ "enableGradientEffect": false,

+ "imageWebUrl": "https://loremflickr.com/640/480",

+ "layout": "plain",

+ "showAuthor": false,

+ "showPublishedDate": false,

+ "showTextBlockAboveTitle": false,

+ "textAboveTitle": "generating ADP",

+ "textAlignment": "center",

+ "title": "strategic underneath protocol Buckinghamshire forecast",

+ "authors@odata.type": "#Collection(String)",

+ "authors": [],

+ "authorByline@odata.type": "#Collection(String)",

+ "authorByline": [],

+ "imageSourceType": 4,

+ "serverProcessedContent": {

+ "htmlStrings": [],

+ "searchablePlainTexts": [],

+ "links": [],

+ "imageSources": []

+ }

+ }

+ }

+ ]

+}

+```

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Enumerate the list of pages in a site",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "Pages/Enumerate",

+ "suppressions": [

+ ]

+}

+-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Delete baseTask",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!-- {

+ "type": "#page.annotation",

+ "description": "baseTask: delta",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/delta

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Get baseTask",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "List linkedResources",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}/linkedResources

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!-- {

+ "type": "#page.annotation",

+ "description": "baseTask: move",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}/move

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Create checklistItem",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}/checklistItems

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Create linkedResource_v2",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}/linkedResources

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Update baseTask",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks/{var}

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!-- {

+ "type": "#page.annotation",

+ "description": "baseTaskList: delta",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/delta

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "List baseTasks",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+<!--

+{

+ "type": "#page.annotation",

+ "description": "Create baseTask",

+ "keywords": "",

+ "section": "documentation",

+ "tocPath": "",

+ "suppressions": [

+ "Error: microsoft.graph.microsoft.graph/me:

+ /me/tasks/lists/{var}/tasks

+ Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'user'. Possible issues:

+ 1) Doc bug where 'tasks' isn't defined on the resource.

+ 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation.

+ 3) Doc bug where 'user' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation."

+ ]

+}

+-->

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+You can also query for Bookings businesses by specifying a string in a `query` parameter to do substring matching among the businesses of a tenant. For details, see [Example 2](#example-2-query-parameter).

+> **Note:** Results are limited to 500 mailboxes. Pagination of the results is not currently supported.

+This method supports some of the [OData query parameters](/graph/query-parameters) to help customize the response.

+This method also supports the `query` parameter which accepts a string value. This parameter limits the GET results to businesses that match the specified string.

+## Examples

+### Example 1: Get the Bookings buinsesses in a tenant

+#### Request

+# [Python](#tab/python)

+#### Response

+### Example 2: Query parameter

+#### Request

+# [Python](#tab/python)

+#### Response

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [PHP](#tab/php)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [Python](#tab/python)

+# [PHP](#tab/php)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)

+# [Python](#tab/python)

+# [PowerShell](#tab/powershell)