Intended for a full management experience. Typical target user is the administrator of an organization.| No | No | | _Calendars.Read_ |Read user calendars |Allows the app to read events in user calendars. |No | Yes | | _Calendars.Read.Shared_ |Read user and shared calendars |Allows the app to read events in all calendars that the user can access, including delegate and shared calendars. |No | No | | _Calendars.ReadWrite_ |Have full access to user calendars |Allows the app to create, read, update, and delete events in user calendars. |No | Yes | | _Calendars.ReadWrite.Shared_ |Read and write user and shared calendars |Allows the app to create, read, update and delete events in all calendars the user has permissions to access. This includes delegate and shared calendars.|No | No | |_Contacts.Read_ |Read user contacts |Allows the app to read user contacts. |No | Yes | |_Contacts.Read.Shared_ |Read user and shared contacts |Allows the app to read contacts that the user has permissions to access, including the user's own and shared contacts. |No |No| |_Contacts.ReadWrite_ |Have full access to user contacts |Allows the app to create, read, update, and delete user contacts. |No |Yes| |_Contacts.ReadWrite.Shared_ |Read and write user and shared contacts |Allows the app to create, read, update and delete contacts that the user has permissions to, including the user's own and shared contacts. |No |No| |_Device.Read_ |Read user devices |Allows the app to read a user's list of devices on behalf of the signed-in user. |No | Yes | |_Device.Command_ |Communicate with user devices |Allows the app to launch another app or communicate with another app on a user's device on behalf of the signed-in user. |No | Yes | | _Directory.Read.All_ |Read directory data | Allows the app to read data in your organization's directory, such as users, groups and apps. **Note**: Users may consent to applications that require this permission if the application is registered in their own organization’s tenant.| Yes | No | | _Directory.ReadWrite.All_ |Read and write directory data | Allows the app to read and write data in your organization's directory, such as users, and groups. It does not allow the app to delete users or groups, or reset user passwords. | Yes | No | | _Directory.AccessAsUser.All_ |Access directory as the signed-in user | Allows the app to have the same access to information in the directory as the signed-in user. | Yes | No | |EduAdministration.Read | Read education app settings | Allows the app to read education app settings on behalf of the user. | Yes | No | |EduAdministration.ReadWrite | Manage education app settings | Allows the app to manage education app settings on behalf of the user. | Yes | No | |EduAssignments.ReadBasic | Read users' class assignments without grades | Allows the app to read assignments without grades on behalf of the user | Yes | No | |EduAssignments.ReadWriteBasic | Read and write users' class assignments without grades | Allows the app to read and write assignments without grades on behalf of the user | Yes | No | |EduAssignments.Read | Read users' view of class assignments and their grades | Allows the app to read assignments and their grades on behalf of the user| Yes | No | |EduAssignments.ReadWrite | Read and write users' view of class assignments and their grades | Allows the app to read and write assignments and their grades on behalf of the user|Yes | No | |EduRostering.ReadBasic| Read a limited subset of users' view of the roster | Allows the app to read a limited subset of the data from the structure of schools and classes in an organization's roster and education-specific information about users to be read on behalf of the user. | Yes | No | | _Files.Read_ | Read user files | Allows the app to read the signed-in user's files. | No | Yes | | _Files.Read.All_ | Read all files that user can access | Allows the app to read all files the signed-in user can access. | No | Yes | | _Files.ReadWrite_ | Have full access to user files | Allows the app to read, create, update, and delete the signed-in user's files. | No| Yes | | _Files.ReadWrite.All_ | Have full access to all files user can access | Allows the app to read, create, update, and delete all files the signed-in user can access. | No | Yes | | _Files.ReadWrite.AppFolder_ | Have full access to the application's folder (preview) | (Preview) Allows the app to read, create, update, and delete files in the application's folder. | No | No | | _Files.Read.Selected_ | Read files that the user selects | **Limited support in Microsoft Graph; see Remarks**
(Preview) Allows the app to read files that the user selects. The app has access for several hours after the user selects a file. | No | No | | _Files.ReadWrite.Selected_ | Read and write files that the user selects | **Limited support in Microsoft Graph; see Remarks**
(Preview) Allows the app to read and write files that the user selects. The app has access for several hours after the user selects a file. | No | No | | _Group.Read.All_ | Read all groups | Allows the app to list groups, and to read their properties and all group memberships on behalf of the signed-in user. Also allows the app to read calendar, conversations, files, and other group content for all groups the signed-in user can access. | Yes | No | | _Group.ReadWrite.All_ | Read and write all groups| Allows the app to create groups and read all group properties and memberships on behalf of the signed-in user. Additionally allows group owners to manage their groups and allows group members to update group content. | Yes | No | | _IdentityRiskEvent.Read.All_ | Read identity risk event information | Allows the app to read identity risk event information for all users in your organization on behalf of the signed-in user. | Yes | No | | _IdentityProvider.Read.All_ | Read identity provider information | Allows the app to read identity providers configured in your Azure AD or Azure AD B2C tenant on behalf of the signed-in user. | Yes | No | | _IdentityProvider.ReadWrite.All_ | Read and write identity provider information | Allows the app to read or write identity providers configured in your Azure AD or Azure AD B2C tenant on behalf of the signed-in user. | Yes | No | |_DeviceManagementApps.Read.All_ | Read Microsoft Intune apps | Allows the app to read the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune. | Yes | No | |_DeviceManagementApps.ReadWrite.All_ | Read and write Microsoft Intune apps | Allows the app to read and write the properties, group assignments and status of apps, app configurations and app protection policies managed by Microsoft Intune. | Yes | No | |_DeviceManagementConfiguration.Read.All_ | Read Microsoft Intune device configuration and policies | Allows the app to read properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups. | Yes | No | |_DeviceManagementConfiguration.ReadWrite.All_ | Read and write Microsoft Intune device configuration and policies | Allows the app to read and write properties of Microsoft Intune-managed device configuration and device compliance policies and their assignment to groups. | Yes | No | |_DeviceManagementManagedDevices.PrivilegedOperations.All_ | Perform user-impacting remote actions on Microsoft Intune devices | Allows the app to perform remote high impact actions such as wiping the device or resetting the passcode on devices managed by Microsoft Intune. | Yes | No | |_DeviceManagementManagedDevices.Read.All_ | Read Microsoft Intune devices | Allows the app to read the properties of devices managed by Microsoft Intune. | Yes | No | |_DeviceManagementManagedDevices.ReadWrite.All_ | Read and write Microsoft Intune devices | Allows the app to read and write the properties of devices managed by Microsoft Intune. Does not allow high impact operations such as remote wipe and password reset on the device’s owner. | Yes | No | |_DeviceManagementRBAC.Read.All_ | Read Microsoft Intune RBAC settings | Allows the app to read the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings. | Yes | No | |_DeviceManagementRBAC.ReadWrite.All_ | Read and write Microsoft Intune RBAC settings | Allows the app to read and write the properties relating to the Microsoft Intune Role-Based Access Control (RBAC) settings. | Yes | No | |_DeviceManagementServiceConfig.Read.All_ | Read Microsoft Intune configuration | Allows the app to read Intune service properties including device enrollment and third party service connection configuration. | Yes | No | |_DeviceManagementServiceConfig.ReadWrite.All_ | Read and write Microsoft Intune configuration | Allows the app to read and write Microsoft Intune service properties including device enrollment and third party service connection configuration. | Yes | No | | _Mail.Read_ | Read user mail | Allows the app to read email in user mailboxes. | No | Yes | _Mail.ReadWrite_ | Read and write access to user mail | Allows the app to create, read, update, and delete email in user mailboxes. Does not include permission to send mail.| No | Yes | _Mail.Read.Shared_ | Read user and shared mail | Allows the app to read mail that the user can access, including the user's own and shared mail. | No | No | _Mail.ReadWrite.Shared_ | Read and write user and shared mail | Allows the app to create, read, update, and delete mail that the user has permission to access, including the user's own and shared mail. Does not include permission to send mail. | No | No | _Mail.Send_ | Send mail as a user | Allows the app to send mail as users in the organization. | No | No | _Mail.Send.Shared_ | Send mail on behalf of others | Allows the app to send mail as the signed-in user, including sending on-behalf of others. | No | No | _MailboxSettings.Read_ | Read user mailbox settings | Allows the app to the read user's mailbox settings. Does not include permission to send mail. | No | No | _MailboxSettings.ReadWrite_ | Read and write user mailbox settings | Allows the app to create, read, update, and delete user's mailbox settings. Does not include permission to directly send mail, but allows the app to create rules that can forward or redirect messages. | No | No | _Member.Read.Hidden_ | Read hidden memberships | Allows the app to read the memberships of hidden groups and administrative units on behalf of the signed-in user, for those hidden groups and administrative units that the signed-in user has access to. | Yes | No | | _Notes.Read_ | Read user OneNote notebooks | Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user. | No | Yes | _Notes.Create_ | Create user OneNote notebooks | Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user.| No | Yes | _Notes.ReadWrite_ | Read and write user OneNote notebooks | Allows the app to read, share, and modify OneNote notebooks on behalf of the signed-in user. | No | Yes | _Notes.Read.All_ | Read all OneNote notebooks that user can access | Allows the app to read OneNote notebooks that the signed-in user has access to in the organization. | No | Yes | _Notes.ReadWrite.All_ | Read and write all OneNote notebooks that user can access | Allows the app to read, share, and modify OneNote notebooks that the signed-in user has access to in the organization.| No | No | _Notes.ReadWrite.CreatedByApp_ | Limited notebook access (deprecated) | **Deprecated**
Do not use. No privileges are granted by this permission. | No | No | _email_ | View users' email address | Allows the app to read your users' primary email address. | No | No | | _offline_access_ | Access user's data anytime | Allows the app to read and update user data, even when they are not currently using the app.| No | No | | _openid_ | Sign users in | Allows users to sign in to the app with their work or school accounts and allows the app to see basic user profile information.| No | No | | _profile_ | View users' basic profile | Allows the app to see your users' basic profile (name, picture, user name).| No | No | | _People.Read_ | Read users' relevant people lists | Allows the app to read a scored list of people relevant to the signed-in user. The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications (such as email and Skype). | No | No | | _People.Read.All_ | Read all users' relevant people lists | Allows the app to read a scored list of people relevant to the signed-in user or other users in the signed-in user's organization. The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications (such as email and Skype). Also allows the app to search the entire directory of the signed-in user's organization. | Yes | No | | _Reports.Read.All_ | Read all usage reports | Allows an app to read all service usage reports without a signed-in user. Services that provide usage reports include Office 365 and Azure Active Directory. | Yes | No | | _SecurityEvents.Read.All_ | Read your organization’s security events | Allows the app to read your organization’s security events on behalf of the signed-in user. | Yes | No | | _SecurityEvents.ReadWrite.All_ | Read and update your organization’s security events | Allows the app to read your organization’s security events on behalf of the signed-in user. Also allows the app to update editable properties in security events on behalf of the signed-in user. | Yes | No | | _Sites.Read.All_ | Read items in all site collections | Allows the app to read documents and list items in all site collections on behalf of the signed-in user. | No | No | | _Sites.ReadWrite.All_ | Read and write items in all site collections | Allows the app to edit or delete documents and list items in all site collections on behalf of the signed-in user. | No | No | | _Sites.Manage.All_ | Create, edit, and delete items and lists in all site collections | Allows the app to manage and create lists, documents, and list items in all site collections on behalf of the signed-in user. | No | No | | _Sites.FullControl.All_ | Have full control of all site collections | Allows the app to have full control to SharePoint sites in all site collections on behalf of the signed-in user. | Yes | No | | _Tasks.Read_ | Read user tasks | Allows the app to read user tasks. | No | Yes | | _Tasks.Read.Shared_ | Read user and shared tasks | Allows the app to read tasks a user has permissions to access, including their own and shared tasks. | No | No | | _Tasks.ReadWrite_ | Create, read, update and delete user tasks and containers | Allows the app to create, read, update and delete tasks and containers (and tasks in them) that are assigned to or shared with the signed-in user.| No | Yes | | _Tasks.ReadWrite.Shared_ | Read and write user and shared tasks | Allows the app to create, read, update, and delete tasks a user has permissions to, including their own and shared tasks. | No | No | | _Agreement.Read.All_ | Read all terms of use agreements | Allows the app to read terms of use agreements on behalf of the signed-in user. | Yes | No | | _Agreement.ReadWrite.All_ | Read and write all terms of use agreements | Allows the app to read and write terms of use agreements on behalf of the signed-in user. | Yes | No | | _AgreementAcceptance.Read_ | Read user terms of use acceptance statuses | Allows the app to read terms of use acceptance statuses on behalf of the signed-in user. | Yes | No | | _AgreementAcceptance.Read.All_ | Read terms of use acceptance statuses that user can access | Allows the app to read terms of use acceptance statuses on behalf of the signed-in user. | Yes | No | | _User.Read_ | Sign-in and read user profile | Allows users to sign-in to the app, and allows the app to read the profile of signed-in users. It also allows the app to read basic company information of signed-in users.| No | Yes | | _User.ReadWrite_ | Read and write access to user profile | Allows the app to read the signed-in user's full profile. It also allows the app to update the signed-in user's profile information on their behalf. | No | Yes | | _User.ReadBasic.All_ | Read all users' basic profiles | Allows the app to read a basic set of profile properties of other users in your organization on behalf of the signed-in user. This includes display name, first and last name, email address, open extensions and photo. Also allows the app to read the full profile of the signed-in user. | No | Yes | | _User.Read.All_ | Read all users' full profiles | Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. | Yes | Yes | | _User.ReadWrite.All_ | Read and write all users' full profiles | Allows the app to read and write the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. Also allows the app to create and delete users as well as reset user passwords on behalf of the signed-in user. | Yes | Yes | | _User.Invite.All_ | Invite guest users to the organization | Allows the app to invite guest users to your organization, on behalf of the signed-in user. | Yes | Yes | | _User.Export.All_ | Export users' data | Allows the app to export an organizational user's data, when performed by a Company Administrator.| Yes | Yes | | _UserActivity.ReadWrite.CreatedByApp_ |Read and write app activity to users' activity feed |Allows the app to read and report the signed-in user's activity in the app. |No | Yes #Delegated Personal | _Calendars.Read_ |Read user calendars |Allows the app to read events in user calendars. |No | Yes | | _Calendars.ReadWrite_ |Have full access to user calendars |Allows the app to create, read, update, and delete events in user calendars. |No | Yes | | _Contacts.Read_ |Read user contacts |Allows the app to read user contacts. |No | Yes | | _Contacts.ReadWrite_ |Have full access to user contacts |Allows the app to create, read, update, and delete user contacts. |No |Yes| |_Device.Read_ |Read user devices |Allows the app to read a user's list of devices on behalf of the signed-in user. |No | Yes | |_Device.Command_ |Communicate with user devices |Allows the app to launch another app or communicate with another app on a user's device on behalf of the signed-in user. |No | Yes | | _Files.Read_ | Read user files | Allows the app to read the signed-in user's files. | No | Yes | | _Files.Read.All_ | Read all files that user can access | Allows the app to read all files the signed-in user can access. | No | Yes | | _Files.ReadWrite_ | Have full access to user files | Allows the app to read, create, update, and delete the signed-in user's files. | No| Yes | | _Files.ReadWrite.All_ | Have full access to all files user can access | Allows the app to read, create, update, and delete all files the signed-in user can access. | No | Yes | | _Mail.ReadWrite_ | Read and write access to user mail | Allows the app to create, read, update, and delete email in user mailboxes. Does not include permission to send mail.| No | Yes | _Member.Read.Hidden_ | Read all hidden memberships | Allows the app to read the memberships of hidden groups and administrative units without a signed-in user. | Yes | | _Notes.Read_ | Read user OneNote notebooks | Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user. | No | Yes | _Notes.Create_ | Create user OneNote notebooks | Allows the app to read the titles of OneNote notebooks and sections and to create new pages, notebooks, and sections on behalf of the signed-in user.| No | Yes | _Notes.ReadWrite_ | Read and write user OneNote notebooks | Allows the app to read, share, and modify OneNote notebooks on behalf of the signed-in user. | No | Yes | _Notes.Read.All_ | Read all OneNote notebooks that user can access | Allows the app to read OneNote notebooks that the signed-in user has access to in the organization. | No | Yes | _Tasks.Read_ | Read user tasks | Allows the app to read user tasks. | No | Yes | | _Tasks.ReadWrite_ | Create, read, update and delete user tasks and containers | Allows the app to create, read, update and delete tasks and containers (and tasks in them) that are assigned to or shared with the signed-in user.| No | Yes | | _User.Read_ | Sign-in and read user profile | Allows users to sign-in to the app, and allows the app to read the profile of signed-in users. It also allows the app to read basic company information of signed-in users.| No | Yes | | _User.ReadWrite_ | Read and write access to user profile | Allows the app to read the signed-in user's full profile. It also allows the app to update the signed-in user's profile information on their behalf. | No | Yes | | _User.ReadBasic.All_ | Read all users' basic profiles | Allows the app to read a basic set of profile properties of other users in your organization on behalf of the signed-in user. This includes display name, first and last name, email address, open extensions and photo. Also allows the app to read the full profile of the signed-in user. | No | Yes | | _User.Read.All_ | Read all users' full profiles | Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. | Yes | Yes | | _User.ReadWrite.All_ | Read and write all users' full profiles | Allows the app to read and write the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. Also allows the app to create and delete users as well as reset user passwords on behalf of the signed-in user. | Yes | Yes | | _User.Invite.All_ | Invite guest users to the organization | Allows the app to invite guest users to your organization, on behalf of the signed-in user. | Yes | Yes | | _User.Export.All_ | Export users' data | Allows the app to export an organizational user's data, when performed by a Company Administrator.| Yes | Yes | | _UserActivity.ReadWrite.CreatedByApp_ |Read and write app activity to users' activity feed |Allows the app to read and report the signed-in user's activity in the app. |No | Yes #Application | _Application.ReadWrite.All_ | Read and write all apps | Allows the calling app to create, and manage (read, update, update application secrets and delete) applications and service principals without a signed-in user. Does not allow management of consent grants or application assignments to users or groups. | Yes | | _Application.ReadWrite.OwnedBy_ | Manage apps that this app creates or owns | Allows the calling app to create other applications and service principals, and fully manage those applications and service principals (read, update, update application secrets and delete), without a signed-in user. It cannot update any applications that it is not an owner of. Does not allow management of consent grants or application assignments to users or groups. | Yes | |_Calendars.Read_ |Read calendars in all mailboxes |Allows the app to read events of all calendars without a signed-in user. |Yes | |_Calendars.ReadWrite_ |Read and write calendars in all mailboxes |Allows the app to create, read, update, and delete events of all calendars without a signed-in user. |Yes | |_Contacts.Read_ |Read contacts in all mailboxes |Allows the app to read all contacts in all mailboxes without a signed-in user. |Yes | |_Contacts.ReadWrite_ |Read and write contacts in all mailboxes |Allows the app to create, read, update, and delete all contacts in all mailboxes without a signed-in user. |Yes | |_Device.ReadWrite.All_ |Read and write devices |Allows the app to read and write all device properties without a signed in user. Does not allow device creation, device deletion, or update of device alternative security identifiers. |Yes | | _Directory.Read.All_ | Read directory data | Allows the app to read data in your organization's directory, such as users, groups and apps, without a signed-in user. | Yes | | _Directory.ReadWrite.All_ | Read and write directory data | Allows the app to read and write data in your organization's directory, such as users, and groups, without a signed-in user. Does not allow user or group deletion. | Yes | |_EduAssignments.ReadBasic.All_| Read class assignments without grades|Allows the app to read assignments without grades for all users| Yes | |_EduAssignments.ReadWriteBasic.All_ | Read and write class assignments without grades | Allows the app to read and write assignments without grades for all users| Yes | |_EduAssignments.Read.All_| Read class assignments with grades | Allows the app to read assignments and their grades for all users | Yes | |_EduAssignments.ReadWrite.All_ | Read and write class assignments with grades | Allows the app to read and write assignments and their grades for all users | Yes | |_EduRostering.ReadBasic.All_ | Read a limited subset of the organization's roster. | Allows the app to read a limited subset of both the structure of schools and classes in an organization's roster and education-specific information about all users. | Yes | |_EduRostering.Read.All_ | Read the organization's roster. | Allows the app to read the structure of schools and classes in the organization's roster and education-specific information about all users to be read. | Yes | |_EduRostering.ReadWrite.All_| Read and write the organization's roster. | Allows the app to read and write the structure of schools and classes in the organization's roster and education-specific information about all users to be read and written. | Yes | | _Files.Read.All_ | Read files in all site collections | Allows the app to read all files in all site collections without a signed in user. | Yes | | _Files.ReadWrite.All_ | Read and write files in all site collections | Allows the app to read, create, update, and delete all files in all site collections without a signed in user. | Yes | | _Group.Read.All_ | Read all groups | Allows the app to read memberships for all groups without a signed-in user. > **NOTE:** that not all group API supports access using app-only permissions. See [known issues](../concepts/known_issues.md) for examples. | Yes | | _Group.ReadWrite.All_ | Read and write all groups | Allows the app to create groups, read and update group memberships, and delete groups. All of these operations can be performed by the app without a signed-in user. > **NOTE:** that not all group API supports access using app-only permissions. See [known issues](../concepts/known_issues.md) for examples.| Yes | | _IdentityRiskEvent.Read.All_ | Read identity risk event information | Allows the app to read identity risk event information for all users in your organization without a signed-in user. | Yes | | Permission | Display String | Description | Admin Consent Required | |:-----------------------------|:-----------------------------------------|:-----------------|:-----------------| | _Mail.Read_ | Read mail in all mailboxes | Allows the app to read mail in all mailboxes without a signed-in user.| Yes | | _Mail.ReadWrite_ | Read and write mail in all mailboxes | Allows the app to create, read, update, and delete mail in all mailboxes without a signed-in user. Does not include permission to send mail. | Yes | | _Mail.Send_ | Send mail as any user | Allows the app to send mail as any user without a signed-in user. | Yes | | _MailboxSettings.Read_ | Read all user mailbox settings | Allows the app to read user's mailbox settings without a signed-in user. Does not include permission to send mail. | No | | _MailboxSettings.ReadWrite_ | Read and write all user mailbox settings | Allows the app to create, read, update, and delete user's mailbox settings without a signed-in user. Does not include permission to send mail. | Yes | | _Notes.Read.All_ | Read all OneNote notebooks | Allows the app to read all the OneNote notebooks in your organization, without a signed-in user. | Yes | | _Notes.ReadWrite.All_ | Read and write all OneNote notebooks | Allows the app to read, share, and modify all the OneNote notebooks in your organization, without a signed-in user.| Yes | | _People.Read.All_ | Read all users' relevant people lists | Allows the app to read a scored list of people relevant to the signed-in user or other users in the signed-in user's organization.
The list can include local contacts, contacts from social networking or your organization's directory, and people from recent communications (such as email and Skype). Also allows the app to search the entire directory of the signed-in user's organization. | Yes | | _Reports.Read.All_ | Read all usage reports | Allows an app to read all service usage reports without a signed-in user. Services that provide usage reports include Office 365 and Azure Active Directory. | Yes | | _SecurityEvents.Read.All_ | Read your organization’s security events | Allows the app to read your organization’s security events. | Yes | | _SecurityEvents.ReadWrite.All_ | Read and update your organization’s security events | Allows the app to read your organization’s security events. Also allows the app to update editable properties in security events. | Yes | | _Sites.Read.All_ | Read items in all site collections | Allows the app to read documents and list items in all site collections without a signed in user. | Yes | | _Sites.ReadWrite.All_ | Read and write items in all site collections | Allows the app to create, read, update, and delete documents and list items in all site collections without a signed in user. | Yes | | _Sites.Manage.All_ | Have full control of all site collections | Allows the app to manage and create lists, documents, and list items in all site collections without a signed-in user. | Yes | | _Sites.FullControl.All_ | Create, edit, and delete items and lists in all site collections | Allows the app to have full control to SharePoint sites in all site collections without a signed-in user. | Yes | | _User.Read.All_ | Read all users' full profiles | Allows the app to read the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user.| Yes | | _User.ReadWrite.All_ | Read and write all users' full profiles | Allows the app to read and write the full set of profile properties, group membership, reports and managers of other users in your organization, without a signed-in user. Also allows the app to create and delete non-administrative users. Does not allow reset of user passwords. | Yes | | _User.Invite.All_ | Invite guest users to the organization | Allows the app to invite guest users to your organization, without a signed-in user. | Yes | | _User.Export.All_ | Export users' data | Allows the app to export organizational users' data, without a signed-in user.| Yes | ================================================ FILE: docs/graphSecurityScheme/GraphSchemes.xml ================================================
\\r\\n
\",\r\n \"messageLanguage\":{\r\n \"locale\":\"en-US\",\r\n \"displayName\":\"English (United States)\"\r\n },\r\n \"scheduledStartTime\": {\r\n \"dateTime\": \"2018-08-07T02:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n },\r\n \"scheduledEndTime\": {\r\n \"dateTime\": \"2018-08-09T02:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n }\r\n },\r\n \"mailboxFull\":false\r\n },\r\n {\r\n \"emailAddress\":{\r\n \"name\":\"\",\r\n \"address\":\"fannyd@contoso.onmicrosoft.com\"\r\n },\r\n \"automaticReplies\":{\r\n \"message\":\"\"\r\n },\r\n \"mailboxFull\":false\r\n }\r\n ]\r\n}\r\n\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Read",
"Mail.Read.Shared"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Read"
]
},
{
"Application": [
"Mail.Read"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/me/reminderView(endDateTime={endDateTime},startDateTime={startDateTime})": {
"get": {
"tags": [
"me.Functions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "me.reminderView.d02b",
"parameters": [
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "endDateTime",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "startDateTime",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.reminder"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\": \"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.reminder)\",\r\n \"value\": [\r\n {\r\n \"eventId\": \"AAMkADNsvAAA=\",\r\n \"changeKey\": \"SuFHwDRP1EeXJUopWbSLlgAAmBvk2g==\",\r\n \"eventSubject\": \"Plan summer company picnic\",\r\n \"eventWebLink\": \"https://outlook.office365.com/owa/?itemid=AAMkADNsvAAA%3D&exvsurl=1&path=/calendar/item\",\r\n \"eventStartTime\": {\r\n \"dateTime\": \"2017-06-09T18:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n },\r\n \"eventEndTime\": {\r\n \"dateTime\": \"2017-06-09T19:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n },\r\n \"eventLocation\": {\r\n \"displayName\": \"Conf Room 3\"\r\n },\r\n \"reminderFireTime\": {\r\n \"dateTime\": \"2017-06-09T17:45:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n }\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.Read",
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.Read",
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.Read",
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/me/sendMail": {
"post": {
"tags": [
"me.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "me.sendMail",
"parameters": [
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
},
"saveToSentItems": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Send"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Send"
]
},
{
"Application": [
"Mail.Send"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/me/onenote": {
"get": {
"tags": [
"me.onenote"
],
"summary": "Get onenote from me",
"operationId": "me.GetOnenote",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"notebooks",
"operations",
"pages",
"resources",
"sectionGroups",
"sections"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"notebooks",
"operations",
"pages",
"resources",
"sectionGroups",
"sections"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.onenote"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/outlook": {
"get": {
"tags": [
"me.outlookUser"
],
"summary": "Get outlook from me",
"operationId": "me.GetOutlook",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"masterCategories"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"masterCategories"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.outlookUser"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/outlook/supportedLanguages()": {
"get": {
"tags": [
"me.Functions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "me.outlook.supportedLanguages.7d99",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.localeInfo"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.localeInfo)\",\r\n \"value\":[\r\n {\r\n \"locale\":\"af-ZA\",\r\n \"displayName\":\"Afrikaans (Suid-Afrika)\"\r\n },\r\n {\r\n \"locale\":\"en-US\",\r\n \"displayName\":\"English (United States)\"\r\n },\r\n {\r\n \"locale\":\"en-CA\",\r\n \"displayName\":\"English (Canada)\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadBasic.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read"
]
},
{
"Application": [
"User.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/me/outlook/supportedTimeZones()": {
"get": {
"tags": [
"me.Functions"
],
"summary": "Invoke function supportedTimeZones",
"operationId": "me.outlook.supportedTimeZones.4c5b",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeZoneInformation"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.timeZoneInformation)\",\r\n \"value\":[\r\n {\r\n \"alias\":\"Dateline Standard Time\",\r\n \"displayName\":\"(UTC-12:00) International Date Line West\"\r\n },\r\n {\r\n \"alias\":\"Samoa Standard Time\",\r\n \"displayName\":\"(UTC+13:00) Samoa\"\r\n },\r\n {\r\n \"alias\":\"UTC-11\",\r\n \"displayName\":\"(UTC-11:00) Coordinated Universal Time-11\"\r\n },\r\n {\r\n \"alias\":\"Aleutian Standard Time\",\r\n \"displayName\":\"(UTC-10:00) Aleutian Islands\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadBasic.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read"
]
},
{
"Application": [
"User.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/me/outlook/supportedTimeZones(TimeZoneStandard={TimeZoneStandard})"
]
},
"/me/outlook/supportedTimeZones(TimeZoneStandard={TimeZoneStandard})": {
"get": {
"tags": [
"me.Functions"
],
"summary": "Invoke function supportedTimeZones",
"operationId": "me.outlook.supportedTimeZones.cfd8",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "TimeZoneStandard",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeZoneStandard"
}
],
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeZoneInformation"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.timeZoneInformation)\",\r\n \"value\":[\r\n {\r\n \"alias\":\"Etc/GMT+12\",\r\n \"displayName\":\"Etc/GMT+12\"\r\n },\r\n {\r\n \"alias\":\"US/Samoa\",\r\n \"displayName\":\"US/Samoa\"\r\n },\r\n {\r\n \"alias\":\"Etc/GMT+11\",\r\n \"displayName\":\"Etc/GMT+11\"\r\n },\r\n {\r\n \"alias\":\"US/Aleutian\",\r\n \"displayName\":\"US/Aleutian\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadBasic.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read"
]
},
{
"Application": [
"User.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/me/outlook/supportedTimeZones()"
]
},
"/me/ownedDevices": {
"get": {
"tags": [
"me.directoryObject"
],
"summary": "Get ownedDevices from me",
"operationId": "me.ListOwnedDevices",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/ownedDevices/{directoryObject-id}": {
"get": {
"tags": [
"me.directoryObject"
],
"summary": "Get ownedDevices from me",
"operationId": "me.GetOwnedDevices",
"parameters": [
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/ownedObjects": {
"get": {
"tags": [
"me.directoryObject"
],
"summary": "Get ownedObjects from me",
"operationId": "me.ListOwnedObjects",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/ownedObjects/{directoryObject-id}": {
"get": {
"tags": [
"me.directoryObject"
],
"summary": "Get ownedObjects from me",
"operationId": "me.GetOwnedObjects",
"parameters": [
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/people": {
"get": {
"tags": [
"me.person"
],
"summary": "Get people from me",
"operationId": "me.ListPeople",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"birthday",
"birthday desc",
"companyName",
"companyName desc",
"department",
"department desc",
"displayName",
"displayName desc",
"scoredEmailAddresses",
"scoredEmailAddresses desc",
"givenName",
"givenName desc",
"imAddress",
"imAddress desc",
"isFavorite",
"isFavorite desc",
"jobTitle",
"jobTitle desc",
"officeLocation",
"officeLocation desc",
"personNotes",
"personNotes desc",
"personType",
"personType desc",
"phones",
"phones desc",
"postalAddresses",
"postalAddresses desc",
"profession",
"profession desc",
"surname",
"surname desc",
"userPrincipalName",
"userPrincipalName desc",
"websites",
"websites desc",
"yomiCompany",
"yomiCompany desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"birthday",
"companyName",
"department",
"displayName",
"scoredEmailAddresses",
"givenName",
"imAddress",
"isFavorite",
"jobTitle",
"officeLocation",
"personNotes",
"personType",
"phones",
"postalAddresses",
"profession",
"surname",
"userPrincipalName",
"websites",
"yomiCompany"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.person"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/people/{person-id}": {
"get": {
"tags": [
"me.person"
],
"summary": "Get people from me",
"operationId": "me.GetPeople",
"parameters": [
{
"name": "person-id",
"in": "path",
"description": "key: person-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "person"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"birthday",
"companyName",
"department",
"displayName",
"scoredEmailAddresses",
"givenName",
"imAddress",
"isFavorite",
"jobTitle",
"officeLocation",
"personNotes",
"personType",
"phones",
"postalAddresses",
"profession",
"surname",
"userPrincipalName",
"websites",
"yomiCompany"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.person"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/photo": {
"get": {
"tags": [
"me.profilePhoto"
],
"summary": "Get photo from me",
"operationId": "me.GetPhoto",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"height",
"width"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.profilePhoto"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/planner": {
"get": {
"tags": [
"me.plannerUser"
],
"summary": "Get planner from me",
"operationId": "me.GetPlanner",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"plans",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"plans",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerUser"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/registeredDevices": {
"get": {
"tags": [
"me.directoryObject"
],
"summary": "Get registeredDevices from me",
"operationId": "me.ListRegisteredDevices",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/me/registeredDevices/{directoryObject-id}": {
"get": {
"tags": [
"me.directoryObject"
],
"summary": "Get registeredDevices from me",
"operationId": "me.GetRegisteredDevices",
"parameters": [
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/organization": {
"get": {
"tags": [
"organization.organization"
],
"summary": "Get organization",
"operationId": "organization.organization.GetOrganization",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"mobileDeviceManagementAuthority",
"assignedPlans",
"businessPhones",
"city",
"companyLastDirSyncTime",
"country",
"countryLetterCode",
"deletionTimestamp",
"dirSyncEnabled",
"displayName",
"marketingNotificationEmails",
"objectType",
"onPremisesLastSyncDateTime",
"onPremisesSyncEnabled",
"postalCode",
"preferredLanguage",
"privacyProfile",
"provisionedPlans",
"securityComplianceNotificationMails",
"securityComplianceNotificationPhones",
"state",
"street",
"technicalNotificationMails",
"telephoneNumber",
"verifiedDomains",
"extensions"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"extensions"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.organization"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"assignedPlans\": [\r\n {\r\n \"assignedDateTime\": \"datetime-value\",\r\n \"capabilityStatus\": \"capabilityStatus-value\",\r\n \"service\": \"service-value\",\r\n \"servicePlanId\": \"servicePlanId-value\"\r\n }\r\n ],\r\n \"businessPhones\": [\r\n \"businessPhones-value\"\r\n ],\r\n \"city\": \"city-value\",\r\n \"country\": \"country-value\",\r\n \"countryLetterCode\": \"countryLetterCode-value\",\r\n \"displayName\": \"displayName-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"Directory.Read.All",
"Directory.ReadWrite.All"
]
},
{
"Application": [
"Directory.Read.All",
"Directory.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"organization.organization"
],
"summary": "Update organization",
"operationId": "organization.organization.UpdateOrganization",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.organization"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Directory.AccessAsUser.All"
]
}
],
"x-ms-docs-operation-type": "operation"
}
},
"/organization/extensions": {
"get": {
"tags": [
"organization.extension"
],
"summary": "Get extensions from organization",
"operationId": "organization.ListExtensions",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/organization/extensions/{extension-id}": {
"get": {
"tags": [
"organization.extension"
],
"summary": "Get extensions from organization",
"operationId": "organization.GetExtensions",
"parameters": [
{
"name": "extension-id",
"in": "path",
"description": "key: extension-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "extension"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner": {
"get": {
"tags": [
"planner.planner"
],
"summary": "The **planner** resource is available at the root of the graph.",
"operationId": "planner.planner.GetPlanner",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"buckets",
"plans",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"buckets",
"plans",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.planner"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"planner.planner"
],
"summary": "Update planner",
"operationId": "planner.planner.UpdatePlanner",
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.planner"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner/buckets": {
"get": {
"tags": [
"planner.plannerBucket"
],
"summary": "Get buckets from planner",
"operationId": "planner.ListBuckets",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"name",
"name desc",
"orderHint",
"orderHint desc",
"planId",
"planId desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"name",
"orderHint",
"planId",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerBucket"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner/buckets/{plannerBucket-id}": {
"get": {
"tags": [
"planner.plannerBucket"
],
"summary": "Get buckets from planner",
"operationId": "planner.GetBuckets",
"parameters": [
{
"name": "plannerBucket-id",
"in": "path",
"description": "key: plannerBucket-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "plannerBucket"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"name",
"orderHint",
"planId",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerBucket"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner/plans": {
"get": {
"tags": [
"planner.plannerPlan"
],
"summary": "Get plans from planner",
"operationId": "planner.ListPlans",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"owner",
"owner desc",
"title",
"title desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"owner",
"title",
"buckets",
"details",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"buckets",
"details",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerPlan"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner/plans/{plannerPlan-id}": {
"get": {
"tags": [
"planner.plannerPlan"
],
"summary": "Get plans from planner",
"operationId": "planner.GetPlans",
"parameters": [
{
"name": "plannerPlan-id",
"in": "path",
"description": "key: plannerPlan-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "plannerPlan"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"owner",
"title",
"buckets",
"details",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"buckets",
"details",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerPlan"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner/tasks": {
"get": {
"tags": [
"planner.plannerTask"
],
"summary": "Get tasks from planner",
"operationId": "planner.ListTasks",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"activeChecklistItemCount",
"activeChecklistItemCount desc",
"appliedCategories",
"appliedCategories desc",
"assigneePriority",
"assigneePriority desc",
"assignments",
"assignments desc",
"bucketId",
"bucketId desc",
"checklistItemCount",
"checklistItemCount desc",
"completedBy",
"completedBy desc",
"completedDateTime",
"completedDateTime desc",
"conversationThreadId",
"conversationThreadId desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"dueDateTime",
"dueDateTime desc",
"hasDescription",
"hasDescription desc",
"orderHint",
"orderHint desc",
"percentComplete",
"percentComplete desc",
"planId",
"planId desc",
"previewType",
"previewType desc",
"referenceCount",
"referenceCount desc",
"startDateTime",
"startDateTime desc",
"title",
"title desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"activeChecklistItemCount",
"appliedCategories",
"assigneePriority",
"assignments",
"bucketId",
"checklistItemCount",
"completedBy",
"completedDateTime",
"conversationThreadId",
"createdBy",
"createdDateTime",
"dueDateTime",
"hasDescription",
"orderHint",
"percentComplete",
"planId",
"previewType",
"referenceCount",
"startDateTime",
"title",
"assignedToTaskBoardFormat",
"bucketTaskBoardFormat",
"details",
"progressTaskBoardFormat"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"assignedToTaskBoardFormat",
"bucketTaskBoardFormat",
"details",
"progressTaskBoardFormat"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerTask"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/planner/tasks/{plannerTask-id}": {
"get": {
"tags": [
"planner.plannerTask"
],
"summary": "Get tasks from planner",
"operationId": "planner.GetTasks",
"parameters": [
{
"name": "plannerTask-id",
"in": "path",
"description": "key: plannerTask-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "plannerTask"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"activeChecklistItemCount",
"appliedCategories",
"assigneePriority",
"assignments",
"bucketId",
"checklistItemCount",
"completedBy",
"completedDateTime",
"conversationThreadId",
"createdBy",
"createdDateTime",
"dueDateTime",
"hasDescription",
"orderHint",
"percentComplete",
"planId",
"previewType",
"referenceCount",
"startDateTime",
"title",
"assignedToTaskBoardFormat",
"bucketTaskBoardFormat",
"details",
"progressTaskBoardFormat"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"assignedToTaskBoardFormat",
"bucketTaskBoardFormat",
"details",
"progressTaskBoardFormat"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerTask"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/reports": {
"get": {
"tags": [
"reports.reportRoot"
],
"summary": "Get reports",
"operationId": "reports.reportRoot.GetReportRoot",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.reportRoot"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"reports.reportRoot"
],
"summary": "Update reports",
"operationId": "reports.reportRoot.UpdateReportRoot",
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.reportRoot"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/reports/getEmailActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailActivityCounts",
"operationId": "reports.getEmailActivityCounts.d2c9",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getEmailActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailActivityUserCounts",
"operationId": "reports.getEmailActivityUserCounts.67ae",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getEmailActivityUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailActivityUserDetail",
"operationId": "reports.getEmailActivityUserDetail.35e0",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getEmailActivityUserDetail(period={period})"
]
},
"/reports/getEmailActivityUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailActivityUserDetail",
"operationId": "reports.getEmailActivityUserDetail.ae84",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getEmailActivityUserDetail(date={date})"
]
},
"/reports/getEmailAppUsageAppsUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailAppUsageAppsUserCounts",
"operationId": "reports.getEmailAppUsageAppsUserCounts.807c",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getEmailAppUsageUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailAppUsageUserCounts",
"operationId": "reports.getEmailAppUsageUserCounts.6fd2",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getEmailAppUsageUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailAppUsageUserDetail",
"operationId": "reports.getEmailAppUsageUserDetail.8c90",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getEmailAppUsageUserDetail(period={period})"
]
},
"/reports/getEmailAppUsageUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailAppUsageUserDetail",
"operationId": "reports.getEmailAppUsageUserDetail.a73d",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getEmailAppUsageUserDetail(date={date})"
]
},
"/reports/getEmailAppUsageVersionsUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getEmailAppUsageVersionsUserCounts",
"operationId": "reports.getEmailAppUsageVersionsUserCounts.f73b",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getMailboxUsageDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getMailboxUsageDetail",
"operationId": "reports.getMailboxUsageDetail.6ef8",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getMailboxUsageMailboxCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getMailboxUsageMailboxCounts",
"operationId": "reports.getMailboxUsageMailboxCounts.1ae9",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getMailboxUsageQuotaStatusMailboxCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getMailboxUsageQuotaStatusMailboxCounts",
"operationId": "reports.getMailboxUsageQuotaStatusMailboxCounts.b080",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getMailboxUsageStorage(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getMailboxUsageStorage",
"operationId": "reports.getMailboxUsageStorage.fdb0",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365ActivationCounts()": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ActivationCounts",
"operationId": "reports.getOffice365ActivationCounts.dd57",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365ActivationsUserCounts()": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ActivationsUserCounts",
"operationId": "reports.getOffice365ActivationsUserCounts.21b3",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365ActivationsUserDetail()": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ActivationsUserDetail",
"operationId": "reports.getOffice365ActivationsUserDetail.1156",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365ActiveUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ActiveUserCounts",
"operationId": "reports.getOffice365ActiveUserCounts.c3b0",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365ActiveUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ActiveUserDetail",
"operationId": "reports.getOffice365ActiveUserDetail.3621",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOffice365ActiveUserDetail(period={period})"
]
},
"/reports/getOffice365ActiveUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ActiveUserDetail",
"operationId": "reports.getOffice365ActiveUserDetail.7f57",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOffice365ActiveUserDetail(date={date})"
]
},
"/reports/getOffice365GroupsActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365GroupsActivityCounts",
"operationId": "reports.getOffice365GroupsActivityCounts.9333",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365GroupsActivityDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365GroupsActivityDetail",
"operationId": "reports.getOffice365GroupsActivityDetail.d699",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOffice365GroupsActivityDetail(period={period})"
]
},
"/reports/getOffice365GroupsActivityDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365GroupsActivityDetail",
"operationId": "reports.getOffice365GroupsActivityDetail.1b51",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOffice365GroupsActivityDetail(date={date})"
]
},
"/reports/getOffice365GroupsActivityFileCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365GroupsActivityFileCounts",
"operationId": "reports.getOffice365GroupsActivityFileCounts.7206",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365GroupsActivityGroupCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365GroupsActivityGroupCounts",
"operationId": "reports.getOffice365GroupsActivityGroupCounts.f5de",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365GroupsActivityStorage(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365GroupsActivityStorage",
"operationId": "reports.getOffice365GroupsActivityStorage.a4d3",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOffice365ServicesUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOffice365ServicesUserCounts",
"operationId": "reports.getOffice365ServicesUserCounts.0d23",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOneDriveActivityFileCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveActivityFileCounts",
"operationId": "reports.getOneDriveActivityFileCounts.c2dc",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOneDriveActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveActivityUserCounts",
"operationId": "reports.getOneDriveActivityUserCounts.442b",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOneDriveActivityUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveActivityUserDetail",
"operationId": "reports.getOneDriveActivityUserDetail.57de",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOneDriveActivityUserDetail(period={period})"
]
},
"/reports/getOneDriveActivityUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveActivityUserDetail",
"operationId": "reports.getOneDriveActivityUserDetail.20ae",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOneDriveActivityUserDetail(date={date})"
]
},
"/reports/getOneDriveUsageAccountCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveUsageAccountCounts",
"operationId": "reports.getOneDriveUsageAccountCounts.801b",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOneDriveUsageAccountDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveUsageAccountDetail",
"operationId": "reports.getOneDriveUsageAccountDetail.b461",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOneDriveUsageAccountDetail(period={period})"
]
},
"/reports/getOneDriveUsageAccountDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveUsageAccountDetail",
"operationId": "reports.getOneDriveUsageAccountDetail.3f04",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getOneDriveUsageAccountDetail(date={date})"
]
},
"/reports/getOneDriveUsageFileCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveUsageFileCounts",
"operationId": "reports.getOneDriveUsageFileCounts.8444",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getOneDriveUsageStorage(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getOneDriveUsageStorage",
"operationId": "reports.getOneDriveUsageStorage.c292",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointActivityFileCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointActivityFileCounts",
"operationId": "reports.getSharePointActivityFileCounts.b044",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointActivityPages(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointActivityPages",
"operationId": "reports.getSharePointActivityPages.73a2",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointActivityUserCounts",
"operationId": "reports.getSharePointActivityUserCounts.a723",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointActivityUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointActivityUserDetail",
"operationId": "reports.getSharePointActivityUserDetail.c908",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSharePointActivityUserDetail(period={period})"
]
},
"/reports/getSharePointActivityUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointActivityUserDetail",
"operationId": "reports.getSharePointActivityUserDetail.9d39",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSharePointActivityUserDetail(date={date})"
]
},
"/reports/getSharePointSiteUsageDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointSiteUsageDetail",
"operationId": "reports.getSharePointSiteUsageDetail.9a98",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSharePointSiteUsageDetail(period={period})"
]
},
"/reports/getSharePointSiteUsageDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointSiteUsageDetail",
"operationId": "reports.getSharePointSiteUsageDetail.bec0",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSharePointSiteUsageDetail(date={date})"
]
},
"/reports/getSharePointSiteUsageFileCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointSiteUsageFileCounts",
"operationId": "reports.getSharePointSiteUsageFileCounts.b2bd",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointSiteUsagePages(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointSiteUsagePages",
"operationId": "reports.getSharePointSiteUsagePages.ef52",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointSiteUsageSiteCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointSiteUsageSiteCounts",
"operationId": "reports.getSharePointSiteUsageSiteCounts.1b68",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSharePointSiteUsageStorage(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSharePointSiteUsageStorage",
"operationId": "reports.getSharePointSiteUsageStorage.4100",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessActivityCounts",
"operationId": "reports.getSkypeForBusinessActivityCounts.1cd1",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessActivityUserCounts",
"operationId": "reports.getSkypeForBusinessActivityUserCounts.502a",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessActivityUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessActivityUserDetail",
"operationId": "reports.getSkypeForBusinessActivityUserDetail.de4b",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSkypeForBusinessActivityUserDetail(period={period})"
]
},
"/reports/getSkypeForBusinessActivityUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessActivityUserDetail",
"operationId": "reports.getSkypeForBusinessActivityUserDetail.2a24",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSkypeForBusinessActivityUserDetail(date={date})"
]
},
"/reports/getSkypeForBusinessDeviceUsageDistributionUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessDeviceUsageDistributionUserCounts",
"operationId": "reports.getSkypeForBusinessDeviceUsageDistributionUserCounts.b288",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessDeviceUsageUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessDeviceUsageUserCounts",
"operationId": "reports.getSkypeForBusinessDeviceUsageUserCounts.afec",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessDeviceUsageUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessDeviceUsageUserDetail",
"operationId": "reports.getSkypeForBusinessDeviceUsageUserDetail.c31f",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSkypeForBusinessDeviceUsageUserDetail(period={period})"
]
},
"/reports/getSkypeForBusinessDeviceUsageUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessDeviceUsageUserDetail",
"operationId": "reports.getSkypeForBusinessDeviceUsageUserDetail.e139",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getSkypeForBusinessDeviceUsageUserDetail(date={date})"
]
},
"/reports/getSkypeForBusinessOrganizerActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessOrganizerActivityCounts",
"operationId": "reports.getSkypeForBusinessOrganizerActivityCounts.337a",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessOrganizerActivityMinuteCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessOrganizerActivityMinuteCounts",
"operationId": "reports.getSkypeForBusinessOrganizerActivityMinuteCounts.a6f3",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessOrganizerActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessOrganizerActivityUserCounts",
"operationId": "reports.getSkypeForBusinessOrganizerActivityUserCounts.61cb",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessParticipantActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessParticipantActivityCounts",
"operationId": "reports.getSkypeForBusinessParticipantActivityCounts.3f25",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessParticipantActivityMinuteCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessParticipantActivityMinuteCounts",
"operationId": "reports.getSkypeForBusinessParticipantActivityMinuteCounts.19f1",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessParticipantActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessParticipantActivityUserCounts",
"operationId": "reports.getSkypeForBusinessParticipantActivityUserCounts.2fb8",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessPeerToPeerActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessPeerToPeerActivityCounts",
"operationId": "reports.getSkypeForBusinessPeerToPeerActivityCounts.4ba6",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessPeerToPeerActivityMinuteCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessPeerToPeerActivityMinuteCounts",
"operationId": "reports.getSkypeForBusinessPeerToPeerActivityMinuteCounts.de62",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getSkypeForBusinessPeerToPeerActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getSkypeForBusinessPeerToPeerActivityUserCounts",
"operationId": "reports.getSkypeForBusinessPeerToPeerActivityUserCounts.5fbc",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getTeamsDeviceUsageDistributionUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsDeviceUsageDistributionUserCounts",
"operationId": "reports.getTeamsDeviceUsageDistributionUserCounts.91e1",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getTeamsDeviceUsageUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsDeviceUsageUserCounts",
"operationId": "reports.getTeamsDeviceUsageUserCounts.c715",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getTeamsDeviceUsageUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsDeviceUsageUserDetail",
"operationId": "reports.getTeamsDeviceUsageUserDetail.43be",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getTeamsDeviceUsageUserDetail(period={period})"
]
},
"/reports/getTeamsDeviceUsageUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsDeviceUsageUserDetail",
"operationId": "reports.getTeamsDeviceUsageUserDetail.aab9",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getTeamsDeviceUsageUserDetail(date={date})"
]
},
"/reports/getTeamsUserActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsUserActivityCounts",
"operationId": "reports.getTeamsUserActivityCounts.0201",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getTeamsUserActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsUserActivityUserCounts",
"operationId": "reports.getTeamsUserActivityUserCounts.fd77",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getTeamsUserActivityUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsUserActivityUserDetail",
"operationId": "reports.getTeamsUserActivityUserDetail.3a37",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getTeamsUserActivityUserDetail(period={period})"
]
},
"/reports/getTeamsUserActivityUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getTeamsUserActivityUserDetail",
"operationId": "reports.getTeamsUserActivityUserDetail.dd45",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getTeamsUserActivityUserDetail(date={date})"
]
},
"/reports/getYammerActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerActivityCounts",
"operationId": "reports.getYammerActivityCounts.31c4",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getYammerActivityUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerActivityUserCounts",
"operationId": "reports.getYammerActivityUserCounts.5f59",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getYammerActivityUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerActivityUserDetail",
"operationId": "reports.getYammerActivityUserDetail.7d9d",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getYammerActivityUserDetail(period={period})"
]
},
"/reports/getYammerActivityUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerActivityUserDetail",
"operationId": "reports.getYammerActivityUserDetail.ca58",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getYammerActivityUserDetail(date={date})"
]
},
"/reports/getYammerDeviceUsageDistributionUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerDeviceUsageDistributionUserCounts",
"operationId": "reports.getYammerDeviceUsageDistributionUserCounts.9d71",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getYammerDeviceUsageUserCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerDeviceUsageUserCounts",
"operationId": "reports.getYammerDeviceUsageUserCounts.0624",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getYammerDeviceUsageUserDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerDeviceUsageUserDetail",
"operationId": "reports.getYammerDeviceUsageUserDetail.c8b5",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getYammerDeviceUsageUserDetail(period={period})"
]
},
"/reports/getYammerDeviceUsageUserDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerDeviceUsageUserDetail",
"operationId": "reports.getYammerDeviceUsageUserDetail.1955",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getYammerDeviceUsageUserDetail(date={date})"
]
},
"/reports/getYammerGroupsActivityCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerGroupsActivityCounts",
"operationId": "reports.getYammerGroupsActivityCounts.3fdb",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/reports/getYammerGroupsActivityDetail(date={date})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerGroupsActivityDetail",
"operationId": "reports.getYammerGroupsActivityDetail.3ad3",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"required": true,
"schema": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$",
"type": "string",
"format": "date",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getYammerGroupsActivityDetail(period={period})"
]
},
"/reports/getYammerGroupsActivityDetail(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerGroupsActivityDetail",
"operationId": "reports.getYammerGroupsActivityDetail.1de3",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/reports/getYammerGroupsActivityDetail(date={date})"
]
},
"/reports/getYammerGroupsActivityGroupCounts(period={period})": {
"get": {
"tags": [
"reports.Functions"
],
"summary": "Invoke function getYammerGroupsActivityGroupCounts",
"operationId": "reports.getYammerGroupsActivityGroupCounts.61cb",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-None-Match",
"in": "header",
"description": "If this request header is included and the eTag provided matches the current tag on the file, a 304 Not Modified response code is returned. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "period",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.report"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Reports.Read.All"
]
},
{
"Application": [
"Reports.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/schemaExtensions": {
"get": {
"tags": [
"schemaExtensions.schemaExtension"
],
"summary": "Get entities from schemaExtensions",
"operationId": "schemaExtensions.schemaExtension.ListSchemaExtension",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"description",
"description desc",
"owner",
"owner desc",
"properties",
"properties desc",
"status",
"status desc",
"targetTypes",
"targetTypes desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"description",
"owner",
"properties",
"status",
"targetTypes"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"title": "Collection of schemaExtension",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.schemaExtension"
}
}
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"post": {
"tags": [
"schemaExtensions.schemaExtension"
],
"summary": "Add new entity to schemaExtensions",
"operationId": "schemaExtensions.schemaExtension.CreateSchemaExtension",
"requestBody": {
"description": "New entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.schemaExtension"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.schemaExtension"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/schemaExtensions/{schemaExtension-id}": {
"get": {
"tags": [
"schemaExtensions.schemaExtension"
],
"summary": "Get entity from schemaExtensions by key",
"operationId": "schemaExtensions.schemaExtension.GetSchemaExtension",
"parameters": [
{
"name": "schemaExtension-id",
"in": "path",
"description": "key: schemaExtension-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "schemaExtension"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"description",
"owner",
"properties",
"status",
"targetTypes"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.schemaExtension"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"schemaExtensions.schemaExtension"
],
"summary": "Update entity in schemaExtensions",
"operationId": "schemaExtensions.schemaExtension.UpdateSchemaExtension",
"parameters": [
{
"name": "schemaExtension-id",
"in": "path",
"description": "key: schemaExtension-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "schemaExtension"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.schemaExtension"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Directory.AccessAsUser.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"delete": {
"tags": [
"schemaExtensions.schemaExtension"
],
"summary": "Delete entity from schemaExtensions",
"operationId": "schemaExtensions.schemaExtension.DeleteSchemaExtension",
"parameters": [
{
"name": "schemaExtension-id",
"in": "path",
"description": "key: schemaExtension-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "schemaExtension"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-Match",
"in": "header",
"description": "ETag",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Directory.AccessAsUser.All"
]
}
],
"x-ms-docs-operation-type": "operation"
}
},
"/security": {
"get": {
"tags": [
"security.security"
],
"summary": "The **security** resource is available at the root of the graph.",
"operationId": "security.security.GetSecurity",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"alerts"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"alerts"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.security"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"security.security"
],
"summary": "Update security",
"operationId": "security.security.UpdateSecurity",
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.security"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/security/alerts": {
"get": {
"tags": [
"security.alert"
],
"summary": "Get alerts from security",
"operationId": "security.ListAlerts",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.alert"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/security/alerts/": {
"get": {
"tags": [
"security.alert"
],
"summary": "Get alerts from security",
"operationId": "security.GetAlerts",
"parameters": [
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.alert"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares": {
"get": {
"tags": [
"shares.sharedDriveItem"
],
"summary": "Get entities from shares",
"operationId": "shares.sharedDriveItem.ListSharedDriveItem",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"owner",
"owner desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"owner",
"createdByUser",
"lastModifiedByUser",
"driveItem",
"items",
"list",
"listItem",
"root",
"site"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"driveItem",
"items",
"list",
"listItem",
"root",
"site"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"title": "Collection of sharedDriveItem",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.sharedDriveItem"
}
}
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"id\": \"B64397C8-07AE-43E4-920E-32BFB4331A5B\",\r\n \"name\": \"contoso project.docx\",\r\n \"owner\": {\r\n \"user\": {\r\n \"id\": \"98E88F1C-F8DC-47CC-A406-C090248B30E5\",\r\n \"displayName\": \"Ryan Gregg\"\r\n }\r\n }\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"post": {
"tags": [
"shares.sharedDriveItem"
],
"summary": "Add new entity to shares",
"operationId": "shares.sharedDriveItem.CreateSharedDriveItem",
"requestBody": {
"description": "New entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.sharedDriveItem"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.sharedDriveItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}": {
"get": {
"tags": [
"shares.sharedDriveItem"
],
"summary": "Get entity from shares by key",
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"owner",
"createdByUser",
"lastModifiedByUser",
"driveItem",
"items",
"list",
"listItem",
"root",
"site"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"driveItem",
"items",
"list",
"listItem",
"root",
"site"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.sharedDriveItem"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"id\": \"B64397C8-07AE-43E4-920E-32BFB4331A5B\",\r\n \"name\": \"contoso project.docx\",\r\n \"owner\": {\r\n \"user\": {\r\n \"id\": \"98E88F1C-F8DC-47CC-A406-C090248B30E5\",\r\n \"displayName\": \"Ryan Gregg\"\r\n }\r\n }\r\n}\n"
}
}
}
},
"links": {
"driveItem": {
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": {
"id": "$request.path.id"
}
},
"items": {
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": {
"id": "$request.path.id"
}
},
"list": {
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": {
"id": "$request.path.id"
}
},
"listItem": {
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": {
"id": "$request.path.id"
}
},
"root": {
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": {
"id": "$request.path.id"
}
},
"site": {
"operationId": "shares.sharedDriveItem.GetSharedDriveItem",
"parameters": {
"id": "$request.path.id"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"shares.sharedDriveItem"
],
"summary": "Update entity in shares",
"operationId": "shares.sharedDriveItem.UpdateSharedDriveItem",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.sharedDriveItem"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"delete": {
"tags": [
"shares.sharedDriveItem"
],
"summary": "Delete entity from shares",
"operationId": "shares.sharedDriveItem.DeleteSharedDriveItem",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "If-Match",
"in": "header",
"description": "ETag",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/driveItem": {
"get": {
"tags": [
"shares.driveItem"
],
"summary": "Get driveItem from shares",
"operationId": "shares.GetDriveItem",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"audio",
"content",
"cTag",
"deleted",
"file",
"fileSystemInfo",
"folder",
"image",
"location",
"package",
"photo",
"publication",
"remoteItem",
"root",
"searchResult",
"shared",
"sharepointIds",
"size",
"specialFolder",
"video",
"webDavUrl",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/driveItem/copy": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "Returns details about how to [monitor the progress](../../../concepts/long_running_actions_overview.md) of the copy, upon accepting the request.",
"operationId": "shares.driveItem.copy",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"parentReference": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemReference"
}
],
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/copy",
"/shares/{sharedDriveItem-id}/root/copy"
]
},
"/shares/{sharedDriveItem-id}/driveItem/createLink": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "The following example requests a sharing link to be created for the DriveItem specified by {itemId} in the user's OneDrive.\r\nThe sharing link is configured to be read-only and usable by anyone with the link.",
"operationId": "shares.driveItem.createLink",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"scope": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.permission"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/createLink",
"/shares/{sharedDriveItem-id}/root/createLink"
]
},
"/shares/{sharedDriveItem-id}/driveItem/createUploadSession": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "Invoke action createUploadSession",
"operationId": "shares.driveItem.createUploadSession",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "if-match",
"in": "header",
"description": "If this request header is included and the eTag (or cTag) provided does not match the current etag on the item, a 412 Precondition Failed error response is returned.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItemUploadableProperties"
}
],
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.uploadSession"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"uploadUrl\": \"https://sn3302.up.1drv.com/up/fe6987415ace7X4e1eF866337\",\r\n \"expirationDateTime\": \"2015-01-29T09:21:55.523Z\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/createUploadSession",
"/shares/{sharedDriveItem-id}/root/createUploadSession"
]
},
"/shares/{sharedDriveItem-id}/driveItem/delta()": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Here is an example of how to call this API to establish your local state.",
"operationId": "shares.driveItem.delta.2209",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc\",\r\n \"name\": \"folder2\",\r\n \"folder\": { }\r\n },\r\n {\r\n \"id\": \"123010204abac\",\r\n \"name\": \"file.txt\",\r\n \"file\": { }\r\n },\r\n {\r\n \"id\": \"2353010204ddgg\",\r\n \"name\": \"file5.txt\",\r\n \"deleted\": { }\r\n }\r\n ],\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/drive/delta(token=1230919asd190410jlka)\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/delta(token={token})",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta()",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta(token={token})",
"/shares/{sharedDriveItem-id}/root/delta()",
"/shares/{sharedDriveItem-id}/root/delta(token={token})"
]
},
"/shares/{sharedDriveItem-id}/driveItem/delta(token={token})": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Here is an example of how to call this API to update your local state.",
"operationId": "shares.driveItem.delta.cf70",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc\",\r\n \"name\": \"folder2\",\r\n \"folder\": { },\r\n \"deleted\": { }\r\n },\r\n {\r\n \"id\": \"123010204abac\",\r\n \"name\": \"file.txt\",\r\n \"file\": { }\r\n }\r\n ],\r\n \"@odata.deltaLink\": \"https://graph.microsoft.com/v1.0/me/drive/root/delta?(token='1230919asd190410jlka')\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/delta()",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta()",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta(token={token})",
"/shares/{sharedDriveItem-id}/root/delta()",
"/shares/{sharedDriveItem-id}/root/delta(token={token})"
]
},
"/shares/{sharedDriveItem-id}/driveItem/invite": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "This example sends a sharing invitation to a user with email address 'ryan@contoso.com' with a message about a file being collaborated on.\r\nThe invitation grants Ryan read-write access to the file.",
"operationId": "shares.driveItem.invite",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveRecipient"
}
],
"nullable": true
}
},
"message": {
"type": "string",
"nullable": true
},
"requireSignIn": {
"type": "boolean",
"default": false,
"nullable": true
},
"sendInvitation": {
"type": "boolean",
"default": false,
"nullable": true
},
"roles": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.permission"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"grantedTo\": {\r\n \"user\": {\r\n \"displayName\": \"Ryan Gregg\",\r\n \"id\": \"42F177F1-22C0-4BE3-900D-4507125C5C20\"\r\n }\r\n },\r\n \"id\": \"CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62\",\r\n \"invitation\": {\r\n \"email\": \"ryan@contoso.com\",\r\n \"signInRequired\": true\r\n },\r\n \"roles\": [ \"write\" ]\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/invite",
"/shares/{sharedDriveItem-id}/root/invite"
]
},
"/shares/{sharedDriveItem-id}/driveItem/search(q={q})": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Invoke function search",
"operationId": "shares.driveItem.search.f2b1",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "q",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc!123\",\r\n \"name\": \"Contoso Project\",\r\n \"folder\": {},\r\n \"searchResult\": { \"onClickTelemetryUrl\": \"https://bing.com/0123456789abc!123\" }\r\n },\r\n {\r\n \"id\": \"0123456789abc!456\",\r\n \"name\": \"Contoso Project 2016\",\r\n \"folder\": {},\r\n \"searchResult\": { \"onClickTelemetryUrl\": \"https://bing.com/0123456789abc!456\" }\r\n }\r\n ],\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/search(q={q})",
"/shares/{sharedDriveItem-id}/root/search(q={q})"
]
},
"/shares/{sharedDriveItem-id}/items": {
"get": {
"tags": [
"shares.driveItem"
],
"summary": "Get items from shares",
"operationId": "shares.ListItems",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"audio",
"audio desc",
"content",
"content desc",
"cTag",
"cTag desc",
"deleted",
"deleted desc",
"file",
"file desc",
"fileSystemInfo",
"fileSystemInfo desc",
"folder",
"folder desc",
"image",
"image desc",
"location",
"location desc",
"package",
"package desc",
"photo",
"photo desc",
"publication",
"publication desc",
"remoteItem",
"remoteItem desc",
"root",
"root desc",
"searchResult",
"searchResult desc",
"shared",
"shared desc",
"sharepointIds",
"sharepointIds desc",
"size",
"size desc",
"specialFolder",
"specialFolder desc",
"video",
"video desc",
"webDavUrl",
"webDavUrl desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"audio",
"content",
"cTag",
"deleted",
"file",
"fileSystemInfo",
"folder",
"image",
"location",
"package",
"photo",
"publication",
"remoteItem",
"root",
"searchResult",
"shared",
"sharepointIds",
"size",
"specialFolder",
"video",
"webDavUrl",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}": {
"get": {
"tags": [
"shares.driveItem"
],
"summary": "Get items from shares",
"operationId": "shares.GetItems",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"audio",
"content",
"cTag",
"deleted",
"file",
"fileSystemInfo",
"folder",
"image",
"location",
"package",
"photo",
"publication",
"remoteItem",
"root",
"searchResult",
"shared",
"sharepointIds",
"size",
"specialFolder",
"video",
"webDavUrl",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/copy": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "Returns details about how to [monitor the progress](../../../concepts/long_running_actions_overview.md) of the copy, upon accepting the request.",
"operationId": "shares.items.copy",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"parentReference": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemReference"
}
],
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/copy",
"/shares/{sharedDriveItem-id}/root/copy"
]
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/createLink": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "The following example requests a sharing link to be created for the DriveItem specified by {itemId} in the user's OneDrive.\r\nThe sharing link is configured to be read-only and usable by anyone with the link.",
"operationId": "shares.items.createLink",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"scope": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.permission"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/createLink",
"/shares/{sharedDriveItem-id}/root/createLink"
]
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/createUploadSession": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "Invoke action createUploadSession",
"operationId": "shares.items.createUploadSession",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
},
{
"name": "if-match",
"in": "header",
"description": "If this request header is included and the eTag (or cTag) provided does not match the current etag on the item, a 412 Precondition Failed error response is returned.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItemUploadableProperties"
}
],
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.uploadSession"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"uploadUrl\": \"https://sn3302.up.1drv.com/up/fe6987415ace7X4e1eF866337\",\r\n \"expirationDateTime\": \"2015-01-29T09:21:55.523Z\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/createUploadSession",
"/shares/{sharedDriveItem-id}/root/createUploadSession"
]
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta()": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Here is an example of how to call this API to establish your local state.",
"operationId": "shares.items.delta.2209",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc\",\r\n \"name\": \"folder2\",\r\n \"folder\": { }\r\n },\r\n {\r\n \"id\": \"123010204abac\",\r\n \"name\": \"file.txt\",\r\n \"file\": { }\r\n },\r\n {\r\n \"id\": \"2353010204ddgg\",\r\n \"name\": \"file5.txt\",\r\n \"deleted\": { }\r\n }\r\n ],\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/drive/delta(token=1230919asd190410jlka)\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/delta()",
"/shares/{sharedDriveItem-id}/driveItem/delta(token={token})",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta(token={token})",
"/shares/{sharedDriveItem-id}/root/delta()",
"/shares/{sharedDriveItem-id}/root/delta(token={token})"
]
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta(token={token})": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Here is an example of how to call this API to update your local state.",
"operationId": "shares.items.delta.cf70",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc\",\r\n \"name\": \"folder2\",\r\n \"folder\": { },\r\n \"deleted\": { }\r\n },\r\n {\r\n \"id\": \"123010204abac\",\r\n \"name\": \"file.txt\",\r\n \"file\": { }\r\n }\r\n ],\r\n \"@odata.deltaLink\": \"https://graph.microsoft.com/v1.0/me/drive/root/delta?(token='1230919asd190410jlka')\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/delta()",
"/shares/{sharedDriveItem-id}/driveItem/delta(token={token})",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta()",
"/shares/{sharedDriveItem-id}/root/delta()",
"/shares/{sharedDriveItem-id}/root/delta(token={token})"
]
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/invite": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "This example sends a sharing invitation to a user with email address 'ryan@contoso.com' with a message about a file being collaborated on.\r\nThe invitation grants Ryan read-write access to the file.",
"operationId": "shares.items.invite",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveRecipient"
}
],
"nullable": true
}
},
"message": {
"type": "string",
"nullable": true
},
"requireSignIn": {
"type": "boolean",
"default": false,
"nullable": true
},
"sendInvitation": {
"type": "boolean",
"default": false,
"nullable": true
},
"roles": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.permission"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"grantedTo\": {\r\n \"user\": {\r\n \"displayName\": \"Ryan Gregg\",\r\n \"id\": \"42F177F1-22C0-4BE3-900D-4507125C5C20\"\r\n }\r\n },\r\n \"id\": \"CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62\",\r\n \"invitation\": {\r\n \"email\": \"ryan@contoso.com\",\r\n \"signInRequired\": true\r\n },\r\n \"roles\": [ \"write\" ]\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/invite",
"/shares/{sharedDriveItem-id}/root/invite"
]
},
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/search(q={q})": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Invoke function search",
"operationId": "shares.items.search.f2b1",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "driveItem-id",
"in": "path",
"description": "key: driveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "driveItem"
},
{
"name": "q",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc!123\",\r\n \"name\": \"Contoso Project\",\r\n \"folder\": {},\r\n \"searchResult\": { \"onClickTelemetryUrl\": \"https://bing.com/0123456789abc!123\" }\r\n },\r\n {\r\n \"id\": \"0123456789abc!456\",\r\n \"name\": \"Contoso Project 2016\",\r\n \"folder\": {},\r\n \"searchResult\": { \"onClickTelemetryUrl\": \"https://bing.com/0123456789abc!456\" }\r\n }\r\n ],\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/search(q={q})",
"/shares/{sharedDriveItem-id}/root/search(q={q})"
]
},
"/shares/{sharedDriveItem-id}/list": {
"get": {
"tags": [
"shares.list"
],
"summary": "Get list from shares",
"operationId": "shares.GetList",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"displayName",
"list",
"system",
"sharepointIds",
"createdByUser",
"lastModifiedByUser",
"columns",
"contentTypes",
"drive",
"items"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"columns",
"contentTypes",
"drive",
"items"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.list"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/listItem": {
"get": {
"tags": [
"shares.listItem"
],
"summary": "Get listItem from shares",
"operationId": "shares.GetListItem",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"contentType",
"sharepointIds",
"createdByUser",
"lastModifiedByUser",
"fields",
"driveItem",
"versions"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"fields",
"driveItem",
"versions"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.listItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/root": {
"get": {
"tags": [
"shares.driveItem"
],
"summary": "Get root from shares",
"operationId": "shares.GetRoot",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"audio",
"content",
"cTag",
"deleted",
"file",
"fileSystemInfo",
"folder",
"image",
"location",
"package",
"photo",
"publication",
"remoteItem",
"root",
"searchResult",
"shared",
"sharepointIds",
"size",
"specialFolder",
"video",
"webDavUrl",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"children",
"permissions",
"thumbnails",
"versions",
"listItem",
"workbook"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/shares/{sharedDriveItem-id}/root/copy": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "Returns details about how to [monitor the progress](../../../concepts/long_running_actions_overview.md) of the copy, upon accepting the request.",
"operationId": "shares.root.copy",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"parentReference": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemReference"
}
],
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/copy",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/copy"
]
},
"/shares/{sharedDriveItem-id}/root/createLink": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "The following example requests a sharing link to be created for the DriveItem specified by {itemId} in the user's OneDrive.\r\nThe sharing link is configured to be read-only and usable by anyone with the link.",
"operationId": "shares.root.createLink",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"scope": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.permission"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/createLink",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/createLink"
]
},
"/shares/{sharedDriveItem-id}/root/createUploadSession": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "Invoke action createUploadSession",
"operationId": "shares.root.createUploadSession",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "if-match",
"in": "header",
"description": "If this request header is included and the eTag (or cTag) provided does not match the current etag on the item, a 412 Precondition Failed error response is returned.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItemUploadableProperties"
}
],
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.uploadSession"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"uploadUrl\": \"https://sn3302.up.1drv.com/up/fe6987415ace7X4e1eF866337\",\r\n \"expirationDateTime\": \"2015-01-29T09:21:55.523Z\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/createUploadSession",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/createUploadSession"
]
},
"/shares/{sharedDriveItem-id}/root/delta()": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Here is an example of how to call this API to establish your local state.",
"operationId": "shares.root.delta.2209",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc\",\r\n \"name\": \"folder2\",\r\n \"folder\": { }\r\n },\r\n {\r\n \"id\": \"123010204abac\",\r\n \"name\": \"file.txt\",\r\n \"file\": { }\r\n },\r\n {\r\n \"id\": \"2353010204ddgg\",\r\n \"name\": \"file5.txt\",\r\n \"deleted\": { }\r\n }\r\n ],\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/drive/delta(token=1230919asd190410jlka)\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/delta()",
"/shares/{sharedDriveItem-id}/driveItem/delta(token={token})",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta()",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta(token={token})",
"/shares/{sharedDriveItem-id}/root/delta(token={token})"
]
},
"/shares/{sharedDriveItem-id}/root/delta(token={token})": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Here is an example of how to call this API to update your local state.",
"operationId": "shares.root.delta.cf70",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc\",\r\n \"name\": \"folder2\",\r\n \"folder\": { },\r\n \"deleted\": { }\r\n },\r\n {\r\n \"id\": \"123010204abac\",\r\n \"name\": \"file.txt\",\r\n \"file\": { }\r\n }\r\n ],\r\n \"@odata.deltaLink\": \"https://graph.microsoft.com/v1.0/me/drive/root/delta?(token='1230919asd190410jlka')\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/delta()",
"/shares/{sharedDriveItem-id}/driveItem/delta(token={token})",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta()",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/delta(token={token})",
"/shares/{sharedDriveItem-id}/root/delta()"
]
},
"/shares/{sharedDriveItem-id}/root/invite": {
"post": {
"tags": [
"shares.Actions"
],
"summary": "This example sends a sharing invitation to a user with email address 'ryan@contoso.com' with a message about a file being collaborated on.\r\nThe invitation grants Ryan read-write access to the file.",
"operationId": "shares.root.invite",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveRecipient"
}
],
"nullable": true
}
},
"message": {
"type": "string",
"nullable": true
},
"requireSignIn": {
"type": "boolean",
"default": false,
"nullable": true
},
"sendInvitation": {
"type": "boolean",
"default": false,
"nullable": true
},
"roles": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.permission"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"grantedTo\": {\r\n \"user\": {\r\n \"displayName\": \"Ryan Gregg\",\r\n \"id\": \"42F177F1-22C0-4BE3-900D-4507125C5C20\"\r\n }\r\n },\r\n \"id\": \"CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62\",\r\n \"invitation\": {\r\n \"email\": \"ryan@contoso.com\",\r\n \"signInRequired\": true\r\n },\r\n \"roles\": [ \"write\" ]\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.ReadWrite",
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.ReadWrite",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.ReadWrite.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/invite",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/invite"
]
},
"/shares/{sharedDriveItem-id}/root/search(q={q})": {
"get": {
"tags": [
"shares.Functions"
],
"summary": "Invoke function search",
"operationId": "shares.root.search.f2b1",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "q",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"value\": [\r\n {\r\n \"id\": \"0123456789abc!123\",\r\n \"name\": \"Contoso Project\",\r\n \"folder\": {},\r\n \"searchResult\": { \"onClickTelemetryUrl\": \"https://bing.com/0123456789abc!123\" }\r\n },\r\n {\r\n \"id\": \"0123456789abc!456\",\r\n \"name\": \"Contoso Project 2016\",\r\n \"folder\": {},\r\n \"searchResult\": { \"onClickTelemetryUrl\": \"https://bing.com/0123456789abc!456\" }\r\n }\r\n ],\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Delegated (personal Microsoft account)": [
"Files.Read",
"Files.ReadWrite",
"Files.Read.All",
"Files.ReadWrite.All"
]
},
{
"Application": [
"Files.Read.All",
"Files.ReadWrite.All",
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/shares/{sharedDriveItem-id}/driveItem/search(q={q})",
"/shares/{sharedDriveItem-id}/items/{driveItem-id}/search(q={q})"
]
},
"/shares/{sharedDriveItem-id}/site": {
"get": {
"tags": [
"shares.site"
],
"summary": "Get site from shares",
"operationId": "shares.GetSite",
"parameters": [
{
"name": "sharedDriveItem-id",
"in": "path",
"description": "key: sharedDriveItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "sharedDriveItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"root",
"sharepointIds",
"siteCollection",
"displayName",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites": {
"get": {
"tags": [
"sites.site"
],
"summary": "Get entities from sites",
"operationId": "sites.site.ListSite",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"root",
"root desc",
"sharepointIds",
"sharepointIds desc",
"siteCollection",
"siteCollection desc",
"displayName",
"displayName desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"root",
"sharepointIds",
"siteCollection",
"displayName",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"title": "Collection of site",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"id\": \"contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE\",\r\n \"displayName\": \"OneDrive Team Site\",\r\n \"name\": \"1drvteam\",\r\n \"createdDateTime\": \"2017-05-09T20:56:00Z\",\r\n \"lastModifiedDateTime\": \"2017-05-09T20:56:01Z\",\r\n \"webUrl\": \"https://contoso.sharepoint.com/teams/1drvteam\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Application": [
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"post": {
"tags": [
"sites.site"
],
"summary": "Add new entity to sites",
"operationId": "sites.site.CreateSite",
"requestBody": {
"description": "New entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}": {
"get": {
"tags": [
"sites.site"
],
"summary": "Get entity from sites by key",
"operationId": "sites.site.GetSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"root",
"sharepointIds",
"siteCollection",
"displayName",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"id\": \"contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE\",\r\n \"displayName\": \"OneDrive Team Site\",\r\n \"name\": \"1drvteam\",\r\n \"createdDateTime\": \"2017-05-09T20:56:00Z\",\r\n \"lastModifiedDateTime\": \"2017-05-09T20:56:01Z\",\r\n \"webUrl\": \"https://contoso.sharepoint.com/teams/1drvteam\"\r\n}\n"
}
}
}
},
"links": {
"contentTypes": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"drive": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"drives": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"items": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"lists": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"sites": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"columns": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
},
"onenote": {
"operationId": "sites.site.GetSite",
"parameters": {
"id": "$request.path.id"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Sites.Read.All",
"Sites.ReadWrite.All"
]
},
{
"Application": [
"Sites.Read.All",
"Sites.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"sites.site"
],
"summary": "Update entity in sites",
"operationId": "sites.site.UpdateSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"delete": {
"tags": [
"sites.site"
],
"summary": "Delete entity from sites",
"operationId": "sites.site.DeleteSite",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "If-Match",
"in": "header",
"description": "ETag",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/columns": {
"get": {
"tags": [
"sites.columnDefinition"
],
"summary": "Get columns from sites",
"operationId": "sites.ListColumns",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"columnGroup",
"columnGroup desc",
"description",
"description desc",
"displayName",
"displayName desc",
"enforceUniqueValues",
"enforceUniqueValues desc",
"hidden",
"hidden desc",
"indexed",
"indexed desc",
"name",
"name desc",
"readOnly",
"readOnly desc",
"required",
"required desc",
"boolean",
"boolean desc",
"calculated",
"calculated desc",
"choice",
"choice desc",
"currency",
"currency desc",
"dateTime",
"dateTime desc",
"defaultValue",
"defaultValue desc",
"lookup",
"lookup desc",
"number",
"number desc",
"personOrGroup",
"personOrGroup desc",
"text",
"text desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"columnGroup",
"description",
"displayName",
"enforceUniqueValues",
"hidden",
"indexed",
"name",
"readOnly",
"required",
"boolean",
"calculated",
"choice",
"currency",
"dateTime",
"defaultValue",
"lookup",
"number",
"personOrGroup",
"text"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.columnDefinition"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/columns/{columnDefinition-id}": {
"get": {
"tags": [
"sites.columnDefinition"
],
"summary": "Get columns from sites",
"operationId": "sites.GetColumns",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "columnDefinition-id",
"in": "path",
"description": "key: columnDefinition-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "columnDefinition"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"columnGroup",
"description",
"displayName",
"enforceUniqueValues",
"hidden",
"indexed",
"name",
"readOnly",
"required",
"boolean",
"calculated",
"choice",
"currency",
"dateTime",
"defaultValue",
"lookup",
"number",
"personOrGroup",
"text"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.columnDefinition"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/contentTypes": {
"get": {
"tags": [
"sites.contentType"
],
"summary": "Get contentTypes from sites",
"operationId": "sites.ListContentTypes",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"description",
"description desc",
"group",
"group desc",
"hidden",
"hidden desc",
"inheritedFrom",
"inheritedFrom desc",
"name",
"name desc",
"order",
"order desc",
"parentId",
"parentId desc",
"readOnly",
"readOnly desc",
"sealed",
"sealed desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"description",
"group",
"hidden",
"inheritedFrom",
"name",
"order",
"parentId",
"readOnly",
"sealed",
"columnLinks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"columnLinks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.contentType"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/contentTypes/{contentType-id}": {
"get": {
"tags": [
"sites.contentType"
],
"summary": "Get contentTypes from sites",
"operationId": "sites.GetContentTypes",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "contentType-id",
"in": "path",
"description": "key: contentType-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "contentType"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"description",
"group",
"hidden",
"inheritedFrom",
"name",
"order",
"parentId",
"readOnly",
"sealed",
"columnLinks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"columnLinks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.contentType"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/drive": {
"get": {
"tags": [
"sites.drive"
],
"summary": "Get drive from sites",
"operationId": "sites.GetDrive",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"driveType",
"owner",
"quota",
"sharepointIds",
"system",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/drives": {
"get": {
"tags": [
"sites.drive"
],
"summary": "Get drives from sites",
"operationId": "sites.ListDrives",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"driveType",
"driveType desc",
"owner",
"owner desc",
"quota",
"quota desc",
"sharepointIds",
"sharepointIds desc",
"system",
"system desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"driveType",
"owner",
"quota",
"sharepointIds",
"system",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/drives/{drive-id}": {
"get": {
"tags": [
"sites.drive"
],
"summary": "Get drives from sites",
"operationId": "sites.GetDrives",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "drive-id",
"in": "path",
"description": "key: drive-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "drive"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"driveType",
"owner",
"quota",
"sharepointIds",
"system",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/items": {
"get": {
"tags": [
"sites.baseItem"
],
"summary": "Get items from sites",
"operationId": "sites.ListItems",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"createdByUser",
"lastModifiedByUser"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.baseItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/items/{baseItem-id}": {
"get": {
"tags": [
"sites.baseItem"
],
"summary": "Get items from sites",
"operationId": "sites.GetItems",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "baseItem-id",
"in": "path",
"description": "key: baseItem-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "baseItem"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"createdByUser",
"lastModifiedByUser"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.baseItem"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/lists": {
"get": {
"tags": [
"sites.list"
],
"summary": "Get lists from sites",
"operationId": "sites.ListLists",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"displayName",
"displayName desc",
"list",
"list desc",
"system",
"system desc",
"sharepointIds",
"sharepointIds desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"displayName",
"list",
"system",
"sharepointIds",
"createdByUser",
"lastModifiedByUser",
"columns",
"contentTypes",
"drive",
"items"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"columns",
"contentTypes",
"drive",
"items"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.list"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/lists/{list-id}": {
"get": {
"tags": [
"sites.list"
],
"summary": "Get lists from sites",
"operationId": "sites.GetLists",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "list-id",
"in": "path",
"description": "key: list-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "list"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"displayName",
"list",
"system",
"sharepointIds",
"createdByUser",
"lastModifiedByUser",
"columns",
"contentTypes",
"drive",
"items"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"columns",
"contentTypes",
"drive",
"items"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.list"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/onenote": {
"get": {
"tags": [
"sites.onenote"
],
"summary": "Get onenote from sites",
"operationId": "sites.GetOnenote",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"notebooks",
"operations",
"pages",
"resources",
"sectionGroups",
"sections"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"notebooks",
"operations",
"pages",
"resources",
"sectionGroups",
"sections"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.onenote"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/sites": {
"get": {
"tags": [
"sites.site"
],
"summary": "Get sites from sites",
"operationId": "sites.ListSites",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"root",
"root desc",
"sharepointIds",
"sharepointIds desc",
"siteCollection",
"siteCollection desc",
"displayName",
"displayName desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"root",
"sharepointIds",
"siteCollection",
"displayName",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/sites/{site-id}/sites/{site-id}": {
"get": {
"tags": [
"sites.site"
],
"summary": "Get sites from sites",
"operationId": "sites.GetSites",
"parameters": [
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "site-id",
"in": "path",
"description": "key: site-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "site"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"root",
"sharepointIds",
"siteCollection",
"displayName",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"contentTypes",
"drive",
"drives",
"items",
"lists",
"sites",
"columns",
"onenote"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/subscribedSkus": {
"get": {
"tags": [
"subscribedSkus.subscribedSku"
],
"summary": "Get entities from subscribedSkus",
"operationId": "subscribedSkus.subscribedSku.ListSubscribedSku",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer token. Required",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"appliesTo",
"appliesTo desc",
"capabilityStatus",
"capabilityStatus desc",
"consumedUnits",
"consumedUnits desc",
"prepaidUnits",
"prepaidUnits desc",
"servicePlans",
"servicePlans desc",
"skuId",
"skuId desc",
"skuPartNumber",
"skuPartNumber desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"appliesTo",
"capabilityStatus",
"consumedUnits",
"prepaidUnits",
"servicePlans",
"skuId",
"skuPartNumber"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"title": "Collection of subscribedSku",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.subscribedSku"
}
}
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\": \"https://graph.microsoft.com/v1.0/$metadata#subscribedSkus/$entity\",\r\n \"capabilityStatus\": \"Enabled\",\r\n \"consumedUnits\": 14,\r\n \"id\": \"48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df\",\r\n \"prepaidUnits\": {\r\n \"enabled\": 25,\r\n \"suspended\": 0,\r\n \"warning\": 0\r\n },\r\n \"servicePlans\": [\r\n {\r\n \"servicePlanId\": \"8c098270-9dd4-4350-9b30-ba4703f3b36b\",\r\n \"servicePlanName\": \"ADALLOM_S_O365\",\r\n \"provisioningStatus\": \"Success\",\r\n \"appliesTo\": \"User\"\r\n },\r\n {\r\n \"servicePlanId\": \"9f431833-0334-42de-a7dc-70aa40db46db\",\r\n \"servicePlanName\": \"LOCKBOX_ENTERPRISE\",\r\n \"provisioningStatus\": \"Success\",\r\n \"appliesTo\": \"User\"\r\n }\r\n ],\r\n \"skuId\": \"c7df2760-2c81-4ef7-b578-5b5392b571df\",\r\n \"skuPartNumber\": \"ENTERPRISEPREMIUM\",\r\n \"appliesTo\": \"User\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Directory.Read.All",
"Directory.ReadWrite.All",
"Directory.AccessAsUser.All"
]
},
{
"Application": [
"Directory.Read.All",
"Directory.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"post": {
"tags": [
"subscribedSkus.subscribedSku"
],
"summary": "Add new entity to subscribedSkus",
"operationId": "subscribedSkus.subscribedSku.CreateSubscribedSku",
"requestBody": {
"description": "New entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscribedSku"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscribedSku"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/subscribedSkus/{subscribedSku-id}": {
"get": {
"tags": [
"subscribedSkus.subscribedSku"
],
"summary": "Get entity from subscribedSkus by key",
"operationId": "subscribedSkus.subscribedSku.GetSubscribedSku",
"parameters": [
{
"name": "subscribedSku-id",
"in": "path",
"description": "key: subscribedSku-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "subscribedSku"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer token. Required",
"schema": {
"type": "string"
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"appliesTo",
"capabilityStatus",
"consumedUnits",
"prepaidUnits",
"servicePlans",
"skuId",
"skuPartNumber"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscribedSku"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\": \"https://graph.microsoft.com/v1.0/$metadata#subscribedSkus/$entity\",\r\n \"capabilityStatus\": \"Enabled\",\r\n \"consumedUnits\": 14,\r\n \"id\": \"48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df\",\r\n \"prepaidUnits\": {\r\n \"enabled\": 25,\r\n \"suspended\": 0,\r\n \"warning\": 0\r\n },\r\n \"servicePlans\": [\r\n {\r\n \"servicePlanId\": \"8c098270-9dd4-4350-9b30-ba4703f3b36b\",\r\n \"servicePlanName\": \"ADALLOM_S_O365\",\r\n \"provisioningStatus\": \"Success\",\r\n \"appliesTo\": \"User\"\r\n },\r\n {\r\n \"servicePlanId\": \"9f431833-0334-42de-a7dc-70aa40db46db\",\r\n \"servicePlanName\": \"LOCKBOX_ENTERPRISE\",\r\n \"provisioningStatus\": \"Success\",\r\n \"appliesTo\": \"User\"\r\n }\r\n ],\r\n \"skuId\": \"c7df2760-2c81-4ef7-b578-5b5392b571df\",\r\n \"skuPartNumber\": \"ENTERPRISEPREMIUM\",\r\n \"appliesTo\": \"User\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Directory.Read.All",
"Directory.ReadWrite.All",
"Directory.AccessAsUser.All"
]
},
{
"Application": [
"Directory.Read.All",
"Directory.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"subscribedSkus.subscribedSku"
],
"summary": "Update entity in subscribedSkus",
"operationId": "subscribedSkus.subscribedSku.UpdateSubscribedSku",
"parameters": [
{
"name": "subscribedSku-id",
"in": "path",
"description": "key: subscribedSku-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "subscribedSku"
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscribedSku"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"delete": {
"tags": [
"subscribedSkus.subscribedSku"
],
"summary": "Delete entity from subscribedSkus",
"operationId": "subscribedSkus.subscribedSku.DeleteSubscribedSku",
"parameters": [
{
"name": "subscribedSku-id",
"in": "path",
"description": "key: subscribedSku-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "subscribedSku"
},
{
"name": "If-Match",
"in": "header",
"description": "ETag",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/subscriptions": {
"get": {
"tags": [
"subscriptions.subscription"
],
"summary": "Get entities from subscriptions",
"operationId": "subscriptions.subscription.ListSubscription",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"changeType",
"changeType desc",
"notificationUrl",
"notificationUrl desc",
"resource",
"resource desc",
"applicationId",
"applicationId desc",
"expirationDateTime",
"expirationDateTime desc",
"clientState",
"clientState desc",
"creatorId",
"creatorId desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"changeType",
"notificationUrl",
"resource",
"applicationId",
"expirationDateTime",
"clientState",
"creatorId"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"title": "Collection of subscription",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.subscription"
}
}
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"id\":\"7f105c7d-2dc5-4530-97cd-4e7ae6534c07\",\r\n \"resource\":\"me/messages\",\r\n \"applicationId\" : \"string\",\r\n \"changeType\":\"created,updated\",\r\n \"clientState\":\"secretClientValue\",\r\n \"notificationUrl\":\"https://webhook.azurewebsites.net/api/send/myNotifyClient\",\r\n \"expirationDateTime\":\"2016-11-20T18:23:45.9356913Z\",\r\n \"creatorId\": \"string\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"post": {
"tags": [
"subscriptions.subscription"
],
"summary": "Add new entity to subscriptions",
"operationId": "subscriptions.subscription.CreateSubscription",
"requestBody": {
"description": "New entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscription"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscription"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/subscriptions/{subscription-id}": {
"get": {
"tags": [
"subscriptions.subscription"
],
"summary": "Get entity from subscriptions by key",
"operationId": "subscriptions.subscription.GetSubscription",
"parameters": [
{
"name": "subscription-id",
"in": "path",
"description": "key: subscription-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "subscription"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"changeType",
"notificationUrl",
"resource",
"applicationId",
"expirationDateTime",
"clientState",
"creatorId"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscription"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"id\":\"7f105c7d-2dc5-4530-97cd-4e7ae6534c07\",\r\n \"resource\":\"me/messages\",\r\n \"applicationId\" : \"string\",\r\n \"changeType\":\"created,updated\",\r\n \"clientState\":\"secretClientValue\",\r\n \"notificationUrl\":\"https://webhook.azurewebsites.net/api/send/myNotifyClient\",\r\n \"expirationDateTime\":\"2016-11-20T18:23:45.9356913Z\",\r\n \"creatorId\": \"string\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"subscriptions.subscription"
],
"summary": "Update entity in subscriptions",
"operationId": "subscriptions.subscription.UpdateSubscription",
"parameters": [
{
"name": "subscription-id",
"in": "path",
"description": "key: subscription-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "subscription"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.subscription"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"delete": {
"tags": [
"subscriptions.subscription"
],
"summary": "Delete entity from subscriptions",
"operationId": "subscriptions.subscription.DeleteSubscription",
"parameters": [
{
"name": "subscription-id",
"in": "path",
"description": "key: subscription-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "subscription"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "If-Match",
"in": "header",
"description": "ETag",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users": {
"get": {
"tags": [
"users.user"
],
"summary": "Get entities from users",
"operationId": "users.user.ListUser",
"parameters": [
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"deviceEnrollmentLimit",
"deviceEnrollmentLimit desc",
"aboutMe",
"aboutMe desc",
"accountEnabled",
"accountEnabled desc",
"ageGroup",
"ageGroup desc",
"assignedLicenses",
"assignedLicenses desc",
"assignedPlans",
"assignedPlans desc",
"birthday",
"birthday desc",
"businessPhones",
"businessPhones desc",
"city",
"city desc",
"companyName",
"companyName desc",
"consentProvidedForMinor",
"consentProvidedForMinor desc",
"country",
"country desc",
"department",
"department desc",
"displayName",
"displayName desc",
"givenName",
"givenName desc",
"hireDate",
"hireDate desc",
"imAddresses",
"imAddresses desc",
"interests",
"interests desc",
"jobTitle",
"jobTitle desc",
"legalAgeGroupClassification",
"legalAgeGroupClassification desc",
"mail",
"mail desc",
"mailboxSettings",
"mailboxSettings desc",
"mailNickname",
"mailNickname desc",
"mobilePhone",
"mobilePhone desc",
"mySite",
"mySite desc",
"officeLocation",
"officeLocation desc",
"onPremisesDomainName",
"onPremisesDomainName desc",
"onPremisesExtensionAttributes",
"onPremisesExtensionAttributes desc",
"onPremisesImmutableId",
"onPremisesImmutableId desc",
"onPremisesLastSyncDateTime",
"onPremisesLastSyncDateTime desc",
"onPremisesProvisioningErrors",
"onPremisesProvisioningErrors desc",
"onPremisesSamAccountName",
"onPremisesSamAccountName desc",
"onPremisesSecurityIdentifier",
"onPremisesSecurityIdentifier desc",
"onPremisesSyncEnabled",
"onPremisesSyncEnabled desc",
"onPremisesUserPrincipalName",
"onPremisesUserPrincipalName desc",
"passwordPolicies",
"passwordPolicies desc",
"passwordProfile",
"passwordProfile desc",
"pastProjects",
"pastProjects desc",
"postalCode",
"postalCode desc",
"preferredLanguage",
"preferredLanguage desc",
"preferredName",
"preferredName desc",
"provisionedPlans",
"provisionedPlans desc",
"proxyAddresses",
"proxyAddresses desc",
"responsibilities",
"responsibilities desc",
"schools",
"schools desc",
"skills",
"skills desc",
"state",
"state desc",
"streetAddress",
"streetAddress desc",
"surname",
"surname desc",
"usageLocation",
"usageLocation desc",
"userPrincipalName",
"userPrincipalName desc",
"userType",
"userType desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"deviceEnrollmentLimit",
"aboutMe",
"accountEnabled",
"ageGroup",
"assignedLicenses",
"assignedPlans",
"birthday",
"businessPhones",
"city",
"companyName",
"consentProvidedForMinor",
"country",
"department",
"displayName",
"givenName",
"hireDate",
"imAddresses",
"interests",
"jobTitle",
"legalAgeGroupClassification",
"mail",
"mailboxSettings",
"mailNickname",
"mobilePhone",
"mySite",
"officeLocation",
"onPremisesDomainName",
"onPremisesExtensionAttributes",
"onPremisesImmutableId",
"onPremisesLastSyncDateTime",
"onPremisesProvisioningErrors",
"onPremisesSamAccountName",
"onPremisesSecurityIdentifier",
"onPremisesSyncEnabled",
"onPremisesUserPrincipalName",
"passwordPolicies",
"passwordProfile",
"pastProjects",
"postalCode",
"preferredLanguage",
"preferredName",
"provisionedPlans",
"proxyAddresses",
"responsibilities",
"schools",
"skills",
"state",
"streetAddress",
"surname",
"usageLocation",
"userPrincipalName",
"userType",
"managedDevices",
"managedAppRegistrations",
"deviceManagementTroubleshootingEvents",
"calendar",
"calendarGroups",
"calendarView",
"calendars",
"contacts",
"contactFolders",
"createdObjects",
"directReports",
"drive",
"drives",
"events",
"inferenceClassification",
"mailFolders",
"manager",
"memberOf",
"messages",
"outlook",
"ownedDevices",
"ownedObjects",
"photo",
"registeredDevices",
"activities",
"extensions",
"licenseDetails",
"onenote",
"people",
"planner"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"managedDevices",
"managedAppRegistrations",
"deviceManagementTroubleshootingEvents",
"calendar",
"calendarGroups",
"calendarView",
"calendars",
"contacts",
"contactFolders",
"createdObjects",
"directReports",
"drive",
"drives",
"events",
"inferenceClassification",
"mailFolders",
"manager",
"memberOf",
"messages",
"outlook",
"ownedDevices",
"ownedObjects",
"photo",
"registeredDevices",
"activities",
"extensions",
"licenseDetails",
"onenote",
"people",
"planner"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"title": "Collection of user",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.user"
}
}
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"post": {
"tags": [
"users.user"
],
"summary": "Add new entity to users",
"operationId": "users.user.CreateUser",
"requestBody": {
"description": "New entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.user"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.user"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}": {
"get": {
"tags": [
"users.user"
],
"summary": "Get entity from users by key",
"operationId": "users.user.GetUser",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"deviceEnrollmentLimit",
"aboutMe",
"accountEnabled",
"ageGroup",
"assignedLicenses",
"assignedPlans",
"birthday",
"businessPhones",
"city",
"companyName",
"consentProvidedForMinor",
"country",
"department",
"displayName",
"givenName",
"hireDate",
"imAddresses",
"interests",
"jobTitle",
"legalAgeGroupClassification",
"mail",
"mailboxSettings",
"mailNickname",
"mobilePhone",
"mySite",
"officeLocation",
"onPremisesDomainName",
"onPremisesExtensionAttributes",
"onPremisesImmutableId",
"onPremisesLastSyncDateTime",
"onPremisesProvisioningErrors",
"onPremisesSamAccountName",
"onPremisesSecurityIdentifier",
"onPremisesSyncEnabled",
"onPremisesUserPrincipalName",
"passwordPolicies",
"passwordProfile",
"pastProjects",
"postalCode",
"preferredLanguage",
"preferredName",
"provisionedPlans",
"proxyAddresses",
"responsibilities",
"schools",
"skills",
"state",
"streetAddress",
"surname",
"usageLocation",
"userPrincipalName",
"userType",
"managedDevices",
"managedAppRegistrations",
"deviceManagementTroubleshootingEvents",
"calendar",
"calendarGroups",
"calendarView",
"calendars",
"contacts",
"contactFolders",
"createdObjects",
"directReports",
"drive",
"drives",
"events",
"inferenceClassification",
"mailFolders",
"manager",
"memberOf",
"messages",
"outlook",
"ownedDevices",
"ownedObjects",
"photo",
"registeredDevices",
"activities",
"extensions",
"licenseDetails",
"onenote",
"people",
"planner"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"managedDevices",
"managedAppRegistrations",
"deviceManagementTroubleshootingEvents",
"calendar",
"calendarGroups",
"calendarView",
"calendars",
"contacts",
"contactFolders",
"createdObjects",
"directReports",
"drive",
"drives",
"events",
"inferenceClassification",
"mailFolders",
"manager",
"memberOf",
"messages",
"outlook",
"ownedDevices",
"ownedObjects",
"photo",
"registeredDevices",
"activities",
"extensions",
"licenseDetails",
"onenote",
"people",
"planner"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.user"
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n}\n"
}
}
}
},
"links": {
"managedDevices": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"managedAppRegistrations": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"deviceManagementTroubleshootingEvents": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"calendar": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"calendarGroups": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"calendarView": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"calendars": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"contacts": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"contactFolders": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"createdObjects": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"directReports": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"drive": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"drives": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"events": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"inferenceClassification": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"mailFolders": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"manager": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"memberOf": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"messages": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"outlook": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"ownedDevices": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"ownedObjects": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"photo": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"registeredDevices": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"activities": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"extensions": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"licenseDetails": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"onenote": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"people": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
},
"planner": {
"operationId": "users.user.GetUser",
"parameters": {
"id": "$request.path.id"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"patch": {
"tags": [
"users.user"
],
"summary": "Update entity in users",
"operationId": "users.user.UpdateUser",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
}
],
"requestBody": {
"description": "New property values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.user"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
},
"delete": {
"tags": [
"users.user"
],
"summary": "Delete entity from users",
"operationId": "users.user.DeleteUser",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "If-Match",
"in": "header",
"description": "ETag",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Directory.AccessAsUser.All"
]
},
{
"Application": [
"User.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/activities": {
"get": {
"tags": [
"users.userActivity"
],
"summary": "Get activities from users",
"operationId": "users.ListActivities",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"appActivityId",
"appActivityId desc",
"activitySourceHost",
"activitySourceHost desc",
"userTimezone",
"userTimezone desc",
"appDisplayName",
"appDisplayName desc",
"activationUrl",
"activationUrl desc",
"contentUrl",
"contentUrl desc",
"fallbackUrl",
"fallbackUrl desc",
"createdDateTime",
"createdDateTime desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"expirationDateTime",
"expirationDateTime desc",
"status",
"status desc",
"contentInfo",
"contentInfo desc",
"visualElements",
"visualElements desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"appActivityId",
"activitySourceHost",
"userTimezone",
"appDisplayName",
"activationUrl",
"contentUrl",
"fallbackUrl",
"createdDateTime",
"lastModifiedDateTime",
"expirationDateTime",
"status",
"contentInfo",
"visualElements",
"historyItems"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"historyItems"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.userActivity"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/activities/{userActivity-id}": {
"get": {
"tags": [
"users.userActivity"
],
"summary": "Get activities from users",
"operationId": "users.GetActivities",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "userActivity-id",
"in": "path",
"description": "key: userActivity-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "userActivity"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"appActivityId",
"activitySourceHost",
"userTimezone",
"appDisplayName",
"activationUrl",
"contentUrl",
"fallbackUrl",
"createdDateTime",
"lastModifiedDateTime",
"expirationDateTime",
"status",
"contentInfo",
"visualElements",
"historyItems"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"historyItems"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.userActivity"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/activities/recent()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function recent",
"operationId": "users.activities.recent.f75f",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.userActivity"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\": \"https://graph.microsoft.com/v1.0/$metadata#Collection(userActivity)\",\r\n \"@odata.nextLink\": \"https://graph.microsoft.com/v1.0/me/activities/recent?$skiptoken=%24filter%3dlastModifiedDateTime+lt+2018-02-26T18%3a06%3a19.365Z\",\r\n \"value\": [{\r\n \"@odata.type\": \"#microsoft.graph.userActivity\",\r\n \"activitySourceHost\": \"https://www.contoso.com\",\r\n \"createdDateTime\": \"2018-02-26T18:34:29.592Z\",\r\n \"lastModifiedDateTime\": \"2018-02-26T18:34:29.607Z\",\r\n \"id\": \"5347642601316252694\",\r\n \"appActivityId\": \"/article?12345\",\r\n \"visualElements\": {\r\n \"attribution\": {\r\n \"iconUrl\": \"http://www.contoso.com/icon\",\r\n \"alternateText\": \"Contoso, Ltd.\",\r\n \"addImageQuery\": false,\r\n },\r\n \"displayText\": \"Contoso How-To: How to Tie a Reef Knot\",\r\n \"description\": \"How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.\",\r\n \"backgroundColor\": \"#ff0000\",\r\n \"content\": {\r\n \"$schema\": \"http://adaptivecards.io/schemas/adaptive-card.json\",\r\n \"type\": \"AdaptiveCard\",\r\n \"body\":\r\n [{\r\n \"type\": \"TextBlock\",\r\n \"text\": \"Contoso MainPage\"\r\n }]\r\n }\r\n },\r\n \"activationUrl\": \"http://www.contoso.com/article?id=12345\",\r\n \"appDisplayName\": \"Contoso, Ltd.\",\r\n \"userTimezone\": \"Africa/Casablanca\",\r\n \"fallbackUrl\": \"http://www.contoso.com/article?id=12345\",\r\n \"contentUrl\": \"http://www.contoso.com/article?id=12345\",\r\n \"contentInfo\": {\r\n \"@context\": \"http://schema.org\",\r\n \"@type\": \"Article\",\r\n \"author\": \"John Doe\",\r\n \"name\": \"How to Tie a Reef Knot\"\r\n },\r\n \"expirationDateTime\": \"2018-03-28T18:34:29.607Z\",\r\n \"status\": \"updated\"\r\n }]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"UserActivity.ReadWrite.CreatedByApp"
]
},
{
"Delegated (personal Microsoft account)": [
"UserActivity.ReadWrite.CreatedByApp"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/users/{user-id}/calendar": {
"get": {
"tags": [
"users.calendar"
],
"summary": "Get calendar from users",
"operationId": "users.GetCalendar",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"canEdit",
"canShare",
"canViewPrivateItems",
"changeKey",
"color",
"name",
"owner",
"calendarView",
"events",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"calendarView",
"events",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.calendar"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendarGroups": {
"get": {
"tags": [
"users.calendarGroup"
],
"summary": "Get calendarGroups from users",
"operationId": "users.ListCalendarGroups",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"changeKey",
"changeKey desc",
"classId",
"classId desc",
"name",
"name desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"changeKey",
"classId",
"name",
"calendars"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"calendars"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.calendarGroup"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendarGroups/{calendarGroup-id}": {
"get": {
"tags": [
"users.calendarGroup"
],
"summary": "Get calendarGroups from users",
"operationId": "users.GetCalendarGroups",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "calendarGroup-id",
"in": "path",
"description": "key: calendarGroup-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "calendarGroup"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"changeKey",
"classId",
"name",
"calendars"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"calendars"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.calendarGroup"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendars": {
"get": {
"tags": [
"users.calendar"
],
"summary": "Get calendars from users",
"operationId": "users.ListCalendars",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"canEdit",
"canEdit desc",
"canShare",
"canShare desc",
"canViewPrivateItems",
"canViewPrivateItems desc",
"changeKey",
"changeKey desc",
"color",
"color desc",
"name",
"name desc",
"owner",
"owner desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"canEdit",
"canShare",
"canViewPrivateItems",
"changeKey",
"color",
"name",
"owner",
"calendarView",
"events",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"calendarView",
"events",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.calendar"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendars/{calendar-id}": {
"get": {
"tags": [
"users.calendar"
],
"summary": "Get calendars from users",
"operationId": "users.GetCalendars",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "calendar-id",
"in": "path",
"description": "key: calendar-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "calendar"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"canEdit",
"canShare",
"canViewPrivateItems",
"changeKey",
"color",
"name",
"owner",
"calendarView",
"events",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"calendarView",
"events",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.calendar"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendarView": {
"get": {
"tags": [
"users.event"
],
"summary": "Get calendarView from users",
"operationId": "users.ListCalendarView",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"categories",
"categories desc",
"changeKey",
"changeKey desc",
"createdDateTime",
"createdDateTime desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"attendees",
"attendees desc",
"body",
"body desc",
"bodyPreview",
"bodyPreview desc",
"end",
"end desc",
"hasAttachments",
"hasAttachments desc",
"iCalUId",
"iCalUId desc",
"importance",
"importance desc",
"isAllDay",
"isAllDay desc",
"isCancelled",
"isCancelled desc",
"isOrganizer",
"isOrganizer desc",
"isReminderOn",
"isReminderOn desc",
"location",
"location desc",
"locations",
"locations desc",
"onlineMeetingUrl",
"onlineMeetingUrl desc",
"organizer",
"organizer desc",
"originalEndTimeZone",
"originalEndTimeZone desc",
"originalStart",
"originalStart desc",
"originalStartTimeZone",
"originalStartTimeZone desc",
"recurrence",
"recurrence desc",
"reminderMinutesBeforeStart",
"reminderMinutesBeforeStart desc",
"responseRequested",
"responseRequested desc",
"responseStatus",
"responseStatus desc",
"sensitivity",
"sensitivity desc",
"seriesMasterId",
"seriesMasterId desc",
"showAs",
"showAs desc",
"start",
"start desc",
"subject",
"subject desc",
"type",
"type desc",
"webLink",
"webLink desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"attendees",
"body",
"bodyPreview",
"end",
"hasAttachments",
"iCalUId",
"importance",
"isAllDay",
"isCancelled",
"isOrganizer",
"isReminderOn",
"location",
"locations",
"onlineMeetingUrl",
"organizer",
"originalEndTimeZone",
"originalStart",
"originalStartTimeZone",
"recurrence",
"reminderMinutesBeforeStart",
"responseRequested",
"responseStatus",
"sensitivity",
"seriesMasterId",
"showAs",
"start",
"subject",
"type",
"webLink",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendarView/{event-id}": {
"get": {
"tags": [
"users.event"
],
"summary": "Get calendarView from users",
"operationId": "users.GetCalendarView",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"attendees",
"body",
"bodyPreview",
"end",
"hasAttachments",
"iCalUId",
"importance",
"isAllDay",
"isCancelled",
"isOrganizer",
"isReminderOn",
"location",
"locations",
"onlineMeetingUrl",
"organizer",
"originalEndTimeZone",
"originalStart",
"originalStartTimeZone",
"recurrence",
"reminderMinutesBeforeStart",
"responseRequested",
"responseStatus",
"sensitivity",
"seriesMasterId",
"showAs",
"start",
"subject",
"type",
"webLink",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/calendarView/{event-id}/accept": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.calendarView.accept",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"sendResponse": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/events/{event-id}/accept"
]
},
"/users/{user-id}/calendarView/{event-id}/decline": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.calendarView.decline",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"sendResponse": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/events/{event-id}/decline"
]
},
"/users/{user-id}/calendarView/{event-id}/dismissReminder": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.calendarView.dismissReminder",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/events/{event-id}/dismissReminder"
]
},
"/users/{user-id}/calendarView/{event-id}/snoozeReminder": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.calendarView.snoozeReminder",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"newReminderTime": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.dateTimeTimeZone"
}
],
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/events/{event-id}/snoozeReminder"
]
},
"/users/{user-id}/calendarView/{event-id}/tentativelyAccept": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.calendarView.tentativelyAccept",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"sendResponse": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/events/{event-id}/tentativelyAccept"
]
},
"/users/{user-id}/calendarView/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.calendarView.delta.2209",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "startDateTime",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "endDateTime",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "odata.maxpagesize={x}. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "{Time zone}. Optional, UTC assumed if absent.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.event"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken={_skipToken_}\",\r\n \"value\": [\r\n {\r\n \"originalStartTimeZone\": \"originalStartTimeZone-value\",\r\n \"originalEndTimeZone\": \"originalEndTimeZone-value\",\r\n \"responseStatus\": {\r\n \"response\": \"response-value\",\r\n \"time\": \"datetime-value\"\r\n },\r\n \"iCalUId\": \"iCalUId-value\",\r\n \"reminderMinutesBeforeStart\": 99,\r\n \"isReminderOn\": true\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.Read"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.Read"
]
},
{
"Application": [
"Calendars.Read"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/contactFolders/delta()",
"/users/{user-id}/contacts/delta()",
"/users/{user-id}/events/delta()",
"/users/{user-id}/mailFolders/delta()",
"/users/{user-id}/messages/delta()",
"/users/delta()"
]
},
"/users/{user-id}/contactFolders": {
"get": {
"tags": [
"users.contactFolder"
],
"summary": "Get contactFolders from users",
"operationId": "users.ListContactFolders",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"displayName",
"displayName desc",
"parentFolderId",
"parentFolderId desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"displayName",
"parentFolderId",
"childFolders",
"contacts",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"childFolders",
"contacts",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.contactFolder"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/contactFolders/{contactFolder-id}": {
"get": {
"tags": [
"users.contactFolder"
],
"summary": "Get contactFolders from users",
"operationId": "users.GetContactFolders",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "contactFolder-id",
"in": "path",
"description": "key: contactFolder-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "contactFolder"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"displayName",
"parentFolderId",
"childFolders",
"contacts",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"childFolders",
"contacts",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.contactFolder"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/contactFolders/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.contactFolders.delta.2209",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "odata.maxpagesize={x}. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.contactFolder"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/me/contactfolders/delta?$skiptoken={_skipToken_}\",\r\n \"value\": [\r\n {\r\n \"parentFolderId\": \"parentFolderId-value\",\r\n \"displayName\": \"displayName-value\",\r\n \"id\": \"id-value\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Contacts.Read",
"Contacts.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Contacts.Read",
"Contacts.ReadWrite"
]
},
{
"Application": [
"Contacts.Read",
"Contacts.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/delta()",
"/users/{user-id}/contacts/delta()",
"/users/{user-id}/events/delta()",
"/users/{user-id}/mailFolders/delta()",
"/users/{user-id}/messages/delta()",
"/users/delta()"
]
},
"/users/{user-id}/contacts": {
"get": {
"tags": [
"users.contact"
],
"summary": "Get contacts from users",
"operationId": "users.ListContacts",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"categories",
"categories desc",
"changeKey",
"changeKey desc",
"createdDateTime",
"createdDateTime desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"assistantName",
"assistantName desc",
"birthday",
"birthday desc",
"businessAddress",
"businessAddress desc",
"businessHomePage",
"businessHomePage desc",
"businessPhones",
"businessPhones desc",
"children",
"children desc",
"companyName",
"companyName desc",
"department",
"department desc",
"displayName",
"displayName desc",
"emailAddresses",
"emailAddresses desc",
"flag",
"flag desc",
"fileAs",
"fileAs desc",
"generation",
"generation desc",
"givenName",
"givenName desc",
"homeAddress",
"homeAddress desc",
"homePhones",
"homePhones desc",
"imAddresses",
"imAddresses desc",
"initials",
"initials desc",
"jobTitle",
"jobTitle desc",
"manager",
"manager desc",
"middleName",
"middleName desc",
"mobilePhone",
"mobilePhone desc",
"nickName",
"nickName desc",
"officeLocation",
"officeLocation desc",
"otherAddress",
"otherAddress desc",
"parentFolderId",
"parentFolderId desc",
"personalNotes",
"personalNotes desc",
"profession",
"profession desc",
"spouseName",
"spouseName desc",
"surname",
"surname desc",
"title",
"title desc",
"yomiCompanyName",
"yomiCompanyName desc",
"yomiGivenName",
"yomiGivenName desc",
"yomiSurname",
"yomiSurname desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"assistantName",
"birthday",
"businessAddress",
"businessHomePage",
"businessPhones",
"children",
"companyName",
"department",
"displayName",
"emailAddresses",
"flag",
"fileAs",
"generation",
"givenName",
"homeAddress",
"homePhones",
"imAddresses",
"initials",
"jobTitle",
"manager",
"middleName",
"mobilePhone",
"nickName",
"officeLocation",
"otherAddress",
"parentFolderId",
"personalNotes",
"profession",
"spouseName",
"surname",
"title",
"yomiCompanyName",
"yomiGivenName",
"yomiSurname",
"photo",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"photo",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.contact"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/contacts/{contact-id}": {
"get": {
"tags": [
"users.contact"
],
"summary": "Get contacts from users",
"operationId": "users.GetContacts",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "contact-id",
"in": "path",
"description": "key: contact-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "contact"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"assistantName",
"birthday",
"businessAddress",
"businessHomePage",
"businessPhones",
"children",
"companyName",
"department",
"displayName",
"emailAddresses",
"flag",
"fileAs",
"generation",
"givenName",
"homeAddress",
"homePhones",
"imAddresses",
"initials",
"jobTitle",
"manager",
"middleName",
"mobilePhone",
"nickName",
"officeLocation",
"otherAddress",
"parentFolderId",
"personalNotes",
"profession",
"spouseName",
"surname",
"title",
"yomiCompanyName",
"yomiGivenName",
"yomiSurname",
"photo",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"photo",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.contact"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/contacts/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.contacts.delta.2209",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "odata.maxpagesize={x}. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.contact"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/me/contactfolders('{id}')/contacts/delta?$skiptoken={_skipToken_}\",\r\n \"value\": [\r\n {\r\n \"parentFolderId\": \"parentFolderId-value\",\r\n \"birthday\": \"2016-10-19T10:37:00Z\",\r\n \"fileAs\": \"fileAs-value\",\r\n \"displayName\": \"displayName-value\",\r\n \"givenName\": \"givenName-value\",\r\n \"initials\": \"initials-value\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Contacts.Read",
"Contacts.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Contacts.Read",
"Contacts.ReadWrite"
]
},
{
"Application": [
"Contacts.Read",
"Contacts.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/delta()",
"/users/{user-id}/contactFolders/delta()",
"/users/{user-id}/events/delta()",
"/users/{user-id}/mailFolders/delta()",
"/users/{user-id}/messages/delta()",
"/users/delta()"
]
},
"/users/{user-id}/createdObjects": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get createdObjects from users",
"operationId": "users.ListCreatedObjects",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/createdObjects/{directoryObject-id}": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get createdObjects from users",
"operationId": "users.GetCreatedObjects",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/deviceManagementTroubleshootingEvents": {
"get": {
"tags": [
"users.deviceManagementTroubleshootingEvent"
],
"summary": "Get deviceManagementTroubleshootingEvents from users",
"operationId": "users.ListDeviceManagementTroubleshootingEvents",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"eventDateTime",
"eventDateTime desc",
"correlationId",
"correlationId desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"eventDateTime",
"correlationId"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/deviceManagementTroubleshootingEvents/{deviceManagementTroubleshootingEvent-id}": {
"get": {
"tags": [
"users.deviceManagementTroubleshootingEvent"
],
"summary": "Get deviceManagementTroubleshootingEvents from users",
"operationId": "users.GetDeviceManagementTroubleshootingEvents",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "deviceManagementTroubleshootingEvent-id",
"in": "path",
"description": "key: deviceManagementTroubleshootingEvent-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "deviceManagementTroubleshootingEvent"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"eventDateTime",
"correlationId"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/directReports": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get directReports from users",
"operationId": "users.ListDirectReports",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/directReports/{directoryObject-id}": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get directReports from users",
"operationId": "users.GetDirectReports",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/drive": {
"get": {
"tags": [
"users.drive"
],
"summary": "Get drive from users",
"operationId": "users.GetDrive",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"driveType",
"owner",
"quota",
"sharepointIds",
"system",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/drives": {
"get": {
"tags": [
"users.drive"
],
"summary": "Get drives from users",
"operationId": "users.ListDrives",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdBy",
"createdBy desc",
"createdDateTime",
"createdDateTime desc",
"description",
"description desc",
"eTag",
"eTag desc",
"lastModifiedBy",
"lastModifiedBy desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"name",
"name desc",
"parentReference",
"parentReference desc",
"webUrl",
"webUrl desc",
"driveType",
"driveType desc",
"owner",
"owner desc",
"quota",
"quota desc",
"sharepointIds",
"sharepointIds desc",
"system",
"system desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"driveType",
"owner",
"quota",
"sharepointIds",
"system",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/drives/{drive-id}": {
"get": {
"tags": [
"users.drive"
],
"summary": "Get drives from users",
"operationId": "users.GetDrives",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "drive-id",
"in": "path",
"description": "key: drive-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "drive"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdBy",
"createdDateTime",
"description",
"eTag",
"lastModifiedBy",
"lastModifiedDateTime",
"name",
"parentReference",
"webUrl",
"driveType",
"owner",
"quota",
"sharepointIds",
"system",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"createdByUser",
"lastModifiedByUser",
"items",
"root",
"special",
"list"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/events": {
"get": {
"tags": [
"users.event"
],
"summary": "Get events from users",
"operationId": "users.ListEvents",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"categories",
"categories desc",
"changeKey",
"changeKey desc",
"createdDateTime",
"createdDateTime desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"attendees",
"attendees desc",
"body",
"body desc",
"bodyPreview",
"bodyPreview desc",
"end",
"end desc",
"hasAttachments",
"hasAttachments desc",
"iCalUId",
"iCalUId desc",
"importance",
"importance desc",
"isAllDay",
"isAllDay desc",
"isCancelled",
"isCancelled desc",
"isOrganizer",
"isOrganizer desc",
"isReminderOn",
"isReminderOn desc",
"location",
"location desc",
"locations",
"locations desc",
"onlineMeetingUrl",
"onlineMeetingUrl desc",
"organizer",
"organizer desc",
"originalEndTimeZone",
"originalEndTimeZone desc",
"originalStart",
"originalStart desc",
"originalStartTimeZone",
"originalStartTimeZone desc",
"recurrence",
"recurrence desc",
"reminderMinutesBeforeStart",
"reminderMinutesBeforeStart desc",
"responseRequested",
"responseRequested desc",
"responseStatus",
"responseStatus desc",
"sensitivity",
"sensitivity desc",
"seriesMasterId",
"seriesMasterId desc",
"showAs",
"showAs desc",
"start",
"start desc",
"subject",
"subject desc",
"type",
"type desc",
"webLink",
"webLink desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"attendees",
"body",
"bodyPreview",
"end",
"hasAttachments",
"iCalUId",
"importance",
"isAllDay",
"isCancelled",
"isOrganizer",
"isReminderOn",
"location",
"locations",
"onlineMeetingUrl",
"organizer",
"originalEndTimeZone",
"originalStart",
"originalStartTimeZone",
"recurrence",
"reminderMinutesBeforeStart",
"responseRequested",
"responseStatus",
"sensitivity",
"seriesMasterId",
"showAs",
"start",
"subject",
"type",
"webLink",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/events/{event-id}": {
"get": {
"tags": [
"users.event"
],
"summary": "Get events from users",
"operationId": "users.GetEvents",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"attendees",
"body",
"bodyPreview",
"end",
"hasAttachments",
"iCalUId",
"importance",
"isAllDay",
"isCancelled",
"isOrganizer",
"isReminderOn",
"location",
"locations",
"onlineMeetingUrl",
"organizer",
"originalEndTimeZone",
"originalStart",
"originalStartTimeZone",
"recurrence",
"reminderMinutesBeforeStart",
"responseRequested",
"responseStatus",
"sensitivity",
"seriesMasterId",
"showAs",
"start",
"subject",
"type",
"webLink",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"attachments",
"calendar",
"extensions",
"instances",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/events/{event-id}/accept": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.events.accept",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"sendResponse": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/{event-id}/accept"
]
},
"/users/{user-id}/events/{event-id}/decline": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.events.decline",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"sendResponse": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/{event-id}/decline"
]
},
"/users/{user-id}/events/{event-id}/dismissReminder": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.events.dismissReminder",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/{event-id}/dismissReminder"
]
},
"/users/{user-id}/events/{event-id}/snoozeReminder": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.events.snoozeReminder",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"newReminderTime": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.dateTimeTimeZone"
}
],
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/{event-id}/snoozeReminder"
]
},
"/users/{user-id}/events/{event-id}/tentativelyAccept": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.events.tentativelyAccept",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "event-id",
"in": "path",
"description": "key: event-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "event"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"sendResponse": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/{event-id}/tentativelyAccept"
]
},
"/users/{user-id}/events/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.events.delta.2209",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "startDateTime",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "endDateTime",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "odata.maxpagesize={x}. Optional.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "{Time zone}. Optional, UTC assumed if absent.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.event"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken={_skipToken_}\",\r\n \"value\": [\r\n {\r\n \"originalStartTimeZone\": \"originalStartTimeZone-value\",\r\n \"originalEndTimeZone\": \"originalEndTimeZone-value\",\r\n \"responseStatus\": {\r\n \"response\": \"response-value\",\r\n \"time\": \"datetime-value\"\r\n },\r\n \"iCalUId\": \"iCalUId-value\",\r\n \"reminderMinutesBeforeStart\": 99,\r\n \"isReminderOn\": true\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.Read"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.Read"
]
},
{
"Application": [
"Calendars.Read"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/delta()",
"/users/{user-id}/contactFolders/delta()",
"/users/{user-id}/contacts/delta()",
"/users/{user-id}/mailFolders/delta()",
"/users/{user-id}/messages/delta()",
"/users/delta()"
]
},
"/users/{user-id}/extensions": {
"get": {
"tags": [
"users.extension"
],
"summary": "Get extensions from users",
"operationId": "users.ListExtensions",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/extensions/{extension-id}": {
"get": {
"tags": [
"users.extension"
],
"summary": "Get extensions from users",
"operationId": "users.GetExtensions",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "extension-id",
"in": "path",
"description": "key: extension-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "extension"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/inferenceClassification": {
"get": {
"tags": [
"users.inferenceClassification"
],
"summary": "Get inferenceClassification from users",
"operationId": "users.GetInferenceClassification",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"overrides"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"overrides"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.inferenceClassification"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/licenseDetails": {
"get": {
"tags": [
"users.licenseDetails"
],
"summary": "Get licenseDetails from users",
"operationId": "users.ListLicenseDetails",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"servicePlans",
"servicePlans desc",
"skuId",
"skuId desc",
"skuPartNumber",
"skuPartNumber desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"servicePlans",
"skuId",
"skuPartNumber"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.licenseDetails"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/licenseDetails/{licenseDetails-id}": {
"get": {
"tags": [
"users.licenseDetails"
],
"summary": "Get licenseDetails from users",
"operationId": "users.GetLicenseDetails",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "licenseDetails-id",
"in": "path",
"description": "key: licenseDetails-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "licenseDetails"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"servicePlans",
"skuId",
"skuPartNumber"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.licenseDetails"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/mailFolders": {
"get": {
"tags": [
"users.mailFolder"
],
"summary": "Get mailFolders from users",
"operationId": "users.ListMailFolders",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"childFolderCount",
"childFolderCount desc",
"displayName",
"displayName desc",
"parentFolderId",
"parentFolderId desc",
"totalItemCount",
"totalItemCount desc",
"unreadItemCount",
"unreadItemCount desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"childFolderCount",
"displayName",
"parentFolderId",
"totalItemCount",
"unreadItemCount",
"childFolders",
"messageRules",
"messages",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"childFolders",
"messageRules",
"messages",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.mailFolder"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/mailFolders/{mailFolder-id}": {
"get": {
"tags": [
"users.mailFolder"
],
"summary": "Get mailFolders from users",
"operationId": "users.GetMailFolders",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "mailFolder-id",
"in": "path",
"description": "key: mailFolder-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "mailFolder"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"childFolderCount",
"displayName",
"parentFolderId",
"totalItemCount",
"unreadItemCount",
"childFolders",
"messageRules",
"messages",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"childFolders",
"messageRules",
"messages",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.mailFolder"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/mailFolders/{mailFolder-id}/copy": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.mailFolders.copy",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "mailFolder-id",
"in": "path",
"description": "key: mailFolder-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "mailFolder"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"destinationId": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mailFolder"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"displayName\": \"displayName-value\",\r\n \"parentFolderId\": \"parentFolderId-value\",\r\n \"childFolderCount\": 99,\r\n \"unreadItemCount\": 99,\r\n \"totalItemCount\": 99,\r\n \"id\": \"id-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/messages/{message-id}/copy"
]
},
"/users/{user-id}/mailFolders/{mailFolder-id}/move": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.mailFolders.move",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "mailFolder-id",
"in": "path",
"description": "key: mailFolder-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "mailFolder"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"destinationId": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mailFolder"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"displayName\": \"displayName-value\",\r\n \"parentFolderId\": \"parentFolderId-value\",\r\n \"childFolderCount\": 99,\r\n \"unreadItemCount\": 99,\r\n \"totalItemCount\": 99,\r\n \"id\": \"id-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/messages/{message-id}/move"
]
},
"/users/{user-id}/mailFolders/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.mailFolders.delta.2209",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "odata.maxpagesize={x}. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mailFolder"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/me/mailfolders/delta?$skiptoken={_skipToken_}\",\r\n \"value\": [\r\n {\r\n \"displayName\": \"displayName-value\",\r\n \"parentFolderId\": \"parentFolderId-value\",\r\n \"childFolderCount\": 99,\r\n \"unreadItemCount\": 99,\r\n \"totalItemCount\": 99\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Read",
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Read",
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.Read",
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/delta()",
"/users/{user-id}/contactFolders/delta()",
"/users/{user-id}/contacts/delta()",
"/users/{user-id}/events/delta()",
"/users/{user-id}/messages/delta()",
"/users/delta()"
]
},
"/users/{user-id}/managedAppRegistrations": {
"get": {
"tags": [
"users.managedAppRegistration"
],
"summary": "Get managedAppRegistrations from users",
"operationId": "users.ListManagedAppRegistrations",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"createdDateTime",
"createdDateTime desc",
"lastSyncDateTime",
"lastSyncDateTime desc",
"applicationVersion",
"applicationVersion desc",
"managementSdkVersion",
"managementSdkVersion desc",
"platformVersion",
"platformVersion desc",
"deviceType",
"deviceType desc",
"deviceTag",
"deviceTag desc",
"deviceName",
"deviceName desc",
"flaggedReasons",
"flaggedReasons desc",
"userId",
"userId desc",
"appIdentifier",
"appIdentifier desc",
"version",
"version desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdDateTime",
"lastSyncDateTime",
"applicationVersion",
"managementSdkVersion",
"platformVersion",
"deviceType",
"deviceTag",
"deviceName",
"flaggedReasons",
"userId",
"appIdentifier",
"version",
"appliedPolicies",
"intendedPolicies",
"operations"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"appliedPolicies",
"intendedPolicies",
"operations"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.managedAppRegistration"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/managedAppRegistrations/{managedAppRegistration-id}": {
"get": {
"tags": [
"users.managedAppRegistration"
],
"summary": "Get managedAppRegistrations from users",
"operationId": "users.GetManagedAppRegistrations",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "managedAppRegistration-id",
"in": "path",
"description": "key: managedAppRegistration-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "managedAppRegistration"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"createdDateTime",
"lastSyncDateTime",
"applicationVersion",
"managementSdkVersion",
"platformVersion",
"deviceType",
"deviceTag",
"deviceName",
"flaggedReasons",
"userId",
"appIdentifier",
"version",
"appliedPolicies",
"intendedPolicies",
"operations"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"appliedPolicies",
"intendedPolicies",
"operations"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.managedAppRegistration"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/managedDevices": {
"get": {
"tags": [
"users.managedDevice"
],
"summary": "Get managedDevices from users",
"operationId": "users.ListManagedDevices",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"userId",
"userId desc",
"deviceName",
"deviceName desc",
"managedDeviceOwnerType",
"managedDeviceOwnerType desc",
"deviceActionResults",
"deviceActionResults desc",
"enrolledDateTime",
"enrolledDateTime desc",
"lastSyncDateTime",
"lastSyncDateTime desc",
"operatingSystem",
"operatingSystem desc",
"complianceState",
"complianceState desc",
"jailBroken",
"jailBroken desc",
"managementAgent",
"managementAgent desc",
"osVersion",
"osVersion desc",
"easActivated",
"easActivated desc",
"easDeviceId",
"easDeviceId desc",
"easActivationDateTime",
"easActivationDateTime desc",
"azureADRegistered",
"azureADRegistered desc",
"deviceEnrollmentType",
"deviceEnrollmentType desc",
"activationLockBypassCode",
"activationLockBypassCode desc",
"emailAddress",
"emailAddress desc",
"azureADDeviceId",
"azureADDeviceId desc",
"deviceRegistrationState",
"deviceRegistrationState desc",
"deviceCategoryDisplayName",
"deviceCategoryDisplayName desc",
"isSupervised",
"isSupervised desc",
"exchangeLastSuccessfulSyncDateTime",
"exchangeLastSuccessfulSyncDateTime desc",
"exchangeAccessState",
"exchangeAccessState desc",
"exchangeAccessStateReason",
"exchangeAccessStateReason desc",
"remoteAssistanceSessionUrl",
"remoteAssistanceSessionUrl desc",
"remoteAssistanceSessionErrorDetails",
"remoteAssistanceSessionErrorDetails desc",
"isEncrypted",
"isEncrypted desc",
"userPrincipalName",
"userPrincipalName desc",
"model",
"model desc",
"manufacturer",
"manufacturer desc",
"imei",
"imei desc",
"complianceGracePeriodExpirationDateTime",
"complianceGracePeriodExpirationDateTime desc",
"serialNumber",
"serialNumber desc",
"phoneNumber",
"phoneNumber desc",
"androidSecurityPatchLevel",
"androidSecurityPatchLevel desc",
"userDisplayName",
"userDisplayName desc",
"configurationManagerClientEnabledFeatures",
"configurationManagerClientEnabledFeatures desc",
"wiFiMacAddress",
"wiFiMacAddress desc",
"deviceHealthAttestationState",
"deviceHealthAttestationState desc",
"subscriberCarrier",
"subscriberCarrier desc",
"meid",
"meid desc",
"totalStorageSpaceInBytes",
"totalStorageSpaceInBytes desc",
"freeStorageSpaceInBytes",
"freeStorageSpaceInBytes desc",
"managedDeviceName",
"managedDeviceName desc",
"partnerReportedThreatState",
"partnerReportedThreatState desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"userId",
"deviceName",
"managedDeviceOwnerType",
"deviceActionResults",
"enrolledDateTime",
"lastSyncDateTime",
"operatingSystem",
"complianceState",
"jailBroken",
"managementAgent",
"osVersion",
"easActivated",
"easDeviceId",
"easActivationDateTime",
"azureADRegistered",
"deviceEnrollmentType",
"activationLockBypassCode",
"emailAddress",
"azureADDeviceId",
"deviceRegistrationState",
"deviceCategoryDisplayName",
"isSupervised",
"exchangeLastSuccessfulSyncDateTime",
"exchangeAccessState",
"exchangeAccessStateReason",
"remoteAssistanceSessionUrl",
"remoteAssistanceSessionErrorDetails",
"isEncrypted",
"userPrincipalName",
"model",
"manufacturer",
"imei",
"complianceGracePeriodExpirationDateTime",
"serialNumber",
"phoneNumber",
"androidSecurityPatchLevel",
"userDisplayName",
"configurationManagerClientEnabledFeatures",
"wiFiMacAddress",
"deviceHealthAttestationState",
"subscriberCarrier",
"meid",
"totalStorageSpaceInBytes",
"freeStorageSpaceInBytes",
"managedDeviceName",
"partnerReportedThreatState",
"deviceCategory"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"deviceCategory"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.managedDevice"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/managedDevices/{managedDevice-id}": {
"get": {
"tags": [
"users.managedDevice"
],
"summary": "Get managedDevices from users",
"operationId": "users.GetManagedDevices",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "managedDevice-id",
"in": "path",
"description": "key: managedDevice-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "managedDevice"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"userId",
"deviceName",
"managedDeviceOwnerType",
"deviceActionResults",
"enrolledDateTime",
"lastSyncDateTime",
"operatingSystem",
"complianceState",
"jailBroken",
"managementAgent",
"osVersion",
"easActivated",
"easDeviceId",
"easActivationDateTime",
"azureADRegistered",
"deviceEnrollmentType",
"activationLockBypassCode",
"emailAddress",
"azureADDeviceId",
"deviceRegistrationState",
"deviceCategoryDisplayName",
"isSupervised",
"exchangeLastSuccessfulSyncDateTime",
"exchangeAccessState",
"exchangeAccessStateReason",
"remoteAssistanceSessionUrl",
"remoteAssistanceSessionErrorDetails",
"isEncrypted",
"userPrincipalName",
"model",
"manufacturer",
"imei",
"complianceGracePeriodExpirationDateTime",
"serialNumber",
"phoneNumber",
"androidSecurityPatchLevel",
"userDisplayName",
"configurationManagerClientEnabledFeatures",
"wiFiMacAddress",
"deviceHealthAttestationState",
"subscriberCarrier",
"meid",
"totalStorageSpaceInBytes",
"freeStorageSpaceInBytes",
"managedDeviceName",
"partnerReportedThreatState",
"deviceCategory"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"deviceCategory"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.managedDevice"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/manager": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get manager from users",
"operationId": "users.GetManager",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/memberOf": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get memberOf from users",
"operationId": "users.ListMemberOf",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/memberOf/{directoryObject-id}": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get memberOf from users",
"operationId": "users.GetMemberOf",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/messages": {
"get": {
"tags": [
"users.message"
],
"summary": "Get messages from users",
"operationId": "users.ListMessages",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"categories",
"categories desc",
"changeKey",
"changeKey desc",
"createdDateTime",
"createdDateTime desc",
"lastModifiedDateTime",
"lastModifiedDateTime desc",
"bccRecipients",
"bccRecipients desc",
"body",
"body desc",
"bodyPreview",
"bodyPreview desc",
"ccRecipients",
"ccRecipients desc",
"conversationId",
"conversationId desc",
"flag",
"flag desc",
"from",
"from desc",
"hasAttachments",
"hasAttachments desc",
"importance",
"importance desc",
"inferenceClassification",
"inferenceClassification desc",
"internetMessageHeaders",
"internetMessageHeaders desc",
"internetMessageId",
"internetMessageId desc",
"isDeliveryReceiptRequested",
"isDeliveryReceiptRequested desc",
"isDraft",
"isDraft desc",
"isRead",
"isRead desc",
"isReadReceiptRequested",
"isReadReceiptRequested desc",
"parentFolderId",
"parentFolderId desc",
"receivedDateTime",
"receivedDateTime desc",
"replyTo",
"replyTo desc",
"sender",
"sender desc",
"sentDateTime",
"sentDateTime desc",
"subject",
"subject desc",
"toRecipients",
"toRecipients desc",
"uniqueBody",
"uniqueBody desc",
"webLink",
"webLink desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"bccRecipients",
"body",
"bodyPreview",
"ccRecipients",
"conversationId",
"flag",
"from",
"hasAttachments",
"importance",
"inferenceClassification",
"internetMessageHeaders",
"internetMessageId",
"isDeliveryReceiptRequested",
"isDraft",
"isRead",
"isReadReceiptRequested",
"parentFolderId",
"receivedDateTime",
"replyTo",
"sender",
"sentDateTime",
"subject",
"toRecipients",
"uniqueBody",
"webLink",
"attachments",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"attachments",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.message"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/messages/{message-id}": {
"get": {
"tags": [
"users.message"
],
"summary": "Get messages from users",
"operationId": "users.GetMessages",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"categories",
"changeKey",
"createdDateTime",
"lastModifiedDateTime",
"bccRecipients",
"body",
"bodyPreview",
"ccRecipients",
"conversationId",
"flag",
"from",
"hasAttachments",
"importance",
"inferenceClassification",
"internetMessageHeaders",
"internetMessageId",
"isDeliveryReceiptRequested",
"isDraft",
"isRead",
"isReadReceiptRequested",
"parentFolderId",
"receivedDateTime",
"replyTo",
"sender",
"sentDateTime",
"subject",
"toRecipients",
"uniqueBody",
"webLink",
"attachments",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"attachments",
"extensions",
"multiValueExtendedProperties",
"singleValueExtendedProperties"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.message"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/messages/{message-id}/copy": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.copy",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"destinationId": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"receivedDateTime\": \"datetime-value\",\r\n \"sentDateTime\": \"datetime-value\",\r\n \"hasAttachments\": true,\r\n \"subject\": \"subject-value\",\r\n \"body\": {\r\n \"contentType\": \"\",\r\n \"content\": \"content-value\"\r\n },\r\n \"bodyPreview\": \"bodyPreview-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/mailFolders/{mailFolder-id}/copy"
]
},
"/users/{user-id}/messages/{message-id}/createForward": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.createForward",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/{message-id}/createReply": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.createReply",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"receivedDateTime\": \"datetime-value\",\r\n \"sentDateTime\": \"datetime-value\",\r\n \"hasAttachments\": true,\r\n \"subject\": \"subject-value\",\r\n \"body\": {\r\n \"contentType\": \"\",\r\n \"content\": \"content-value\"\r\n },\r\n \"bodyPreview\": \"bodyPreview-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/{message-id}/createReplyAll": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.createReplyAll",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"receivedDateTime\": \"datetime-value\",\r\n \"sentDateTime\": \"datetime-value\",\r\n \"hasAttachments\": true,\r\n \"subject\": \"subject-value\",\r\n \"body\": {\r\n \"contentType\": \"\",\r\n \"content\": \"content-value\"\r\n },\r\n \"bodyPreview\": \"bodyPreview-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/{message-id}/forward": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.forward",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"toRecipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
}
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Send"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Send"
]
},
{
"Application": [
"Mail.Send"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/{message-id}/move": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.move",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"destinationId": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "action"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/mailFolders/{mailFolder-id}/move"
]
},
"/users/{user-id}/messages/{message-id}/reply": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.reply",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Send"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Send"
]
},
{
"Application": [
"Mail.Send"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/{message-id}/replyAll": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.messages.replyAll",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "Nature of the data in the body of an entity. Required.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Send"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Send"
]
},
{
"Application": [
"Mail.Send"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/{message-id}/send": {
"post": {
"tags": [
"users.Actions"
],
"summary": "The following example shows how to call this API.",
"operationId": "users.messages.send",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "message-id",
"in": "path",
"description": "key: message-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "message"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Length",
"in": "header",
"description": "* Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Send"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Send"
]
},
{
"Application": [
"Mail.Send"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/messages/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.messages.delta.2209",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json. Required.",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"description": "odata.maxpagesize={x}. Optional.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/me/mailfolders('{id}')/messages/delta?$skiptoken={_skipToken_}\",\r\n \"value\": [\r\n {\r\n \"receivedDateTime\": \"datetime-value\",\r\n \"sentDateTime\": \"datetime-value\",\r\n \"hasAttachments\": true,\r\n \"internetMessageId\": \"internetMessageId-value\",\r\n \"subject\": \"subject-value\",\r\n \"body\": {\r\n \"contentType\": \"contentType-value\",\r\n \"content\": \"content-value\"\r\n }\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Read",
"Mail.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Read",
"Mail.ReadWrite"
]
},
{
"Application": [
"Mail.Read",
"Mail.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/delta()",
"/users/{user-id}/contactFolders/delta()",
"/users/{user-id}/contacts/delta()",
"/users/{user-id}/events/delta()",
"/users/{user-id}/mailFolders/delta()",
"/users/delta()"
]
},
"/users/{user-id}/assignLicense": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.assignLicense",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"addLicenses": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.assignedLicense"
}
],
"nullable": true
}
},
"removeLicenses": {
"type": "array",
"items": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"format": "uuid",
"nullable": true
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.user"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"accountEnabled\": true,\r\n \"assignedLicenses\": [\r\n {\r\n \"disabledPlans\": [ \"11b0131d-43c8-4bbb-b2c8-e80f9a50834a\" ],\r\n \"skuId\": \"0118A350-71FC-4EC3-8F0C-6A1CB8867561\"\r\n }\r\n ],\r\n \"assignedPlans\": [\r\n {\r\n \"assignedDateTime\": \"2016-10-02T12:13:14Z\",\r\n \"capabilityStatus\": \"capabilityStatus-value\",\r\n \"service\": \"service-value\",\r\n \"servicePlanId\": \"bea13e0c-3828-4daa-a392-28af7ff61a0f\"\r\n }\r\n ],\r\n \"businessPhones\": [\r\n \"businessPhones-value\"\r\n ],\r\n \"city\": \"city-value\",\r\n \"companyName\": \"companyName-value\"\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.ReadWrite.All",
"Directory.ReadWrite.All"
]
},
{
"Application": [
"User.ReadWrite.All",
"Directory.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/findMeetingTimes": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Notice that the request specifies time in the PST time zone, and the response returns meeting time suggestions in UTC, by default. You can use the `Prefer: outlook.timezone` request \r\nheader to specify PST as well for the time values in the response.",
"operationId": "users.findMeetingTimes",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Prefer: outlook.timezone",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"attendees": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.attendeeBase"
}
],
"nullable": true
}
},
"locationConstraint": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.locationConstraint"
}
],
"nullable": true
},
"timeConstraint": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeConstraint"
}
],
"nullable": true
},
"meetingDuration": {
"pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
"type": "string",
"format": "duration",
"nullable": true
},
"returnSuggestionReasons": {
"type": "boolean",
"default": false,
"nullable": true
},
"minimumAttendeePercentage": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"enum": [
"-INF",
"INF",
"NaN"
]
}
],
"format": "double",
"nullable": true
},
"isOrganizerOptional": {
"type": "boolean",
"default": false,
"nullable": true
},
"maxCandidates": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.meetingTimeSuggestionsResult"
}
],
"nullable": true
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.meetingTimeSuggestionsResult\",\r\n \"emptySuggestionsReason\":\"\",\r\n \"meetingTimeSuggestions\":[\r\n {\r\n \"confidence\":100.0,\r\n \"organizerAvailability\":\"free\",\r\n \"suggestionReason\":\"Suggested because it is one of the nearest times when all attendees are available.\",\r\n \"meetingTimeSlot\":{\r\n \"start\":{\r\n \"dateTime\":\"2017-04-17T18:00:00.0000000\",\r\n \"timeZone\":\"Pacific Standard Time\"\r\n },\r\n \"end\":{\r\n \"dateTime\":\"2017-04-17T20:00:00.0000000\",\r\n \"timeZone\":\"Pacific Standard Time\"\r\n }\r\n },\r\n \"attendeeAvailability\":[\r\n {\r\n \"availability\":\"free\",\r\n \"attendee\":{\r\n \"type\":\"required\",\r\n \"emailAddress\":{\r\n \"address\":\"samanthab@contoso.onmicrosoft.com\"\r\n }\r\n }\r\n }\r\n ],\r\n \"locations\":[\r\n {\r\n \"displayName\":\"Conf room Hood\"\r\n }\r\n ]\r\n },\r\n {\r\n \"confidence\":100.0,\r\n \"organizerAvailability\":\"free\",\r\n \"suggestionReason\":\"Suggested because it is one of the nearest times when all attendees are available.\",\r\n \"meetingTimeSlot\":{\r\n \"start\":{\r\n \"dateTime\":\"2017-04-17T20:00:00.0000000\",\r\n \"timeZone\":\"Pacific Standard Time\"\r\n },\r\n \"end\":{\r\n \"dateTime\":\"2017-04-17T22:00:00.0000000\",\r\n \"timeZone\":\"Pacific Standard Time\"\r\n }\r\n },\r\n \"attendeeAvailability\":[\r\n {\r\n \"availability\":\"free\",\r\n \"attendee\":{\r\n \"type\":\"required\",\r\n \"emailAddress\":{\r\n \"address\":\"samanthab@contoso.onmicrosoft.com\"\r\n }\r\n }\r\n }\r\n ],\r\n \"locations\":[\r\n {\r\n \"displayName\":\"Conf room Hood\"\r\n }\r\n ]\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.Read.Shared",
"Calendars.ReadWrite.Shared"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/getMailTips": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Invoke action getMailTips",
"operationId": "users.getMailTips",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"EmailAddresses": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"MailTipsOptions": {
"type": "string",
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mailTips"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.mailTips)\",\r\n \"value\":[\r\n {\r\n \"emailAddress\":{\r\n \"name\":\"\",\r\n \"address\":\"danas@contoso.onmicrosoft.com\"\r\n },\r\n \"automaticReplies\":{\r\n \"message\":\"\\r\\n\\r\\n
\\r\\nHi, I am on vacation right now. I'll get back to you after I return.
\\r\\n
\\r\\n
\",\r\n \"messageLanguage\":{\r\n \"locale\":\"en-US\",\r\n \"displayName\":\"English (United States)\"\r\n },\r\n \"scheduledStartTime\": {\r\n \"dateTime\": \"2018-08-07T02:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n },\r\n \"scheduledEndTime\": {\r\n \"dateTime\": \"2018-08-09T02:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n }\r\n },\r\n \"mailboxFull\":false\r\n },\r\n {\r\n \"emailAddress\":{\r\n \"name\":\"\",\r\n \"address\":\"fannyd@contoso.onmicrosoft.com\"\r\n },\r\n \"automaticReplies\":{\r\n \"message\":\"\"\r\n },\r\n \"mailboxFull\":false\r\n }\r\n ]\r\n}\r\n\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Read",
"Mail.Read.Shared"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Read"
]
},
{
"Application": [
"Mail.Read"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/reminderView(endDateTime={endDateTime},startDateTime={startDateTime})": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.reminderView.d02b",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Prefer",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "endDateTime",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "startDateTime",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.reminder"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\": \"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.reminder)\",\r\n \"value\": [\r\n {\r\n \"eventId\": \"AAMkADNsvAAA=\",\r\n \"changeKey\": \"SuFHwDRP1EeXJUopWbSLlgAAmBvk2g==\",\r\n \"eventSubject\": \"Plan summer company picnic\",\r\n \"eventWebLink\": \"https://outlook.office365.com/owa/?itemid=AAMkADNsvAAA%3D&exvsurl=1&path=/calendar/item\",\r\n \"eventStartTime\": {\r\n \"dateTime\": \"2017-06-09T18:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n },\r\n \"eventEndTime\": {\r\n \"dateTime\": \"2017-06-09T19:00:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n },\r\n \"eventLocation\": {\r\n \"displayName\": \"Conf Room 3\"\r\n },\r\n \"reminderFireTime\": {\r\n \"dateTime\": \"2017-06-09T17:45:00.0000000\",\r\n \"timeZone\": \"UTC\"\r\n }\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Calendars.Read",
"Calendars.ReadWrite"
]
},
{
"Delegated (personal Microsoft account)": [
"Calendars.Read",
"Calendars.ReadWrite"
]
},
{
"Application": [
"Calendars.Read",
"Calendars.ReadWrite"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/users/{user-id}/sendMail": {
"post": {
"tags": [
"users.Actions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.sendMail",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Action parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
}
],
"nullable": true
},
"saveToSentItems": {
"type": "boolean",
"default": false,
"nullable": true
}
}
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"Mail.Send"
]
},
{
"Delegated (personal Microsoft account)": [
"Mail.Send"
]
},
{
"Application": [
"Mail.Send"
]
}
],
"x-ms-docs-operation-type": "action"
}
},
"/users/{user-id}/onenote": {
"get": {
"tags": [
"users.onenote"
],
"summary": "Get onenote from users",
"operationId": "users.GetOnenote",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"notebooks",
"operations",
"pages",
"resources",
"sectionGroups",
"sections"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"notebooks",
"operations",
"pages",
"resources",
"sectionGroups",
"sections"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.onenote"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/outlook": {
"get": {
"tags": [
"users.outlookUser"
],
"summary": "Get outlook from users",
"operationId": "users.GetOutlook",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"masterCategories"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"masterCategories"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.outlookUser"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/outlook/supportedLanguages()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Here is an example of how to call this API.",
"operationId": "users.outlook.supportedLanguages.7d99",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.localeInfo"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.localeInfo)\",\r\n \"value\":[\r\n {\r\n \"locale\":\"af-ZA\",\r\n \"displayName\":\"Afrikaans (Suid-Afrika)\"\r\n },\r\n {\r\n \"locale\":\"en-US\",\r\n \"displayName\":\"English (United States)\"\r\n },\r\n {\r\n \"locale\":\"en-CA\",\r\n \"displayName\":\"English (Canada)\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadBasic.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read"
]
},
{
"Application": [
"User.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
}
},
"/users/{user-id}/outlook/supportedTimeZones()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function supportedTimeZones",
"operationId": "users.outlook.supportedTimeZones.4c5b",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeZoneInformation"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.timeZoneInformation)\",\r\n \"value\":[\r\n {\r\n \"alias\":\"Dateline Standard Time\",\r\n \"displayName\":\"(UTC-12:00) International Date Line West\"\r\n },\r\n {\r\n \"alias\":\"Samoa Standard Time\",\r\n \"displayName\":\"(UTC+13:00) Samoa\"\r\n },\r\n {\r\n \"alias\":\"UTC-11\",\r\n \"displayName\":\"(UTC-11:00) Coordinated Universal Time-11\"\r\n },\r\n {\r\n \"alias\":\"Aleutian Standard Time\",\r\n \"displayName\":\"(UTC-10:00) Aleutian Islands\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadBasic.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read"
]
},
{
"Application": [
"User.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/outlook/supportedTimeZones(TimeZoneStandard={TimeZoneStandard})"
]
},
"/users/{user-id}/outlook/supportedTimeZones(TimeZoneStandard={TimeZoneStandard})": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function supportedTimeZones",
"operationId": "users.outlook.supportedTimeZones.cfd8",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer {token}. Required.",
"schema": {
"type": "string"
}
},
{
"name": "TimeZoneStandard",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeZoneStandard"
}
],
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.timeZoneInformation"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.timeZoneInformation)\",\r\n \"value\":[\r\n {\r\n \"alias\":\"Etc/GMT+12\",\r\n \"displayName\":\"Etc/GMT+12\"\r\n },\r\n {\r\n \"alias\":\"US/Samoa\",\r\n \"displayName\":\"US/Samoa\"\r\n },\r\n {\r\n \"alias\":\"Etc/GMT+11\",\r\n \"displayName\":\"Etc/GMT+11\"\r\n },\r\n {\r\n \"alias\":\"US/Aleutian\",\r\n \"displayName\":\"US/Aleutian\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadBasic.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read"
]
},
{
"Application": [
"User.Read.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/outlook/supportedTimeZones()"
]
},
"/users/{user-id}/ownedDevices": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get ownedDevices from users",
"operationId": "users.ListOwnedDevices",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/ownedDevices/{directoryObject-id}": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get ownedDevices from users",
"operationId": "users.GetOwnedDevices",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/ownedObjects": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get ownedObjects from users",
"operationId": "users.ListOwnedObjects",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/ownedObjects/{directoryObject-id}": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get ownedObjects from users",
"operationId": "users.GetOwnedObjects",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/people": {
"get": {
"tags": [
"users.person"
],
"summary": "Get people from users",
"operationId": "users.ListPeople",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc",
"birthday",
"birthday desc",
"companyName",
"companyName desc",
"department",
"department desc",
"displayName",
"displayName desc",
"scoredEmailAddresses",
"scoredEmailAddresses desc",
"givenName",
"givenName desc",
"imAddress",
"imAddress desc",
"isFavorite",
"isFavorite desc",
"jobTitle",
"jobTitle desc",
"officeLocation",
"officeLocation desc",
"personNotes",
"personNotes desc",
"personType",
"personType desc",
"phones",
"phones desc",
"postalAddresses",
"postalAddresses desc",
"profession",
"profession desc",
"surname",
"surname desc",
"userPrincipalName",
"userPrincipalName desc",
"websites",
"websites desc",
"yomiCompany",
"yomiCompany desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"birthday",
"companyName",
"department",
"displayName",
"scoredEmailAddresses",
"givenName",
"imAddress",
"isFavorite",
"jobTitle",
"officeLocation",
"personNotes",
"personType",
"phones",
"postalAddresses",
"profession",
"surname",
"userPrincipalName",
"websites",
"yomiCompany"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.person"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/people/{person-id}": {
"get": {
"tags": [
"users.person"
],
"summary": "Get people from users",
"operationId": "users.GetPeople",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "person-id",
"in": "path",
"description": "key: person-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "person"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"birthday",
"companyName",
"department",
"displayName",
"scoredEmailAddresses",
"givenName",
"imAddress",
"isFavorite",
"jobTitle",
"officeLocation",
"personNotes",
"personType",
"phones",
"postalAddresses",
"profession",
"surname",
"userPrincipalName",
"websites",
"yomiCompany"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.person"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/photo": {
"get": {
"tags": [
"users.profilePhoto"
],
"summary": "Get photo from users",
"operationId": "users.GetPhoto",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"height",
"width"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.profilePhoto"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/planner": {
"get": {
"tags": [
"users.plannerUser"
],
"summary": "Get planner from users",
"operationId": "users.GetPlanner",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"plans",
"tasks"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*",
"plans",
"tasks"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.plannerUser"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/registeredDevices": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get registeredDevices from users",
"operationId": "users.ListRegisteredDevices",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"in": "query",
"description": "Order items by property values",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id",
"id desc"
],
"type": "string"
}
}
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/{user-id}/registeredDevices/{directoryObject-id}": {
"get": {
"tags": [
"users.directoryObject"
],
"summary": "Get registeredDevices from users",
"operationId": "users.GetRegisteredDevices",
"parameters": [
{
"name": "user-id",
"in": "path",
"description": "key: user-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "user"
},
{
"name": "directoryObject-id",
"in": "path",
"description": "key: directoryObject-id",
"required": true,
"schema": {
"type": "string",
"nullable": true
},
"x-ms-docs-key-type": "directoryObject"
},
{
"name": "$select",
"in": "query",
"description": "Select properties to be returned",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"id"
],
"type": "string"
}
}
},
{
"name": "$expand",
"in": "query",
"description": "Expand related entities",
"style": "simple",
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"*"
],
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Retrieved navigation property",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"x-ms-docs-operation-type": "operation"
}
},
"/users/delta()": {
"get": {
"tags": [
"users.Functions"
],
"summary": "Invoke function delta",
"operationId": "users.delta.2209",
"parameters": [
{
"name": "$deltatoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "$skiptoken",
"in": "query",
"description": "String",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "Bearer token",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/json",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.user"
}
],
"nullable": true
}
},
"examples": {
"example-1": {
"description": "application/json",
"value": "{\r\n \"@odata.context\":\"https://graph.microsoft.com/v1.0/$metadata#users\",\r\n \"@odata.nextLink\":\"https://graph.microsoft.com/v1.0/users/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc\",\r\n \"value\": [\r\n {\r\n \"businessPhones\": [\r\n \"businessPhones-value\"\r\n ],\r\n \"displayName\": \"displayName-value\",\r\n \"givenName\": \"givenName-value\",\r\n \"jobTitle\": \"jobTitle-value\",\r\n \"mail\": \"mail-value\",\r\n \"mobilePhone\": \"mobilePhone-value\",\r\n \"officeLocation\": \"officeLocation-value\",\r\n \"preferredLanguage\": \"preferredLanguage-value\",\r\n \"surname\": \"surname-value\",\r\n \"userPrincipalName\": \"userPrincipalName-value\",\r\n \"id\": \"id-value\"\r\n }\r\n ]\r\n}\n"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/error"
}
},
"security": [
{
"Delegated (work or school account)": [
"User.Read",
"User.ReadWrite",
"User.ReadBasic.All",
"User.Read.All",
"User.ReadWrite.All",
"Directory.Read.All",
"Directory.ReadWrite.All",
"Directory.AccessAsUser.All"
]
},
{
"Delegated (personal Microsoft account)": [
"User.Read",
"User.ReadWrite"
]
},
{
"Application": [
"User.Read.All",
"User.ReadWrite.All",
"Directory.Read.All",
"Directory.ReadWrite.All"
]
}
],
"x-ms-docs-operation-type": "function"
},
"x-ms-docs-grouped-path": [
"/users/{user-id}/calendarView/delta()",
"/users/{user-id}/contactFolders/delta()",
"/users/{user-id}/contacts/delta()",
"/users/{user-id}/events/delta()",
"/users/{user-id}/mailFolders/delta()",
"/users/{user-id}/messages/delta()"
]
}
},
"components": {
"schemas": {
"microsoft.graph.entity": {
"title": "entity",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Read-only.",
"nullable": true
}
},
"example": {
"id": "string (identifier)"
}
},
"microsoft.graph.attachment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "attachment",
"type": "object",
"properties": {
"contentType": {
"type": "string",
"description": "The MIME type.",
"nullable": true
},
"isInline": {
"type": "boolean",
"description": "true if the attachment is an inline attachment; otherwise, false.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "The attachment's file name.",
"nullable": true
},
"size": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The length of the attachment in bytes.",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"contentType": "string",
"isInline": true,
"lastModifiedDateTime": "string (timestamp)",
"name": "string",
"size": "integer"
}
},
"microsoft.graph.baseItem": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "baseItem",
"type": "object",
"properties": {
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Identity of the user, device, or application which created the item. Read-only.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Date and time of item creation. Read-only.",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"description": "Provides a user-visible description of the item. Optional.",
"nullable": true
},
"eTag": {
"type": "string",
"description": "ETag for the item. Read-only.",
"nullable": true
},
"lastModifiedBy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Identity of the user, device, and application which last modified the item. Read-only.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Date and time the item was last modified. Read-only.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the item. Read-write.",
"nullable": true
},
"parentReference": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemReference"
}
],
"description": "Parent information, if the item has a parent. Read-write.",
"nullable": true
},
"webUrl": {
"type": "string",
"description": "URL that displays the resource in the browser. Read-only.",
"nullable": true
},
"createdByUser": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.user"
}
],
"nullable": true
},
"lastModifiedByUser": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.user"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "string (timestamp)",
"description": "string",
"eTag": "string",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "string (timestamp)",
"name": "string",
"parentReference": {
"@odata.type": "microsoft.graph.itemReference"
},
"webUrl": "string",
"createdByUser": {
"@odata.type": "microsoft.graph.user"
},
"lastModifiedByUser": {
"@odata.type": "microsoft.graph.user"
}
}
},
"microsoft.graph.baseItemVersion": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "baseItemVersion",
"type": "object",
"properties": {
"lastModifiedBy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Identity of the user which last modified the version. Read-only.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Date and time the version was last modified. Read-only.",
"format": "date-time",
"nullable": true
},
"publication": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.publicationFacet"
}
],
"description": "Indicates the publication status of this particular version. Read-only.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "string (timestamp)",
"publication": {
"@odata.type": "microsoft.graph.publicationFacet"
}
}
},
"microsoft.graph.calendar": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "calendar",
"type": "object",
"properties": {
"canEdit": {
"type": "boolean",
"description": "True if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who has been shared a calendar and granted write access.",
"nullable": true
},
"canShare": {
"type": "boolean",
"description": "True if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it.",
"nullable": true
},
"canViewPrivateItems": {
"type": "boolean",
"description": "True if the user can read calendar items that have been marked private, false otherwise.",
"nullable": true
},
"changeKey": {
"type": "string",
"description": "Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.",
"nullable": true
},
"color": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.calendarColor"
}
],
"description": "Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1",
"nullable": true
},
"name": {
"type": "string",
"description": "The calendar name.",
"nullable": true
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.emailAddress"
}
],
"description": "If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user.",
"nullable": true
},
"calendarView": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
},
"multiValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty"
}
},
"singleValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"canEdit": true,
"canShare": true,
"canViewPrivateItems": true,
"changeKey": "string",
"color": {
"@odata.type": "microsoft.graph.calendarColor"
},
"name": "string",
"owner": {
"@odata.type": "microsoft.graph.emailAddress"
},
"calendarView": [
{
"@odata.type": "microsoft.graph.event"
}
],
"events": [
{
"@odata.type": "microsoft.graph.event"
}
],
"multiValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"
}
],
"singleValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"
}
]
}
},
"microsoft.graph.calendarGroup": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "calendarGroup",
"type": "object",
"properties": {
"changeKey": {
"type": "string",
"description": "Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.",
"nullable": true
},
"classId": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"description": "The class identifier. Read-only.",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"description": "The group name.",
"nullable": true
},
"calendars": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.calendar"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"changeKey": "string",
"classId": "string",
"name": "string",
"calendars": [
{
"@odata.type": "microsoft.graph.calendar"
}
]
}
},
"microsoft.graph.workbookChart": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChart",
"type": "object",
"properties": {
"height": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"enum": [
"-INF",
"INF",
"NaN"
]
}
],
"description": "Represents the height, in points, of the chart object.",
"format": "double",
"nullable": true
},
"left": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"enum": [
"-INF",
"INF",
"NaN"
]
}
],
"description": "The distance, in points, from the left side of the chart to the worksheet origin.",
"format": "double",
"nullable": true
},
"name": {
"type": "string",
"description": "Represents the name of a chart object.",
"nullable": true
},
"top": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"enum": [
"-INF",
"INF",
"NaN"
]
}
],
"description": "Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).",
"format": "double",
"nullable": true
},
"width": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"enum": [
"-INF",
"INF",
"NaN"
]
}
],
"description": "Represents the width, in points, of the chart object.",
"format": "double",
"nullable": true
},
"axes": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxes"
}
],
"nullable": true
},
"dataLabels": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartDataLabels"
}
],
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAreaFormat"
}
],
"nullable": true
},
"legend": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartLegend"
}
],
"nullable": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.workbookChartSeries"
}
},
"title": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartTitle"
}
],
"nullable": true
},
"worksheet": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookWorksheet"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"height": "double",
"left": "double",
"name": "string",
"top": "double",
"width": "double",
"axes": {
"@odata.type": "microsoft.graph.workbookChartAxes"
},
"dataLabels": {
"@odata.type": "microsoft.graph.workbookChartDataLabels"
},
"format": {
"@odata.type": "microsoft.graph.workbookChartAreaFormat"
},
"legend": {
"@odata.type": "microsoft.graph.workbookChartLegend"
},
"series": [
{
"@odata.type": "microsoft.graph.workbookChartSeries"
}
],
"title": {
"@odata.type": "microsoft.graph.workbookChartTitle"
},
"worksheet": {
"@odata.type": "microsoft.graph.workbookWorksheet"
}
}
},
"microsoft.graph.workbookChartAreaFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartAreaFormat",
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFill"
}
],
"nullable": true
},
"font": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFont"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"fill": {
"@odata.type": "microsoft.graph.workbookChartFill"
},
"font": {
"@odata.type": "microsoft.graph.workbookChartFont"
}
}
},
"microsoft.graph.workbookChartAxes": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartAxes",
"type": "object",
"properties": {
"categoryAxis": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxis"
}
],
"nullable": true
},
"seriesAxis": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxis"
}
],
"nullable": true
},
"valueAxis": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxis"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"categoryAxis": {
"@odata.type": "microsoft.graph.workbookChartAxis"
},
"seriesAxis": {
"@odata.type": "microsoft.graph.workbookChartAxis"
},
"valueAxis": {
"@odata.type": "microsoft.graph.workbookChartAxis"
}
}
},
"microsoft.graph.workbookChartAxis": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartAxis",
"type": "object",
"properties": {
"majorUnit": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.Json"
}
],
"description": "Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number.",
"nullable": true
},
"maximum": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.Json"
}
],
"description": "Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.",
"nullable": true
},
"minimum": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.Json"
}
],
"description": "Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.",
"nullable": true
},
"minorUnit": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.Json"
}
],
"description": "Represents the interval between two minor tick marks. 'Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxisFormat"
}
],
"nullable": true
},
"majorGridlines": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartGridlines"
}
],
"nullable": true
},
"minorGridlines": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartGridlines"
}
],
"nullable": true
},
"title": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxisTitle"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"majorUnit": {
"@odata.type": "microsoft.graph.Json"
},
"maximum": {
"@odata.type": "microsoft.graph.Json"
},
"minimum": {
"@odata.type": "microsoft.graph.Json"
},
"minorUnit": {
"@odata.type": "microsoft.graph.Json"
},
"format": {
"@odata.type": "microsoft.graph.workbookChartAxisFormat"
},
"majorGridlines": {
"@odata.type": "microsoft.graph.workbookChartGridlines"
},
"minorGridlines": {
"@odata.type": "microsoft.graph.workbookChartGridlines"
},
"title": {
"@odata.type": "microsoft.graph.workbookChartAxisTitle"
}
}
},
"microsoft.graph.workbookChartAxisFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartAxisFormat",
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFont"
}
],
"nullable": true
},
"line": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartLineFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"font": {
"@odata.type": "microsoft.graph.workbookChartFont"
},
"line": {
"@odata.type": "microsoft.graph.workbookChartLineFormat"
}
}
},
"microsoft.graph.workbookChartAxisTitle": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartAxisTitle",
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Represents the axis title.",
"nullable": true
},
"visible": {
"type": "boolean",
"description": "A boolean that specifies the visibility of an axis title.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartAxisTitleFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"text": "string",
"visible": true,
"format": {
"@odata.type": "microsoft.graph.workbookChartAxisTitleFormat"
}
}
},
"microsoft.graph.workbookChartAxisTitleFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartAxisTitleFormat",
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFont"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"font": {
"@odata.type": "microsoft.graph.workbookChartFont"
}
}
},
"microsoft.graph.workbookChartDataLabelFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartDataLabelFormat",
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFill"
}
],
"nullable": true
},
"font": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFont"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"fill": {
"@odata.type": "microsoft.graph.workbookChartFill"
},
"font": {
"@odata.type": "microsoft.graph.workbookChartFont"
}
}
},
"microsoft.graph.workbookChartDataLabels": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartDataLabels",
"type": "object",
"properties": {
"position": {
"type": "string",
"description": "DataLabelPosition value that represents the position of the data label. The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.",
"nullable": true
},
"separator": {
"type": "string",
"description": "String representing the separator used for the data labels on a chart.",
"nullable": true
},
"showBubbleSize": {
"type": "boolean",
"description": "Boolean value representing if the data label bubble size is visible or not.",
"nullable": true
},
"showCategoryName": {
"type": "boolean",
"description": "Boolean value representing if the data label category name is visible or not.",
"nullable": true
},
"showLegendKey": {
"type": "boolean",
"description": "Boolean value representing if the data label legend key is visible or not.",
"nullable": true
},
"showPercentage": {
"type": "boolean",
"description": "Boolean value representing if the data label percentage is visible or not.",
"nullable": true
},
"showSeriesName": {
"type": "boolean",
"description": "Boolean value representing if the data label series name is visible or not.",
"nullable": true
},
"showValue": {
"type": "boolean",
"description": "Boolean value representing if the data label value is visible or not.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartDataLabelFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"position": "string",
"separator": "string",
"showBubbleSize": true,
"showCategoryName": true,
"showLegendKey": true,
"showPercentage": true,
"showSeriesName": true,
"showValue": true,
"format": {
"@odata.type": "microsoft.graph.workbookChartDataLabelFormat"
}
}
},
"microsoft.graph.workbookChartFill": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartFill",
"type": "object"
}
],
"example": {
"id": "string (identifier)"
}
},
"microsoft.graph.workbookChartFont": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartFont",
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"description": "Represents the bold status of font.",
"nullable": true
},
"color": {
"type": "string",
"description": "HTML color code representation of the text color. E.g. #FF0000 represents Red.",
"nullable": true
},
"italic": {
"type": "boolean",
"description": "Represents the italic status of the font.",
"nullable": true
},
"name": {
"type": "string",
"description": "Font name (e.g. 'Calibri')",
"nullable": true
},
"size": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
},
{
"enum": [
"-INF",
"INF",
"NaN"
]
}
],
"description": "Size of the font (e.g. 11)",
"format": "double",
"nullable": true
},
"underline": {
"type": "string",
"description": "Type of underline applied to the font. The possible values are: None, Single.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"bold": true,
"color": "string",
"italic": true,
"name": "string",
"size": "double",
"underline": "string"
}
},
"microsoft.graph.workbookChartGridlines": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartGridlines",
"type": "object",
"properties": {
"visible": {
"type": "boolean",
"description": "Boolean value representing if the axis gridlines are visible or not.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartGridlinesFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"visible": true,
"format": {
"@odata.type": "microsoft.graph.workbookChartGridlinesFormat"
}
}
},
"microsoft.graph.workbookChartGridlinesFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartGridlinesFormat",
"type": "object",
"properties": {
"line": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartLineFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"line": {
"@odata.type": "microsoft.graph.workbookChartLineFormat"
}
}
},
"microsoft.graph.workbookChartLegend": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartLegend",
"type": "object",
"properties": {
"overlay": {
"type": "boolean",
"description": "Boolean value for whether the chart legend should overlap with the main body of the chart.",
"nullable": true
},
"position": {
"type": "string",
"description": "Represents the position of the legend on the chart. The possible values are: Top, Bottom, Left, Right, Corner, Custom.",
"nullable": true
},
"visible": {
"type": "boolean",
"description": "A boolean value the represents the visibility of a ChartLegend object.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartLegendFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"overlay": true,
"position": "string",
"visible": true,
"format": {
"@odata.type": "microsoft.graph.workbookChartLegendFormat"
}
}
},
"microsoft.graph.workbookChartLegendFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartLegendFormat",
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFill"
}
],
"nullable": true
},
"font": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFont"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"fill": {
"@odata.type": "microsoft.graph.workbookChartFill"
},
"font": {
"@odata.type": "microsoft.graph.workbookChartFont"
}
}
},
"microsoft.graph.workbookChartLineFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartLineFormat",
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "HTML color code representing the color of lines in the chart.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"color": "string"
}
},
"microsoft.graph.workbookChartPoint": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartPoint",
"type": "object",
"properties": {
"value": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.Json"
}
],
"description": "Returns the value of a chart point. Read-only.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartPointFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"value": {
"@odata.type": "microsoft.graph.Json"
},
"format": {
"@odata.type": "microsoft.graph.workbookChartPointFormat"
}
}
},
"microsoft.graph.workbookChartPointFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartPointFormat",
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFill"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"fill": {
"@odata.type": "microsoft.graph.workbookChartFill"
}
}
},
"microsoft.graph.workbookChartSeries": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartSeries",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Represents the name of a series in a chart.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartSeriesFormat"
}
],
"nullable": true
},
"points": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.workbookChartPoint"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"name": "string",
"format": {
"@odata.type": "microsoft.graph.workbookChartSeriesFormat"
},
"points": [
{
"@odata.type": "microsoft.graph.workbookChartPoint"
}
]
}
},
"microsoft.graph.workbookChartSeriesFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartSeriesFormat",
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFill"
}
],
"nullable": true
},
"line": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartLineFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"fill": {
"@odata.type": "microsoft.graph.workbookChartFill"
},
"line": {
"@odata.type": "microsoft.graph.workbookChartLineFormat"
}
}
},
"microsoft.graph.workbookChartTitle": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartTitle",
"type": "object",
"properties": {
"overlay": {
"type": "boolean",
"description": "Boolean value representing if the chart title will overlay the chart or not.",
"nullable": true
},
"text": {
"type": "string",
"description": "Represents the title text of a chart.",
"nullable": true
},
"visible": {
"type": "boolean",
"description": "A boolean value the represents the visibility of a chart title object.",
"nullable": true
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartTitleFormat"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"overlay": true,
"text": "string",
"visible": true,
"format": {
"@odata.type": "microsoft.graph.workbookChartTitleFormat"
}
}
},
"microsoft.graph.workbookChartTitleFormat": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookChartTitleFormat",
"type": "object",
"properties": {
"fill": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFill"
}
],
"nullable": true
},
"font": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookChartFont"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"fill": {
"@odata.type": "microsoft.graph.workbookChartFill"
},
"font": {
"@odata.type": "microsoft.graph.workbookChartFont"
}
}
},
"microsoft.graph.columnDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "columnDefinition",
"type": "object",
"properties": {
"columnGroup": {
"type": "string",
"description": "For site columns, the name of the group this column belongs to. Helps organize related columns.",
"nullable": true
},
"description": {
"type": "string",
"description": "The user-facing description of the column.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The user-facing name of the column.",
"nullable": true
},
"enforceUniqueValues": {
"type": "boolean",
"description": "If true, no two list items may have the same value for this column.",
"nullable": true
},
"hidden": {
"type": "boolean",
"description": "Specifies whether the column is displayed in the user interface.",
"nullable": true
},
"indexed": {
"type": "boolean",
"description": "Specifies whether the column values can used for sorting and searching.",
"nullable": true
},
"name": {
"type": "string",
"description": "The API-facing name of the column as it appears in the [fields][] on a [listItem][]. For the user-facing name, see displayName.",
"nullable": true
},
"readOnly": {
"type": "boolean",
"description": "Specifies whether the column values can be modified.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Specifies whether the column value is not optional.",
"nullable": true
},
"boolean": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.booleanColumn"
}
],
"description": "This column stores boolean values.",
"nullable": true
},
"calculated": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.calculatedColumn"
}
],
"description": "This column's data is calculated based on other columns.",
"nullable": true
},
"choice": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.choiceColumn"
}
],
"description": "This column stores data from a list of choices.",
"nullable": true
},
"currency": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.currencyColumn"
}
],
"description": "This column stores currency values.",
"nullable": true
},
"dateTime": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.dateTimeColumn"
}
],
"description": "This column stores DateTime values.",
"nullable": true
},
"defaultValue": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.defaultColumnValue"
}
],
"description": "The default value for this column.",
"nullable": true
},
"lookup": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.lookupColumn"
}
],
"description": "This column's data is looked up from another source in the site.",
"nullable": true
},
"number": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.numberColumn"
}
],
"description": "This column stores number values.",
"nullable": true
},
"personOrGroup": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.personOrGroupColumn"
}
],
"description": "This column stores Person or Group values.",
"nullable": true
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.textColumn"
}
],
"description": "This column stores text values.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"columnGroup": "string",
"description": "string",
"displayName": "string",
"enforceUniqueValues": true,
"hidden": true,
"indexed": true,
"name": "string",
"readOnly": true,
"required": true,
"boolean": {
"@odata.type": "microsoft.graph.booleanColumn"
},
"calculated": {
"@odata.type": "microsoft.graph.calculatedColumn"
},
"choice": {
"@odata.type": "microsoft.graph.choiceColumn"
},
"currency": {
"@odata.type": "microsoft.graph.currencyColumn"
},
"dateTime": {
"@odata.type": "microsoft.graph.dateTimeColumn"
},
"defaultValue": {
"@odata.type": "microsoft.graph.defaultColumnValue"
},
"lookup": {
"@odata.type": "microsoft.graph.lookupColumn"
},
"number": {
"@odata.type": "microsoft.graph.numberColumn"
},
"personOrGroup": {
"@odata.type": "microsoft.graph.personOrGroupColumn"
},
"text": {
"@odata.type": "microsoft.graph.textColumn"
}
}
},
"microsoft.graph.columnLink": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "columnLink",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the column in this content type.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"name": "string"
}
},
"microsoft.graph.outlookItem": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "outlookItem",
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The categories associated with the item"
},
"changeKey": {
"type": "string",
"description": "Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"categories": [
"string"
],
"changeKey": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)"
}
},
"microsoft.graph.contact": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.outlookItem"
},
{
"title": "contact",
"type": "object",
"properties": {
"assistantName": {
"type": "string",
"description": "The name of the contact's assistant.",
"nullable": true
},
"birthday": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The contact's birthday. 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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"businessAddress": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.physicalAddress"
}
],
"description": "The contact's business address.",
"nullable": true
},
"businessHomePage": {
"type": "string",
"description": "The business home page of the contact.",
"nullable": true
},
"businessPhones": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The contact's business phone numbers."
},
"children": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The names of the contact's children."
},
"companyName": {
"type": "string",
"description": "The name of the contact's company.",
"nullable": true
},
"department": {
"type": "string",
"description": "The contact's department.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The contact's display name.",
"nullable": true
},
"emailAddresses": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.emailAddress"
}
],
"nullable": true
},
"description": "The contact's email addresses."
},
"flag": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.followupFlag"
}
],
"description": "The flag value that indicates the status, start date, due date, or completion date for the message.",
"nullable": true
},
"fileAs": {
"type": "string",
"description": "The name the contact is filed under.",
"nullable": true
},
"generation": {
"type": "string",
"description": "The contact's generation.",
"nullable": true
},
"givenName": {
"type": "string",
"description": "The contact's given name.",
"nullable": true
},
"homeAddress": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.physicalAddress"
}
],
"description": "The contact's home address.",
"nullable": true
},
"homePhones": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The contact's home phone numbers."
},
"imAddresses": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The contact's instant messaging (IM) addresses."
},
"initials": {
"type": "string",
"description": "The contact's initials.",
"nullable": true
},
"jobTitle": {
"type": "string",
"description": "The contact’s job title.",
"nullable": true
},
"manager": {
"type": "string",
"description": "The name of the contact's manager.",
"nullable": true
},
"middleName": {
"type": "string",
"description": "The contact's middle name.",
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "The contact's mobile phone number.",
"nullable": true
},
"nickName": {
"type": "string",
"description": "The contact's nickname.",
"nullable": true
},
"officeLocation": {
"type": "string",
"description": "The location of the contact's office.",
"nullable": true
},
"otherAddress": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.physicalAddress"
}
],
"description": "Other addresses for the contact.",
"nullable": true
},
"parentFolderId": {
"type": "string",
"description": "The ID of the contact's parent folder.",
"nullable": true
},
"personalNotes": {
"type": "string",
"description": "The user's notes about the contact.",
"nullable": true
},
"profession": {
"type": "string",
"description": "The contact's profession.",
"nullable": true
},
"spouseName": {
"type": "string",
"description": "The name of the contact's spouse/partner.",
"nullable": true
},
"surname": {
"type": "string",
"description": "The contact's surname.",
"nullable": true
},
"title": {
"type": "string",
"description": "The contact's title.",
"nullable": true
},
"yomiCompanyName": {
"type": "string",
"description": "The phonetic Japanese company name of the contact.",
"nullable": true
},
"yomiGivenName": {
"type": "string",
"description": "The phonetic Japanese given name (first name) of the contact.",
"nullable": true
},
"yomiSurname": {
"type": "string",
"description": "The phonetic Japanese surname (last name) of the contact.",
"nullable": true
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.profilePhoto"
}
],
"nullable": true
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
},
"multiValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty"
}
},
"singleValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"categories": [
"string"
],
"changeKey": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"assistantName": "string",
"birthday": "string (timestamp)",
"businessAddress": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"businessHomePage": "string",
"businessPhones": [
"string"
],
"children": [
"string"
],
"companyName": "string",
"department": "string",
"displayName": "string",
"emailAddresses": [
{
"@odata.type": "microsoft.graph.emailAddress"
}
],
"flag": {
"@odata.type": "microsoft.graph.followupFlag"
},
"fileAs": "string",
"generation": "string",
"givenName": "string",
"homeAddress": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"homePhones": [
"string"
],
"imAddresses": [
"string"
],
"initials": "string",
"jobTitle": "string",
"manager": "string",
"middleName": "string",
"mobilePhone": "string",
"nickName": "string",
"officeLocation": "string",
"otherAddress": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"parentFolderId": "string",
"personalNotes": "string",
"profession": "string",
"spouseName": "string",
"surname": "string",
"title": "string",
"yomiCompanyName": "string",
"yomiGivenName": "string",
"yomiSurname": "string",
"photo": {
"@odata.type": "microsoft.graph.profilePhoto"
},
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
],
"multiValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"
}
],
"singleValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"
}
]
}
},
"microsoft.graph.contactFolder": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "contactFolder",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The folder's display name.",
"nullable": true
},
"parentFolderId": {
"type": "string",
"description": "The ID of the folder's parent folder.",
"nullable": true
},
"childFolders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.contactFolder"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.contact"
}
},
"multiValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty"
}
},
"singleValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"parentFolderId": "string",
"childFolders": [
{
"@odata.type": "microsoft.graph.contactFolder"
}
],
"contacts": [
{
"@odata.type": "microsoft.graph.contact"
}
],
"multiValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"
}
],
"singleValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"
}
]
}
},
"microsoft.graph.contentType": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "contentType",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The descriptive text for the item.",
"nullable": true
},
"group": {
"type": "string",
"description": "The name of the group this content type belongs to. Helps organize related content types.",
"nullable": true
},
"hidden": {
"type": "boolean",
"description": "Indicates whether the content type is hidden in the list's 'New' menu.",
"nullable": true
},
"inheritedFrom": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemReference"
}
],
"description": "If this content type is inherited from another scope (like a site), provides a reference to the item where the content type is defined.",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the content type.",
"nullable": true
},
"order": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.contentTypeOrder"
}
],
"description": "Specifies the order in which the content type appears in the selection UI.",
"nullable": true
},
"parentId": {
"type": "string",
"description": "The unique identifier of the content type.",
"nullable": true
},
"readOnly": {
"type": "boolean",
"description": "If true, the content type cannot be modified unless this value is first set to false.",
"nullable": true
},
"sealed": {
"type": "boolean",
"description": "If true, the content type cannot be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.",
"nullable": true
},
"columnLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.columnLink"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"group": "string",
"hidden": true,
"inheritedFrom": {
"@odata.type": "microsoft.graph.itemReference"
},
"name": "string",
"order": {
"@odata.type": "microsoft.graph.contentTypeOrder"
},
"parentId": "string",
"readOnly": true,
"sealed": true,
"columnLinks": [
{
"@odata.type": "microsoft.graph.columnLink"
}
]
}
},
"microsoft.graph.directoryObject": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "directoryObject",
"type": "object"
}
],
"example": {
"id": "string (identifier)"
}
},
"microsoft.graph.contract": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "contract",
"type": "object",
"properties": {
"contractType": {
"type": "string",
"description": "Type of contract.Possible values are: SyndicationPartner - Partner that exclusively resells and manages O365 and Intune for this customer. They resell and support their customers. BreadthPartner - Partner has the ability to provide administrative support for this customer. However, the partner is not allowed to resell to the customer.ResellerPartner - Partner that is similar to a syndication partner, except that the partner doesn’t have exclusive access to a tenant. In the syndication case, the customer cannot buy additional direct subscriptions from Microsoft or from other partners.",
"nullable": true
},
"customerId": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"description": "The unique identifier for the customer tenant referenced by this partnership. Corresponds to the id property of the customer tenant's organization resource.",
"format": "uuid",
"nullable": true
},
"defaultDomainName": {
"type": "string",
"description": "A copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's default domain name changes.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "A copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's display name changes.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"contractType": "string",
"customerId": "string",
"defaultDomainName": "string",
"displayName": "string"
}
},
"microsoft.graph.conversation": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "conversation",
"type": "object",
"properties": {
"hasAttachments": {
"type": "boolean",
"description": "Indicates whether any of the posts within this Conversation has at least one attachment.",
"nullable": true
},
"lastDeliveredDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"preview": {
"type": "string",
"description": "A short summary from the body of the latest post in this converstaion.",
"nullable": true
},
"topic": {
"type": "string",
"description": "The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.",
"nullable": true
},
"uniqueSenders": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "All the users that sent a message to this Conversation."
},
"threads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.conversationThread"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"hasAttachments": true,
"lastDeliveredDateTime": "string (timestamp)",
"preview": "string",
"topic": "string",
"uniqueSenders": [
"string"
],
"threads": [
{
"@odata.type": "microsoft.graph.conversationThread"
}
]
}
},
"microsoft.graph.conversationThread": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "conversationThread",
"type": "object",
"properties": {
"ccRecipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
},
"description": "The Cc: recipients for the thread."
},
"hasAttachments": {
"type": "boolean",
"description": "Indicates whether any of the posts within this thread has at least one attachment.",
"nullable": true
},
"isLocked": {
"type": "boolean",
"description": "Indicates if the thread is locked.",
"nullable": true
},
"lastDeliveredDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"preview": {
"type": "string",
"description": "A short summary from the body of the latest post in this converstaion.",
"nullable": true
},
"toRecipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
},
"description": "The To: recipients for the thread."
},
"topic": {
"type": "string",
"description": "The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.",
"nullable": true
},
"uniqueSenders": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "All the users that sent a message to this thread."
},
"posts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.post"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"ccRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"hasAttachments": true,
"isLocked": true,
"lastDeliveredDateTime": "string (timestamp)",
"preview": "string",
"toRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"topic": "string",
"uniqueSenders": [
"string"
],
"posts": [
{
"@odata.type": "microsoft.graph.post"
}
]
}
},
"microsoft.graph.device": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "device",
"type": "object",
"properties": {
"accountEnabled": {
"type": "boolean",
"description": "true if the account is enabled; otherwise, false. Required.",
"nullable": true
},
"alternativeSecurityIds": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.alternativeSecurityId"
}
],
"nullable": true
},
"description": "For internal use only. Not nullable."
},
"approximateLastSignInDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z' Read-only.",
"format": "date-time",
"nullable": true
},
"deviceId": {
"type": "string",
"description": "Unique identifier set by Azure Device Registration Service at the time of registration.",
"nullable": true
},
"deviceMetadata": {
"type": "string",
"description": "For interal use only. Set to null.",
"nullable": true
},
"deviceVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "For interal use only.",
"format": "int32",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name for the device. Required.",
"nullable": true
},
"isCompliant": {
"type": "boolean",
"description": "true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices.",
"nullable": true
},
"isManaged": {
"type": "boolean",
"description": "true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices.",
"nullable": true
},
"onPremisesLastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The last time at which the object was synced with the on-premises directory.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 would look like this: '2014-01-01T00:00:00Z' Read-only.",
"format": "date-time",
"nullable": true
},
"onPremisesSyncEnabled": {
"type": "boolean",
"description": "true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only.",
"nullable": true
},
"operatingSystem": {
"type": "string",
"description": "The type of operating system on the device. Required.",
"nullable": true
},
"operatingSystemVersion": {
"type": "string",
"description": "The version of the operating system on the device. Required.",
"nullable": true
},
"physicalIds": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "For interal use only. Not nullable."
},
"trustType": {
"type": "string",
"description": "Type of trust for the joined device. Read-only. Possible values: Workplace - indicates bring your own personal devicesAzureAd - Cloud only joined devicesServerAd - on-premises domain joined devices joined to Azure AD. For more details, see Introduction to device management in Azure Active Directory",
"nullable": true
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
},
"registeredOwners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"registeredUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"accountEnabled": true,
"alternativeSecurityIds": [
{
"@odata.type": "microsoft.graph.alternativeSecurityId"
}
],
"approximateLastSignInDateTime": "string (timestamp)",
"deviceId": "string",
"deviceMetadata": "string",
"deviceVersion": "integer",
"displayName": "string",
"isCompliant": true,
"isManaged": true,
"onPremisesLastSyncDateTime": "string (timestamp)",
"onPremisesSyncEnabled": true,
"operatingSystem": "string",
"operatingSystemVersion": "string",
"physicalIds": [
"string"
],
"trustType": "string",
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
],
"registeredOwners": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"registeredUsers": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
]
}
},
"microsoft.graph.directory": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "directory",
"type": "object",
"properties": {
"deletedItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"deletedItems": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
]
}
},
"microsoft.graph.directoryRole": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "directoryRole",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description for the directory role. Read-only.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name for the directory role. Read-only.",
"nullable": true
},
"roleTemplateId": {
"type": "string",
"description": "The id of the directoryRoleTemplate that this role is based on. The property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read only.",
"nullable": true
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"displayName": "string",
"roleTemplateId": "string",
"members": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
]
}
},
"microsoft.graph.directoryRoleTemplate": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "directoryRoleTemplate",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description to set for the directory role. Read-only.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name to set for the directory role. Read-only.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"displayName": "string"
}
},
"microsoft.graph.domain": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "domain",
"type": "object",
"properties": {
"authenticationType": {
"type": "string",
"description": "Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Azure AD performs user authentication.Federated indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable",
"nullable": true
},
"availabilityStatus": {
"type": "string",
"description": "This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled.",
"nullable": true
},
"isAdminManaged": {
"type": "boolean",
"description": "The value of the property is false if the DNS record management of the domain has been delegated to Office 365. Otherwise, the value is true. Not nullable",
"nullable": true
},
"isDefault": {
"type": "boolean",
"description": "True if this is the default domain that is used for user creation. There is only one default domain per company. Not nullable",
"nullable": true
},
"isInitial": {
"type": "boolean",
"description": "True if this is the initial domain created by Microsoft Online Services (companyname.onmicrosoft.com). There is only one initial domain per company. Not nullable",
"nullable": true
},
"isRoot": {
"type": "boolean",
"description": "True if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable",
"nullable": true
},
"isVerified": {
"type": "boolean",
"description": "True if the domain has completed domain ownership verification. Not nullable",
"nullable": true
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.domainState"
}
],
"description": "Status of asynchronous operations scheduled for the domain.",
"nullable": true
},
"supportedServices": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The capabilities assigned to the domain.Can include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune The values which you can add/remove using Graph API include: Email, OfficeCommunicationsOnline, YammerNot nullable"
},
"domainNameReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"serviceConfigurationRecords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
}
},
"verificationDnsRecords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"authenticationType": "string",
"availabilityStatus": "string",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true,
"isVerified": true,
"state": {
"@odata.type": "microsoft.graph.domainState"
},
"supportedServices": [
"string"
],
"domainNameReferences": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"serviceConfigurationRecords": [
{
"@odata.type": "microsoft.graph.domainDnsRecord"
}
],
"verificationDnsRecords": [
{
"@odata.type": "microsoft.graph.domainDnsRecord"
}
]
}
},
"microsoft.graph.domainDnsRecord": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "domainDnsRecord",
"type": "object",
"properties": {
"isOptional": {
"type": "boolean",
"description": "If false, this record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain.",
"nullable": true
},
"label": {
"type": "string",
"description": "Value used when configuring the name of the DNS record at the DNS host.",
"nullable": true
},
"recordType": {
"type": "string",
"description": "Indicates what type of DNS record this entity represents.The value can be one of the following: CName, Mx, Srv, TxtKey",
"nullable": true
},
"supportedService": {
"type": "string",
"description": "Microsoft Online Service or feature that has a dependency on this DNS record.Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune",
"nullable": true
},
"ttl": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"isOptional": true,
"label": "string",
"recordType": "string",
"supportedService": "string",
"ttl": "integer"
}
},
"microsoft.graph.domainDnsCnameRecord": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
},
{
"title": "domainDnsCnameRecord",
"type": "object",
"properties": {
"canonicalName": {
"type": "string",
"description": "The canonical name of the CNAME record. Used to configure the CNAME record at the DNS host.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"isOptional": true,
"label": "string",
"recordType": "string",
"supportedService": "string",
"ttl": "integer",
"canonicalName": "string"
}
},
"microsoft.graph.domainDnsMxRecord": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
},
{
"title": "domainDnsMxRecord",
"type": "object",
"properties": {
"mailExchange": {
"type": "string",
"description": "Value used when configuring the answer/destination/value of the MX record at the DNS host.",
"nullable": true
},
"preference": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Value used when configuring the Preference/Priority property of the MX record at the DNS host.",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"isOptional": true,
"label": "string",
"recordType": "string",
"supportedService": "string",
"ttl": "integer",
"mailExchange": "string",
"preference": "integer"
}
},
"microsoft.graph.domainDnsSrvRecord": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
},
{
"title": "domainDnsSrvRecord",
"type": "object",
"properties": {
"nameTarget": {
"type": "string",
"description": "Value to use when configuring the Target property of the SRV record at the DNS host.",
"nullable": true
},
"port": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Value to use when configuring the port property of the SRV record at the DNS host.",
"format": "int32",
"nullable": true
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Value to use when configuring the priority property of the SRV record at the DNS host.",
"format": "int32",
"nullable": true
},
"protocol": {
"type": "string",
"description": "Value to use when configuring the protocol property of the SRV record at the DNS host.",
"nullable": true
},
"service": {
"type": "string",
"description": "Value to use when configuring the service property of the SRV record at the DNS host.",
"nullable": true
},
"weight": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Value to use when configuring the weight property of the SRV record at the DNS host.",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"isOptional": true,
"label": "string",
"recordType": "string",
"supportedService": "string",
"ttl": "integer",
"nameTarget": "string",
"port": "integer",
"priority": "integer",
"protocol": "string",
"service": "string",
"weight": "integer"
}
},
"microsoft.graph.domainDnsTxtRecord": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
},
{
"title": "domainDnsTxtRecord",
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Value used when configuring the text property at the DNS host.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"isOptional": true,
"label": "string",
"recordType": "string",
"supportedService": "string",
"ttl": "integer",
"text": "string"
}
},
"microsoft.graph.domainDnsUnavailableRecord": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.domainDnsRecord"
},
{
"title": "domainDnsUnavailableRecord",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Provides the reason why the DomainDnsUnavailableRecord entity is returned.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"isOptional": true,
"label": "string",
"recordType": "string",
"supportedService": "string",
"ttl": "integer",
"description": "string"
}
},
"microsoft.graph.drive": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.baseItem"
},
{
"title": "drive",
"type": "object",
"properties": {
"driveType": {
"type": "string",
"description": "Describes the type of drive represented by this resource. OneDrive personal drives will return personal. OneDrive for Business will return business. SharePoint document libraries will return documentLibrary. Read-only.",
"nullable": true
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Optional. The user account that owns the drive. Read-only.",
"nullable": true
},
"quota": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.quota"
}
],
"description": "Optional. Information about the drive's storage space quota. Read-only.",
"nullable": true
},
"sharepointIds": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.sharepointIds"
}
],
"description": "Returns identifiers useful for SharePoint REST compatibility. Read-only.",
"nullable": true
},
"system": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.systemFacet"
}
],
"description": "If present, indicates that this is a system-managed drive. Read-only.",
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
},
"root": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
],
"nullable": true
},
"special": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
},
"list": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.list"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "string (timestamp)",
"description": "string",
"eTag": "string",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "string (timestamp)",
"name": "string",
"parentReference": {
"@odata.type": "microsoft.graph.itemReference"
},
"webUrl": "string",
"createdByUser": {
"@odata.type": "microsoft.graph.user"
},
"lastModifiedByUser": {
"@odata.type": "microsoft.graph.user"
},
"driveType": "string",
"owner": {
"@odata.type": "microsoft.graph.identitySet"
},
"quota": {
"@odata.type": "microsoft.graph.quota"
},
"sharepointIds": {
"@odata.type": "microsoft.graph.sharepointIds"
},
"system": {
"@odata.type": "microsoft.graph.systemFacet"
},
"items": [
{
"@odata.type": "microsoft.graph.driveItem"
}
],
"root": {
"@odata.type": "microsoft.graph.driveItem"
},
"special": [
{
"@odata.type": "microsoft.graph.driveItem"
}
],
"list": {
"@odata.type": "microsoft.graph.list"
}
}
},
"microsoft.graph.driveItem": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.baseItem"
},
{
"title": "driveItem",
"type": "object",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.audio"
}
],
"description": "Audio metadata, if the item is an audio file. Read-only.",
"nullable": true
},
"content": {
"type": "string",
"description": "The content stream, if the item represents a file.",
"format": "base64url",
"nullable": true
},
"cTag": {
"type": "string",
"description": "An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.",
"nullable": true
},
"deleted": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deleted"
}
],
"description": "Information about the deleted state of the item. Read-only.",
"nullable": true
},
"file": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.file"
}
],
"description": "File metadata, if the item is a file. Read-only.",
"nullable": true
},
"fileSystemInfo": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.fileSystemInfo"
}
],
"description": "File system information on client. Read-write.",
"nullable": true
},
"folder": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.folder"
}
],
"description": "Folder metadata, if the item is a folder. Read-only.",
"nullable": true
},
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.image"
}
],
"description": "Image metadata, if the item is an image. Read-only.",
"nullable": true
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.geoCoordinates"
}
],
"description": "Location metadata, if the item has location data. Read-only.",
"nullable": true
},
"package": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.package"
}
],
"description": "If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only.",
"nullable": true
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.photo"
}
],
"description": "Photo metadata, if the item is a photo. Read-only.",
"nullable": true
},
"publication": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.publicationFacet"
}
],
"description": "Provides information about the published or checked-out state of an item, in locations that support such actions. This property is not returned by default. Read-only.",
"nullable": true
},
"remoteItem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.remoteItem"
}
],
"description": "Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.",
"nullable": true
},
"root": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.root"
}
],
"description": "If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.",
"nullable": true
},
"searchResult": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.searchResult"
}
],
"description": "Search metadata, if the item is from a search result. Read-only.",
"nullable": true
},
"shared": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.shared"
}
],
"description": "Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.",
"nullable": true
},
"sharepointIds": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.sharepointIds"
}
],
"description": "Returns identifiers useful for SharePoint REST compatibility. Read-only.",
"nullable": true
},
"size": {
"type": "integer",
"description": "Size of the item in bytes. Read-only.",
"format": "int64",
"nullable": true
},
"specialFolder": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.specialFolder"
}
],
"description": "If the current item is also available as a special folder, this facet is returned. Read-only.",
"nullable": true
},
"video": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.video"
}
],
"description": "Video metadata, if the item is a video. Read-only.",
"nullable": true
},
"webDavUrl": {
"type": "string",
"description": "WebDAV compatible URL for the item.",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.driveItem"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.permission"
}
},
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.thumbnailSet"
}
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.driveItemVersion"
}
},
"listItem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.listItem"
}
],
"nullable": true
},
"workbook": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbook"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"createdDateTime": "string (timestamp)",
"description": "string",
"eTag": "string",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "string (timestamp)",
"name": "string",
"parentReference": {
"@odata.type": "microsoft.graph.itemReference"
},
"webUrl": "string",
"createdByUser": {
"@odata.type": "microsoft.graph.user"
},
"lastModifiedByUser": {
"@odata.type": "microsoft.graph.user"
},
"audio": {
"@odata.type": "microsoft.graph.audio"
},
"content": "string",
"cTag": "string",
"deleted": {
"@odata.type": "microsoft.graph.deleted"
},
"file": {
"@odata.type": "microsoft.graph.file"
},
"fileSystemInfo": {
"@odata.type": "microsoft.graph.fileSystemInfo"
},
"folder": {
"@odata.type": "microsoft.graph.folder"
},
"image": {
"@odata.type": "microsoft.graph.image"
},
"location": {
"@odata.type": "microsoft.graph.geoCoordinates"
},
"package": {
"@odata.type": "microsoft.graph.package"
},
"photo": {
"@odata.type": "microsoft.graph.photo"
},
"publication": {
"@odata.type": "microsoft.graph.publicationFacet"
},
"remoteItem": {
"@odata.type": "microsoft.graph.remoteItem"
},
"root": {
"@odata.type": "microsoft.graph.root"
},
"searchResult": {
"@odata.type": "microsoft.graph.searchResult"
},
"shared": {
"@odata.type": "microsoft.graph.shared"
},
"sharepointIds": {
"@odata.type": "microsoft.graph.sharepointIds"
},
"size": "integer",
"specialFolder": {
"@odata.type": "microsoft.graph.specialFolder"
},
"video": {
"@odata.type": "microsoft.graph.video"
},
"webDavUrl": "string",
"children": [
{
"@odata.type": "microsoft.graph.driveItem"
}
],
"permissions": [
{
"@odata.type": "microsoft.graph.permission"
}
],
"thumbnails": [
{
"@odata.type": "microsoft.graph.thumbnailSet"
}
],
"versions": [
{
"@odata.type": "microsoft.graph.driveItemVersion"
}
],
"listItem": {
"@odata.type": "microsoft.graph.listItem"
},
"workbook": {
"@odata.type": "microsoft.graph.workbook"
}
}
},
"microsoft.graph.driveItemVersion": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.baseItemVersion"
},
{
"title": "driveItemVersion",
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The content stream for this version of the item.",
"format": "base64url",
"nullable": true
},
"size": {
"type": "integer",
"description": "Indicates the size of the content stream for this version of the item.",
"format": "int64",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "string (timestamp)",
"publication": {
"@odata.type": "microsoft.graph.publicationFacet"
},
"content": "string",
"size": "integer"
}
},
"microsoft.graph.educationClass": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "educationClass",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the class.",
"nullable": true
},
"classCode": {
"type": "string",
"description": "Class code used by the school to identify the class.",
"nullable": true
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Entity who created the class",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Name of the class.",
"nullable": true
},
"externalId": {
"type": "string",
"description": "ID of the class from the syncing system.",
"nullable": true
},
"externalName": {
"type": "string",
"description": "Name of the class in the syncing system.",
"nullable": true
},
"externalSource": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationExternalSource"
}
],
"description": "How this class was created. The possible values are: sis, manual, unknownFutureValue.",
"nullable": true
},
"mailNickname": {
"type": "string",
"description": "Mail name for sending email to all members, if this is enabled.",
"nullable": true
},
"term": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationTerm"
}
],
"description": "Term for this class.",
"nullable": true
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationUser"
}
},
"schools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationSchool"
}
},
"teachers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationUser"
}
},
"group": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.group"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"classCode": "string",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"displayName": "string",
"externalId": "string",
"externalName": "string",
"externalSource": {
"@odata.type": "microsoft.graph.educationExternalSource"
},
"mailNickname": "string",
"term": {
"@odata.type": "microsoft.graph.educationTerm"
},
"members": [
{
"@odata.type": "microsoft.graph.educationUser"
}
],
"schools": [
{
"@odata.type": "microsoft.graph.educationSchool"
}
],
"teachers": [
{
"@odata.type": "microsoft.graph.educationUser"
}
],
"group": {
"@odata.type": "microsoft.graph.group"
}
}
},
"microsoft.graph.educationOrganization": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "educationOrganization",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Organization description.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Organization display name.",
"nullable": true
},
"externalSource": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationExternalSource"
}
],
"description": "Source where this organization was created from. The possible values are: sis, manual, unknownFutureValue.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"displayName": "string",
"externalSource": {
"@odata.type": "microsoft.graph.educationExternalSource"
}
}
},
"microsoft.graph.educationRoot": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "educationRoot",
"type": "object",
"properties": {
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationClass"
}
},
"me": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationUser"
}
],
"nullable": true
},
"schools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationSchool"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationUser"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"classes": [
{
"@odata.type": "microsoft.graph.educationClass"
}
],
"me": {
"@odata.type": "microsoft.graph.educationUser"
},
"schools": [
{
"@odata.type": "microsoft.graph.educationSchool"
}
],
"users": [
{
"@odata.type": "microsoft.graph.educationUser"
}
]
}
},
"microsoft.graph.educationSchool": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationOrganization"
},
{
"title": "educationSchool",
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Read-Only. The possible values are: inactive, active, expired, deleteable.",
"nullable": true
},
"principalEmail": {
"type": "string",
"description": "Email address of the principal.",
"nullable": true
},
"principalName": {
"type": "string",
"description": "Name of the principal.",
"nullable": true
},
"externalPrincipalId": {
"type": "string",
"description": "ID of principal in syncing system.",
"nullable": true
},
"highestGrade": {
"type": "string",
"description": "Highest grade taught.",
"nullable": true
},
"lowestGrade": {
"type": "string",
"description": "Lowest grade taught.",
"nullable": true
},
"schoolNumber": {
"type": "string",
"description": "School Number.",
"nullable": true
},
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.physicalAddress"
}
],
"description": "Address of the school.",
"nullable": true
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Entity who created the school.",
"nullable": true
},
"externalId": {
"type": "string",
"description": "ID of school in syncing system.",
"nullable": true
},
"fax": {
"type": "string",
"description": "Fax number of school.",
"nullable": true
},
"phone": {
"type": "string",
"description": "Phone number of school.",
"nullable": true
},
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationClass"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationUser"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"displayName": "string",
"externalSource": {
"@odata.type": "microsoft.graph.educationExternalSource"
},
"status": "string",
"principalEmail": "string",
"principalName": "string",
"externalPrincipalId": "string",
"highestGrade": "string",
"lowestGrade": "string",
"schoolNumber": "string",
"address": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"externalId": "string",
"fax": "string",
"phone": "string",
"classes": [
{
"@odata.type": "microsoft.graph.educationClass"
}
],
"users": [
{
"@odata.type": "microsoft.graph.educationUser"
}
]
}
},
"microsoft.graph.educationUser": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "educationUser",
"type": "object",
"properties": {
"accountEnabled": {
"type": "boolean",
"description": "True if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter.",
"nullable": true
},
"assignedLicenses": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.assignedLicense"
}
],
"nullable": true
},
"description": "The licenses that are assigned to the user. Not nullable."
},
"assignedPlans": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.assignedPlan"
}
],
"nullable": true
},
"description": "The plans that are assigned to the user. Read-only. Not nullable."
},
"businessPhones": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The telephone numbers for the user. Note: Although this is a string collection, only one number can be set for this property."
},
"department": {
"type": "string",
"description": "The name for the department in which the user works. Supports $filter.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Supports $filter and $orderby.",
"nullable": true
},
"givenName": {
"type": "string",
"description": "The given name (first name) of the user. Supports $filter.",
"nullable": true
},
"middleName": {
"type": "string",
"description": "The middle name of user.",
"nullable": true
},
"surname": {
"type": "string",
"description": "The user's surname (family name or last name). Supports $filter.",
"nullable": true
},
"mail": {
"type": "string",
"description": "The SMTP address for the user; for example, 'jeff@contoso.onmicrosoft.com'. Read-Only. Supports $filter.",
"nullable": true
},
"mailNickname": {
"type": "string",
"description": "The mail alias for the user. This property must be specified when a user is created. Supports $filter.",
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "The primary cellular telephone number for the user.",
"nullable": true
},
"createdBy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.identitySet"
}
],
"description": "Entity who created the user.",
"nullable": true
},
"externalSource": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationExternalSource"
}
],
"description": "Where this user was created from. The possible values are: sis, manual, unkownFutureValue.",
"nullable": true
},
"mailingAddress": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.physicalAddress"
}
],
"description": "Mail address of user.",
"nullable": true
},
"passwordPolicies": {
"type": "string",
"description": "Specifies password policies for the user. This value is an enumeration with one possible value being 'DisableStrongPassword', which allows weaker passwords than the default policy to be specified. 'DisablePasswordExpiration' can also be specified. The two can be specified together; for example: 'DisablePasswordExpiration, DisableStrongPassword'.",
"nullable": true
},
"passwordProfile": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.passwordProfile"
}
],
"description": "Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.",
"nullable": true
},
"preferredLanguage": {
"type": "string",
"description": "The preferred language for the user. Should follow ISO 639-1 Code; for example, 'en-US'.",
"nullable": true
},
"primaryRole": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationUserRole"
}
],
"description": "Default role for a user. The user's role might be different in an individual class. The possible values are: student, teacher, unknownFutureValue. Supports $filter.",
"nullable": true
},
"provisionedPlans": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.provisionedPlan"
}
],
"nullable": true
},
"description": "The plans that are provisioned for the user. Read-only. Not nullable."
},
"residenceAddress": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.physicalAddress"
}
],
"description": "Address where user lives.",
"nullable": true
},
"student": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationStudent"
}
],
"description": "If the primary role is student, this block will contain student specific data.",
"nullable": true
},
"teacher": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationTeacher"
}
],
"description": "If the primary role is teacher, this block will conatin teacher specific data.",
"nullable": true
},
"usageLocation": {
"type": "string",
"description": "A two-letter country code (ISO standard 3166). Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. Examples include: 'US', 'JP', and 'GB'. Not nullable. Supports $filter.",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. Supports $filter and $orderby.",
"nullable": true
},
"userType": {
"type": "string",
"description": "A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'. Supports $filter.",
"nullable": true
},
"classes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationClass"
}
},
"schools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.educationSchool"
}
},
"assignments": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.educationAssignment"
}
],
"nullable": true
},
"user": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.user"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"accountEnabled": true,
"assignedLicenses": [
{
"@odata.type": "microsoft.graph.assignedLicense"
}
],
"assignedPlans": [
{
"@odata.type": "microsoft.graph.assignedPlan"
}
],
"businessPhones": [
"string"
],
"department": "string",
"displayName": "string",
"givenName": "string",
"middleName": "string",
"surname": "string",
"mail": "string",
"mailNickname": "string",
"mobilePhone": "string",
"createdBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"externalSource": {
"@odata.type": "microsoft.graph.educationExternalSource"
},
"mailingAddress": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"passwordPolicies": "string",
"passwordProfile": {
"@odata.type": "microsoft.graph.passwordProfile"
},
"preferredLanguage": "string",
"primaryRole": {
"@odata.type": "microsoft.graph.educationUserRole"
},
"provisionedPlans": [
{
"@odata.type": "microsoft.graph.provisionedPlan"
}
],
"residenceAddress": {
"@odata.type": "microsoft.graph.physicalAddress"
},
"student": {
"@odata.type": "microsoft.graph.educationStudent"
},
"teacher": {
"@odata.type": "microsoft.graph.educationTeacher"
},
"usageLocation": "string",
"userPrincipalName": "string",
"userType": "string",
"classes": [
{
"@odata.type": "microsoft.graph.educationClass"
}
],
"schools": [
{
"@odata.type": "microsoft.graph.educationSchool"
}
],
"assignments": {
"@odata.type": "microsoft.graph.educationAssignment"
},
"user": {
"@odata.type": "microsoft.graph.user"
}
}
},
"microsoft.graph.event": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.outlookItem"
},
{
"title": "event",
"type": "object",
"properties": {
"attendees": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.attendee"
}
],
"nullable": true
},
"description": "The collection of attendees for the event."
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemBody"
}
],
"description": "The body of the message associated with the event. It can be in HTML or text format.",
"nullable": true
},
"bodyPreview": {
"type": "string",
"description": "The preview of the message associated with the event. It is in text format.",
"nullable": true
},
"end": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.dateTimeTimeZone"
}
],
"description": "The date, time, and time zone that the event ends.",
"nullable": true
},
"hasAttachments": {
"type": "boolean",
"description": "Set to true if the event has attachments.",
"nullable": true
},
"iCalUId": {
"type": "string",
"description": "A unique identifier that is shared by all instances of an event across different calendars.",
"nullable": true
},
"importance": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.importance"
}
],
"description": "The importance of the event. The possible values are: low, normal, high.",
"nullable": true
},
"isAllDay": {
"type": "boolean",
"description": "Set to true if the event lasts all day.",
"nullable": true
},
"isCancelled": {
"type": "boolean",
"description": "Set to true if the event has been canceled.",
"nullable": true
},
"isOrganizer": {
"type": "boolean",
"description": "Set to true if the message sender is also the organizer.",
"nullable": true
},
"isReminderOn": {
"type": "boolean",
"description": "Set to true if an alert is set to remind the user of the event.",
"nullable": true
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.location"
}
],
"description": "The location of the event.",
"nullable": true
},
"locations": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.location"
}
],
"nullable": true
},
"description": "The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value."
},
"onlineMeetingUrl": {
"type": "string",
"description": "A URL for an online meeting. The property is set only when an organizer specifies an event as an online meeting such as a Skype meeting. Read-only.",
"nullable": true
},
"organizer": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"description": "The organizer of the event.",
"nullable": true
},
"originalEndTimeZone": {
"type": "string",
"description": "The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.",
"nullable": true
},
"originalStart": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"originalStartTimeZone": {
"type": "string",
"description": "The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.",
"nullable": true
},
"recurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.patternedRecurrence"
}
],
"description": "The recurrence pattern for the event.",
"nullable": true
},
"reminderMinutesBeforeStart": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of minutes before the event start time that the reminder alert occurs.",
"format": "int32",
"nullable": true
},
"responseRequested": {
"type": "boolean",
"description": "Set to true if the sender would like a response when the event is accepted or declined.",
"nullable": true
},
"responseStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.responseStatus"
}
],
"description": "Indicates the type of response sent in response to an event message.",
"nullable": true
},
"sensitivity": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.sensitivity"
}
],
"description": "The possible values are: normal, personal, private, confidential.",
"nullable": true
},
"seriesMasterId": {
"type": "string",
"description": "The ID for the recurring series master item, if this event is part of a recurring series.",
"nullable": true
},
"showAs": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.freeBusyStatus"
}
],
"description": "The status to show. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown.",
"nullable": true
},
"start": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.dateTimeTimeZone"
}
],
"description": "The date, time, and time zone that the event starts.",
"nullable": true
},
"subject": {
"type": "string",
"description": "The text of the event's subject line.",
"nullable": true
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.eventType"
}
],
"description": "The event type. The possible values are: singleInstance, occurrence, exception, seriesMaster. Read-only.",
"nullable": true
},
"webLink": {
"type": "string",
"description": "The URL to open the event in Outlook Web App.The event will open in the browser if you are logged in to your mailbox via Outlook Web App. You will be prompted to login if you are not already logged in with the browser.This URL can be accessed from within an iFrame.",
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.attachment"
}
},
"calendar": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.calendar"
}
],
"nullable": true
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
},
"instances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
},
"multiValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty"
}
},
"singleValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"categories": [
"string"
],
"changeKey": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"attendees": [
{
"@odata.type": "microsoft.graph.attendee"
}
],
"body": {
"@odata.type": "microsoft.graph.itemBody"
},
"bodyPreview": "string",
"end": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"hasAttachments": true,
"iCalUId": "string",
"importance": {
"@odata.type": "microsoft.graph.importance"
},
"isAllDay": true,
"isCancelled": true,
"isOrganizer": true,
"isReminderOn": true,
"location": {
"@odata.type": "microsoft.graph.location"
},
"locations": [
{
"@odata.type": "microsoft.graph.location"
}
],
"onlineMeetingUrl": "string",
"organizer": {
"@odata.type": "microsoft.graph.recipient"
},
"originalEndTimeZone": "string",
"originalStart": "string (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {
"@odata.type": "microsoft.graph.patternedRecurrence"
},
"reminderMinutesBeforeStart": "integer",
"responseRequested": true,
"responseStatus": {
"@odata.type": "microsoft.graph.responseStatus"
},
"sensitivity": {
"@odata.type": "microsoft.graph.sensitivity"
},
"seriesMasterId": "string",
"showAs": {
"@odata.type": "microsoft.graph.freeBusyStatus"
},
"start": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"subject": "string",
"type": {
"@odata.type": "microsoft.graph.eventType"
},
"webLink": "string",
"attachments": [
{
"@odata.type": "microsoft.graph.attachment"
}
],
"calendar": {
"@odata.type": "microsoft.graph.calendar"
},
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
],
"instances": [
{
"@odata.type": "microsoft.graph.event"
}
],
"multiValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"
}
],
"singleValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"
}
]
}
},
"microsoft.graph.message": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.outlookItem"
},
{
"title": "message",
"type": "object",
"properties": {
"bccRecipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
},
"description": "The Bcc: recipients for the message."
},
"body": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemBody"
}
],
"description": "The body of the message. It can be in HTML or text format.",
"nullable": true
},
"bodyPreview": {
"type": "string",
"description": "The first 255 characters of the message body. It is in text format.",
"nullable": true
},
"ccRecipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
},
"description": "The Cc: recipients for the message."
},
"conversationId": {
"type": "string",
"description": "The ID of the conversation the email belongs to.",
"nullable": true
},
"flag": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.followupFlag"
}
],
"description": "The flag value that indicates the status, start date, due date, or completion date for the message.",
"nullable": true
},
"from": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"description": "The mailbox owner and sender of the message. The value must correspond to the actual mailbox used.",
"nullable": true
},
"hasAttachments": {
"type": "boolean",
"description": "Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as \\r\\n
\\r\\nHi, I am on vacation right now. I'll get back to you after I return.
\\r\\n
.",
"nullable": true
},
"importance": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.importance"
}
],
"description": "The importance of the message: Low, Normal, High.",
"nullable": true
},
"inferenceClassification": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.inferenceClassificationType"
}
],
"description": "The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.",
"nullable": true
},
"internetMessageHeaders": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.internetMessageHeader"
}
],
"nullable": true
},
"description": "A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message."
},
"internetMessageId": {
"type": "string",
"description": "The message ID in the format specified by RFC2822.",
"nullable": true
},
"isDeliveryReceiptRequested": {
"type": "boolean",
"description": "Indicates whether a read receipt is requested for the message.",
"nullable": true
},
"isDraft": {
"type": "boolean",
"description": "Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.",
"nullable": true
},
"isRead": {
"type": "boolean",
"description": "Indicates whether the message has been read.",
"nullable": true
},
"isReadReceiptRequested": {
"type": "boolean",
"description": "Indicates whether a read receipt is requested for the message.",
"nullable": true
},
"parentFolderId": {
"type": "string",
"description": "The unique identifier for the message's parent mailFolder.",
"nullable": true
},
"receivedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time the message was received.",
"format": "date-time",
"nullable": true
},
"replyTo": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
},
"description": "The email addresses to use when replying."
},
"sender": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"description": "The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, or sending a message as a delegate. In any case, the value must correspond to the actual mailbox used.",
"nullable": true
},
"sentDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time the message was sent.",
"format": "date-time",
"nullable": true
},
"subject": {
"type": "string",
"description": "The subject of the message.",
"nullable": true
},
"toRecipients": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.recipient"
}
],
"nullable": true
},
"description": "The To: recipients for the message."
},
"uniqueBody": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.itemBody"
}
],
"description": "The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.",
"nullable": true
},
"webLink": {
"type": "string",
"description": "The URL to open the message in Outlook Web App.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser will show the message in the Outlook Web App review pane.The message will open in the browser if you are logged in to your mailbox via Outlook Web App. You will be prompted to login if you are not already logged in with the browser.This URL can be accessed from within an iFrame.",
"nullable": true
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.attachment"
}
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
},
"multiValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty"
}
},
"singleValueExtendedProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"categories": [
"string"
],
"changeKey": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"bccRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"body": {
"@odata.type": "microsoft.graph.itemBody"
},
"bodyPreview": "string",
"ccRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"conversationId": "string",
"flag": {
"@odata.type": "microsoft.graph.followupFlag"
},
"from": {
"@odata.type": "microsoft.graph.recipient"
},
"hasAttachments": true,
"importance": {
"@odata.type": "microsoft.graph.importance"
},
"inferenceClassification": {
"@odata.type": "microsoft.graph.inferenceClassificationType"
},
"internetMessageHeaders": [
{
"@odata.type": "microsoft.graph.internetMessageHeader"
}
],
"internetMessageId": "string",
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isRead": true,
"isReadReceiptRequested": true,
"parentFolderId": "string",
"receivedDateTime": "string (timestamp)",
"replyTo": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"sender": {
"@odata.type": "microsoft.graph.recipient"
},
"sentDateTime": "string (timestamp)",
"subject": "string",
"toRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"uniqueBody": {
"@odata.type": "microsoft.graph.itemBody"
},
"webLink": "string",
"attachments": [
{
"@odata.type": "microsoft.graph.attachment"
}
],
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
],
"multiValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"
}
],
"singleValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"
}
]
}
},
"microsoft.graph.eventMessage": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.message"
},
{
"title": "eventMessage",
"type": "object",
"properties": {
"meetingMessageType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.meetingMessageType"
}
],
"description": "The type of event message: none, meetingRequest, meetingCancelled, meetingAccepted, meetingTenativelyAccepted, meetingDeclined.",
"nullable": true
},
"event": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.event"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"categories": [
"string"
],
"changeKey": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"bccRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"body": {
"@odata.type": "microsoft.graph.itemBody"
},
"bodyPreview": "string",
"ccRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"conversationId": "string",
"flag": {
"@odata.type": "microsoft.graph.followupFlag"
},
"from": {
"@odata.type": "microsoft.graph.recipient"
},
"hasAttachments": true,
"importance": {
"@odata.type": "microsoft.graph.importance"
},
"inferenceClassification": {
"@odata.type": "microsoft.graph.inferenceClassificationType"
},
"internetMessageHeaders": [
{
"@odata.type": "microsoft.graph.internetMessageHeader"
}
],
"internetMessageId": "string",
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isRead": true,
"isReadReceiptRequested": true,
"parentFolderId": "string",
"receivedDateTime": "string (timestamp)",
"replyTo": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"sender": {
"@odata.type": "microsoft.graph.recipient"
},
"sentDateTime": "string (timestamp)",
"subject": "string",
"toRecipients": [
{
"@odata.type": "microsoft.graph.recipient"
}
],
"uniqueBody": {
"@odata.type": "microsoft.graph.itemBody"
},
"webLink": "string",
"attachments": [
{
"@odata.type": "microsoft.graph.attachment"
}
],
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
],
"multiValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"
}
],
"singleValueExtendedProperties": [
{
"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"
}
],
"meetingMessageType": {
"@odata.type": "microsoft.graph.meetingMessageType"
},
"event": {
"@odata.type": "microsoft.graph.event"
}
}
},
"microsoft.graph.extension": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "extension",
"type": "object"
}
],
"example": {
"id": "string (identifier)"
}
},
"microsoft.graph.fieldValueSet": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "fieldValueSet",
"type": "object"
}
],
"example": {
"id": "string (identifier)"
}
},
"microsoft.graph.fileAttachment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.attachment"
},
{
"title": "fileAttachment",
"type": "object",
"properties": {
"contentBytes": {
"type": "string",
"description": "The base64-encoded contents of the file.",
"format": "base64url",
"nullable": true
},
"contentId": {
"type": "string",
"description": "The ID of the attachment in the Exchange store.",
"nullable": true
},
"contentLocation": {
"type": "string",
"description": "The Uniform Resource Identifier (URI) that corresponds to the location of the content of the attachment.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"contentType": "string",
"isInline": true,
"lastModifiedDateTime": "string (timestamp)",
"name": "string",
"size": "integer",
"contentBytes": "string",
"contentId": "string",
"contentLocation": "string"
}
},
"microsoft.graph.workbookFilter": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookFilter",
"type": "object",
"properties": {
"criteria": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.workbookFilterCriteria"
}
],
"description": "The currently applied filter on the given column. Read-only.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"criteria": {
"@odata.type": "microsoft.graph.workbookFilterCriteria"
}
}
},
"microsoft.graph.workbookFormatProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "workbookFormatProtection",
"type": "object",
"properties": {
"formulaHidden": {
"type": "boolean",
"description": "Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting.",
"nullable": true
},
"locked": {
"type": "boolean",
"description": "Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"formulaHidden": true,
"locked": true
}
},
"microsoft.graph.group": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "group",
"type": "object",
"properties": {
"allowExternalSenders": {
"type": "boolean",
"description": "Default is false. Indicates if people external to the organization can send messages to the group.",
"nullable": true
},
"autoSubscribeNewMembers": {
"type": "boolean",
"description": "Default is false. Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group.",
"nullable": true
},
"classification": {
"type": "string",
"description": "Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only.",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"description": "An optional description for the group.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name for the group. This property is required when a group is created and it cannot be cleared during updates. Supports $filter and $orderby.",
"nullable": true
},
"groupTypes": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Specifies the type of group to create. Possible values are Unified to create an Office 365 group, or DynamicMembership for dynamic groups. For all other group types, like security-enabled groups and email-enabled security groups, do not set this property. Supports $filter."
},
"isSubscribedByMail": {
"type": "boolean",
"description": "Default value is true. Indicates whether the current user is subscribed to receive email conversations.",
"nullable": true
},
"mail": {
"type": "string",
"description": "The SMTP address for the group, for example, 'serviceadmins@contoso.onmicrosoft.com'. Read-only. Supports $filter.",
"nullable": true
},
"mailEnabled": {
"type": "boolean",
"description": "Specifies whether the group is mail-enabled. If the securityEnabled property is also true, the group is a mail-enabled security group; otherwise, the group is a Microsoft Exchange distribution group.",
"nullable": true
},
"mailNickname": {
"type": "string",
"description": "The mail alias for the group, unique in the organization. This property must be specified when a group is created. Supports $filter.",
"nullable": true
},
"onPremisesLastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Indicates the last time at which the group was synced with the on-premises directory.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 would look like this: '2014-01-01T00:00:00Z'. Read-only. Supports $filter.",
"format": "date-time",
"nullable": true
},
"onPremisesProvisioningErrors": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.onPremisesProvisioningError"
}
],
"nullable": true
},
"description": "Errors when using Microsoft synchronization product during provisioning."
},
"onPremisesSecurityIdentifier": {
"type": "string",
"description": "Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Read-only.",
"nullable": true
},
"onPremisesSyncEnabled": {
"type": "boolean",
"description": "true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter.",
"nullable": true
},
"proxyAddresses": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The any operator is required for filter expressions on multi-valued properties. Read-only. Not nullable. Supports $filter."
},
"renewedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. 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 would look like this: '2014-01-01T00:00:00Z'. Read-only.",
"format": "date-time",
"nullable": true
},
"securityEnabled": {
"type": "boolean",
"description": "Specifies whether the group is a security group. If the mailEnabled property is also true, the group is a mail-enabled security group; otherwise it is a security group. Must be false for Office 365 groups. Supports $filter.",
"nullable": true
},
"unseenCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Count of posts that the current user has not seen since his last visit.",
"format": "int32",
"nullable": true
},
"visibility": {
"type": "string",
"description": "Specifies the visibility of an Office 365 group. The possible values are: Private, Public, HiddenMembership, or empty (which is interpreted as Public).",
"nullable": true
},
"acceptedSenders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"calendar": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.calendar"
}
],
"nullable": true
},
"calendarView": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
},
"conversations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.conversation"
}
},
"createdOnBehalfOf": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
],
"nullable": true
},
"drive": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.drive"
}
],
"nullable": true
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.event"
}
},
"memberOf": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"owners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.profilePhoto"
}
],
"nullable": true
},
"rejectedSenders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
}
},
"sites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.site"
}
},
"threads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.conversationThread"
}
},
"drives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.drive"
}
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
},
"groupLifecyclePolicies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.groupLifecyclePolicy"
}
},
"onenote": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.onenote"
}
],
"nullable": true
},
"photos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.profilePhoto"
}
},
"planner": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.plannerGroup"
}
],
"nullable": true
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.groupSetting"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"allowExternalSenders": true,
"autoSubscribeNewMembers": true,
"classification": "string",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"groupTypes": [
"string"
],
"isSubscribedByMail": true,
"mail": "string",
"mailEnabled": true,
"mailNickname": "string",
"onPremisesLastSyncDateTime": "string (timestamp)",
"onPremisesProvisioningErrors": [
{
"@odata.type": "microsoft.graph.onPremisesProvisioningError"
}
],
"onPremisesSecurityIdentifier": "string",
"onPremisesSyncEnabled": true,
"proxyAddresses": [
"string"
],
"renewedDateTime": "string (timestamp)",
"securityEnabled": true,
"unseenCount": "integer",
"visibility": "string",
"acceptedSenders": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"calendar": {
"@odata.type": "microsoft.graph.calendar"
},
"calendarView": [
{
"@odata.type": "microsoft.graph.event"
}
],
"conversations": [
{
"@odata.type": "microsoft.graph.conversation"
}
],
"createdOnBehalfOf": {
"@odata.type": "microsoft.graph.directoryObject"
},
"drive": {
"@odata.type": "microsoft.graph.drive"
},
"events": [
{
"@odata.type": "microsoft.graph.event"
}
],
"memberOf": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"members": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"owners": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"photo": {
"@odata.type": "microsoft.graph.profilePhoto"
},
"rejectedSenders": [
{
"@odata.type": "microsoft.graph.directoryObject"
}
],
"sites": [
{
"@odata.type": "microsoft.graph.site"
}
],
"threads": [
{
"@odata.type": "microsoft.graph.conversationThread"
}
],
"drives": [
{
"@odata.type": "microsoft.graph.drive"
}
],
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
],
"groupLifecyclePolicies": [
{
"@odata.type": "microsoft.graph.groupLifecyclePolicy"
}
],
"onenote": {
"@odata.type": "microsoft.graph.onenote"
},
"photos": [
{
"@odata.type": "microsoft.graph.profilePhoto"
}
],
"planner": {
"@odata.type": "microsoft.graph.plannerGroup"
},
"settings": [
{
"@odata.type": "microsoft.graph.groupSetting"
}
]
}
},
"microsoft.graph.groupLifecyclePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "groupLifecyclePolicy",
"type": "object",
"properties": {
"alternateNotificationEmails": {
"type": "string",
"description": "List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.",
"nullable": true
},
"groupLifetimeInDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined.",
"format": "int32",
"nullable": true
},
"managedGroupTypes": {
"type": "string",
"description": "The group type for which the expiration policy applies. Possible values are All, Selected or None.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"alternateNotificationEmails": "string",
"groupLifetimeInDays": "integer",
"managedGroupTypes": "string"
}
},
"microsoft.graph.groupSetting": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "groupSetting",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Display name of this group of settings, which comes from the associated template.",
"nullable": true
},
"templateId": {
"type": "string",
"description": "Unique identifier for the template used to create this group of settings. Read-only.",
"nullable": true
},
"values": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.settingValue"
}
],
"nullable": true
},
"description": "Collection of name value pairs. Must contain and set all the settings defined in the template."
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"templateId": "string",
"values": [
{
"@odata.type": "microsoft.graph.settingValue"
}
]
}
},
"microsoft.graph.groupSettingTemplate": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "groupSettingTemplate",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the template.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Display name of the template.",
"nullable": true
},
"values": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.settingTemplateValue"
}
],
"nullable": true
},
"description": "Collection of settingTemplateValues that list the set of available settings, defaults and types that make up this template."
}
}
}
],
"example": {
"id": "string (identifier)",
"description": "string",
"displayName": "string",
"values": [
{
"@odata.type": "microsoft.graph.settingTemplateValue"
}
]
}
},
"microsoft.graph.inferenceClassification": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "inferenceClassification",
"type": "object",
"properties": {
"overrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.inferenceClassificationOverride"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"overrides": [
{
"@odata.type": "microsoft.graph.inferenceClassificationOverride"
}
]
}
},
"microsoft.graph.inferenceClassificationOverride": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "inferenceClassificationOverride",
"type": "object",
"properties": {
"classifyAs": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.inferenceClassificationType"
}
],
"description": "Specifies how incoming messages from a specific sender should always be classified as. The possible values are: focused, other.",
"nullable": true
},
"senderEmailAddress": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.emailAddress"
}
],
"description": "The email address information of the sender for whom the override is created.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"classifyAs": {
"@odata.type": "microsoft.graph.inferenceClassificationType"
},
"senderEmailAddress": {
"@odata.type": "microsoft.graph.emailAddress"
}
}
},
"microsoft.graph.mobileApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "mobileApp",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The admin provided or imported title of the app.",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the app.",
"nullable": true
},
"publisher": {
"type": "string",
"description": "The publisher of the app.",
"nullable": true
},
"largeIcon": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mimeContent"
}
],
"description": "The large icon, to be displayed in the app details and used for upload of the icon.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time the app was created.",
"format": "date-time",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time the app was last modified.",
"format": "date-time",
"nullable": true
},
"isFeatured": {
"type": "boolean",
"description": "The value indicating whether the app is marked as featured by the admin.",
"nullable": true
},
"privacyInformationUrl": {
"type": "string",
"description": "The privacy statement Url.",
"nullable": true
},
"informationUrl": {
"type": "string",
"description": "The more information Url.",
"nullable": true
},
"owner": {
"type": "string",
"description": "The owner of the app.",
"nullable": true
},
"developer": {
"type": "string",
"description": "The developer of the app.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Notes for the app.",
"nullable": true
},
"publishingState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileAppPublishingState"
}
],
"description": "The publishing state for the app. The app cannot be assigned unless the app is published. Possible values are: notPublished, processing, published.",
"nullable": true
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.mobileAppCategory"
}
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.mobileAppAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
]
}
},
"microsoft.graph.mobileLobApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "mobileLobApp",
"type": "object",
"properties": {
"committedContentVersion": {
"type": "string",
"description": "The internal committed content version.",
"nullable": true
},
"fileName": {
"type": "string",
"description": "The name of the main Lob application file.",
"nullable": true
},
"size": {
"type": "integer",
"description": "The total size, including all uploaded files.",
"format": "int64",
"nullable": true
},
"contentVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.mobileAppContent"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
]
}
},
"microsoft.graph.androidLobApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileLobApp"
},
{
"title": "androidLobApp",
"type": "object",
"properties": {
"packageId": {
"type": "string",
"description": "The package identifier.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
},
"versionName": {
"type": "string",
"description": "The version name of Android Line of Business (LoB) app.",
"nullable": true
},
"versionCode": {
"type": "string",
"description": "The version code of Android Line of Business (LoB) app.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
],
"packageId": "string",
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.androidMinimumOperatingSystem"
},
"versionName": "string",
"versionCode": "string"
}
},
"microsoft.graph.androidStoreApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "androidStoreApp",
"type": "object",
"properties": {
"packageId": {
"type": "string",
"description": "The package identifier.",
"nullable": true
},
"appStoreUrl": {
"type": "string",
"description": "The Android app store URL.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"packageId": "string",
"appStoreUrl": "string",
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.androidMinimumOperatingSystem"
}
}
},
"microsoft.graph.iosLobApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileLobApp"
},
{
"title": "iosLobApp",
"type": "object",
"properties": {
"bundleId": {
"type": "string",
"description": "The Identity Name.",
"nullable": true
},
"applicableDeviceType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosDeviceType"
}
],
"description": "The iOS architecture for which this app can run on.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
},
"expirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The expiration time.",
"format": "date-time",
"nullable": true
},
"versionNumber": {
"type": "string",
"description": "The version number of iOS Line of Business (LoB) app.",
"nullable": true
},
"buildNumber": {
"type": "string",
"description": "The build number of iOS Line of Business (LoB) app.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
],
"bundleId": "string",
"applicableDeviceType": {
"@odata.type": "microsoft.graph.iosDeviceType"
},
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.iosMinimumOperatingSystem"
},
"expirationDateTime": "string (timestamp)",
"versionNumber": "string",
"buildNumber": "string"
}
},
"microsoft.graph.managedDeviceMobileAppConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceMobileAppConfiguration",
"type": "object",
"properties": {
"targetedMobileApps": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "the associated app."
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was created.",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"description": "Admin provided description of the Device Configuration.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was last modified.",
"format": "date-time",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Admin provided name of the device configuration.",
"nullable": true
},
"version": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the device configuration.",
"format": "int32",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationAssignment"
}
},
"deviceStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationDeviceStatus"
}
},
"userStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationUserStatus"
}
},
"deviceStatusSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationDeviceSummary"
}
],
"nullable": true
},
"userStatusSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationUserSummary"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"targetedMobileApps": [
"string"
],
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationUserStatus"
}
],
"deviceStatusSummary": {
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationDeviceSummary"
},
"userStatusSummary": {
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationUserSummary"
}
}
},
"microsoft.graph.iosMobileAppConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedDeviceMobileAppConfiguration"
},
{
"title": "iosMobileAppConfiguration",
"type": "object",
"properties": {
"encodedSettingXml": {
"type": "string",
"description": "mdm app configuration Base64 binary.",
"format": "base64url",
"nullable": true
},
"settings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appConfigurationSettingItem"
}
],
"nullable": true
},
"description": "app configuration setting items."
}
}
}
],
"example": {
"id": "string (identifier)",
"targetedMobileApps": [
"string"
],
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationUserStatus"
}
],
"deviceStatusSummary": {
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationDeviceSummary"
},
"userStatusSummary": {
"@odata.type": "microsoft.graph.managedDeviceMobileAppConfigurationUserSummary"
},
"encodedSettingXml": "string",
"settings": [
{
"@odata.type": "microsoft.graph.appConfigurationSettingItem"
}
]
}
},
"microsoft.graph.iosStoreApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "iosStoreApp",
"type": "object",
"properties": {
"bundleId": {
"type": "string",
"description": "The Identity Name.",
"nullable": true
},
"appStoreUrl": {
"type": "string",
"description": "The Apple App Store URL",
"nullable": true
},
"applicableDeviceType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosDeviceType"
}
],
"description": "The iOS architecture for which this app can run on.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"bundleId": "string",
"appStoreUrl": "string",
"applicableDeviceType": {
"@odata.type": "microsoft.graph.iosDeviceType"
},
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.iosMinimumOperatingSystem"
}
}
},
"microsoft.graph.iosVppApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "iosVppApp",
"type": "object",
"properties": {
"usedLicenseCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of VPP licenses in use.",
"format": "int32",
"nullable": true
},
"totalLicenseCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The total number of VPP licenses.",
"format": "int32",
"nullable": true
},
"releaseDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The VPP application release date and time.",
"format": "date-time",
"nullable": true
},
"appStoreUrl": {
"type": "string",
"description": "The store URL.",
"nullable": true
},
"licensingType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.vppLicensingType"
}
],
"description": "The supported License Type.",
"nullable": true
},
"applicableDeviceType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosDeviceType"
}
],
"description": "The applicable iOS Device Type.",
"nullable": true
},
"vppTokenOrganizationName": {
"type": "string",
"description": "The organization associated with the Apple Volume Purchase Program Token",
"nullable": true
},
"vppTokenAccountType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.vppTokenAccountType"
}
],
"description": "The type of volume purchase program which the given Apple Volume Purchase Program Token is associated with. Possible values are: business, education. Possible values are: business, education.",
"nullable": true
},
"vppTokenAppleId": {
"type": "string",
"description": "The Apple Id associated with the given Apple Volume Purchase Program Token.",
"nullable": true
},
"bundleId": {
"type": "string",
"description": "The Identity Name.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"usedLicenseCount": "integer",
"totalLicenseCount": "integer",
"releaseDateTime": "string (timestamp)",
"appStoreUrl": "string",
"licensingType": {
"@odata.type": "microsoft.graph.vppLicensingType"
},
"applicableDeviceType": {
"@odata.type": "microsoft.graph.iosDeviceType"
},
"vppTokenOrganizationName": "string",
"vppTokenAccountType": {
"@odata.type": "microsoft.graph.vppTokenAccountType"
},
"vppTokenAppleId": "string",
"bundleId": "string"
}
},
"microsoft.graph.macOSOfficeSuiteApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "macOSOfficeSuiteApp",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
]
}
},
"microsoft.graph.managedApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "managedApp",
"type": "object",
"properties": {
"appAvailability": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppAvailability"
}
],
"description": "The Application's availability. Possible values are: global, lineOfBusiness.",
"nullable": true
},
"version": {
"type": "string",
"description": "The Application's version.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appAvailability": {
"@odata.type": "microsoft.graph.managedAppAvailability"
},
"version": "string"
}
},
"microsoft.graph.managedMobileLobApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedApp"
},
{
"title": "managedMobileLobApp",
"type": "object",
"properties": {
"committedContentVersion": {
"type": "string",
"description": "The internal committed content version.",
"nullable": true
},
"fileName": {
"type": "string",
"description": "The name of the main Lob application file.",
"nullable": true
},
"size": {
"type": "integer",
"description": "The total size, including all uploaded files.",
"format": "int64",
"nullable": true
},
"contentVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.mobileAppContent"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appAvailability": {
"@odata.type": "microsoft.graph.managedAppAvailability"
},
"version": "string",
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
]
}
},
"microsoft.graph.managedAndroidLobApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedMobileLobApp"
},
{
"title": "managedAndroidLobApp",
"type": "object",
"properties": {
"packageId": {
"type": "string",
"description": "The package identifier.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
},
"versionName": {
"type": "string",
"description": "The version name of managed Android Line of Business (LoB) app.",
"nullable": true
},
"versionCode": {
"type": "string",
"description": "The version code of managed Android Line of Business (LoB) app.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appAvailability": {
"@odata.type": "microsoft.graph.managedAppAvailability"
},
"version": "string",
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
],
"packageId": "string",
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.androidMinimumOperatingSystem"
},
"versionName": "string",
"versionCode": "string"
}
},
"microsoft.graph.managedAndroidStoreApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedApp"
},
{
"title": "managedAndroidStoreApp",
"type": "object",
"properties": {
"packageId": {
"type": "string",
"description": "The app's package ID.",
"nullable": true
},
"appStoreUrl": {
"type": "string",
"description": "The Android AppStoreUrl.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidMinimumOperatingSystem"
}
],
"description": "The value for the minimum supported operating system.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appAvailability": {
"@odata.type": "microsoft.graph.managedAppAvailability"
},
"version": "string",
"packageId": "string",
"appStoreUrl": "string",
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.androidMinimumOperatingSystem"
}
}
},
"microsoft.graph.managedDeviceMobileAppConfigurationAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceMobileAppConfigurationAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "Assignment target that the T&C policy is assigned to.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
}
},
"microsoft.graph.managedDeviceMobileAppConfigurationDeviceStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceMobileAppConfigurationDeviceStatus",
"type": "object",
"properties": {
"deviceDisplayName": {
"type": "string",
"description": "Device name of the DevicePolicyStatus.",
"nullable": true
},
"userName": {
"type": "string",
"description": "The User Name that is being reported",
"nullable": true
},
"deviceModel": {
"type": "string",
"description": "The device model that is being reported",
"nullable": true
},
"complianceGracePeriodExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The DateTime when device compliance grace period expires",
"format": "date-time",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"deviceDisplayName": "string",
"userName": "string",
"deviceModel": "string",
"complianceGracePeriodExpirationDateTime": "string (timestamp)",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.managedDeviceMobileAppConfigurationDeviceSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceMobileAppConfigurationDeviceSummary",
"type": "object",
"properties": {
"pendingCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of pending devices",
"format": "int32",
"nullable": true
},
"notApplicableCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices",
"format": "int32",
"nullable": true
},
"successCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of succeeded devices",
"format": "int32",
"nullable": true
},
"errorCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error devices",
"format": "int32",
"nullable": true
},
"failedCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of failed devices",
"format": "int32",
"nullable": true
},
"lastUpdateDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last update time",
"format": "date-time",
"nullable": true
},
"configurationVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the policy for that overview",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"pendingCount": "integer",
"notApplicableCount": "integer",
"successCount": "integer",
"errorCount": "integer",
"failedCount": "integer",
"lastUpdateDateTime": "string (timestamp)",
"configurationVersion": "integer"
}
},
"microsoft.graph.managedDeviceMobileAppConfigurationUserStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceMobileAppConfigurationUserStatus",
"type": "object",
"properties": {
"userDisplayName": {
"type": "string",
"description": "User name of the DevicePolicyStatus.",
"nullable": true
},
"devicesCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Devices count for that user.",
"format": "int32",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"userDisplayName": "string",
"devicesCount": "integer",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.managedDeviceMobileAppConfigurationUserSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceMobileAppConfigurationUserSummary",
"type": "object",
"properties": {
"pendingCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of pending Users",
"format": "int32",
"nullable": true
},
"notApplicableCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable users",
"format": "int32",
"nullable": true
},
"successCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of succeeded Users",
"format": "int32",
"nullable": true
},
"errorCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error Users",
"format": "int32",
"nullable": true
},
"failedCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of failed Users",
"format": "int32",
"nullable": true
},
"lastUpdateDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last update time",
"format": "date-time",
"nullable": true
},
"configurationVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the policy for that overview",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"pendingCount": "integer",
"notApplicableCount": "integer",
"successCount": "integer",
"errorCount": "integer",
"failedCount": "integer",
"lastUpdateDateTime": "string (timestamp)",
"configurationVersion": "integer"
}
},
"microsoft.graph.managedIOSLobApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedMobileLobApp"
},
{
"title": "managedIOSLobApp",
"type": "object",
"properties": {
"bundleId": {
"type": "string",
"description": "The Identity Name.",
"nullable": true
},
"applicableDeviceType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosDeviceType"
}
],
"description": "The iOS architecture for which this app can run on.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
},
"expirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The expiration time.",
"format": "date-time",
"nullable": true
},
"versionNumber": {
"type": "string",
"description": "The version number of managed iOS Line of Business (LoB) app.",
"nullable": true
},
"buildNumber": {
"type": "string",
"description": "The build number of managed iOS Line of Business (LoB) app.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appAvailability": {
"@odata.type": "microsoft.graph.managedAppAvailability"
},
"version": "string",
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
],
"bundleId": "string",
"applicableDeviceType": {
"@odata.type": "microsoft.graph.iosDeviceType"
},
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.iosMinimumOperatingSystem"
},
"expirationDateTime": "string (timestamp)",
"versionNumber": "string",
"buildNumber": "string"
}
},
"microsoft.graph.managedIOSStoreApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedApp"
},
{
"title": "managedIOSStoreApp",
"type": "object",
"properties": {
"bundleId": {
"type": "string",
"description": "The app's Bundle ID.",
"nullable": true
},
"appStoreUrl": {
"type": "string",
"description": "The Apple AppStoreUrl.",
"nullable": true
},
"applicableDeviceType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosDeviceType"
}
],
"description": "The iOS architecture for which this app can run on.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosMinimumOperatingSystem"
}
],
"description": "The value for the minimum supported operating system.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appAvailability": {
"@odata.type": "microsoft.graph.managedAppAvailability"
},
"version": "string",
"bundleId": "string",
"appStoreUrl": "string",
"applicableDeviceType": {
"@odata.type": "microsoft.graph.iosDeviceType"
},
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.iosMinimumOperatingSystem"
}
}
},
"microsoft.graph.microsoftStoreForBusinessApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "microsoftStoreForBusinessApp",
"type": "object",
"properties": {
"usedLicenseCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of Microsoft Store for Business licenses in use.",
"format": "int32",
"nullable": true
},
"totalLicenseCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The total number of Microsoft Store for Business licenses.",
"format": "int32",
"nullable": true
},
"productKey": {
"type": "string",
"description": "The app product key",
"nullable": true
},
"licenseType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.microsoftStoreForBusinessLicenseType"
}
],
"description": "The app license type. Possible values are: offline, online.",
"nullable": true
},
"packageIdentityName": {
"type": "string",
"description": "The app package identifier",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"usedLicenseCount": "integer",
"totalLicenseCount": "integer",
"productKey": "string",
"licenseType": {
"@odata.type": "microsoft.graph.microsoftStoreForBusinessLicenseType"
},
"packageIdentityName": "string"
}
},
"microsoft.graph.mobileAppAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "mobileAppAssignment",
"type": "object",
"properties": {
"intent": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.installIntent"
}
],
"description": "The install intent defined by the admin. Possible values are: available, required, uninstall, availableWithoutEnrollment.",
"nullable": true
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "The target group assignment defined by the admin.",
"nullable": true
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileAppAssignmentSettings"
}
],
"description": "The settings for target assignment defined by the admin.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"intent": {
"@odata.type": "microsoft.graph.installIntent"
},
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
},
"settings": {
"@odata.type": "microsoft.graph.mobileAppAssignmentSettings"
}
}
},
"microsoft.graph.mobileAppCategory": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "mobileAppCategory",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the app category.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time the mobileAppCategory was last modified.",
"format": "date-time",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"lastModifiedDateTime": "string (timestamp)"
}
},
"microsoft.graph.mobileAppContent": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "mobileAppContent",
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.mobileAppContentFile"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"files": [
{
"@odata.type": "microsoft.graph.mobileAppContentFile"
}
]
}
},
"microsoft.graph.mobileAppContentFile": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "mobileAppContentFile",
"type": "object",
"properties": {
"azureStorageUri": {
"type": "string",
"description": "The Azure Storage URI.",
"nullable": true
},
"isCommitted": {
"type": "boolean",
"description": "A value indicating whether the file is committed.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The time the file was created.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "the file name.",
"nullable": true
},
"size": {
"type": "integer",
"description": "The size of the file prior to encryption.",
"format": "int64",
"nullable": true
},
"sizeEncrypted": {
"type": "integer",
"description": "The size of the file after encryption.",
"format": "int64",
"nullable": true
},
"azureStorageUriExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The time the Azure storage Uri expires.",
"format": "date-time",
"nullable": true
},
"manifest": {
"type": "string",
"description": "The manifest information.",
"format": "base64url",
"nullable": true
},
"uploadState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileAppContentFileUploadState"
}
],
"description": "The state of the current upload request. Possible values are: success, transientError, error, unknown, azureStorageUriRequestSuccess, azureStorageUriRequestPending, azureStorageUriRequestFailed, azureStorageUriRequestTimedOut, azureStorageUriRenewalSuccess, azureStorageUriRenewalPending, azureStorageUriRenewalFailed, azureStorageUriRenewalTimedOut, commitFileSuccess, commitFilePending, commitFileFailed, commitFileTimedOut.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"azureStorageUri": "string",
"isCommitted": true,
"createdDateTime": "string (timestamp)",
"name": "string",
"size": "integer",
"sizeEncrypted": "integer",
"azureStorageUriExpirationDateTime": "string (timestamp)",
"manifest": "string",
"uploadState": {
"@odata.type": "microsoft.graph.mobileAppContentFileUploadState"
}
}
},
"microsoft.graph.webApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileApp"
},
{
"title": "webApp",
"type": "object",
"properties": {
"appUrl": {
"type": "string",
"description": "The web app URL.",
"nullable": true
},
"useManagedBrowser": {
"type": "boolean",
"description": "Whether or not to use managed browser. This property is only applicable for Android and IOS.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"appUrl": "string",
"useManagedBrowser": true
}
},
"microsoft.graph.windowsMobileMSI": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileLobApp"
},
{
"title": "windowsMobileMSI",
"type": "object",
"properties": {
"commandLine": {
"type": "string",
"description": "The command line.",
"nullable": true
},
"productCode": {
"type": "string",
"description": "The product code.",
"nullable": true
},
"productVersion": {
"type": "string",
"description": "The product version of Windows Mobile MSI Line of Business (LoB) app.",
"nullable": true
},
"ignoreVersionDetection": {
"type": "boolean",
"description": "A boolean to control whether the app's version will be used to detect the app after it is installed on a device. Set this to true for Windows Mobile MSI Line of Business (LoB) apps that use a self update feature.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
],
"commandLine": "string",
"productCode": "string",
"productVersion": "string",
"ignoreVersionDetection": true
}
},
"microsoft.graph.windowsUniversalAppX": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileLobApp"
},
{
"title": "windowsUniversalAppX",
"type": "object",
"properties": {
"applicableArchitectures": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsArchitecture"
}
],
"description": "The Windows architecture(s) for which this app can run on. Possible values are: none, x86, x64, arm, neutral.",
"nullable": true
},
"applicableDeviceTypes": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsDeviceType"
}
],
"description": "The Windows device type(s) for which this app can run on. Possible values are: none, desktop, mobile, holographic, team.",
"nullable": true
},
"identityName": {
"type": "string",
"description": "The Identity Name.",
"nullable": true
},
"identityPublisherHash": {
"type": "string",
"description": "The Identity Publisher Hash.",
"nullable": true
},
"identityResourceIdentifier": {
"type": "string",
"description": "The Identity Resource Identifier.",
"nullable": true
},
"isBundle": {
"type": "boolean",
"description": "Whether or not the app is a bundle.",
"nullable": true
},
"minimumSupportedOperatingSystem": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsMinimumOperatingSystem"
}
],
"description": "The value for the minimum applicable operating system.",
"nullable": true
},
"identityVersion": {
"type": "string",
"description": "The identity version.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"isFeatured": true,
"privacyInformationUrl": "string",
"informationUrl": "string",
"owner": "string",
"developer": "string",
"notes": "string",
"publishingState": {
"@odata.type": "microsoft.graph.mobileAppPublishingState"
},
"categories": [
{
"@odata.type": "microsoft.graph.mobileAppCategory"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.mobileAppAssignment"
}
],
"committedContentVersion": "string",
"fileName": "string",
"size": "integer",
"contentVersions": [
{
"@odata.type": "microsoft.graph.mobileAppContent"
}
],
"applicableArchitectures": {
"@odata.type": "microsoft.graph.windowsArchitecture"
},
"applicableDeviceTypes": {
"@odata.type": "microsoft.graph.windowsDeviceType"
},
"identityName": "string",
"identityPublisherHash": "string",
"identityResourceIdentifier": "string",
"isBundle": true,
"minimumSupportedOperatingSystem": {
"@odata.type": "microsoft.graph.windowsMinimumOperatingSystem"
},
"identityVersion": "string"
}
},
"microsoft.graph.auditEvent": {
"title": "auditEvent",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Key of the entity.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Event display name.",
"nullable": true
},
"componentName": {
"type": "string",
"description": "Component name.",
"nullable": true
},
"actor": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.auditActor"
}
],
"description": "AAD user and application that are associated with the audit event.",
"nullable": true
},
"activity": {
"type": "string",
"description": "Friendly name of the activity.",
"nullable": true
},
"activityDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date time in UTC when the activity was performed.",
"format": "date-time",
"nullable": true
},
"activityType": {
"type": "string",
"description": "The type of activity that was being performed.",
"nullable": true
},
"activityOperationType": {
"type": "string",
"description": "The HTTP operation type of the activity.",
"nullable": true
},
"activityResult": {
"type": "string",
"description": "The result of the activity.",
"nullable": true
},
"correlationId": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"description": "The client request Id that is used to correlate activity within the system.",
"format": "uuid",
"nullable": true
},
"resources": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.auditResource"
}
],
"nullable": true
},
"description": "Resources being modified."
},
"category": {
"type": "string",
"description": "Audit category.",
"nullable": true
}
},
"example": {
"id": "string (identifier)",
"displayName": "string",
"componentName": "string",
"actor": {
"@odata.type": "microsoft.graph.auditActor"
},
"activity": "string",
"activityDateTime": "string (timestamp)",
"activityType": "string",
"activityOperationType": "string",
"activityResult": "string",
"correlationId": "string",
"resources": [
{
"@odata.type": "microsoft.graph.auditResource"
}
],
"category": "string"
}
},
"microsoft.graph.deviceInstallState": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceInstallState",
"type": "object",
"properties": {
"deviceName": {
"type": "string",
"description": "Device name.",
"nullable": true
},
"deviceId": {
"type": "string",
"description": "Device Id.",
"nullable": true
},
"lastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last sync date and time.",
"format": "date-time",
"nullable": true
},
"installState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.installState"
}
],
"description": "The install state of the eBook. Possible values are: notApplicable, installed, failed, notInstalled, uninstallFailed, unknown.",
"nullable": true
},
"errorCode": {
"type": "string",
"description": "The error code for install failures.",
"nullable": true
},
"osVersion": {
"type": "string",
"description": "OS Version.",
"nullable": true
},
"osDescription": {
"type": "string",
"description": "OS Description.",
"nullable": true
},
"userName": {
"type": "string",
"description": "Device User Name.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"deviceName": "string",
"deviceId": "string",
"lastSyncDateTime": "string (timestamp)",
"installState": {
"@odata.type": "microsoft.graph.installState"
},
"errorCode": "string",
"osVersion": "string",
"osDescription": "string",
"userName": "string"
}
},
"microsoft.graph.eBookInstallSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "eBookInstallSummary",
"type": "object",
"properties": {
"installedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of Devices that have successfully installed this book.",
"format": "int32",
"nullable": true
},
"failedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of Devices that have failed to install this book.",
"format": "int32",
"nullable": true
},
"notInstalledDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of Devices that does not have this book installed.",
"format": "int32",
"nullable": true
},
"installedUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of Users whose devices have all succeeded to install this book.",
"format": "int32",
"nullable": true
},
"failedUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of Users that have 1 or more device that failed to install this book.",
"format": "int32",
"nullable": true
},
"notInstalledUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of Users that did not install this book.",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"installedDeviceCount": "integer",
"failedDeviceCount": "integer",
"notInstalledDeviceCount": "integer",
"installedUserCount": "integer",
"failedUserCount": "integer",
"notInstalledUserCount": "integer"
}
},
"microsoft.graph.managedEBook": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedEBook",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Name of the eBook.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description.",
"nullable": true
},
"publisher": {
"type": "string",
"description": "Publisher.",
"nullable": true
},
"publishedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time when the eBook was published.",
"format": "date-time",
"nullable": true
},
"largeCover": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mimeContent"
}
],
"description": "Book cover.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time when the eBook file was created.",
"format": "date-time",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time when the eBook was last modified.",
"format": "date-time",
"nullable": true
},
"informationUrl": {
"type": "string",
"description": "The more information Url.",
"nullable": true
},
"privacyInformationUrl": {
"type": "string",
"description": "The privacy statement Url.",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedEBookAssignment"
}
},
"installSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.eBookInstallSummary"
}
],
"nullable": true
},
"deviceStates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceInstallState"
}
},
"userStateSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.userInstallStateSummary"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"publishedDateTime": "string (timestamp)",
"largeCover": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"informationUrl": "string",
"privacyInformationUrl": "string",
"assignments": [
{
"@odata.type": "microsoft.graph.managedEBookAssignment"
}
],
"installSummary": {
"@odata.type": "microsoft.graph.eBookInstallSummary"
},
"deviceStates": [
{
"@odata.type": "microsoft.graph.deviceInstallState"
}
],
"userStateSummary": [
{
"@odata.type": "microsoft.graph.userInstallStateSummary"
}
]
}
},
"microsoft.graph.iosVppEBook": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedEBook"
},
{
"title": "iosVppEBook",
"type": "object",
"properties": {
"vppTokenId": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"description": "The Vpp token ID.",
"format": "uuid",
"nullable": true
},
"appleId": {
"type": "string",
"description": "The Apple ID associated with Vpp token.",
"nullable": true
},
"vppOrganizationName": {
"type": "string",
"description": "The Vpp token's organization name.",
"nullable": true
},
"genres": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Genres."
},
"language": {
"type": "string",
"description": "Language.",
"nullable": true
},
"seller": {
"type": "string",
"description": "Seller.",
"nullable": true
},
"totalLicenseCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Total license count.",
"format": "int32",
"nullable": true
},
"usedLicenseCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Used license count.",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"publisher": "string",
"publishedDateTime": "string (timestamp)",
"largeCover": {
"@odata.type": "microsoft.graph.mimeContent"
},
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"informationUrl": "string",
"privacyInformationUrl": "string",
"assignments": [
{
"@odata.type": "microsoft.graph.managedEBookAssignment"
}
],
"installSummary": {
"@odata.type": "microsoft.graph.eBookInstallSummary"
},
"deviceStates": [
{
"@odata.type": "microsoft.graph.deviceInstallState"
}
],
"userStateSummary": [
{
"@odata.type": "microsoft.graph.userInstallStateSummary"
}
],
"vppTokenId": "string",
"appleId": "string",
"vppOrganizationName": "string",
"genres": [
"string"
],
"language": "string",
"seller": "string",
"totalLicenseCount": "integer",
"usedLicenseCount": "integer"
}
},
"microsoft.graph.managedEBookAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedEBookAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "The assignment target for eBook.",
"nullable": true
},
"installIntent": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.installIntent"
}
],
"description": "The install intent for eBook. Possible values are: available, required, uninstall, availableWithoutEnrollment.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
},
"installIntent": {
"@odata.type": "microsoft.graph.installIntent"
}
}
},
"microsoft.graph.iosVppEBookAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedEBookAssignment"
},
{
"title": "iosVppEBookAssignment",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
},
"installIntent": {
"@odata.type": "microsoft.graph.installIntent"
}
}
},
"microsoft.graph.userInstallStateSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "userInstallStateSummary",
"type": "object",
"properties": {
"userName": {
"type": "string",
"description": "User name.",
"nullable": true
},
"installedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Installed Device Count.",
"format": "int32",
"nullable": true
},
"failedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Failed Device Count.",
"format": "int32",
"nullable": true
},
"notInstalledDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not installed device count.",
"format": "int32",
"nullable": true
},
"deviceStates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceInstallState"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"userName": "string",
"installedDeviceCount": "integer",
"failedDeviceCount": "integer",
"notInstalledDeviceCount": "integer",
"deviceStates": [
{
"@odata.type": "microsoft.graph.deviceInstallState"
}
]
}
},
"microsoft.graph.termsAndConditions": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "termsAndConditions",
"type": "object",
"properties": {
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was created.",
"format": "date-time",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was last modified.",
"format": "date-time",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Administrator-supplied name for the T&C policy.",
"nullable": true
},
"description": {
"type": "string",
"description": "Administrator-supplied description of the T&C policy.",
"nullable": true
},
"title": {
"type": "string",
"description": "Administrator-supplied title of the terms and conditions. This is shown to the user on prompts to accept the T&C policy.",
"nullable": true
},
"bodyText": {
"type": "string",
"description": "Administrator-supplied body text of the terms and conditions, typically the terms themselves. This is shown to the user on prompts to accept the T&C policy.",
"nullable": true
},
"acceptanceStatement": {
"type": "string",
"description": "Administrator-supplied explanation of the terms and conditions, typically describing what it means to accept the terms and conditions set out in the T&C policy. This is shown to the user on prompts to accept the T&C policy.",
"nullable": true
},
"version": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Integer indicating the current version of the terms. Incremented when an administrator makes a change to the terms and wishes to require users to re-accept the modified T&C policy.",
"format": "int32",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.termsAndConditionsAssignment"
}
},
"acceptanceStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.termsAndConditionsAcceptanceStatus"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"description": "string",
"title": "string",
"bodyText": "string",
"acceptanceStatement": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.termsAndConditionsAssignment"
}
],
"acceptanceStatuses": [
{
"@odata.type": "microsoft.graph.termsAndConditionsAcceptanceStatus"
}
]
}
},
"microsoft.graph.termsAndConditionsAcceptanceStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "termsAndConditionsAcceptanceStatus",
"type": "object",
"properties": {
"userDisplayName": {
"type": "string",
"description": "Display name of the user whose acceptance the entity represents.",
"nullable": true
},
"acceptedVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Most recent version number of the T&C accepted by the user.",
"format": "int32",
"nullable": true
},
"acceptedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime when the terms were last accepted by the user.",
"format": "date-time",
"nullable": true
},
"termsAndConditions": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.termsAndConditions"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"userDisplayName": "string",
"acceptedVersion": "integer",
"acceptedDateTime": "string (timestamp)",
"termsAndConditions": {
"@odata.type": "microsoft.graph.termsAndConditions"
}
}
},
"microsoft.graph.termsAndConditionsAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "termsAndConditionsAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "Assignment target that the T&C policy is assigned to.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
}
},
"microsoft.graph.deviceCompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceCompliancePolicy",
"type": "object",
"properties": {
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was created.",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"description": "Admin provided description of the Device Configuration.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was last modified.",
"format": "date-time",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Admin provided name of the device configuration.",
"nullable": true
},
"version": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the device configuration.",
"format": "int32",
"nullable": true
},
"scheduledActionsForRule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceScheduledActionForRule"
}
},
"deviceStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceDeviceStatus"
}
},
"userStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceUserStatus"
}
},
"deviceStatusOverview": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceDeviceOverview"
}
],
"nullable": true
},
"userStatusOverview": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceUserOverview"
}
],
"nullable": true
},
"deviceSettingStateSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.settingStateDeviceSummary"
}
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicyAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
]
}
},
"microsoft.graph.androidCompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "androidCompliancePolicy",
"type": "object",
"properties": {
"passwordRequired": {
"type": "boolean",
"description": "Require a password to unlock device.",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum password length. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidRequiredPasswordType"
}
],
"description": "Type of characters in password. Possible values are: deviceDefault, alphabetic, alphanumeric, alphanumericWithSymbols, lowSecurityBiometric, numeric, numericComplex, any.",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires. Valid values 1 to 65535",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block.",
"format": "int32",
"nullable": true
},
"securityPreventInstallAppsFromUnknownSources": {
"type": "boolean",
"description": "Require that devices disallow installation of apps from unknown sources.",
"nullable": true
},
"securityDisableUsbDebugging": {
"type": "boolean",
"description": "Disable USB debugging on Android devices.",
"nullable": true
},
"securityRequireVerifyApps": {
"type": "boolean",
"description": "Require the Android Verify apps feature is turned on.",
"nullable": true
},
"deviceThreatProtectionEnabled": {
"type": "boolean",
"description": "Require that devices have enabled device threat protection.",
"nullable": true
},
"deviceThreatProtectionRequiredSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceThreatProtectionLevel"
}
],
"description": "Require Mobile Threat Protection minimum risk level to report noncompliance. Possible values are: unavailable, secured, low, medium, high, notSet.",
"nullable": true
},
"securityBlockJailbrokenDevices": {
"type": "boolean",
"description": "Devices must not be jailbroken or rooted.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum Android version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum Android version.",
"nullable": true
},
"minAndroidSecurityPatchLevel": {
"type": "string",
"description": "Minimum Android security patch level.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Require encryption on Android devices.",
"nullable": true
},
"securityRequireSafetyNetAttestationBasicIntegrity": {
"type": "boolean",
"description": "Require the device to pass the SafetyNet basic integrity check.",
"nullable": true
},
"securityRequireSafetyNetAttestationCertifiedDevice": {
"type": "boolean",
"description": "Require the device to pass the SafetyNet certified device check.",
"nullable": true
},
"securityRequireGooglePlayServices": {
"type": "boolean",
"description": "Require Google Play Services to be installed and enabled on the device.",
"nullable": true
},
"securityRequireUpToDateSecurityProviders": {
"type": "boolean",
"description": "Require the device to have up to date security providers. The device will require Google Play Services to be enabled and up to date.",
"nullable": true
},
"securityRequireCompanyPortalAppIntegrity": {
"type": "boolean",
"description": "Require the device to pass the Company Portal client app runtime integrity check.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordRequired": true,
"passwordMinimumLength": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.androidRequiredPasswordType"
},
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordExpirationDays": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"securityPreventInstallAppsFromUnknownSources": true,
"securityDisableUsbDebugging": true,
"securityRequireVerifyApps": true,
"deviceThreatProtectionEnabled": true,
"deviceThreatProtectionRequiredSecurityLevel": {
"@odata.type": "microsoft.graph.deviceThreatProtectionLevel"
},
"securityBlockJailbrokenDevices": true,
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"minAndroidSecurityPatchLevel": "string",
"storageRequireEncryption": true,
"securityRequireSafetyNetAttestationBasicIntegrity": true,
"securityRequireSafetyNetAttestationCertifiedDevice": true,
"securityRequireGooglePlayServices": true,
"securityRequireUpToDateSecurityProviders": true,
"securityRequireCompanyPortalAppIntegrity": true
}
},
"microsoft.graph.deviceConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfiguration",
"type": "object",
"properties": {
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was last modified.",
"format": "date-time",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was created.",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string",
"description": "Admin provided description of the Device Configuration.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Admin provided name of the device configuration.",
"nullable": true
},
"version": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the device configuration.",
"format": "int32",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceConfigurationAssignment"
}
},
"deviceStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceConfigurationDeviceStatus"
}
},
"userStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceConfigurationUserStatus"
}
},
"deviceStatusOverview": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfigurationDeviceOverview"
}
],
"nullable": true
},
"userStatusOverview": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfigurationUserOverview"
}
],
"nullable": true
},
"deviceSettingStateSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.settingStateDeviceSummary"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
]
}
},
"microsoft.graph.androidCustomConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "androidCustomConfiguration",
"type": "object",
"properties": {
"omaSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.omaSetting"
}
],
"nullable": true
},
"description": "OMA settings. This collection can contain a maximum of 1000 elements."
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"omaSettings": [
{
"@odata.type": "microsoft.graph.omaSetting"
}
]
}
},
"microsoft.graph.androidGeneralDeviceConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "androidGeneralDeviceConfiguration",
"type": "object",
"properties": {
"appsBlockClipboardSharing": {
"type": "boolean",
"description": "Indicates whether or not to block clipboard sharing to copy and paste between applications.",
"nullable": true
},
"appsBlockCopyPaste": {
"type": "boolean",
"description": "Indicates whether or not to block copy and paste within applications.",
"nullable": true
},
"appsBlockYouTube": {
"type": "boolean",
"description": "Indicates whether or not to block the YouTube app.",
"nullable": true
},
"bluetoothBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block Bluetooth.",
"nullable": true
},
"cameraBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the use of the camera.",
"nullable": true
},
"cellularBlockDataRoaming": {
"type": "boolean",
"description": "Indicates whether or not to block data roaming.",
"nullable": true
},
"cellularBlockMessaging": {
"type": "boolean",
"description": "Indicates whether or not to block SMS/MMS messaging.",
"nullable": true
},
"cellularBlockVoiceRoaming": {
"type": "boolean",
"description": "Indicates whether or not to block voice roaming.",
"nullable": true
},
"cellularBlockWiFiTethering": {
"type": "boolean",
"description": "Indicates whether or not to block syncing Wi-Fi tethering.",
"nullable": true
},
"compliantAppsList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps in the compliance (either allow list or block list, controlled by CompliantAppListType). This collection can contain a maximum of 10000 elements."
},
"compliantAppListType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListType"
}
],
"description": "Type of list that is in the CompliantAppsList. Possible values are: none, appsInListCompliant, appsNotInListCompliant.",
"nullable": true
},
"diagnosticDataBlockSubmission": {
"type": "boolean",
"description": "Indicates whether or not to block diagnostic data submission.",
"nullable": true
},
"locationServicesBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block location services.",
"nullable": true
},
"googleAccountBlockAutoSync": {
"type": "boolean",
"description": "Indicates whether or not to block Google account auto sync.",
"nullable": true
},
"googlePlayStoreBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the Google Play store.",
"nullable": true
},
"kioskModeBlockSleepButton": {
"type": "boolean",
"description": "Indicates whether or not to block the screen sleep button while in Kiosk Mode.",
"nullable": true
},
"kioskModeBlockVolumeButtons": {
"type": "boolean",
"description": "Indicates whether or not to block the volume buttons while in Kiosk Mode.",
"nullable": true
},
"kioskModeApps": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "A list of apps that will be allowed to run when the device is in Kiosk Mode. This collection can contain a maximum of 500 elements."
},
"nfcBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block Near-Field Communication.",
"nullable": true
},
"passwordBlockFingerprintUnlock": {
"type": "boolean",
"description": "Indicates whether or not to block fingerprint unlock.",
"nullable": true
},
"passwordBlockTrustAgents": {
"type": "boolean",
"description": "Indicates whether or not to block Smart Lock and other trust agents.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires. Valid values 1 to 365",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passwords. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before the screen times out.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"passwordSignInFailureCountBeforeFactoryReset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of sign in failures allowed before factory reset. Valid values 4 to 11",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidRequiredPasswordType"
}
],
"description": "Type of password that is required. Possible values are: deviceDefault, alphabetic, alphanumeric, alphanumericWithSymbols, lowSecurityBiometric, numeric, numericComplex, any.",
"nullable": true
},
"passwordRequired": {
"type": "boolean",
"description": "Indicates whether or not to require a password.",
"nullable": true
},
"powerOffBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block powering off the device.",
"nullable": true
},
"factoryResetBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block user performing a factory reset.",
"nullable": true
},
"screenCaptureBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block screenshots.",
"nullable": true
},
"deviceSharingAllowed": {
"type": "boolean",
"description": "Indicates whether or not to allow device sharing mode.",
"nullable": true
},
"storageBlockGoogleBackup": {
"type": "boolean",
"description": "Indicates whether or not to block Google Backup.",
"nullable": true
},
"storageBlockRemovableStorage": {
"type": "boolean",
"description": "Indicates whether or not to block removable storage usage.",
"nullable": true
},
"storageRequireDeviceEncryption": {
"type": "boolean",
"description": "Indicates whether or not to require device encryption.",
"nullable": true
},
"storageRequireRemovableStorageEncryption": {
"type": "boolean",
"description": "Indicates whether or not to require removable storage encryption.",
"nullable": true
},
"voiceAssistantBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the use of the Voice Assistant.",
"nullable": true
},
"voiceDialingBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block voice dialing.",
"nullable": true
},
"webBrowserBlockPopups": {
"type": "boolean",
"description": "Indicates whether or not to block popups within the web browser.",
"nullable": true
},
"webBrowserBlockAutofill": {
"type": "boolean",
"description": "Indicates whether or not to block the web browser's auto fill feature.",
"nullable": true
},
"webBrowserBlockJavaScript": {
"type": "boolean",
"description": "Indicates whether or not to block JavaScript within the web browser.",
"nullable": true
},
"webBrowserBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the web browser.",
"nullable": true
},
"webBrowserCookieSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.webBrowserCookieSettings"
}
],
"description": "Cookie settings within the web browser. Possible values are: browserDefault, blockAlways, allowCurrentWebSite, allowFromWebsitesVisited, allowAlways.",
"nullable": true
},
"wiFiBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block syncing Wi-Fi.",
"nullable": true
},
"appsInstallAllowList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps which can be installed on the KNOX device. This collection can contain a maximum of 500 elements."
},
"appsLaunchBlockList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps which are blocked from being launched on the KNOX device. This collection can contain a maximum of 500 elements."
},
"appsHideList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps to be hidden on the KNOX device. This collection can contain a maximum of 500 elements."
},
"securityRequireVerifyApps": {
"type": "boolean",
"description": "Require the Android Verify apps feature is turned on.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"appsBlockClipboardSharing": true,
"appsBlockCopyPaste": true,
"appsBlockYouTube": true,
"bluetoothBlocked": true,
"cameraBlocked": true,
"cellularBlockDataRoaming": true,
"cellularBlockMessaging": true,
"cellularBlockVoiceRoaming": true,
"cellularBlockWiFiTethering": true,
"compliantAppsList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"compliantAppListType": {
"@odata.type": "microsoft.graph.appListType"
},
"diagnosticDataBlockSubmission": true,
"locationServicesBlocked": true,
"googleAccountBlockAutoSync": true,
"googlePlayStoreBlocked": true,
"kioskModeBlockSleepButton": true,
"kioskModeBlockVolumeButtons": true,
"kioskModeApps": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"nfcBlocked": true,
"passwordBlockFingerprintUnlock": true,
"passwordBlockTrustAgents": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeScreenTimeout": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordSignInFailureCountBeforeFactoryReset": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.androidRequiredPasswordType"
},
"passwordRequired": true,
"powerOffBlocked": true,
"factoryResetBlocked": true,
"screenCaptureBlocked": true,
"deviceSharingAllowed": true,
"storageBlockGoogleBackup": true,
"storageBlockRemovableStorage": true,
"storageRequireDeviceEncryption": true,
"storageRequireRemovableStorageEncryption": true,
"voiceAssistantBlocked": true,
"voiceDialingBlocked": true,
"webBrowserBlockPopups": true,
"webBrowserBlockAutofill": true,
"webBrowserBlockJavaScript": true,
"webBrowserBlocked": true,
"webBrowserCookieSettings": {
"@odata.type": "microsoft.graph.webBrowserCookieSettings"
},
"wiFiBlocked": true,
"appsInstallAllowList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"appsLaunchBlockList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"appsHideList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"securityRequireVerifyApps": true
}
},
"microsoft.graph.androidWorkProfileCompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "androidWorkProfileCompliancePolicy",
"type": "object",
"properties": {
"passwordRequired": {
"type": "boolean",
"description": "Require a password to unlock device.",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum password length. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidRequiredPasswordType"
}
],
"description": "Type of characters in password. Possible values are: deviceDefault, alphabetic, alphanumeric, alphanumericWithSymbols, lowSecurityBiometric, numeric, numericComplex, any.",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires. Valid values 1 to 365",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block.",
"format": "int32",
"nullable": true
},
"securityPreventInstallAppsFromUnknownSources": {
"type": "boolean",
"description": "Require that devices disallow installation of apps from unknown sources.",
"nullable": true
},
"securityDisableUsbDebugging": {
"type": "boolean",
"description": "Disable USB debugging on Android devices.",
"nullable": true
},
"securityRequireVerifyApps": {
"type": "boolean",
"description": "Require the Android Verify apps feature is turned on.",
"nullable": true
},
"deviceThreatProtectionEnabled": {
"type": "boolean",
"description": "Require that devices have enabled device threat protection.",
"nullable": true
},
"deviceThreatProtectionRequiredSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceThreatProtectionLevel"
}
],
"description": "Require Mobile Threat Protection minimum risk level to report noncompliance. Possible values are: unavailable, secured, low, medium, high, notSet.",
"nullable": true
},
"securityBlockJailbrokenDevices": {
"type": "boolean",
"description": "Devices must not be jailbroken or rooted.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum Android version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum Android version.",
"nullable": true
},
"minAndroidSecurityPatchLevel": {
"type": "string",
"description": "Minimum Android security patch level.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Require encryption on Android devices.",
"nullable": true
},
"securityRequireSafetyNetAttestationBasicIntegrity": {
"type": "boolean",
"description": "Require the device to pass the SafetyNet basic integrity check.",
"nullable": true
},
"securityRequireSafetyNetAttestationCertifiedDevice": {
"type": "boolean",
"description": "Require the device to pass the SafetyNet certified device check.",
"nullable": true
},
"securityRequireGooglePlayServices": {
"type": "boolean",
"description": "Require Google Play Services to be installed and enabled on the device.",
"nullable": true
},
"securityRequireUpToDateSecurityProviders": {
"type": "boolean",
"description": "Require the device to have up to date security providers. The device will require Google Play Services to be enabled and up to date.",
"nullable": true
},
"securityRequireCompanyPortalAppIntegrity": {
"type": "boolean",
"description": "Require the device to pass the Company Portal client app runtime integrity check.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordRequired": true,
"passwordMinimumLength": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.androidRequiredPasswordType"
},
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordExpirationDays": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"securityPreventInstallAppsFromUnknownSources": true,
"securityDisableUsbDebugging": true,
"securityRequireVerifyApps": true,
"deviceThreatProtectionEnabled": true,
"deviceThreatProtectionRequiredSecurityLevel": {
"@odata.type": "microsoft.graph.deviceThreatProtectionLevel"
},
"securityBlockJailbrokenDevices": true,
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"minAndroidSecurityPatchLevel": "string",
"storageRequireEncryption": true,
"securityRequireSafetyNetAttestationBasicIntegrity": true,
"securityRequireSafetyNetAttestationCertifiedDevice": true,
"securityRequireGooglePlayServices": true,
"securityRequireUpToDateSecurityProviders": true,
"securityRequireCompanyPortalAppIntegrity": true
}
},
"microsoft.graph.androidWorkProfileCustomConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "androidWorkProfileCustomConfiguration",
"type": "object",
"properties": {
"omaSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.omaSetting"
}
],
"nullable": true
},
"description": "OMA settings. This collection can contain a maximum of 500 elements."
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"omaSettings": [
{
"@odata.type": "microsoft.graph.omaSetting"
}
]
}
},
"microsoft.graph.androidWorkProfileGeneralDeviceConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "androidWorkProfileGeneralDeviceConfiguration",
"type": "object",
"properties": {
"passwordBlockFingerprintUnlock": {
"type": "boolean",
"description": "Indicates whether or not to block fingerprint unlock.",
"nullable": true
},
"passwordBlockTrustAgents": {
"type": "boolean",
"description": "Indicates whether or not to block Smart Lock and other trust agents.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires. Valid values 1 to 365",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passwords. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before the screen times out.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"passwordSignInFailureCountBeforeFactoryReset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of sign in failures allowed before factory reset. Valid values 4 to 11",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidWorkProfileRequiredPasswordType"
}
],
"description": "Type of password that is required. Possible values are: deviceDefault, lowSecurityBiometric, required, atLeastNumeric, numericComplex, atLeastAlphabetic, atLeastAlphanumeric, alphanumericWithSymbols.",
"nullable": true
},
"workProfileDataSharingType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidWorkProfileCrossProfileDataSharingType"
}
],
"description": "Type of data sharing that is allowed. Possible values are: deviceDefault, preventAny, allowPersonalToWork, noRestrictions.",
"nullable": true
},
"workProfileBlockNotificationsWhileDeviceLocked": {
"type": "boolean",
"description": "Indicates whether or not to block notifications while device locked.",
"nullable": true
},
"workProfileBlockAddingAccounts": {
"type": "boolean",
"description": "Block users from adding/removing accounts in work profile.",
"nullable": true
},
"workProfileBluetoothEnableContactSharing": {
"type": "boolean",
"description": "Allow bluetooth devices to access enterprise contacts.",
"nullable": true
},
"workProfileBlockScreenCapture": {
"type": "boolean",
"description": "Block screen capture in work profile.",
"nullable": true
},
"workProfileBlockCrossProfileCallerId": {
"type": "boolean",
"description": "Block display work profile caller ID in personal profile.",
"nullable": true
},
"workProfileBlockCamera": {
"type": "boolean",
"description": "Block work profile camera.",
"nullable": true
},
"workProfileBlockCrossProfileContactsSearch": {
"type": "boolean",
"description": "Block work profile contacts availability in personal profile.",
"nullable": true
},
"workProfileBlockCrossProfileCopyPaste": {
"type": "boolean",
"description": "Boolean that indicates if the setting disallow cross profile copy/paste is enabled.",
"nullable": true
},
"workProfileDefaultAppPermissionPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidWorkProfileDefaultAppPermissionPolicyType"
}
],
"description": "Type of password that is required. Possible values are: deviceDefault, prompt, autoGrant, autoDeny.",
"nullable": true
},
"workProfilePasswordBlockFingerprintUnlock": {
"type": "boolean",
"description": "Indicates whether or not to block fingerprint unlock for work profile.",
"nullable": true
},
"workProfilePasswordBlockTrustAgents": {
"type": "boolean",
"description": "Indicates whether or not to block Smart Lock and other trust agents for work profile.",
"nullable": true
},
"workProfilePasswordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the work profile password expires. Valid values 1 to 365",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of work profile password. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinNumericCharacters": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum # of numeric characters required in work profile password. Valid values 1 to 10",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinNonLetterCharacters": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum # of non-letter characters required in work profile password. Valid values 1 to 10",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinLetterCharacters": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum # of letter characters required in work profile password. Valid values 1 to 10",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinLowerCaseCharacters": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum # of lower-case characters required in work profile password. Valid values 1 to 10",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinUpperCaseCharacters": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum # of upper-case characters required in work profile password. Valid values 1 to 10",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinSymbolCharacters": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum # of symbols required in work profile password. Valid values 1 to 10",
"format": "int32",
"nullable": true
},
"workProfilePasswordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before the screen times out.",
"format": "int32",
"nullable": true
},
"workProfilePasswordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous work profile passwords to block. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"workProfilePasswordSignInFailureCountBeforeFactoryReset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of sign in failures allowed before work profile is removed and all corporate data deleted. Valid values 4 to 11",
"format": "int32",
"nullable": true
},
"workProfilePasswordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.androidWorkProfileRequiredPasswordType"
}
],
"description": "Type of work profile password that is required. Possible values are: deviceDefault, lowSecurityBiometric, required, atLeastNumeric, numericComplex, atLeastAlphabetic, atLeastAlphanumeric, alphanumericWithSymbols.",
"nullable": true
},
"workProfileRequirePassword": {
"type": "boolean",
"description": "Password is required or not for work profile",
"nullable": true
},
"securityRequireVerifyApps": {
"type": "boolean",
"description": "Require the Android Verify apps feature is turned on.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"passwordBlockFingerprintUnlock": true,
"passwordBlockTrustAgents": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeScreenTimeout": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordSignInFailureCountBeforeFactoryReset": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.androidWorkProfileRequiredPasswordType"
},
"workProfileDataSharingType": {
"@odata.type": "microsoft.graph.androidWorkProfileCrossProfileDataSharingType"
},
"workProfileBlockNotificationsWhileDeviceLocked": true,
"workProfileBlockAddingAccounts": true,
"workProfileBluetoothEnableContactSharing": true,
"workProfileBlockScreenCapture": true,
"workProfileBlockCrossProfileCallerId": true,
"workProfileBlockCamera": true,
"workProfileBlockCrossProfileContactsSearch": true,
"workProfileBlockCrossProfileCopyPaste": true,
"workProfileDefaultAppPermissionPolicy": {
"@odata.type": "microsoft.graph.androidWorkProfileDefaultAppPermissionPolicyType"
},
"workProfilePasswordBlockFingerprintUnlock": true,
"workProfilePasswordBlockTrustAgents": true,
"workProfilePasswordExpirationDays": "integer",
"workProfilePasswordMinimumLength": "integer",
"workProfilePasswordMinNumericCharacters": "integer",
"workProfilePasswordMinNonLetterCharacters": "integer",
"workProfilePasswordMinLetterCharacters": "integer",
"workProfilePasswordMinLowerCaseCharacters": "integer",
"workProfilePasswordMinUpperCaseCharacters": "integer",
"workProfilePasswordMinSymbolCharacters": "integer",
"workProfilePasswordMinutesOfInactivityBeforeScreenTimeout": "integer",
"workProfilePasswordPreviousPasswordBlockCount": "integer",
"workProfilePasswordSignInFailureCountBeforeFactoryReset": "integer",
"workProfilePasswordRequiredType": {
"@odata.type": "microsoft.graph.androidWorkProfileRequiredPasswordType"
},
"workProfileRequirePassword": true,
"securityRequireVerifyApps": true
}
},
"microsoft.graph.appleDeviceFeaturesConfigurationBase": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "appleDeviceFeaturesConfigurationBase",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
]
}
},
"microsoft.graph.deviceComplianceActionItem": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceActionItem",
"type": "object",
"properties": {
"gracePeriodHours": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of hours to wait till the action will be enforced. Valid values 0 to 8760",
"format": "int32",
"nullable": true
},
"actionType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceActionType"
}
],
"description": "What action to take. Possible values are: noAction, notification, block, retire, wipe, removeResourceAccessProfiles, pushNotification.",
"nullable": true
},
"notificationTemplateId": {
"type": "string",
"description": "What notification Message template to use",
"nullable": true
},
"notificationMessageCCList": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "A list of group IDs to speicify who to CC this notification message to."
}
}
}
],
"example": {
"id": "string (identifier)",
"gracePeriodHours": "integer",
"actionType": {
"@odata.type": "microsoft.graph.deviceComplianceActionType"
},
"notificationTemplateId": "string",
"notificationMessageCCList": [
"string"
]
}
},
"microsoft.graph.deviceComplianceDeviceOverview": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceDeviceOverview",
"type": "object",
"properties": {
"pendingCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of pending devices",
"format": "int32",
"nullable": true
},
"notApplicableCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices",
"format": "int32",
"nullable": true
},
"successCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of succeeded devices",
"format": "int32",
"nullable": true
},
"errorCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error devices",
"format": "int32",
"nullable": true
},
"failedCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of failed devices",
"format": "int32",
"nullable": true
},
"lastUpdateDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last update time",
"format": "date-time",
"nullable": true
},
"configurationVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the policy for that overview",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"pendingCount": "integer",
"notApplicableCount": "integer",
"successCount": "integer",
"errorCount": "integer",
"failedCount": "integer",
"lastUpdateDateTime": "string (timestamp)",
"configurationVersion": "integer"
}
},
"microsoft.graph.deviceComplianceDeviceStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceDeviceStatus",
"type": "object",
"properties": {
"deviceDisplayName": {
"type": "string",
"description": "Device name of the DevicePolicyStatus.",
"nullable": true
},
"userName": {
"type": "string",
"description": "The User Name that is being reported",
"nullable": true
},
"deviceModel": {
"type": "string",
"description": "The device model that is being reported",
"nullable": true
},
"complianceGracePeriodExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The DateTime when device compliance grace period expires",
"format": "date-time",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"deviceDisplayName": "string",
"userName": "string",
"deviceModel": "string",
"complianceGracePeriodExpirationDateTime": "string (timestamp)",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.deviceCompliancePolicyAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceCompliancePolicyAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "Target for the compliance policy assignment.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
}
},
"microsoft.graph.deviceCompliancePolicyDeviceStateSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceCompliancePolicyDeviceStateSummary",
"type": "object",
"properties": {
"inGracePeriodCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of devices that are in grace period",
"format": "int32",
"nullable": true
},
"configManagerCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of devices that have compliance managed by System Center Configuration Manager",
"format": "int32",
"nullable": true
},
"unknownDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of unknown devices",
"format": "int32",
"nullable": true
},
"notApplicableDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices",
"format": "int32",
"nullable": true
},
"compliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of compliant devices",
"format": "int32",
"nullable": true
},
"remediatedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of remediated devices",
"format": "int32",
"nullable": true
},
"nonCompliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of NonCompliant devices",
"format": "int32",
"nullable": true
},
"errorDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error devices",
"format": "int32",
"nullable": true
},
"conflictDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of conflict devices",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"inGracePeriodCount": "integer",
"configManagerCount": "integer",
"unknownDeviceCount": "integer",
"notApplicableDeviceCount": "integer",
"compliantDeviceCount": "integer",
"remediatedDeviceCount": "integer",
"nonCompliantDeviceCount": "integer",
"errorDeviceCount": "integer",
"conflictDeviceCount": "integer"
}
},
"microsoft.graph.deviceCompliancePolicySettingStateSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceCompliancePolicySettingStateSummary",
"type": "object",
"properties": {
"setting": {
"type": "string",
"description": "The setting class name and property name.",
"nullable": true
},
"settingName": {
"type": "string",
"description": "Name of the setting.",
"nullable": true
},
"platformType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.policyPlatformType"
}
],
"description": "Setting platform. Possible values are: android, iOS, macOS, windowsPhone81, windows81AndLater, windows10AndLater, androidWorkProfile, all.",
"nullable": true
},
"unknownDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of unknown devices",
"format": "int32",
"nullable": true
},
"notApplicableDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices",
"format": "int32",
"nullable": true
},
"compliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of compliant devices",
"format": "int32",
"nullable": true
},
"remediatedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of remediated devices",
"format": "int32",
"nullable": true
},
"nonCompliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of NonCompliant devices",
"format": "int32",
"nullable": true
},
"errorDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error devices",
"format": "int32",
"nullable": true
},
"conflictDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of conflict devices",
"format": "int32",
"nullable": true
},
"deviceComplianceSettingStates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceSettingState"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"setting": "string",
"settingName": "string",
"platformType": {
"@odata.type": "microsoft.graph.policyPlatformType"
},
"unknownDeviceCount": "integer",
"notApplicableDeviceCount": "integer",
"compliantDeviceCount": "integer",
"remediatedDeviceCount": "integer",
"nonCompliantDeviceCount": "integer",
"errorDeviceCount": "integer",
"conflictDeviceCount": "integer",
"deviceComplianceSettingStates": [
{
"@odata.type": "microsoft.graph.deviceComplianceSettingState"
}
]
}
},
"microsoft.graph.deviceComplianceScheduledActionForRule": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceScheduledActionForRule",
"type": "object",
"properties": {
"ruleName": {
"type": "string",
"description": "Name of the rule which this scheduled action applies to.",
"nullable": true
},
"scheduledActionConfigurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.deviceComplianceActionItem"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"ruleName": "string",
"scheduledActionConfigurations": [
{
"@odata.type": "microsoft.graph.deviceComplianceActionItem"
}
]
}
},
"microsoft.graph.deviceComplianceSettingState": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceSettingState",
"type": "object",
"properties": {
"setting": {
"type": "string",
"description": "The setting class name and property name.",
"nullable": true
},
"settingName": {
"type": "string",
"description": "The Setting Name that is being reported",
"nullable": true
},
"deviceId": {
"type": "string",
"description": "The Device Id that is being reported",
"nullable": true
},
"deviceName": {
"type": "string",
"description": "The Device Name that is being reported",
"nullable": true
},
"userId": {
"type": "string",
"description": "The user Id that is being reported",
"nullable": true
},
"userEmail": {
"type": "string",
"description": "The User email address that is being reported",
"nullable": true
},
"userName": {
"type": "string",
"description": "The User Name that is being reported",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "The User PrincipalName that is being reported",
"nullable": true
},
"deviceModel": {
"type": "string",
"description": "The device model that is being reported",
"nullable": true
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "The compliance state of the setting. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"complianceGracePeriodExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The DateTime when device compliance grace period expires",
"format": "date-time",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"setting": "string",
"settingName": "string",
"deviceId": "string",
"deviceName": "string",
"userId": "string",
"userEmail": "string",
"userName": "string",
"userPrincipalName": "string",
"deviceModel": "string",
"state": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"complianceGracePeriodExpirationDateTime": "string (timestamp)"
}
},
"microsoft.graph.deviceComplianceUserOverview": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceUserOverview",
"type": "object",
"properties": {
"pendingCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of pending Users",
"format": "int32",
"nullable": true
},
"notApplicableCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable users",
"format": "int32",
"nullable": true
},
"successCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of succeeded Users",
"format": "int32",
"nullable": true
},
"errorCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error Users",
"format": "int32",
"nullable": true
},
"failedCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of failed Users",
"format": "int32",
"nullable": true
},
"lastUpdateDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last update time",
"format": "date-time",
"nullable": true
},
"configurationVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the policy for that overview",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"pendingCount": "integer",
"notApplicableCount": "integer",
"successCount": "integer",
"errorCount": "integer",
"failedCount": "integer",
"lastUpdateDateTime": "string (timestamp)",
"configurationVersion": "integer"
}
},
"microsoft.graph.deviceComplianceUserStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceComplianceUserStatus",
"type": "object",
"properties": {
"userDisplayName": {
"type": "string",
"description": "User name of the DevicePolicyStatus.",
"nullable": true
},
"devicesCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Devices count for that user.",
"format": "int32",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"userDisplayName": "string",
"devicesCount": "integer",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.deviceConfigurationAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfigurationAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "The assignment target for the device configuration.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
}
},
"microsoft.graph.deviceConfigurationDeviceOverview": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfigurationDeviceOverview",
"type": "object",
"properties": {
"pendingCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of pending devices",
"format": "int32",
"nullable": true
},
"notApplicableCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices",
"format": "int32",
"nullable": true
},
"successCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of succeeded devices",
"format": "int32",
"nullable": true
},
"errorCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error devices",
"format": "int32",
"nullable": true
},
"failedCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of failed devices",
"format": "int32",
"nullable": true
},
"lastUpdateDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last update time",
"format": "date-time",
"nullable": true
},
"configurationVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the policy for that overview",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"pendingCount": "integer",
"notApplicableCount": "integer",
"successCount": "integer",
"errorCount": "integer",
"failedCount": "integer",
"lastUpdateDateTime": "string (timestamp)",
"configurationVersion": "integer"
}
},
"microsoft.graph.deviceConfigurationDeviceStateSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfigurationDeviceStateSummary",
"type": "object",
"properties": {
"unknownDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of unknown devices",
"format": "int32",
"nullable": true
},
"notApplicableDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices",
"format": "int32",
"nullable": true
},
"compliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of compliant devices",
"format": "int32",
"nullable": true
},
"remediatedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of remediated devices",
"format": "int32",
"nullable": true
},
"nonCompliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of NonCompliant devices",
"format": "int32",
"nullable": true
},
"errorDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error devices",
"format": "int32",
"nullable": true
},
"conflictDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of conflict devices",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"unknownDeviceCount": "integer",
"notApplicableDeviceCount": "integer",
"compliantDeviceCount": "integer",
"remediatedDeviceCount": "integer",
"nonCompliantDeviceCount": "integer",
"errorDeviceCount": "integer",
"conflictDeviceCount": "integer"
}
},
"microsoft.graph.deviceConfigurationDeviceStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfigurationDeviceStatus",
"type": "object",
"properties": {
"deviceDisplayName": {
"type": "string",
"description": "Device name of the DevicePolicyStatus.",
"nullable": true
},
"userName": {
"type": "string",
"description": "The User Name that is being reported",
"nullable": true
},
"deviceModel": {
"type": "string",
"description": "The device model that is being reported",
"nullable": true
},
"complianceGracePeriodExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The DateTime when device compliance grace period expires",
"format": "date-time",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"deviceDisplayName": "string",
"userName": "string",
"deviceModel": "string",
"complianceGracePeriodExpirationDateTime": "string (timestamp)",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.deviceConfigurationUserOverview": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfigurationUserOverview",
"type": "object",
"properties": {
"pendingCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of pending Users",
"format": "int32",
"nullable": true
},
"notApplicableCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable users",
"format": "int32",
"nullable": true
},
"successCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of succeeded Users",
"format": "int32",
"nullable": true
},
"errorCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of error Users",
"format": "int32",
"nullable": true
},
"failedCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of failed Users",
"format": "int32",
"nullable": true
},
"lastUpdateDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last update time",
"format": "date-time",
"nullable": true
},
"configurationVersion": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Version of the policy for that overview",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"pendingCount": "integer",
"notApplicableCount": "integer",
"successCount": "integer",
"errorCount": "integer",
"failedCount": "integer",
"lastUpdateDateTime": "string (timestamp)",
"configurationVersion": "integer"
}
},
"microsoft.graph.deviceConfigurationUserStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceConfigurationUserStatus",
"type": "object",
"properties": {
"userDisplayName": {
"type": "string",
"description": "User name of the DevicePolicyStatus.",
"nullable": true
},
"devicesCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Devices count for that user.",
"format": "int32",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"userDisplayName": "string",
"devicesCount": "integer",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.editionUpgradeConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "editionUpgradeConfiguration",
"type": "object",
"properties": {
"licenseType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.editionUpgradeLicenseType"
}
],
"description": "Edition Upgrade License Type. Possible values are: productKey, licenseFile.",
"nullable": true
},
"targetEdition": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windows10EditionType"
}
],
"description": "Edition Upgrade Target Edition. Possible values are: windows10Enterprise, windows10EnterpriseN, windows10Education, windows10EducationN, windows10MobileEnterprise, windows10HolographicEnterprise, windows10Professional, windows10ProfessionalN, windows10ProfessionalEducation, windows10ProfessionalEducationN, windows10ProfessionalWorkstation, windows10ProfessionalWorkstationN.",
"nullable": true
},
"license": {
"type": "string",
"description": "Edition Upgrade License File Content.",
"nullable": true
},
"productKey": {
"type": "string",
"description": "Edition Upgrade Product Key.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"licenseType": {
"@odata.type": "microsoft.graph.editionUpgradeLicenseType"
},
"targetEdition": {
"@odata.type": "microsoft.graph.windows10EditionType"
},
"license": "string",
"productKey": "string"
}
},
"microsoft.graph.iosCertificateProfile": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "iosCertificateProfile",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
]
}
},
"microsoft.graph.iosCompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "iosCompliancePolicy",
"type": "object",
"properties": {
"passcodeBlockSimple": {
"type": "boolean",
"description": "Indicates whether or not to block simple passcodes.",
"nullable": true
},
"passcodeExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the passcode expires. Valid values 1 to 65535",
"format": "int32",
"nullable": true
},
"passcodeMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passcode. Valid values 4 to 14",
"format": "int32",
"nullable": true
},
"passcodeMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a passcode is required.",
"format": "int32",
"nullable": true
},
"passcodePreviousPasscodeBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passcodes to block. Valid values 1 to 24",
"format": "int32",
"nullable": true
},
"passcodeMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passcodeRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required passcode type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passcodeRequired": {
"type": "boolean",
"description": "Indicates whether or not to require a passcode.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum IOS version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum IOS version.",
"nullable": true
},
"securityBlockJailbrokenDevices": {
"type": "boolean",
"description": "Devices must not be jailbroken or rooted.",
"nullable": true
},
"deviceThreatProtectionEnabled": {
"type": "boolean",
"description": "Require that devices have enabled device threat protection .",
"nullable": true
},
"deviceThreatProtectionRequiredSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceThreatProtectionLevel"
}
],
"description": "Require Mobile Threat Protection minimum risk level to report noncompliance. Possible values are: unavailable, secured, low, medium, high, notSet.",
"nullable": true
},
"managedEmailProfileRequired": {
"type": "boolean",
"description": "Indicates whether or not to require a managed email profile.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passcodeBlockSimple": true,
"passcodeExpirationDays": "integer",
"passcodeMinimumLength": "integer",
"passcodeMinutesOfInactivityBeforeLock": "integer",
"passcodePreviousPasscodeBlockCount": "integer",
"passcodeMinimumCharacterSetCount": "integer",
"passcodeRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passcodeRequired": true,
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"securityBlockJailbrokenDevices": true,
"deviceThreatProtectionEnabled": true,
"deviceThreatProtectionRequiredSecurityLevel": {
"@odata.type": "microsoft.graph.deviceThreatProtectionLevel"
},
"managedEmailProfileRequired": true
}
},
"microsoft.graph.iosCustomConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "iosCustomConfiguration",
"type": "object",
"properties": {
"payloadName": {
"type": "string",
"description": "Name that is displayed to the user.",
"nullable": true
},
"payloadFileName": {
"type": "string",
"description": "Payload file name (.mobileconfig",
"nullable": true
},
"payload": {
"type": "string",
"description": "Payload. (UTF8 encoded byte array)",
"format": "base64url",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"payloadName": "string",
"payloadFileName": "string",
"payload": "string"
}
},
"microsoft.graph.iosDeviceFeaturesConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appleDeviceFeaturesConfigurationBase"
},
{
"title": "iosDeviceFeaturesConfiguration",
"type": "object",
"properties": {
"assetTagTemplate": {
"type": "string",
"description": "Asset tag information for the device, displayed on the login window and lock screen.",
"nullable": true
},
"lockScreenFootnote": {
"type": "string",
"description": "A footnote displayed on the login window and lock screen. Available in iOS 9.3.1 and later.",
"nullable": true
},
"homeScreenDockIcons": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosHomeScreenItem"
}
],
"nullable": true
},
"description": "A list of app and folders to appear on the Home Screen Dock. This collection can contain a maximum of 500 elements."
},
"homeScreenPages": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosHomeScreenPage"
}
],
"nullable": true
},
"description": "A list of pages on the Home Screen. This collection can contain a maximum of 500 elements."
},
"notificationSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosNotificationSettings"
}
],
"nullable": true
},
"description": "Notification settings for each bundle id. Applicable to devices in supervised mode only (iOS 9.3 and later). This collection can contain a maximum of 500 elements."
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assetTagTemplate": "string",
"lockScreenFootnote": "string",
"homeScreenDockIcons": [
{
"@odata.type": "microsoft.graph.iosHomeScreenItem"
}
],
"homeScreenPages": [
{
"@odata.type": "microsoft.graph.iosHomeScreenPage"
}
],
"notificationSettings": [
{
"@odata.type": "microsoft.graph.iosNotificationSettings"
}
]
}
},
"microsoft.graph.iosGeneralDeviceConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "iosGeneralDeviceConfiguration",
"type": "object",
"properties": {
"accountBlockModification": {
"type": "boolean",
"description": "Indicates whether or not to allow account modification when the device is in supervised mode.",
"nullable": true
},
"activationLockAllowWhenSupervised": {
"type": "boolean",
"description": "Indicates whether or not to allow activation lock when the device is in the supervised mode.",
"nullable": true
},
"airDropBlocked": {
"type": "boolean",
"description": "Indicates whether or not to allow AirDrop when the device is in supervised mode.",
"nullable": true
},
"airDropForceUnmanagedDropTarget": {
"type": "boolean",
"description": "Indicates whether or not to cause AirDrop to be considered an unmanaged drop target (iOS 9.0 and later).",
"nullable": true
},
"airPlayForcePairingPasswordForOutgoingRequests": {
"type": "boolean",
"description": "Indicates whether or not to enforce all devices receiving AirPlay requests from this device to use a pairing password.",
"nullable": true
},
"appleWatchBlockPairing": {
"type": "boolean",
"description": "Indicates whether or not to allow Apple Watch pairing when the device is in supervised mode (iOS 9.0 and later).",
"nullable": true
},
"appleWatchForceWristDetection": {
"type": "boolean",
"description": "Indicates whether or not to force a paired Apple Watch to use Wrist Detection (iOS 8.2 and later).",
"nullable": true
},
"appleNewsBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using News when the device is in supervised mode (iOS 9.0 and later).",
"nullable": true
},
"appsSingleAppModeList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "Gets or sets the list of iOS apps allowed to autonomously enter Single App Mode. Supervised only. iOS 7.0 and later. This collection can contain a maximum of 500 elements."
},
"appsVisibilityList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps in the visibility list (either visible/launchable apps list or hidden/unlaunchable apps list, controlled by AppsVisibilityListType) (iOS 9.3 and later). This collection can contain a maximum of 10000 elements."
},
"appsVisibilityListType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListType"
}
],
"description": "Type of list that is in the AppsVisibilityList. Possible values are: none, appsInListCompliant, appsNotInListCompliant.",
"nullable": true
},
"appStoreBlockAutomaticDownloads": {
"type": "boolean",
"description": "Indicates whether or not to block the automatic downloading of apps purchased on other devices when the device is in supervised mode (iOS 9.0 and later).",
"nullable": true
},
"appStoreBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using the App Store.",
"nullable": true
},
"appStoreBlockInAppPurchases": {
"type": "boolean",
"description": "Indicates whether or not to block the user from making in app purchases.",
"nullable": true
},
"appStoreBlockUIAppInstallation": {
"type": "boolean",
"description": "Indicates whether or not to block the App Store app, not restricting installation through Host apps. Applies to supervised mode only (iOS 9.0 and later).",
"nullable": true
},
"appStoreRequirePassword": {
"type": "boolean",
"description": "Indicates whether or not to require a password when using the app store.",
"nullable": true
},
"bluetoothBlockModification": {
"type": "boolean",
"description": "Indicates whether or not to allow modification of Bluetooth settings when the device is in supervised mode (iOS 10.0 and later).",
"nullable": true
},
"cameraBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from accessing the camera of the device.",
"nullable": true
},
"cellularBlockDataRoaming": {
"type": "boolean",
"description": "Indicates whether or not to block data roaming.",
"nullable": true
},
"cellularBlockGlobalBackgroundFetchWhileRoaming": {
"type": "boolean",
"description": "Indicates whether or not to block global background fetch while roaming.",
"nullable": true
},
"cellularBlockPerAppDataModification": {
"type": "boolean",
"description": "Indicates whether or not to allow changes to cellular app data usage settings when the device is in supervised mode.",
"nullable": true
},
"cellularBlockPersonalHotspot": {
"type": "boolean",
"description": "Indicates whether or not to block Personal Hotspot.",
"nullable": true
},
"cellularBlockVoiceRoaming": {
"type": "boolean",
"description": "Indicates whether or not to block voice roaming.",
"nullable": true
},
"certificatesBlockUntrustedTlsCertificates": {
"type": "boolean",
"description": "Indicates whether or not to block untrusted TLS certificates.",
"nullable": true
},
"classroomAppBlockRemoteScreenObservation": {
"type": "boolean",
"description": "Indicates whether or not to allow remote screen observation by Classroom app when the device is in supervised mode (iOS 9.3 and later).",
"nullable": true
},
"classroomAppForceUnpromptedScreenObservation": {
"type": "boolean",
"description": "Indicates whether or not to automatically give permission to the teacher of a managed course on the Classroom app to view a student's screen without prompting when the device is in supervised mode.",
"nullable": true
},
"compliantAppsList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps in the compliance (either allow list or block list, controlled by CompliantAppListType). This collection can contain a maximum of 10000 elements."
},
"compliantAppListType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListType"
}
],
"description": "List that is in the AppComplianceList. Possible values are: none, appsInListCompliant, appsNotInListCompliant.",
"nullable": true
},
"configurationProfileBlockChanges": {
"type": "boolean",
"description": "Indicates whether or not to block the user from installing configuration profiles and certificates interactively when the device is in supervised mode.",
"nullable": true
},
"definitionLookupBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block definition lookup when the device is in supervised mode (iOS 8.1.3 and later ).",
"nullable": true
},
"deviceBlockEnableRestrictions": {
"type": "boolean",
"description": "Indicates whether or not to allow the user to enables restrictions in the device settings when the device is in supervised mode.",
"nullable": true
},
"deviceBlockEraseContentAndSettings": {
"type": "boolean",
"description": "Indicates whether or not to allow the use of the 'Erase all content and settings' option on the device when the device is in supervised mode.",
"nullable": true
},
"deviceBlockNameModification": {
"type": "boolean",
"description": "Indicates whether or not to allow device name modification when the device is in supervised mode (iOS 9.0 and later).",
"nullable": true
},
"diagnosticDataBlockSubmission": {
"type": "boolean",
"description": "Indicates whether or not to block diagnostic data submission.",
"nullable": true
},
"diagnosticDataBlockSubmissionModification": {
"type": "boolean",
"description": "Indicates whether or not to allow diagnostics submission settings modification when the device is in supervised mode (iOS 9.3.2 and later).",
"nullable": true
},
"documentsBlockManagedDocumentsInUnmanagedApps": {
"type": "boolean",
"description": "Indicates whether or not to block the user from viewing managed documents in unmanaged apps.",
"nullable": true
},
"documentsBlockUnmanagedDocumentsInManagedApps": {
"type": "boolean",
"description": "Indicates whether or not to block the user from viewing unmanaged documents in managed apps.",
"nullable": true
},
"emailInDomainSuffixes": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "An email address lacking a suffix that matches any of these strings will be considered out-of-domain."
},
"enterpriseAppBlockTrust": {
"type": "boolean",
"description": "Indicates whether or not to block the user from trusting an enterprise app.",
"nullable": true
},
"enterpriseAppBlockTrustModification": {
"type": "boolean",
"description": "Indicates whether or not to block the user from modifying the enterprise app trust settings.",
"nullable": true
},
"faceTimeBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using FaceTime.",
"nullable": true
},
"findMyFriendsBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block Find My Friends when the device is in supervised mode.",
"nullable": true
},
"gamingBlockGameCenterFriends": {
"type": "boolean",
"description": "Indicates whether or not to block the user from having friends in Game Center.",
"nullable": true
},
"gamingBlockMultiplayer": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using multiplayer gaming.",
"nullable": true
},
"gameCenterBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using Game Center when the device is in supervised mode.",
"nullable": true
},
"hostPairingBlocked": {
"type": "boolean",
"description": "indicates whether or not to allow host pairing to control the devices an iOS device can pair with when the iOS device is in supervised mode.",
"nullable": true
},
"iBooksStoreBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using the iBooks Store when the device is in supervised mode.",
"nullable": true
},
"iBooksStoreBlockErotica": {
"type": "boolean",
"description": "Indicates whether or not to block the user from downloading media from the iBookstore that has been tagged as erotica.",
"nullable": true
},
"iCloudBlockActivityContinuation": {
"type": "boolean",
"description": "Indicates whether or not to block the the user from continuing work they started on iOS device to another iOS or macOS device.",
"nullable": true
},
"iCloudBlockBackup": {
"type": "boolean",
"description": "Indicates whether or not to block iCloud backup.",
"nullable": true
},
"iCloudBlockDocumentSync": {
"type": "boolean",
"description": "Indicates whether or not to block iCloud document sync.",
"nullable": true
},
"iCloudBlockManagedAppsSync": {
"type": "boolean",
"description": "Indicates whether or not to block Managed Apps Cloud Sync.",
"nullable": true
},
"iCloudBlockPhotoLibrary": {
"type": "boolean",
"description": "Indicates whether or not to block iCloud Photo Library.",
"nullable": true
},
"iCloudBlockPhotoStreamSync": {
"type": "boolean",
"description": "Indicates whether or not to block iCloud Photo Stream Sync.",
"nullable": true
},
"iCloudBlockSharedPhotoStream": {
"type": "boolean",
"description": "Indicates whether or not to block Shared Photo Stream.",
"nullable": true
},
"iCloudRequireEncryptedBackup": {
"type": "boolean",
"description": "Indicates whether or not to require backups to iCloud be encrypted.",
"nullable": true
},
"iTunesBlockExplicitContent": {
"type": "boolean",
"description": "Indicates whether or not to block the user from accessing explicit content in iTunes and the App Store.",
"nullable": true
},
"iTunesBlockMusicService": {
"type": "boolean",
"description": "Indicates whether or not to block Music service and revert Music app to classic mode when the device is in supervised mode (iOS 9.3 and later and macOS 10.12 and later).",
"nullable": true
},
"iTunesBlockRadio": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using iTunes Radio when the device is in supervised mode (iOS 9.3 and later).",
"nullable": true
},
"keyboardBlockAutoCorrect": {
"type": "boolean",
"description": "Indicates whether or not to block keyboard auto-correction when the device is in supervised mode (iOS 8.1.3 and later).",
"nullable": true
},
"keyboardBlockDictation": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using dictation input when the device is in supervised mode.",
"nullable": true
},
"keyboardBlockPredictive": {
"type": "boolean",
"description": "Indicates whether or not to block predictive keyboards when device is in supervised mode (iOS 8.1.3 and later).",
"nullable": true
},
"keyboardBlockShortcuts": {
"type": "boolean",
"description": "Indicates whether or not to block keyboard shortcuts when the device is in supervised mode (iOS 9.0 and later).",
"nullable": true
},
"keyboardBlockSpellCheck": {
"type": "boolean",
"description": "Indicates whether or not to block keyboard spell-checking when the device is in supervised mode (iOS 8.1.3 and later).",
"nullable": true
},
"kioskModeAllowAssistiveSpeak": {
"type": "boolean",
"description": "Indicates whether or not to allow assistive speak while in kiosk mode.",
"nullable": true
},
"kioskModeAllowAssistiveTouchSettings": {
"type": "boolean",
"description": "Indicates whether or not to allow access to the Assistive Touch Settings while in kiosk mode.",
"nullable": true
},
"kioskModeAllowAutoLock": {
"type": "boolean",
"description": "Indicates whether or not to allow device auto lock while in kiosk mode.",
"nullable": true
},
"kioskModeAllowColorInversionSettings": {
"type": "boolean",
"description": "Indicates whether or not to allow access to the Color Inversion Settings while in kiosk mode.",
"nullable": true
},
"kioskModeAllowRingerSwitch": {
"type": "boolean",
"description": "Indicates whether or not to allow use of the ringer switch while in kiosk mode.",
"nullable": true
},
"kioskModeAllowScreenRotation": {
"type": "boolean",
"description": "Indicates whether or not to allow screen rotation while in kiosk mode.",
"nullable": true
},
"kioskModeAllowSleepButton": {
"type": "boolean",
"description": "Indicates whether or not to allow use of the sleep button while in kiosk mode.",
"nullable": true
},
"kioskModeAllowTouchscreen": {
"type": "boolean",
"description": "Indicates whether or not to allow use of the touchscreen while in kiosk mode.",
"nullable": true
},
"kioskModeAllowVoiceOverSettings": {
"type": "boolean",
"description": "Indicates whether or not to allow access to the voice over settings while in kiosk mode.",
"nullable": true
},
"kioskModeAllowVolumeButtons": {
"type": "boolean",
"description": "Indicates whether or not to allow use of the volume buttons while in kiosk mode.",
"nullable": true
},
"kioskModeAllowZoomSettings": {
"type": "boolean",
"description": "Indicates whether or not to allow access to the zoom settings while in kiosk mode.",
"nullable": true
},
"kioskModeAppStoreUrl": {
"type": "string",
"description": "URL in the app store to the app to use for kiosk mode. Use if KioskModeManagedAppId is not known.",
"nullable": true
},
"kioskModeBuiltInAppId": {
"type": "string",
"description": "ID for built-in apps to use for kiosk mode. Used when KioskModeManagedAppId and KioskModeAppStoreUrl are not set.",
"nullable": true
},
"kioskModeRequireAssistiveTouch": {
"type": "boolean",
"description": "Indicates whether or not to require assistive touch while in kiosk mode.",
"nullable": true
},
"kioskModeRequireColorInversion": {
"type": "boolean",
"description": "Indicates whether or not to require color inversion while in kiosk mode.",
"nullable": true
},
"kioskModeRequireMonoAudio": {
"type": "boolean",
"description": "Indicates whether or not to require mono audio while in kiosk mode.",
"nullable": true
},
"kioskModeRequireVoiceOver": {
"type": "boolean",
"description": "Indicates whether or not to require voice over while in kiosk mode.",
"nullable": true
},
"kioskModeRequireZoom": {
"type": "boolean",
"description": "Indicates whether or not to require zoom while in kiosk mode.",
"nullable": true
},
"kioskModeManagedAppId": {
"type": "string",
"description": "Managed app id of the app to use for kiosk mode. If KioskModeManagedAppId is specified then KioskModeAppStoreUrl will be ignored.",
"nullable": true
},
"lockScreenBlockControlCenter": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using control center on the lock screen.",
"nullable": true
},
"lockScreenBlockNotificationView": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using the notification view on the lock screen.",
"nullable": true
},
"lockScreenBlockPassbook": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using passbook when the device is locked.",
"nullable": true
},
"lockScreenBlockTodayView": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using the Today View on the lock screen.",
"nullable": true
},
"mediaContentRatingAustralia": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingAustralia"
}
],
"description": "Media content rating settings for Australia",
"nullable": true
},
"mediaContentRatingCanada": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingCanada"
}
],
"description": "Media content rating settings for Canada",
"nullable": true
},
"mediaContentRatingFrance": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingFrance"
}
],
"description": "Media content rating settings for France",
"nullable": true
},
"mediaContentRatingGermany": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingGermany"
}
],
"description": "Media content rating settings for Germany",
"nullable": true
},
"mediaContentRatingIreland": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingIreland"
}
],
"description": "Media content rating settings for Ireland",
"nullable": true
},
"mediaContentRatingJapan": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingJapan"
}
],
"description": "Media content rating settings for Japan",
"nullable": true
},
"mediaContentRatingNewZealand": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingNewZealand"
}
],
"description": "Media content rating settings for New Zealand",
"nullable": true
},
"mediaContentRatingUnitedKingdom": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingUnitedKingdom"
}
],
"description": "Media content rating settings for United Kingdom",
"nullable": true
},
"mediaContentRatingUnitedStates": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mediaContentRatingUnitedStates"
}
],
"description": "Media content rating settings for United States",
"nullable": true
},
"networkUsageRules": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosNetworkUsageRule"
}
],
"nullable": true
},
"description": "List of managed apps and the network rules that applies to them. This collection can contain a maximum of 1000 elements."
},
"mediaContentRatingApps": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.ratingAppsType"
}
],
"description": "Media content rating settings for Apps. Possible values are: allAllowed, allBlocked, agesAbove4, agesAbove9, agesAbove12, agesAbove17.",
"nullable": true
},
"messagesBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using the Messages app on the supervised device.",
"nullable": true
},
"notificationsBlockSettingsModification": {
"type": "boolean",
"description": "Indicates whether or not to allow notifications settings modification (iOS 9.3 and later).",
"nullable": true
},
"passcodeBlockFingerprintUnlock": {
"type": "boolean",
"description": "Indicates whether or not to block fingerprint unlock.",
"nullable": true
},
"passcodeBlockFingerprintModification": {
"type": "boolean",
"description": "Block modification of registered Touch ID fingerprints when in supervised mode.",
"nullable": true
},
"passcodeBlockModification": {
"type": "boolean",
"description": "Indicates whether or not to allow passcode modification on the supervised device (iOS 9.0 and later).",
"nullable": true
},
"passcodeBlockSimple": {
"type": "boolean",
"description": "Indicates whether or not to block simple passcodes.",
"nullable": true
},
"passcodeExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the passcode expires. Valid values 1 to 65535",
"format": "int32",
"nullable": true
},
"passcodeMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passcode. Valid values 4 to 14",
"format": "int32",
"nullable": true
},
"passcodeMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a passcode is required.",
"format": "int32",
"nullable": true
},
"passcodeMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before the screen times out.",
"format": "int32",
"nullable": true
},
"passcodeMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of character sets a passcode must contain. Valid values 0 to 4",
"format": "int32",
"nullable": true
},
"passcodePreviousPasscodeBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passcodes to block. Valid values 1 to 24",
"format": "int32",
"nullable": true
},
"passcodeSignInFailureCountBeforeWipe": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of sign in failures allowed before wiping the device. Valid values 4 to 11",
"format": "int32",
"nullable": true
},
"passcodeRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "Type of passcode that is required. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passcodeRequired": {
"type": "boolean",
"description": "Indicates whether or not to require a passcode.",
"nullable": true
},
"podcastsBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using podcasts on the supervised device (iOS 8.0 and later).",
"nullable": true
},
"safariBlockAutofill": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using Auto fill in Safari.",
"nullable": true
},
"safariBlockJavaScript": {
"type": "boolean",
"description": "Indicates whether or not to block JavaScript in Safari.",
"nullable": true
},
"safariBlockPopups": {
"type": "boolean",
"description": "Indicates whether or not to block popups in Safari.",
"nullable": true
},
"safariBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using Safari.",
"nullable": true
},
"safariCookieSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.webBrowserCookieSettings"
}
],
"description": "Cookie settings for Safari. Possible values are: browserDefault, blockAlways, allowCurrentWebSite, allowFromWebsitesVisited, allowAlways.",
"nullable": true
},
"safariManagedDomains": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "URLs matching the patterns listed here will be considered managed."
},
"safariPasswordAutoFillDomains": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Users can save passwords in Safari only from URLs matching the patterns listed here. Applies to devices in supervised mode (iOS 9.3 and later)."
},
"safariRequireFraudWarning": {
"type": "boolean",
"description": "Indicates whether or not to require fraud warning in Safari.",
"nullable": true
},
"screenCaptureBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from taking Screenshots.",
"nullable": true
},
"siriBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using Siri.",
"nullable": true
},
"siriBlockedWhenLocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from using Siri when locked.",
"nullable": true
},
"siriBlockUserGeneratedContent": {
"type": "boolean",
"description": "Indicates whether or not to block Siri from querying user-generated content when used on a supervised device.",
"nullable": true
},
"siriRequireProfanityFilter": {
"type": "boolean",
"description": "Indicates whether or not to prevent Siri from dictating, or speaking profane language on supervised device.",
"nullable": true
},
"spotlightBlockInternetResults": {
"type": "boolean",
"description": "Indicates whether or not to block Spotlight search from returning internet results on supervised device.",
"nullable": true
},
"voiceDialingBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block voice dialing.",
"nullable": true
},
"wallpaperBlockModification": {
"type": "boolean",
"description": "Indicates whether or not to allow wallpaper modification on supervised device (iOS 9.0 and later) .",
"nullable": true
},
"wiFiConnectOnlyToConfiguredNetworks": {
"type": "boolean",
"description": "Indicates whether or not to force the device to use only Wi-Fi networks from configuration profiles when the device is in supervised mode.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"accountBlockModification": true,
"activationLockAllowWhenSupervised": true,
"airDropBlocked": true,
"airDropForceUnmanagedDropTarget": true,
"airPlayForcePairingPasswordForOutgoingRequests": true,
"appleWatchBlockPairing": true,
"appleWatchForceWristDetection": true,
"appleNewsBlocked": true,
"appsSingleAppModeList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"appsVisibilityList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"appsVisibilityListType": {
"@odata.type": "microsoft.graph.appListType"
},
"appStoreBlockAutomaticDownloads": true,
"appStoreBlocked": true,
"appStoreBlockInAppPurchases": true,
"appStoreBlockUIAppInstallation": true,
"appStoreRequirePassword": true,
"bluetoothBlockModification": true,
"cameraBlocked": true,
"cellularBlockDataRoaming": true,
"cellularBlockGlobalBackgroundFetchWhileRoaming": true,
"cellularBlockPerAppDataModification": true,
"cellularBlockPersonalHotspot": true,
"cellularBlockVoiceRoaming": true,
"certificatesBlockUntrustedTlsCertificates": true,
"classroomAppBlockRemoteScreenObservation": true,
"classroomAppForceUnpromptedScreenObservation": true,
"compliantAppsList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"compliantAppListType": {
"@odata.type": "microsoft.graph.appListType"
},
"configurationProfileBlockChanges": true,
"definitionLookupBlocked": true,
"deviceBlockEnableRestrictions": true,
"deviceBlockEraseContentAndSettings": true,
"deviceBlockNameModification": true,
"diagnosticDataBlockSubmission": true,
"diagnosticDataBlockSubmissionModification": true,
"documentsBlockManagedDocumentsInUnmanagedApps": true,
"documentsBlockUnmanagedDocumentsInManagedApps": true,
"emailInDomainSuffixes": [
"string"
],
"enterpriseAppBlockTrust": true,
"enterpriseAppBlockTrustModification": true,
"faceTimeBlocked": true,
"findMyFriendsBlocked": true,
"gamingBlockGameCenterFriends": true,
"gamingBlockMultiplayer": true,
"gameCenterBlocked": true,
"hostPairingBlocked": true,
"iBooksStoreBlocked": true,
"iBooksStoreBlockErotica": true,
"iCloudBlockActivityContinuation": true,
"iCloudBlockBackup": true,
"iCloudBlockDocumentSync": true,
"iCloudBlockManagedAppsSync": true,
"iCloudBlockPhotoLibrary": true,
"iCloudBlockPhotoStreamSync": true,
"iCloudBlockSharedPhotoStream": true,
"iCloudRequireEncryptedBackup": true,
"iTunesBlockExplicitContent": true,
"iTunesBlockMusicService": true,
"iTunesBlockRadio": true,
"keyboardBlockAutoCorrect": true,
"keyboardBlockDictation": true,
"keyboardBlockPredictive": true,
"keyboardBlockShortcuts": true,
"keyboardBlockSpellCheck": true,
"kioskModeAllowAssistiveSpeak": true,
"kioskModeAllowAssistiveTouchSettings": true,
"kioskModeAllowAutoLock": true,
"kioskModeAllowColorInversionSettings": true,
"kioskModeAllowRingerSwitch": true,
"kioskModeAllowScreenRotation": true,
"kioskModeAllowSleepButton": true,
"kioskModeAllowTouchscreen": true,
"kioskModeAllowVoiceOverSettings": true,
"kioskModeAllowVolumeButtons": true,
"kioskModeAllowZoomSettings": true,
"kioskModeAppStoreUrl": "string",
"kioskModeBuiltInAppId": "string",
"kioskModeRequireAssistiveTouch": true,
"kioskModeRequireColorInversion": true,
"kioskModeRequireMonoAudio": true,
"kioskModeRequireVoiceOver": true,
"kioskModeRequireZoom": true,
"kioskModeManagedAppId": "string",
"lockScreenBlockControlCenter": true,
"lockScreenBlockNotificationView": true,
"lockScreenBlockPassbook": true,
"lockScreenBlockTodayView": true,
"mediaContentRatingAustralia": {
"@odata.type": "microsoft.graph.mediaContentRatingAustralia"
},
"mediaContentRatingCanada": {
"@odata.type": "microsoft.graph.mediaContentRatingCanada"
},
"mediaContentRatingFrance": {
"@odata.type": "microsoft.graph.mediaContentRatingFrance"
},
"mediaContentRatingGermany": {
"@odata.type": "microsoft.graph.mediaContentRatingGermany"
},
"mediaContentRatingIreland": {
"@odata.type": "microsoft.graph.mediaContentRatingIreland"
},
"mediaContentRatingJapan": {
"@odata.type": "microsoft.graph.mediaContentRatingJapan"
},
"mediaContentRatingNewZealand": {
"@odata.type": "microsoft.graph.mediaContentRatingNewZealand"
},
"mediaContentRatingUnitedKingdom": {
"@odata.type": "microsoft.graph.mediaContentRatingUnitedKingdom"
},
"mediaContentRatingUnitedStates": {
"@odata.type": "microsoft.graph.mediaContentRatingUnitedStates"
},
"networkUsageRules": [
{
"@odata.type": "microsoft.graph.iosNetworkUsageRule"
}
],
"mediaContentRatingApps": {
"@odata.type": "microsoft.graph.ratingAppsType"
},
"messagesBlocked": true,
"notificationsBlockSettingsModification": true,
"passcodeBlockFingerprintUnlock": true,
"passcodeBlockFingerprintModification": true,
"passcodeBlockModification": true,
"passcodeBlockSimple": true,
"passcodeExpirationDays": "integer",
"passcodeMinimumLength": "integer",
"passcodeMinutesOfInactivityBeforeLock": "integer",
"passcodeMinutesOfInactivityBeforeScreenTimeout": "integer",
"passcodeMinimumCharacterSetCount": "integer",
"passcodePreviousPasscodeBlockCount": "integer",
"passcodeSignInFailureCountBeforeWipe": "integer",
"passcodeRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passcodeRequired": true,
"podcastsBlocked": true,
"safariBlockAutofill": true,
"safariBlockJavaScript": true,
"safariBlockPopups": true,
"safariBlocked": true,
"safariCookieSettings": {
"@odata.type": "microsoft.graph.webBrowserCookieSettings"
},
"safariManagedDomains": [
"string"
],
"safariPasswordAutoFillDomains": [
"string"
],
"safariRequireFraudWarning": true,
"screenCaptureBlocked": true,
"siriBlocked": true,
"siriBlockedWhenLocked": true,
"siriBlockUserGeneratedContent": true,
"siriRequireProfanityFilter": true,
"spotlightBlockInternetResults": true,
"voiceDialingBlocked": true,
"wallpaperBlockModification": true,
"wiFiConnectOnlyToConfiguredNetworks": true
}
},
"microsoft.graph.iosUpdateConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "iosUpdateConfiguration",
"type": "object",
"properties": {
"activeHoursStart": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$",
"type": "string",
"description": "Active Hours Start (active hours mean the time window when updates install should not happen)",
"format": "time",
"nullable": true
},
"activeHoursEnd": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$",
"type": "string",
"description": "Active Hours End (active hours mean the time window when updates install should not happen)",
"format": "time",
"nullable": true
},
"scheduledInstallDays": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.dayOfWeek"
}
],
"nullable": true
},
"description": "Days in week for which active hours are configured. This collection can contain a maximum of 7 elements."
},
"utcTimeOffsetInMinutes": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "UTC Time Offset indicated in minutes",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"activeHoursStart": "string (timestamp)",
"activeHoursEnd": "string (timestamp)",
"scheduledInstallDays": [
{
"@odata.type": "microsoft.graph.dayOfWeek"
}
],
"utcTimeOffsetInMinutes": "integer"
}
},
"microsoft.graph.iosUpdateDeviceStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "iosUpdateDeviceStatus",
"type": "object",
"properties": {
"installStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.iosUpdatesInstallStatus"
}
],
"description": "The installation status of the policy report. Possible values are: success, available, idle, unknown, downloading, downloadFailed, downloadRequiresComputer, downloadInsufficientSpace, downloadInsufficientPower, downloadInsufficientNetwork, installing, installInsufficientSpace, installInsufficientPower, installPhoneCallInProgress, installFailed, notSupportedOperation, sharedDeviceUserLoggedInError.",
"nullable": true
},
"osVersion": {
"type": "string",
"description": "The device version that is being reported.",
"nullable": true
},
"deviceId": {
"type": "string",
"description": "The device id that is being reported.",
"nullable": true
},
"userId": {
"type": "string",
"description": "The User id that is being reported.",
"nullable": true
},
"deviceDisplayName": {
"type": "string",
"description": "Device name of the DevicePolicyStatus.",
"nullable": true
},
"userName": {
"type": "string",
"description": "The User Name that is being reported",
"nullable": true
},
"deviceModel": {
"type": "string",
"description": "The device model that is being reported",
"nullable": true
},
"complianceGracePeriodExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The DateTime when device compliance grace period expires",
"format": "date-time",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceStatus"
}
],
"description": "Compliance status of the policy report. Possible values are: unknown, notApplicable, compliant, remediated, nonCompliant, error, conflict, notAssigned.",
"nullable": true
},
"lastReportedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date time of the policy report.",
"format": "date-time",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "UserPrincipalName.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"installStatus": {
"@odata.type": "microsoft.graph.iosUpdatesInstallStatus"
},
"osVersion": "string",
"deviceId": "string",
"userId": "string",
"deviceDisplayName": "string",
"userName": "string",
"deviceModel": "string",
"complianceGracePeriodExpirationDateTime": "string (timestamp)",
"status": {
"@odata.type": "microsoft.graph.complianceStatus"
},
"lastReportedDateTime": "string (timestamp)",
"userPrincipalName": "string"
}
},
"microsoft.graph.macOSCompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "macOSCompliancePolicy",
"type": "object",
"properties": {
"passwordRequired": {
"type": "boolean",
"description": "Whether or not to require a password.",
"nullable": true
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Indicates whether or not to block simple passwords.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires. Valid values 1 to 65535",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of password. Valid values 4 to 14",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block. Valid values 1 to 24",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum IOS version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum IOS version.",
"nullable": true
},
"systemIntegrityProtectionEnabled": {
"type": "boolean",
"description": "Require that devices have enabled system integrity protection.",
"nullable": true
},
"deviceThreatProtectionEnabled": {
"type": "boolean",
"description": "Require that devices have enabled device threat protection .",
"nullable": true
},
"deviceThreatProtectionRequiredSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceThreatProtectionLevel"
}
],
"description": "Require Mobile Threat Protection minimum risk level to report noncompliance. Possible values are: unavailable, secured, low, medium, high, notSet.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Require encryption on Mac OS devices.",
"nullable": true
},
"firewallEnabled": {
"type": "boolean",
"description": "Whether the firewall should be enabled or not.",
"nullable": true
},
"firewallBlockAllIncoming": {
"type": "boolean",
"description": "Corresponds to the 'Block all incoming connections' option.",
"nullable": true
},
"firewallEnableStealthMode": {
"type": "boolean",
"description": "Corresponds to 'Enable stealth mode.'",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordRequired": true,
"passwordBlockSimple": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"systemIntegrityProtectionEnabled": true,
"deviceThreatProtectionEnabled": true,
"deviceThreatProtectionRequiredSecurityLevel": {
"@odata.type": "microsoft.graph.deviceThreatProtectionLevel"
},
"storageRequireEncryption": true,
"firewallEnabled": true,
"firewallBlockAllIncoming": true,
"firewallEnableStealthMode": true
}
},
"microsoft.graph.macOSCustomConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "macOSCustomConfiguration",
"type": "object",
"properties": {
"payloadName": {
"type": "string",
"description": "Name that is displayed to the user.",
"nullable": true
},
"payloadFileName": {
"type": "string",
"description": "Payload file name (.mobileconfig",
"nullable": true
},
"payload": {
"type": "string",
"description": "Payload. (UTF8 encoded byte array)",
"format": "base64url",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"payloadName": "string",
"payloadFileName": "string",
"payload": "string"
}
},
"microsoft.graph.macOSDeviceFeaturesConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appleDeviceFeaturesConfigurationBase"
},
{
"title": "macOSDeviceFeaturesConfiguration",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
]
}
},
"microsoft.graph.macOSGeneralDeviceConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "macOSGeneralDeviceConfiguration",
"type": "object",
"properties": {
"compliantAppsList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps in the compliance (either allow list or block list, controlled by CompliantAppListType). This collection can contain a maximum of 10000 elements."
},
"compliantAppListType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListType"
}
],
"description": "List that is in the CompliantAppsList. Possible values are: none, appsInListCompliant, appsNotInListCompliant.",
"nullable": true
},
"emailInDomainSuffixes": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "An email address lacking a suffix that matches any of these strings will be considered out-of-domain."
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Block simple passwords.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of character sets a password must contain. Valid values 0 to 4",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passwords.",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity required before a password is required.",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity required before the screen times out.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "Type of password that is required. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordRequired": {
"type": "boolean",
"description": "Whether or not to require a password.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"compliantAppsList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"compliantAppListType": {
"@odata.type": "microsoft.graph.appListType"
},
"emailInDomainSuffixes": [
"string"
],
"passwordBlockSimple": true,
"passwordExpirationDays": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordMinutesOfInactivityBeforeScreenTimeout": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordRequired": true
}
},
"microsoft.graph.settingSource": {
"title": "settingSource",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Not yet documented",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Not yet documented",
"nullable": true
}
},
"example": {
"id": "string (identifier)",
"displayName": "string"
}
},
"microsoft.graph.settingStateDeviceSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "settingStateDeviceSummary",
"type": "object",
"properties": {
"settingName": {
"type": "string",
"description": "Name of the setting",
"nullable": true
},
"instancePath": {
"type": "string",
"description": "Name of the InstancePath for the setting",
"nullable": true
},
"unknownDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device Unkown count for the setting",
"format": "int32",
"nullable": true
},
"notApplicableDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device Not Applicable count for the setting",
"format": "int32",
"nullable": true
},
"compliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device Compliant count for the setting",
"format": "int32",
"nullable": true
},
"remediatedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device Compliant count for the setting",
"format": "int32",
"nullable": true
},
"nonCompliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device NonCompliant count for the setting",
"format": "int32",
"nullable": true
},
"errorDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device error count for the setting",
"format": "int32",
"nullable": true
},
"conflictDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Device conflict error count for the setting",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"settingName": "string",
"instancePath": "string",
"unknownDeviceCount": "integer",
"notApplicableDeviceCount": "integer",
"compliantDeviceCount": "integer",
"remediatedDeviceCount": "integer",
"nonCompliantDeviceCount": "integer",
"errorDeviceCount": "integer",
"conflictDeviceCount": "integer"
}
},
"microsoft.graph.sharedPCConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "sharedPCConfiguration",
"type": "object",
"properties": {
"accountManagerPolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.sharedPCAccountManagerPolicy"
}
],
"description": "Specifies how accounts are managed on a shared PC. Only applies when disableAccountManager is false.",
"nullable": true
},
"allowedAccounts": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.sharedPCAllowedAccountType"
}
],
"description": "Indicates which type of accounts are allowed to use on a shared PC. Possible values are: guest, domain.",
"nullable": true
},
"allowLocalStorage": {
"type": "boolean",
"description": "Specifies whether local storage is allowed on a shared PC.",
"nullable": true
},
"disableAccountManager": {
"type": "boolean",
"description": "Disables the account manager for shared PC mode.",
"nullable": true
},
"disableEduPolicies": {
"type": "boolean",
"description": "Specifies whether the default shared PC education environment policies should be disabled. For Windows 10 RS2 and later, this policy will be applied without setting Enabled to true.",
"nullable": true
},
"disablePowerPolicies": {
"type": "boolean",
"description": "Specifies whether the default shared PC power policies should be disabled.",
"nullable": true
},
"disableSignInOnResume": {
"type": "boolean",
"description": "Disables the requirement to sign in whenever the device wakes up from sleep mode.",
"nullable": true
},
"enabled": {
"type": "boolean",
"description": "Enables shared PC mode and applies the shared pc policies.",
"nullable": true
},
"idleTimeBeforeSleepInSeconds": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specifies the time in seconds that a device must sit idle before the PC goes to sleep. Setting this value to 0 prevents the sleep timeout from occurring.",
"format": "int32",
"nullable": true
},
"kioskAppDisplayName": {
"type": "string",
"description": "Specifies the display text for the account shown on the sign-in screen which launches the app specified by SetKioskAppUserModelId. Only applies when KioskAppUserModelId is set.",
"nullable": true
},
"kioskAppUserModelId": {
"type": "string",
"description": "Specifies the application user model ID of the app to use with assigned access.",
"nullable": true
},
"maintenanceStartTime": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$",
"type": "string",
"description": "Specifies the daily start time of maintenance hour.",
"format": "time",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"accountManagerPolicy": {
"@odata.type": "microsoft.graph.sharedPCAccountManagerPolicy"
},
"allowedAccounts": {
"@odata.type": "microsoft.graph.sharedPCAllowedAccountType"
},
"allowLocalStorage": true,
"disableAccountManager": true,
"disableEduPolicies": true,
"disablePowerPolicies": true,
"disableSignInOnResume": true,
"enabled": true,
"idleTimeBeforeSleepInSeconds": "integer",
"kioskAppDisplayName": "string",
"kioskAppUserModelId": "string",
"maintenanceStartTime": "string (timestamp)"
}
},
"microsoft.graph.softwareUpdateStatusSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "softwareUpdateStatusSummary",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the policy.",
"nullable": true
},
"compliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of compliant devices.",
"format": "int32",
"nullable": true
},
"nonCompliantDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of non compliant devices.",
"format": "int32",
"nullable": true
},
"remediatedDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of remediated devices.",
"format": "int32",
"nullable": true
},
"errorDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of devices had error.",
"format": "int32",
"nullable": true
},
"unknownDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of unknown devices.",
"format": "int32",
"nullable": true
},
"conflictDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of conflict devices.",
"format": "int32",
"nullable": true
},
"notApplicableDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable devices.",
"format": "int32",
"nullable": true
},
"compliantUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of compliant users.",
"format": "int32",
"nullable": true
},
"nonCompliantUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of non compliant users.",
"format": "int32",
"nullable": true
},
"remediatedUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of remediated users.",
"format": "int32",
"nullable": true
},
"errorUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of users had error.",
"format": "int32",
"nullable": true
},
"unknownUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of unknown users.",
"format": "int32",
"nullable": true
},
"conflictUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of conflict users.",
"format": "int32",
"nullable": true
},
"notApplicableUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of not applicable users.",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"compliantDeviceCount": "integer",
"nonCompliantDeviceCount": "integer",
"remediatedDeviceCount": "integer",
"errorDeviceCount": "integer",
"unknownDeviceCount": "integer",
"conflictDeviceCount": "integer",
"notApplicableDeviceCount": "integer",
"compliantUserCount": "integer",
"nonCompliantUserCount": "integer",
"remediatedUserCount": "integer",
"errorUserCount": "integer",
"unknownUserCount": "integer",
"conflictUserCount": "integer",
"notApplicableUserCount": "integer"
}
},
"microsoft.graph.windows10CompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "windows10CompliancePolicy",
"type": "object",
"properties": {
"passwordRequired": {
"type": "boolean",
"description": "Require a password to unlock Windows device.",
"nullable": true
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Indicates whether or not to block simple password.",
"nullable": true
},
"passwordRequiredToUnlockFromIdle": {
"type": "boolean",
"description": "Require a password to unlock an idle device.",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The password expiration in days.",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The minimum password length.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of previous passwords to prevent re-use of.",
"format": "int32",
"nullable": true
},
"requireHealthyDeviceReport": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum Windows 10 version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum Windows 10 version.",
"nullable": true
},
"mobileOsMinimumVersion": {
"type": "string",
"description": "Minimum Windows Phone version.",
"nullable": true
},
"mobileOsMaximumVersion": {
"type": "string",
"description": "Maximum Windows Phone version.",
"nullable": true
},
"earlyLaunchAntiMalwareDriverEnabled": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation - early launch antimalware driver is enabled.",
"nullable": true
},
"bitLockerEnabled": {
"type": "boolean",
"description": "Require devices to be reported healthy by Windows Device Health Attestation - bit locker is enabled",
"nullable": true
},
"secureBootEnabled": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation - secure boot is enabled.",
"nullable": true
},
"codeIntegrityEnabled": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Require encryption on windows devices.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordRequired": true,
"passwordBlockSimple": true,
"passwordRequiredToUnlockFromIdle": true,
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordPreviousPasswordBlockCount": "integer",
"requireHealthyDeviceReport": true,
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"mobileOsMinimumVersion": "string",
"mobileOsMaximumVersion": "string",
"earlyLaunchAntiMalwareDriverEnabled": true,
"bitLockerEnabled": true,
"secureBootEnabled": true,
"codeIntegrityEnabled": true,
"storageRequireEncryption": true
}
},
"microsoft.graph.windows10CustomConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows10CustomConfiguration",
"type": "object",
"properties": {
"omaSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.omaSetting"
}
],
"nullable": true
},
"description": "OMA settings. This collection can contain a maximum of 1000 elements."
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"omaSettings": [
{
"@odata.type": "microsoft.graph.omaSetting"
}
]
}
},
"microsoft.graph.windows10EndpointProtectionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows10EndpointProtectionConfiguration",
"type": "object",
"properties": {
"firewallBlockStatefulFTP": {
"type": "boolean",
"description": "Blocks stateful FTP connections to the device",
"nullable": true
},
"firewallIdleTimeoutForSecurityAssociationInSeconds": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Configures the idle timeout for security associations, in seconds, from 300 to 3600 inclusive. This is the period after which security associations will expire and be deleted. Valid values 300 to 3600",
"format": "int32",
"nullable": true
},
"firewallPreSharedKeyEncodingMethod": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.firewallPreSharedKeyEncodingMethodType"
}
],
"description": "Select the preshared key encoding to be used. Possible values are: deviceDefault, none, utF8.",
"nullable": true
},
"firewallIPSecExemptionsAllowNeighborDiscovery": {
"type": "boolean",
"description": "Configures IPSec exemptions to allow neighbor discovery IPv6 ICMP type-codes",
"nullable": true
},
"firewallIPSecExemptionsAllowICMP": {
"type": "boolean",
"description": "Configures IPSec exemptions to allow ICMP",
"nullable": true
},
"firewallIPSecExemptionsAllowRouterDiscovery": {
"type": "boolean",
"description": "Configures IPSec exemptions to allow router discovery IPv6 ICMP type-codes",
"nullable": true
},
"firewallIPSecExemptionsAllowDHCP": {
"type": "boolean",
"description": "Configures IPSec exemptions to allow both IPv4 and IPv6 DHCP traffic",
"nullable": true
},
"firewallCertificateRevocationListCheckMethod": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.firewallCertificateRevocationListCheckMethodType"
}
],
"description": "Specify how the certificate revocation list is to be enforced. Possible values are: deviceDefault, none, attempt, require.",
"nullable": true
},
"firewallMergeKeyingModuleSettings": {
"type": "boolean",
"description": "If an authentication set is not fully supported by a keying module, direct the module to ignore only unsupported authentication suites rather than the entire set",
"nullable": true
},
"firewallPacketQueueingMethod": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.firewallPacketQueueingMethodType"
}
],
"description": "Configures how packet queueing should be applied in the tunnel gateway scenario. Possible values are: deviceDefault, disabled, queueInbound, queueOutbound, queueBoth.",
"nullable": true
},
"firewallProfileDomain": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsFirewallNetworkProfile"
}
],
"description": "Configures the firewall profile settings for domain networks",
"nullable": true
},
"firewallProfilePublic": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsFirewallNetworkProfile"
}
],
"description": "Configures the firewall profile settings for public networks",
"nullable": true
},
"firewallProfilePrivate": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsFirewallNetworkProfile"
}
],
"description": "Configures the firewall profile settings for private networks",
"nullable": true
},
"defenderAttackSurfaceReductionExcludedPaths": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "List of exe files and folders to be excluded from attack surface reduction rules"
},
"defenderGuardedFoldersAllowedAppPaths": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "List of paths to exe that are allowed to access protected folders"
},
"defenderAdditionalGuardedFolders": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "List of folder paths to be added to the list of protected folders"
},
"defenderExploitProtectionXml": {
"type": "string",
"description": "Xml content containing information regarding exploit protection details.",
"format": "base64url",
"nullable": true
},
"defenderExploitProtectionXmlFileName": {
"type": "string",
"description": "Name of the file from which DefenderExploitProtectionXml was obtained.",
"nullable": true
},
"defenderSecurityCenterBlockExploitProtectionOverride": {
"type": "boolean",
"description": "Indicates whether or not to block user from overriding Exploit Protection settings.",
"nullable": true
},
"appLockerApplicationControl": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appLockerApplicationControlType"
}
],
"description": "Enables the Admin to choose what types of app to allow on devices. Possible values are: notConfigured, enforceComponentsAndStoreApps, auditComponentsAndStoreApps, enforceComponentsStoreAppsAndSmartlocker, auditComponentsStoreAppsAndSmartlocker.",
"nullable": true
},
"smartScreenEnableInShell": {
"type": "boolean",
"description": "Allows IT Admins to configure SmartScreen for Windows.",
"nullable": true
},
"smartScreenBlockOverrideForFiles": {
"type": "boolean",
"description": "Allows IT Admins to control whether users can can ignore SmartScreen warnings and run malicious files.",
"nullable": true
},
"applicationGuardEnabled": {
"type": "boolean",
"description": "Enable Windows Defender Application Guard",
"nullable": true
},
"applicationGuardBlockFileTransfer": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.applicationGuardBlockFileTransferType"
}
],
"description": "Block clipboard to transfer image file, text file or neither of them. Possible values are: notConfigured, blockImageAndTextFile, blockImageFile, blockNone, blockTextFile.",
"nullable": true
},
"applicationGuardBlockNonEnterpriseContent": {
"type": "boolean",
"description": "Block enterprise sites to load non-enterprise content, such as third party plug-ins",
"nullable": true
},
"applicationGuardAllowPersistence": {
"type": "boolean",
"description": "Allow persisting user generated data inside the App Guard Containter (favorites, cookies, web passwords, etc.)",
"nullable": true
},
"applicationGuardForceAuditing": {
"type": "boolean",
"description": "Force auditing will persist Windows logs and events to meet security/compliance criteria (sample events are user login-logoff, use of privilege rights, software installation, system changes, etc.)",
"nullable": true
},
"applicationGuardBlockClipboardSharing": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.applicationGuardBlockClipboardSharingType"
}
],
"description": "Block clipboard to share data from Host to Container, or from Container to Host, or both ways, or neither ways. Possible values are: notConfigured, blockBoth, blockHostToContainer, blockContainerToHost, blockNone.",
"nullable": true
},
"applicationGuardAllowPrintToPDF": {
"type": "boolean",
"description": "Allow printing to PDF from Container",
"nullable": true
},
"applicationGuardAllowPrintToXPS": {
"type": "boolean",
"description": "Allow printing to XPS from Container",
"nullable": true
},
"applicationGuardAllowPrintToLocalPrinters": {
"type": "boolean",
"description": "Allow printing to Local Printers from Container",
"nullable": true
},
"applicationGuardAllowPrintToNetworkPrinters": {
"type": "boolean",
"description": "Allow printing to Network Printers from Container",
"nullable": true
},
"bitLockerDisableWarningForOtherDiskEncryption": {
"type": "boolean",
"description": "Allows the Admin to disable the warning prompt for other disk encryption on the user machines.",
"nullable": true
},
"bitLockerEnableStorageCardEncryptionOnMobile": {
"type": "boolean",
"description": "Allows the admin to require encryption to be turned on using BitLocker. This policy is valid only for a mobile SKU.",
"nullable": true
},
"bitLockerEncryptDevice": {
"type": "boolean",
"description": "Allows the admin to require encryption to be turned on using BitLocker.",
"nullable": true
},
"bitLockerRemovableDrivePolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.bitLockerRemovableDrivePolicy"
}
],
"description": "BitLocker Removable Drive Policy.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"firewallBlockStatefulFTP": true,
"firewallIdleTimeoutForSecurityAssociationInSeconds": "integer",
"firewallPreSharedKeyEncodingMethod": {
"@odata.type": "microsoft.graph.firewallPreSharedKeyEncodingMethodType"
},
"firewallIPSecExemptionsAllowNeighborDiscovery": true,
"firewallIPSecExemptionsAllowICMP": true,
"firewallIPSecExemptionsAllowRouterDiscovery": true,
"firewallIPSecExemptionsAllowDHCP": true,
"firewallCertificateRevocationListCheckMethod": {
"@odata.type": "microsoft.graph.firewallCertificateRevocationListCheckMethodType"
},
"firewallMergeKeyingModuleSettings": true,
"firewallPacketQueueingMethod": {
"@odata.type": "microsoft.graph.firewallPacketQueueingMethodType"
},
"firewallProfileDomain": {
"@odata.type": "microsoft.graph.windowsFirewallNetworkProfile"
},
"firewallProfilePublic": {
"@odata.type": "microsoft.graph.windowsFirewallNetworkProfile"
},
"firewallProfilePrivate": {
"@odata.type": "microsoft.graph.windowsFirewallNetworkProfile"
},
"defenderAttackSurfaceReductionExcludedPaths": [
"string"
],
"defenderGuardedFoldersAllowedAppPaths": [
"string"
],
"defenderAdditionalGuardedFolders": [
"string"
],
"defenderExploitProtectionXml": "string",
"defenderExploitProtectionXmlFileName": "string",
"defenderSecurityCenterBlockExploitProtectionOverride": true,
"appLockerApplicationControl": {
"@odata.type": "microsoft.graph.appLockerApplicationControlType"
},
"smartScreenEnableInShell": true,
"smartScreenBlockOverrideForFiles": true,
"applicationGuardEnabled": true,
"applicationGuardBlockFileTransfer": {
"@odata.type": "microsoft.graph.applicationGuardBlockFileTransferType"
},
"applicationGuardBlockNonEnterpriseContent": true,
"applicationGuardAllowPersistence": true,
"applicationGuardForceAuditing": true,
"applicationGuardBlockClipboardSharing": {
"@odata.type": "microsoft.graph.applicationGuardBlockClipboardSharingType"
},
"applicationGuardAllowPrintToPDF": true,
"applicationGuardAllowPrintToXPS": true,
"applicationGuardAllowPrintToLocalPrinters": true,
"applicationGuardAllowPrintToNetworkPrinters": true,
"bitLockerDisableWarningForOtherDiskEncryption": true,
"bitLockerEnableStorageCardEncryptionOnMobile": true,
"bitLockerEncryptDevice": true,
"bitLockerRemovableDrivePolicy": {
"@odata.type": "microsoft.graph.bitLockerRemovableDrivePolicy"
}
}
},
"microsoft.graph.windows10EnterpriseModernAppManagementConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows10EnterpriseModernAppManagementConfiguration",
"type": "object",
"properties": {
"uninstallBuiltInApps": {
"type": "boolean",
"description": "Indicates whether or not to uninstall a fixed list of built-in Windows apps.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"uninstallBuiltInApps": true
}
},
"microsoft.graph.windows10GeneralConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows10GeneralConfiguration",
"type": "object",
"properties": {
"enterpriseCloudPrintDiscoveryEndPoint": {
"type": "string",
"description": "Endpoint for discovering cloud printers.",
"nullable": true
},
"enterpriseCloudPrintOAuthAuthority": {
"type": "string",
"description": "Authentication endpoint for acquiring OAuth tokens.",
"nullable": true
},
"enterpriseCloudPrintOAuthClientIdentifier": {
"type": "string",
"description": "GUID of a client application authorized to retrieve OAuth tokens from the OAuth Authority.",
"nullable": true
},
"enterpriseCloudPrintResourceIdentifier": {
"type": "string",
"description": "OAuth resource URI for print service as configured in the Azure portal.",
"nullable": true
},
"enterpriseCloudPrintDiscoveryMaxLimit": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Maximum number of printers that should be queried from a discovery endpoint. This is a mobile only setting. Valid values 1 to 65535",
"format": "int32",
"nullable": true
},
"enterpriseCloudPrintMopriaDiscoveryResourceIdentifier": {
"type": "string",
"description": "OAuth resource URI for printer discovery service as configured in Azure portal.",
"nullable": true
},
"searchBlockDiacritics": {
"type": "boolean",
"description": "Specifies if search can use diacritics.",
"nullable": true
},
"searchDisableAutoLanguageDetection": {
"type": "boolean",
"description": "Specifies whether to use automatic language detection when indexing content and properties.",
"nullable": true
},
"searchDisableIndexingEncryptedItems": {
"type": "boolean",
"description": "Indicates whether or not to block indexing of WIP-protected items to prevent them from appearing in search results for Cortana or Explorer.",
"nullable": true
},
"searchEnableRemoteQueries": {
"type": "boolean",
"description": "Indicates whether or not to block remote queries of this computer’s index.",
"nullable": true
},
"searchDisableIndexerBackoff": {
"type": "boolean",
"description": "Indicates whether or not to disable the search indexer backoff feature.",
"nullable": true
},
"searchDisableIndexingRemovableDrive": {
"type": "boolean",
"description": "Indicates whether or not to allow users to add locations on removable drives to libraries and to be indexed.",
"nullable": true
},
"searchEnableAutomaticIndexSizeManangement": {
"type": "boolean",
"description": "Specifies minimum amount of hard drive space on the same drive as the index location before indexing stops.",
"nullable": true
},
"diagnosticsDataSubmissionMode": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.diagnosticDataSubmissionMode"
}
],
"description": "Gets or sets a value allowing the device to send diagnostic and usage telemetry data, such as Watson. Possible values are: userDefined, none, basic, enhanced, full.",
"nullable": true
},
"oneDriveDisableFileSync": {
"type": "boolean",
"description": "Gets or sets a value allowing IT admins to prevent apps and features from working with files on OneDrive.",
"nullable": true
},
"smartScreenEnableAppInstallControl": {
"type": "boolean",
"description": "Allows IT Admins to control whether users are allowed to install apps from places other than the Store.",
"nullable": true
},
"personalizationDesktopImageUrl": {
"type": "string",
"description": "A http or https Url to a jpg, jpeg or png image that needs to be downloaded and used as the Desktop Image or a file Url to a local image on the file system that needs to used as the Desktop Image.",
"nullable": true
},
"personalizationLockScreenImageUrl": {
"type": "string",
"description": "A http or https Url to a jpg, jpeg or png image that neeeds to be downloaded and used as the Lock Screen Image or a file Url to a local image on the file system that needs to be used as the Lock Screen Image.",
"nullable": true
},
"bluetoothAllowedServices": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Specify a list of allowed Bluetooth services and profiles in hex formatted strings."
},
"bluetoothBlockAdvertising": {
"type": "boolean",
"description": "Whether or not to Block the user from using bluetooth advertising.",
"nullable": true
},
"bluetoothBlockDiscoverableMode": {
"type": "boolean",
"description": "Whether or not to Block the user from using bluetooth discoverable mode.",
"nullable": true
},
"bluetoothBlockPrePairing": {
"type": "boolean",
"description": "Whether or not to block specific bundled Bluetooth peripherals to automatically pair with the host device.",
"nullable": true
},
"edgeBlockAutofill": {
"type": "boolean",
"description": "Indicates whether or not to block auto fill.",
"nullable": true
},
"edgeBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using the Edge browser.",
"nullable": true
},
"edgeCookiePolicy": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.edgeCookiePolicy"
}
],
"description": "Indicates which cookies to block in the Edge browser. Possible values are: userDefined, allow, blockThirdParty, blockAll.",
"nullable": true
},
"edgeBlockDeveloperTools": {
"type": "boolean",
"description": "Indicates whether or not to block developer tools in the Edge browser.",
"nullable": true
},
"edgeBlockSendingDoNotTrackHeader": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from sending the do not track header.",
"nullable": true
},
"edgeBlockExtensions": {
"type": "boolean",
"description": "Indicates whether or not to block extensions in the Edge browser.",
"nullable": true
},
"edgeBlockInPrivateBrowsing": {
"type": "boolean",
"description": "Indicates whether or not to block InPrivate browsing on corporate networks, in the Edge browser.",
"nullable": true
},
"edgeBlockJavaScript": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using JavaScript.",
"nullable": true
},
"edgeBlockPasswordManager": {
"type": "boolean",
"description": "Indicates whether or not to Block password manager.",
"nullable": true
},
"edgeBlockAddressBarDropdown": {
"type": "boolean",
"description": "Block the address bar dropdown functionality in Microsoft Edge. Disable this settings to minimize network connections from Microsoft Edge to Microsoft services.",
"nullable": true
},
"edgeBlockCompatibilityList": {
"type": "boolean",
"description": "Block Microsoft compatibility list in Microsoft Edge. This list from Microsoft helps Edge properly display sites with known compatibility issues.",
"nullable": true
},
"edgeClearBrowsingDataOnExit": {
"type": "boolean",
"description": "Clear browsing data on exiting Microsoft Edge.",
"nullable": true
},
"edgeAllowStartPagesModification": {
"type": "boolean",
"description": "Allow users to change Start pages on Edge. Use the EdgeHomepageUrls to specify the Start pages that the user would see by default when they open Edge.",
"nullable": true
},
"edgeDisableFirstRunPage": {
"type": "boolean",
"description": "Block the Microsoft web page that opens on the first use of Microsoft Edge. This policy allows enterprises, like those enrolled in zero emissions configurations, to block this page.",
"nullable": true
},
"edgeBlockLiveTileDataCollection": {
"type": "boolean",
"description": "Block the collection of information by Microsoft for live tile creation when users pin a site to Start from Microsoft Edge.",
"nullable": true
},
"edgeSyncFavoritesWithInternetExplorer": {
"type": "boolean",
"description": "Enable favorites sync between Internet Explorer and Microsoft Edge. Additions, deletions, modifications and order changes to favorites are shared between browsers.",
"nullable": true
},
"cellularBlockDataWhenRoaming": {
"type": "boolean",
"description": "Whether or not to Block the user from using data over cellular while roaming.",
"nullable": true
},
"cellularBlockVpn": {
"type": "boolean",
"description": "Whether or not to Block the user from using VPN over cellular.",
"nullable": true
},
"cellularBlockVpnWhenRoaming": {
"type": "boolean",
"description": "Whether or not to Block the user from using VPN when roaming over cellular.",
"nullable": true
},
"defenderBlockEndUserAccess": {
"type": "boolean",
"description": "Whether or not to block end user access to Defender.",
"nullable": true
},
"defenderDaysBeforeDeletingQuarantinedMalware": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before deleting quarantined malware. Valid values 0 to 90",
"format": "int32",
"nullable": true
},
"defenderDetectedMalwareActions": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.defenderDetectedMalwareActions"
}
],
"description": "Gets or sets Defender’s actions to take on detected Malware per threat level.",
"nullable": true
},
"defenderSystemScanSchedule": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.weeklySchedule"
}
],
"description": "Defender day of the week for the system scan. Possible values are: userDefined, everyday, sunday, monday, tuesday, wednesday, thursday, friday, saturday.",
"nullable": true
},
"defenderFilesAndFoldersToExclude": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Files and folder to exclude from scans and real time protection."
},
"defenderFileExtensionsToExclude": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "File extensions to exclude from scans and real time protection."
},
"defenderScanMaxCpu": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Max CPU usage percentage during scan. Valid values 0 to 100",
"format": "int32",
"nullable": true
},
"defenderMonitorFileActivity": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.defenderMonitorFileActivity"
}
],
"description": "Value for monitoring file activity. Possible values are: userDefined, disable, monitorAllFiles, monitorIncomingFilesOnly, monitorOutgoingFilesOnly.",
"nullable": true
},
"defenderProcessesToExclude": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Processes to exclude from scans and real time protection."
},
"defenderPromptForSampleSubmission": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.defenderPromptForSampleSubmission"
}
],
"description": "The configuration for how to prompt user for sample submission. Possible values are: userDefined, alwaysPrompt, promptBeforeSendingPersonalData, neverSendData, sendAllDataWithoutPrompting.",
"nullable": true
},
"defenderRequireBehaviorMonitoring": {
"type": "boolean",
"description": "Indicates whether or not to require behavior monitoring.",
"nullable": true
},
"defenderRequireCloudProtection": {
"type": "boolean",
"description": "Indicates whether or not to require cloud protection.",
"nullable": true
},
"defenderRequireNetworkInspectionSystem": {
"type": "boolean",
"description": "Indicates whether or not to require network inspection system.",
"nullable": true
},
"defenderRequireRealTimeMonitoring": {
"type": "boolean",
"description": "Indicates whether or not to require real time monitoring.",
"nullable": true
},
"defenderScanArchiveFiles": {
"type": "boolean",
"description": "Indicates whether or not to scan archive files.",
"nullable": true
},
"defenderScanDownloads": {
"type": "boolean",
"description": "Indicates whether or not to scan downloads.",
"nullable": true
},
"defenderScanNetworkFiles": {
"type": "boolean",
"description": "Indicates whether or not to scan files opened from a network folder.",
"nullable": true
},
"defenderScanIncomingMail": {
"type": "boolean",
"description": "Indicates whether or not to scan incoming mail messages.",
"nullable": true
},
"defenderScanMappedNetworkDrivesDuringFullScan": {
"type": "boolean",
"description": "Indicates whether or not to scan mapped network drives during full scan.",
"nullable": true
},
"defenderScanRemovableDrivesDuringFullScan": {
"type": "boolean",
"description": "Indicates whether or not to scan removable drives during full scan.",
"nullable": true
},
"defenderScanScriptsLoadedInInternetExplorer": {
"type": "boolean",
"description": "Indicates whether or not to scan scripts loaded in Internet Explorer browser.",
"nullable": true
},
"defenderSignatureUpdateIntervalInHours": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The signature update interval in hours. Specify 0 not to check. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"defenderScanType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.defenderScanType"
}
],
"description": "The defender system scan type. Possible values are: userDefined, disabled, quick, full.",
"nullable": true
},
"defenderScheduledScanTime": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$",
"type": "string",
"description": "The defender time for the system scan.",
"format": "time",
"nullable": true
},
"defenderScheduledQuickScanTime": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$",
"type": "string",
"description": "The time to perform a daily quick scan.",
"format": "time",
"nullable": true
},
"defenderCloudBlockLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.defenderCloudBlockLevelType"
}
],
"description": "Specifies the level of cloud-delivered protection. Possible values are: notConfigured, high, highPlus, zeroTolerance.",
"nullable": true
},
"lockScreenAllowTimeoutConfiguration": {
"type": "boolean",
"description": "Specify whether to show a user-configurable setting to control the screen timeout while on the lock screen of Windows 10 Mobile devices. If this policy is set to Allow, the value set by lockScreenTimeoutInSeconds is ignored.",
"nullable": true
},
"lockScreenBlockActionCenterNotifications": {
"type": "boolean",
"description": "Indicates whether or not to block action center notifications over lock screen.",
"nullable": true
},
"lockScreenBlockCortana": {
"type": "boolean",
"description": "Indicates whether or not the user can interact with Cortana using speech while the system is locked.",
"nullable": true
},
"lockScreenBlockToastNotifications": {
"type": "boolean",
"description": "Indicates whether to allow toast notifications above the device lock screen.",
"nullable": true
},
"lockScreenTimeoutInSeconds": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Set the duration (in seconds) from the screen locking to the screen turning off for Windows 10 Mobile devices. Supported values are 11-1800. Valid values 11 to 1800",
"format": "int32",
"nullable": true
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Specify whether PINs or passwords such as '1111' or '1234' are allowed. For Windows 10 desktops, it also controls the use of picture passwords.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The password expiration in days. Valid values 0 to 730",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The minimum password length. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The minutes of inactivity before the screen times out.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of previous passwords to prevent reuse of. Valid values 0 to 50",
"format": "int32",
"nullable": true
},
"passwordRequired": {
"type": "boolean",
"description": "Indicates whether or not to require the user to have a password.",
"nullable": true
},
"passwordRequireWhenResumeFromIdleState": {
"type": "boolean",
"description": "Indicates whether or not to require a password upon resuming from an idle state.",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordSignInFailureCountBeforeFactoryReset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of sign in failures before factory reset. Valid values 0 to 999",
"format": "int32",
"nullable": true
},
"privacyAdvertisingId": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.stateManagementSetting"
}
],
"description": "Enables or disables the use of advertising ID. Added in Windows 10, version 1607. Possible values are: notConfigured, blocked, allowed.",
"nullable": true
},
"privacyAutoAcceptPairingAndConsentPrompts": {
"type": "boolean",
"description": "Indicates whether or not to allow the automatic acceptance of the pairing and privacy user consent dialog when launching apps.",
"nullable": true
},
"privacyBlockInputPersonalization": {
"type": "boolean",
"description": "Indicates whether or not to block the usage of cloud based speech services for Cortana, Dictation, or Store applications.",
"nullable": true
},
"startBlockUnpinningAppsFromTaskbar": {
"type": "boolean",
"description": "Indicates whether or not to block the user from unpinning apps from taskbar.",
"nullable": true
},
"startMenuAppListVisibility": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsStartMenuAppListVisibilityType"
}
],
"description": "Setting the value of this collapses the app list, removes the app list entirely, or disables the corresponding toggle in the Settings app. Possible values are: userDefined, collapse, remove, disableSettingsApp.",
"nullable": true
},
"startMenuHideChangeAccountSettings": {
"type": "boolean",
"description": "Enabling this policy hides the change account setting from appearing in the user tile in the start menu.",
"nullable": true
},
"startMenuHideFrequentlyUsedApps": {
"type": "boolean",
"description": "Enabling this policy hides the most used apps from appearing on the start menu and disables the corresponding toggle in the Settings app.",
"nullable": true
},
"startMenuHideHibernate": {
"type": "boolean",
"description": "Enabling this policy hides hibernate from appearing in the power button in the start menu.",
"nullable": true
},
"startMenuHideLock": {
"type": "boolean",
"description": "Enabling this policy hides lock from appearing in the user tile in the start menu.",
"nullable": true
},
"startMenuHidePowerButton": {
"type": "boolean",
"description": "Enabling this policy hides the power button from appearing in the start menu.",
"nullable": true
},
"startMenuHideRecentJumpLists": {
"type": "boolean",
"description": "Enabling this policy hides recent jump lists from appearing on the start menu/taskbar and disables the corresponding toggle in the Settings app.",
"nullable": true
},
"startMenuHideRecentlyAddedApps": {
"type": "boolean",
"description": "Enabling this policy hides recently added apps from appearing on the start menu and disables the corresponding toggle in the Settings app.",
"nullable": true
},
"startMenuHideRestartOptions": {
"type": "boolean",
"description": "Enabling this policy hides 'Restart/Update and Restart' from appearing in the power button in the start menu.",
"nullable": true
},
"startMenuHideShutDown": {
"type": "boolean",
"description": "Enabling this policy hides shut down/update and shut down from appearing in the power button in the start menu.",
"nullable": true
},
"startMenuHideSignOut": {
"type": "boolean",
"description": "Enabling this policy hides sign out from appearing in the user tile in the start menu.",
"nullable": true
},
"startMenuHideSleep": {
"type": "boolean",
"description": "Enabling this policy hides sleep from appearing in the power button in the start menu.",
"nullable": true
},
"startMenuHideSwitchAccount": {
"type": "boolean",
"description": "Enabling this policy hides switch account from appearing in the user tile in the start menu.",
"nullable": true
},
"startMenuHideUserTile": {
"type": "boolean",
"description": "Enabling this policy hides the user tile from appearing in the start menu.",
"nullable": true
},
"startMenuLayoutEdgeAssetsXml": {
"type": "string",
"description": "This policy setting allows you to import Edge assets to be used with startMenuLayoutXml policy. Start layout can contain secondary tile from Edge app which looks for Edge local asset file. Edge local asset would not exist and cause Edge secondary tile to appear empty in this case. This policy only gets applied when startMenuLayoutXml policy is modified. The value should be a UTF-8 Base64 encoded byte array.",
"format": "base64url",
"nullable": true
},
"startMenuLayoutXml": {
"type": "string",
"description": "Allows admins to override the default Start menu layout and prevents the user from changing it. The layout is modified by specifying an XML file based on a layout modification schema. XML needs to be in a UTF8 encoded byte array format.",
"format": "base64url",
"nullable": true
},
"startMenuMode": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsStartMenuModeType"
}
],
"description": "Allows admins to decide how the Start menu is displayed. Possible values are: userDefined, fullScreen, nonFullScreen.",
"nullable": true
},
"startMenuPinnedFolderDocuments": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Documents folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderDownloads": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Downloads folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderFileExplorer": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the FileExplorer shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderHomeGroup": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the HomeGroup folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderMusic": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Music folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderNetwork": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Network folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderPersonalFolder": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the PersonalFolder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderPictures": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Pictures folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Settings folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"startMenuPinnedFolderVideos": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.visibilitySetting"
}
],
"description": "Enforces the visibility (Show/Hide) of the Videos folder shortcut on the Start menu. Possible values are: notConfigured, hide, show.",
"nullable": true
},
"settingsBlockSettingsApp": {
"type": "boolean",
"description": "Indicates whether or not to block access to Settings app.",
"nullable": true
},
"settingsBlockSystemPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to System in Settings app.",
"nullable": true
},
"settingsBlockDevicesPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Devices in Settings app.",
"nullable": true
},
"settingsBlockNetworkInternetPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Network & Internet in Settings app.",
"nullable": true
},
"settingsBlockPersonalizationPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Personalization in Settings app.",
"nullable": true
},
"settingsBlockAccountsPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Accounts in Settings app.",
"nullable": true
},
"settingsBlockTimeLanguagePage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Time & Language in Settings app.",
"nullable": true
},
"settingsBlockEaseOfAccessPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Ease of Access in Settings app.",
"nullable": true
},
"settingsBlockPrivacyPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Privacy in Settings app.",
"nullable": true
},
"settingsBlockUpdateSecurityPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Update & Security in Settings app.",
"nullable": true
},
"settingsBlockAppsPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Apps in Settings app.",
"nullable": true
},
"settingsBlockGamingPage": {
"type": "boolean",
"description": "Indicates whether or not to block access to Gaming in Settings app.",
"nullable": true
},
"windowsSpotlightBlockConsumerSpecificFeatures": {
"type": "boolean",
"description": "Allows IT admins to block experiences that are typically for consumers only, such as Start suggestions, Membership notifications, Post-OOBE app install and redirect tiles.",
"nullable": true
},
"windowsSpotlightBlocked": {
"type": "boolean",
"description": "Allows IT admins to turn off all Windows Spotlight features",
"nullable": true
},
"windowsSpotlightBlockOnActionCenter": {
"type": "boolean",
"description": "Block suggestions from Microsoft that show after each OS clean install, upgrade or in an on-going basis to introduce users to what is new or changed",
"nullable": true
},
"windowsSpotlightBlockTailoredExperiences": {
"type": "boolean",
"description": "Block personalized content in Windows spotlight based on user’s device usage.",
"nullable": true
},
"windowsSpotlightBlockThirdPartyNotifications": {
"type": "boolean",
"description": "Block third party content delivered via Windows Spotlight",
"nullable": true
},
"windowsSpotlightBlockWelcomeExperience": {
"type": "boolean",
"description": "Block Windows Spotlight Windows welcome experience",
"nullable": true
},
"windowsSpotlightBlockWindowsTips": {
"type": "boolean",
"description": "Allows IT admins to turn off the popup of Windows Tips.",
"nullable": true
},
"windowsSpotlightConfigureOnLockScreen": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsSpotlightEnablementSettings"
}
],
"description": "Specifies the type of Spotlight. Possible values are: notConfigured, disabled, enabled.",
"nullable": true
},
"networkProxyApplySettingsDeviceWide": {
"type": "boolean",
"description": "If set, proxy settings will be applied to all processes and accounts in the device. Otherwise, it will be applied to the user account that’s enrolled into MDM.",
"nullable": true
},
"networkProxyDisableAutoDetect": {
"type": "boolean",
"description": "Disable automatic detection of settings. If enabled, the system will try to find the path to a proxy auto-config (PAC) script.",
"nullable": true
},
"networkProxyAutomaticConfigurationUrl": {
"type": "string",
"description": "Address to the proxy auto-config (PAC) script you want to use.",
"nullable": true
},
"networkProxyServer": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windows10NetworkProxyServer"
}
],
"description": "Specifies manual proxy server settings.",
"nullable": true
},
"accountsBlockAddingNonMicrosoftAccountEmail": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from adding email accounts to the device that are not associated with a Microsoft account.",
"nullable": true
},
"antiTheftModeBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the user from selecting an AntiTheft mode preference (Windows 10 Mobile only).",
"nullable": true
},
"bluetoothBlocked": {
"type": "boolean",
"description": "Whether or not to Block the user from using bluetooth.",
"nullable": true
},
"cameraBlocked": {
"type": "boolean",
"description": "Whether or not to Block the user from accessing the camera of the device.",
"nullable": true
},
"connectedDevicesServiceBlocked": {
"type": "boolean",
"description": "Whether or not to block Connected Devices Service which enables discovery and connection to other devices, remote messaging, remote app sessions and other cross-device experiences.",
"nullable": true
},
"certificatesBlockManualRootCertificateInstallation": {
"type": "boolean",
"description": "Whether or not to Block the user from doing manual root certificate installation.",
"nullable": true
},
"copyPasteBlocked": {
"type": "boolean",
"description": "Whether or not to Block the user from using copy paste.",
"nullable": true
},
"cortanaBlocked": {
"type": "boolean",
"description": "Whether or not to Block the user from using Cortana.",
"nullable": true
},
"deviceManagementBlockFactoryResetOnMobile": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from resetting their phone.",
"nullable": true
},
"deviceManagementBlockManualUnenroll": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from doing manual un-enrollment from device management.",
"nullable": true
},
"safeSearchFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.safeSearchFilterType"
}
],
"description": "Specifies what filter level of safe search is required. Possible values are: userDefined, strict, moderate.",
"nullable": true
},
"edgeBlockPopups": {
"type": "boolean",
"description": "Indicates whether or not to block popups.",
"nullable": true
},
"edgeBlockSearchSuggestions": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using the search suggestions in the address bar.",
"nullable": true
},
"edgeBlockSendingIntranetTrafficToInternetExplorer": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from sending Intranet traffic to Internet Explorer from Edge.",
"nullable": true
},
"edgeRequireSmartScreen": {
"type": "boolean",
"description": "Indicates whether or not to Require the user to use the smart screen filter.",
"nullable": true
},
"edgeEnterpriseModeSiteListLocation": {
"type": "string",
"description": "Indicates the enterprise mode site list location. Could be a local file, local network or http location.",
"nullable": true
},
"edgeFirstRunUrl": {
"type": "string",
"description": "The first run URL for when Edge browser is opened for the first time.",
"nullable": true
},
"edgeSearchEngine": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.edgeSearchEngineBase"
}
],
"description": "Allows IT admins to set a default search engine for MDM-Controlled devices. Users can override this and change their default search engine provided the AllowSearchEngineCustomization policy is not set.",
"nullable": true
},
"edgeHomepageUrls": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The list of URLs for homepages shodwn on MDM-enrolled devices on Edge browser."
},
"edgeBlockAccessToAboutFlags": {
"type": "boolean",
"description": "Indicates whether or not to prevent access to about flags on Edge browser.",
"nullable": true
},
"smartScreenBlockPromptOverride": {
"type": "boolean",
"description": "Indicates whether or not users can override SmartScreen Filter warnings about potentially malicious websites.",
"nullable": true
},
"smartScreenBlockPromptOverrideForFiles": {
"type": "boolean",
"description": "Indicates whether or not users can override the SmartScreen Filter warnings about downloading unverified files",
"nullable": true
},
"webRtcBlockLocalhostIpAddress": {
"type": "boolean",
"description": "Indicates whether or not user's localhost IP address is displayed while making phone calls using the WebRTC",
"nullable": true
},
"internetSharingBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using internet sharing.",
"nullable": true
},
"settingsBlockAddProvisioningPackage": {
"type": "boolean",
"description": "Indicates whether or not to block the user from installing provisioning packages.",
"nullable": true
},
"settingsBlockRemoveProvisioningPackage": {
"type": "boolean",
"description": "Indicates whether or not to block the runtime configuration agent from removing provisioning packages.",
"nullable": true
},
"settingsBlockChangeSystemTime": {
"type": "boolean",
"description": "Indicates whether or not to block the user from changing date and time settings.",
"nullable": true
},
"settingsBlockEditDeviceName": {
"type": "boolean",
"description": "Indicates whether or not to block the user from editing the device name.",
"nullable": true
},
"settingsBlockChangeRegion": {
"type": "boolean",
"description": "Indicates whether or not to block the user from changing the region settings.",
"nullable": true
},
"settingsBlockChangeLanguage": {
"type": "boolean",
"description": "Indicates whether or not to block the user from changing the language settings.",
"nullable": true
},
"settingsBlockChangePowerSleep": {
"type": "boolean",
"description": "Indicates whether or not to block the user from changing power and sleep settings.",
"nullable": true
},
"locationServicesBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from location services.",
"nullable": true
},
"microsoftAccountBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block a Microsoft account.",
"nullable": true
},
"microsoftAccountBlockSettingsSync": {
"type": "boolean",
"description": "Indicates whether or not to Block Microsoft account settings sync.",
"nullable": true
},
"nfcBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using near field communication.",
"nullable": true
},
"resetProtectionModeBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from reset protection mode.",
"nullable": true
},
"screenCaptureBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from taking Screenshots.",
"nullable": true
},
"storageBlockRemovableStorage": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using removable storage.",
"nullable": true
},
"storageRequireMobileDeviceEncryption": {
"type": "boolean",
"description": "Indicating whether or not to require encryption on a mobile device.",
"nullable": true
},
"usbBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from USB connection.",
"nullable": true
},
"voiceRecordingBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from voice recording.",
"nullable": true
},
"wiFiBlockAutomaticConnectHotspots": {
"type": "boolean",
"description": "Indicating whether or not to block automatically connecting to Wi-Fi hotspots. Has no impact if Wi-Fi is blocked.",
"nullable": true
},
"wiFiBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using Wi-Fi.",
"nullable": true
},
"wiFiBlockManualConfiguration": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using Wi-Fi manual configuration.",
"nullable": true
},
"wiFiScanInterval": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specify how often devices scan for Wi-Fi networks. Supported values are 1-500, where 100 = default, and 500 = low frequency. Valid values 1 to 500",
"format": "int32",
"nullable": true
},
"wirelessDisplayBlockProjectionToThisDevice": {
"type": "boolean",
"description": "Indicates whether or not to allow other devices from discovering this PC for projection.",
"nullable": true
},
"wirelessDisplayBlockUserInputFromReceiver": {
"type": "boolean",
"description": "Indicates whether or not to allow user input from wireless display receiver.",
"nullable": true
},
"wirelessDisplayRequirePinForPairing": {
"type": "boolean",
"description": "Indicates whether or not to require a PIN for new devices to initiate pairing.",
"nullable": true
},
"windowsStoreBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using the Windows store.",
"nullable": true
},
"appsAllowTrustedAppsSideloading": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.stateManagementSetting"
}
],
"description": "Indicates whether apps from AppX packages signed with a trusted certificate can be side loaded. Possible values are: notConfigured, blocked, allowed.",
"nullable": true
},
"windowsStoreBlockAutoUpdate": {
"type": "boolean",
"description": "Indicates whether or not to block automatic update of apps from Windows Store.",
"nullable": true
},
"developerUnlockSetting": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.stateManagementSetting"
}
],
"description": "Indicates whether or not to allow developer unlock. Possible values are: notConfigured, blocked, allowed.",
"nullable": true
},
"sharedUserAppDataAllowed": {
"type": "boolean",
"description": "Indicates whether or not to block multiple users of the same app to share data.",
"nullable": true
},
"appsBlockWindowsStoreOriginatedApps": {
"type": "boolean",
"description": "Indicates whether or not to disable the launch of all apps from Windows Store that came pre-installed or were downloaded.",
"nullable": true
},
"windowsStoreEnablePrivateStoreOnly": {
"type": "boolean",
"description": "Indicates whether or not to enable Private Store Only.",
"nullable": true
},
"storageRestrictAppDataToSystemVolume": {
"type": "boolean",
"description": "Indicates whether application data is restricted to the system drive.",
"nullable": true
},
"storageRestrictAppInstallToSystemVolume": {
"type": "boolean",
"description": "Indicates whether the installation of applications is restricted to the system drive.",
"nullable": true
},
"gameDvrBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block DVR and broadcasting.",
"nullable": true
},
"experienceBlockDeviceDiscovery": {
"type": "boolean",
"description": "Indicates whether or not to enable device discovery UX.",
"nullable": true
},
"experienceBlockErrorDialogWhenNoSIM": {
"type": "boolean",
"description": "Indicates whether or not to allow the error dialog from displaying if no SIM card is detected.",
"nullable": true
},
"experienceBlockTaskSwitcher": {
"type": "boolean",
"description": "Indicates whether or not to enable task switching on the device.",
"nullable": true
},
"logonBlockFastUserSwitching": {
"type": "boolean",
"description": "Disables the ability to quickly switch between users that are logged on simultaneously without logging off.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"enterpriseCloudPrintDiscoveryEndPoint": "string",
"enterpriseCloudPrintOAuthAuthority": "string",
"enterpriseCloudPrintOAuthClientIdentifier": "string",
"enterpriseCloudPrintResourceIdentifier": "string",
"enterpriseCloudPrintDiscoveryMaxLimit": "integer",
"enterpriseCloudPrintMopriaDiscoveryResourceIdentifier": "string",
"searchBlockDiacritics": true,
"searchDisableAutoLanguageDetection": true,
"searchDisableIndexingEncryptedItems": true,
"searchEnableRemoteQueries": true,
"searchDisableIndexerBackoff": true,
"searchDisableIndexingRemovableDrive": true,
"searchEnableAutomaticIndexSizeManangement": true,
"diagnosticsDataSubmissionMode": {
"@odata.type": "microsoft.graph.diagnosticDataSubmissionMode"
},
"oneDriveDisableFileSync": true,
"smartScreenEnableAppInstallControl": true,
"personalizationDesktopImageUrl": "string",
"personalizationLockScreenImageUrl": "string",
"bluetoothAllowedServices": [
"string"
],
"bluetoothBlockAdvertising": true,
"bluetoothBlockDiscoverableMode": true,
"bluetoothBlockPrePairing": true,
"edgeBlockAutofill": true,
"edgeBlocked": true,
"edgeCookiePolicy": {
"@odata.type": "microsoft.graph.edgeCookiePolicy"
},
"edgeBlockDeveloperTools": true,
"edgeBlockSendingDoNotTrackHeader": true,
"edgeBlockExtensions": true,
"edgeBlockInPrivateBrowsing": true,
"edgeBlockJavaScript": true,
"edgeBlockPasswordManager": true,
"edgeBlockAddressBarDropdown": true,
"edgeBlockCompatibilityList": true,
"edgeClearBrowsingDataOnExit": true,
"edgeAllowStartPagesModification": true,
"edgeDisableFirstRunPage": true,
"edgeBlockLiveTileDataCollection": true,
"edgeSyncFavoritesWithInternetExplorer": true,
"cellularBlockDataWhenRoaming": true,
"cellularBlockVpn": true,
"cellularBlockVpnWhenRoaming": true,
"defenderBlockEndUserAccess": true,
"defenderDaysBeforeDeletingQuarantinedMalware": "integer",
"defenderDetectedMalwareActions": {
"@odata.type": "microsoft.graph.defenderDetectedMalwareActions"
},
"defenderSystemScanSchedule": {
"@odata.type": "microsoft.graph.weeklySchedule"
},
"defenderFilesAndFoldersToExclude": [
"string"
],
"defenderFileExtensionsToExclude": [
"string"
],
"defenderScanMaxCpu": "integer",
"defenderMonitorFileActivity": {
"@odata.type": "microsoft.graph.defenderMonitorFileActivity"
},
"defenderProcessesToExclude": [
"string"
],
"defenderPromptForSampleSubmission": {
"@odata.type": "microsoft.graph.defenderPromptForSampleSubmission"
},
"defenderRequireBehaviorMonitoring": true,
"defenderRequireCloudProtection": true,
"defenderRequireNetworkInspectionSystem": true,
"defenderRequireRealTimeMonitoring": true,
"defenderScanArchiveFiles": true,
"defenderScanDownloads": true,
"defenderScanNetworkFiles": true,
"defenderScanIncomingMail": true,
"defenderScanMappedNetworkDrivesDuringFullScan": true,
"defenderScanRemovableDrivesDuringFullScan": true,
"defenderScanScriptsLoadedInInternetExplorer": true,
"defenderSignatureUpdateIntervalInHours": "integer",
"defenderScanType": {
"@odata.type": "microsoft.graph.defenderScanType"
},
"defenderScheduledScanTime": "string (timestamp)",
"defenderScheduledQuickScanTime": "string (timestamp)",
"defenderCloudBlockLevel": {
"@odata.type": "microsoft.graph.defenderCloudBlockLevelType"
},
"lockScreenAllowTimeoutConfiguration": true,
"lockScreenBlockActionCenterNotifications": true,
"lockScreenBlockCortana": true,
"lockScreenBlockToastNotifications": true,
"lockScreenTimeoutInSeconds": "integer",
"passwordBlockSimple": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeScreenTimeout": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordRequired": true,
"passwordRequireWhenResumeFromIdleState": true,
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordSignInFailureCountBeforeFactoryReset": "integer",
"privacyAdvertisingId": {
"@odata.type": "microsoft.graph.stateManagementSetting"
},
"privacyAutoAcceptPairingAndConsentPrompts": true,
"privacyBlockInputPersonalization": true,
"startBlockUnpinningAppsFromTaskbar": true,
"startMenuAppListVisibility": {
"@odata.type": "microsoft.graph.windowsStartMenuAppListVisibilityType"
},
"startMenuHideChangeAccountSettings": true,
"startMenuHideFrequentlyUsedApps": true,
"startMenuHideHibernate": true,
"startMenuHideLock": true,
"startMenuHidePowerButton": true,
"startMenuHideRecentJumpLists": true,
"startMenuHideRecentlyAddedApps": true,
"startMenuHideRestartOptions": true,
"startMenuHideShutDown": true,
"startMenuHideSignOut": true,
"startMenuHideSleep": true,
"startMenuHideSwitchAccount": true,
"startMenuHideUserTile": true,
"startMenuLayoutEdgeAssetsXml": "string",
"startMenuLayoutXml": "string",
"startMenuMode": {
"@odata.type": "microsoft.graph.windowsStartMenuModeType"
},
"startMenuPinnedFolderDocuments": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderDownloads": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderFileExplorer": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderHomeGroup": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderMusic": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderNetwork": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderPersonalFolder": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderPictures": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderSettings": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"startMenuPinnedFolderVideos": {
"@odata.type": "microsoft.graph.visibilitySetting"
},
"settingsBlockSettingsApp": true,
"settingsBlockSystemPage": true,
"settingsBlockDevicesPage": true,
"settingsBlockNetworkInternetPage": true,
"settingsBlockPersonalizationPage": true,
"settingsBlockAccountsPage": true,
"settingsBlockTimeLanguagePage": true,
"settingsBlockEaseOfAccessPage": true,
"settingsBlockPrivacyPage": true,
"settingsBlockUpdateSecurityPage": true,
"settingsBlockAppsPage": true,
"settingsBlockGamingPage": true,
"windowsSpotlightBlockConsumerSpecificFeatures": true,
"windowsSpotlightBlocked": true,
"windowsSpotlightBlockOnActionCenter": true,
"windowsSpotlightBlockTailoredExperiences": true,
"windowsSpotlightBlockThirdPartyNotifications": true,
"windowsSpotlightBlockWelcomeExperience": true,
"windowsSpotlightBlockWindowsTips": true,
"windowsSpotlightConfigureOnLockScreen": {
"@odata.type": "microsoft.graph.windowsSpotlightEnablementSettings"
},
"networkProxyApplySettingsDeviceWide": true,
"networkProxyDisableAutoDetect": true,
"networkProxyAutomaticConfigurationUrl": "string",
"networkProxyServer": {
"@odata.type": "microsoft.graph.windows10NetworkProxyServer"
},
"accountsBlockAddingNonMicrosoftAccountEmail": true,
"antiTheftModeBlocked": true,
"bluetoothBlocked": true,
"cameraBlocked": true,
"connectedDevicesServiceBlocked": true,
"certificatesBlockManualRootCertificateInstallation": true,
"copyPasteBlocked": true,
"cortanaBlocked": true,
"deviceManagementBlockFactoryResetOnMobile": true,
"deviceManagementBlockManualUnenroll": true,
"safeSearchFilter": {
"@odata.type": "microsoft.graph.safeSearchFilterType"
},
"edgeBlockPopups": true,
"edgeBlockSearchSuggestions": true,
"edgeBlockSendingIntranetTrafficToInternetExplorer": true,
"edgeRequireSmartScreen": true,
"edgeEnterpriseModeSiteListLocation": "string",
"edgeFirstRunUrl": "string",
"edgeSearchEngine": {
"@odata.type": "microsoft.graph.edgeSearchEngineBase"
},
"edgeHomepageUrls": [
"string"
],
"edgeBlockAccessToAboutFlags": true,
"smartScreenBlockPromptOverride": true,
"smartScreenBlockPromptOverrideForFiles": true,
"webRtcBlockLocalhostIpAddress": true,
"internetSharingBlocked": true,
"settingsBlockAddProvisioningPackage": true,
"settingsBlockRemoveProvisioningPackage": true,
"settingsBlockChangeSystemTime": true,
"settingsBlockEditDeviceName": true,
"settingsBlockChangeRegion": true,
"settingsBlockChangeLanguage": true,
"settingsBlockChangePowerSleep": true,
"locationServicesBlocked": true,
"microsoftAccountBlocked": true,
"microsoftAccountBlockSettingsSync": true,
"nfcBlocked": true,
"resetProtectionModeBlocked": true,
"screenCaptureBlocked": true,
"storageBlockRemovableStorage": true,
"storageRequireMobileDeviceEncryption": true,
"usbBlocked": true,
"voiceRecordingBlocked": true,
"wiFiBlockAutomaticConnectHotspots": true,
"wiFiBlocked": true,
"wiFiBlockManualConfiguration": true,
"wiFiScanInterval": "integer",
"wirelessDisplayBlockProjectionToThisDevice": true,
"wirelessDisplayBlockUserInputFromReceiver": true,
"wirelessDisplayRequirePinForPairing": true,
"windowsStoreBlocked": true,
"appsAllowTrustedAppsSideloading": {
"@odata.type": "microsoft.graph.stateManagementSetting"
},
"windowsStoreBlockAutoUpdate": true,
"developerUnlockSetting": {
"@odata.type": "microsoft.graph.stateManagementSetting"
},
"sharedUserAppDataAllowed": true,
"appsBlockWindowsStoreOriginatedApps": true,
"windowsStoreEnablePrivateStoreOnly": true,
"storageRestrictAppDataToSystemVolume": true,
"storageRestrictAppInstallToSystemVolume": true,
"gameDvrBlocked": true,
"experienceBlockDeviceDiscovery": true,
"experienceBlockErrorDialogWhenNoSIM": true,
"experienceBlockTaskSwitcher": true,
"logonBlockFastUserSwitching": true
}
},
"microsoft.graph.windows10MobileCompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "windows10MobileCompliancePolicy",
"type": "object",
"properties": {
"passwordRequired": {
"type": "boolean",
"description": "Require a password to unlock Windows Phone device.",
"nullable": true
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Whether or not to block syncing the calendar.",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum password length. Valid values 4 to 16",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of previous passwords to prevent re-use of.",
"format": "int32",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before password expiration. Valid values 1 to 255",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordRequireToUnlockFromIdle": {
"type": "boolean",
"description": "Require a password to unlock an idle device.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum Windows Phone version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum Windows Phone version.",
"nullable": true
},
"earlyLaunchAntiMalwareDriverEnabled": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation - early launch antimalware driver is enabled.",
"nullable": true
},
"bitLockerEnabled": {
"type": "boolean",
"description": "Require devices to be reported healthy by Windows Device Health Attestation - bit locker is enabled",
"nullable": true
},
"secureBootEnabled": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation - secure boot is enabled.",
"nullable": true
},
"codeIntegrityEnabled": {
"type": "boolean",
"description": "Require devices to be reported as healthy by Windows Device Health Attestation.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Require encryption on windows devices.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordRequired": true,
"passwordBlockSimple": true,
"passwordMinimumLength": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordPreviousPasswordBlockCount": "integer",
"passwordExpirationDays": "integer",
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordRequireToUnlockFromIdle": true,
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"earlyLaunchAntiMalwareDriverEnabled": true,
"bitLockerEnabled": true,
"secureBootEnabled": true,
"codeIntegrityEnabled": true,
"storageRequireEncryption": true
}
},
"microsoft.graph.windows10SecureAssessmentConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows10SecureAssessmentConfiguration",
"type": "object",
"properties": {
"launchUri": {
"type": "string",
"description": "Url link to an assessment that's automatically loaded when the secure assessment browser is launched. It has to be a valid Url (http[s]://msdn.microsoft.com/).",
"nullable": true
},
"configurationAccount": {
"type": "string",
"description": "The account used to configure the Windows device for taking the test. The user can be a domain account (domain/user), an AAD account (username@tenant.com) or a local account (username).",
"nullable": true
},
"allowPrinting": {
"type": "boolean",
"description": "Indicates whether or not to allow the app from printing during the test.",
"nullable": true
},
"allowScreenCapture": {
"type": "boolean",
"description": "Indicates whether or not to allow screen capture capability during a test.",
"nullable": true
},
"allowTextSuggestion": {
"type": "boolean",
"description": "Indicates whether or not to allow text suggestions during the test.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"launchUri": "string",
"configurationAccount": "string",
"allowPrinting": true,
"allowScreenCapture": true,
"allowTextSuggestion": true
}
},
"microsoft.graph.windows10TeamGeneralConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows10TeamGeneralConfiguration",
"type": "object",
"properties": {
"azureOperationalInsightsBlockTelemetry": {
"type": "boolean",
"description": "Indicates whether or not to Block Azure Operational Insights.",
"nullable": true
},
"azureOperationalInsightsWorkspaceId": {
"type": "string",
"description": "The Azure Operational Insights workspace id.",
"nullable": true
},
"azureOperationalInsightsWorkspaceKey": {
"type": "string",
"description": "The Azure Operational Insights Workspace key.",
"nullable": true
},
"connectAppBlockAutoLaunch": {
"type": "boolean",
"description": "Specifies whether to automatically launch the Connect app whenever a projection is initiated.",
"nullable": true
},
"maintenanceWindowBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block setting a maintenance window for device updates.",
"nullable": true
},
"maintenanceWindowDurationInHours": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Maintenance window duration for device updates. Valid values 0 to 5",
"format": "int32",
"nullable": true
},
"maintenanceWindowStartTime": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$",
"type": "string",
"description": "Maintenance window start time for device updates.",
"format": "time",
"nullable": true
},
"miracastChannel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.miracastChannel"
}
],
"description": "The channel. Possible values are: userDefined, one, two, three, four, five, six, seven, eight, nine, ten, eleven, thirtySix, forty, fortyFour, fortyEight, oneHundredFortyNine, oneHundredFiftyThree, oneHundredFiftySeven, oneHundredSixtyOne, oneHundredSixtyFive.",
"nullable": true
},
"miracastBlocked": {
"type": "boolean",
"description": "Indicates whether or not to Block wireless projection.",
"nullable": true
},
"miracastRequirePin": {
"type": "boolean",
"description": "Indicates whether or not to require a pin for wireless projection.",
"nullable": true
},
"settingsBlockMyMeetingsAndFiles": {
"type": "boolean",
"description": "Specifies whether to disable the 'My meetings and files' feature in the Start menu, which shows the signed-in user's meetings and files from Office 365.",
"nullable": true
},
"settingsBlockSessionResume": {
"type": "boolean",
"description": "Specifies whether to allow the ability to resume a session when the session times out.",
"nullable": true
},
"settingsBlockSigninSuggestions": {
"type": "boolean",
"description": "Specifies whether to disable auto-populating of the sign-in dialog with invitees from scheduled meetings.",
"nullable": true
},
"settingsDefaultVolume": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specifies the default volume value for a new session. Permitted values are 0-100. The default is 45. Valid values 0 to 100",
"format": "int32",
"nullable": true
},
"settingsScreenTimeoutInMinutes": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specifies the number of minutes until the Hub screen turns off.",
"format": "int32",
"nullable": true
},
"settingsSessionTimeoutInMinutes": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specifies the number of minutes until the session times out.",
"format": "int32",
"nullable": true
},
"settingsSleepTimeoutInMinutes": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specifies the number of minutes until the Hub enters sleep mode.",
"format": "int32",
"nullable": true
},
"welcomeScreenBlockAutomaticWakeUp": {
"type": "boolean",
"description": "Indicates whether or not to Block the welcome screen from waking up automatically when someone enters the room.",
"nullable": true
},
"welcomeScreenBackgroundImageUrl": {
"type": "string",
"description": "The welcome screen background image URL. The URL must use the HTTPS protocol and return a PNG image.",
"nullable": true
},
"welcomeScreenMeetingInformation": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.welcomeScreenMeetingInformation"
}
],
"description": "The welcome screen meeting information shown. Possible values are: userDefined, showOrganizerAndTimeOnly, showOrganizerAndTimeAndSubject.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"azureOperationalInsightsBlockTelemetry": true,
"azureOperationalInsightsWorkspaceId": "string",
"azureOperationalInsightsWorkspaceKey": "string",
"connectAppBlockAutoLaunch": true,
"maintenanceWindowBlocked": true,
"maintenanceWindowDurationInHours": "integer",
"maintenanceWindowStartTime": "string (timestamp)",
"miracastChannel": {
"@odata.type": "microsoft.graph.miracastChannel"
},
"miracastBlocked": true,
"miracastRequirePin": true,
"settingsBlockMyMeetingsAndFiles": true,
"settingsBlockSessionResume": true,
"settingsBlockSigninSuggestions": true,
"settingsDefaultVolume": "integer",
"settingsScreenTimeoutInMinutes": "integer",
"settingsSessionTimeoutInMinutes": "integer",
"settingsSleepTimeoutInMinutes": "integer",
"welcomeScreenBlockAutomaticWakeUp": true,
"welcomeScreenBackgroundImageUrl": "string",
"welcomeScreenMeetingInformation": {
"@odata.type": "microsoft.graph.welcomeScreenMeetingInformation"
}
}
},
"microsoft.graph.windows81CompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "windows81CompliancePolicy",
"type": "object",
"properties": {
"passwordRequired": {
"type": "boolean",
"description": "Require a password to unlock Windows device.",
"nullable": true
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Indicates whether or not to block simple password.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Password expiration in days.",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The minimum password length.",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of previous passwords to prevent re-use of. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum Windows 8.1 version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum Windows 8.1 version.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Indicates whether or not to require encryption on a windows 8.1 device.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordRequired": true,
"passwordBlockSimple": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordPreviousPasswordBlockCount": "integer",
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"storageRequireEncryption": true
}
},
"microsoft.graph.windows81GeneralConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windows81GeneralConfiguration",
"type": "object",
"properties": {
"accountsBlockAddingNonMicrosoftAccountEmail": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from adding email accounts to the device that are not associated with a Microsoft account.",
"nullable": true
},
"applyOnlyToWindows81": {
"type": "boolean",
"description": "Value indicating whether this policy only applies to Windows 8.1. This property is read-only.",
"nullable": true
},
"browserBlockAutofill": {
"type": "boolean",
"description": "Indicates whether or not to block auto fill.",
"nullable": true
},
"browserBlockAutomaticDetectionOfIntranetSites": {
"type": "boolean",
"description": "Indicates whether or not to block automatic detection of Intranet sites.",
"nullable": true
},
"browserBlockEnterpriseModeAccess": {
"type": "boolean",
"description": "Indicates whether or not to block enterprise mode access.",
"nullable": true
},
"browserBlockJavaScript": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using JavaScript.",
"nullable": true
},
"browserBlockPlugins": {
"type": "boolean",
"description": "Indicates whether or not to block plug-ins.",
"nullable": true
},
"browserBlockPopups": {
"type": "boolean",
"description": "Indicates whether or not to block popups.",
"nullable": true
},
"browserBlockSendingDoNotTrackHeader": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from sending the do not track header.",
"nullable": true
},
"browserBlockSingleWordEntryOnIntranetSites": {
"type": "boolean",
"description": "Indicates whether or not to block a single word entry on Intranet sites.",
"nullable": true
},
"browserRequireSmartScreen": {
"type": "boolean",
"description": "Indicates whether or not to require the user to use the smart screen filter.",
"nullable": true
},
"browserEnterpriseModeSiteListLocation": {
"type": "string",
"description": "The enterprise mode site list location. Could be a local file, local network or http location.",
"nullable": true
},
"browserInternetSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.internetSiteSecurityLevel"
}
],
"description": "The internet security level. Possible values are: userDefined, medium, mediumHigh, high.",
"nullable": true
},
"browserIntranetSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.siteSecurityLevel"
}
],
"description": "The Intranet security level. Possible values are: userDefined, low, mediumLow, medium, mediumHigh, high.",
"nullable": true
},
"browserLoggingReportLocation": {
"type": "string",
"description": "The logging report location.",
"nullable": true
},
"browserRequireHighSecurityForRestrictedSites": {
"type": "boolean",
"description": "Indicates whether or not to require high security for restricted sites.",
"nullable": true
},
"browserRequireFirewall": {
"type": "boolean",
"description": "Indicates whether or not to require a firewall.",
"nullable": true
},
"browserRequireFraudWarning": {
"type": "boolean",
"description": "Indicates whether or not to require fraud warning.",
"nullable": true
},
"browserTrustedSitesSecurityLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.siteSecurityLevel"
}
],
"description": "The trusted sites security level. Possible values are: userDefined, low, mediumLow, medium, mediumHigh, high.",
"nullable": true
},
"cellularBlockDataRoaming": {
"type": "boolean",
"description": "Indicates whether or not to block data roaming.",
"nullable": true
},
"diagnosticsBlockDataSubmission": {
"type": "boolean",
"description": "Indicates whether or not to block diagnostic data submission.",
"nullable": true
},
"passwordBlockPicturePasswordAndPin": {
"type": "boolean",
"description": "Indicates whether or not to Block the user from using a pictures password and pin.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Password expiration in days.",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The minimum password length.",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The minutes of inactivity before the screen times out.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of previous passwords to prevent re-use of. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordSignInFailureCountBeforeFactoryReset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of sign in failures before factory reset.",
"format": "int32",
"nullable": true
},
"storageRequireDeviceEncryption": {
"type": "boolean",
"description": "Indicates whether or not to require encryption on a mobile device.",
"nullable": true
},
"updatesRequireAutomaticUpdates": {
"type": "boolean",
"description": "Indicates whether or not to require automatic updates.",
"nullable": true
},
"userAccountControlSettings": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsUserAccountControlSettings"
}
],
"description": "The user account control settings. Possible values are: userDefined, alwaysNotify, notifyOnAppChanges, notifyOnAppChangesWithoutDimming, neverNotify.",
"nullable": true
},
"workFoldersUrl": {
"type": "string",
"description": "The work folders url.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"accountsBlockAddingNonMicrosoftAccountEmail": true,
"applyOnlyToWindows81": true,
"browserBlockAutofill": true,
"browserBlockAutomaticDetectionOfIntranetSites": true,
"browserBlockEnterpriseModeAccess": true,
"browserBlockJavaScript": true,
"browserBlockPlugins": true,
"browserBlockPopups": true,
"browserBlockSendingDoNotTrackHeader": true,
"browserBlockSingleWordEntryOnIntranetSites": true,
"browserRequireSmartScreen": true,
"browserEnterpriseModeSiteListLocation": "string",
"browserInternetSecurityLevel": {
"@odata.type": "microsoft.graph.internetSiteSecurityLevel"
},
"browserIntranetSecurityLevel": {
"@odata.type": "microsoft.graph.siteSecurityLevel"
},
"browserLoggingReportLocation": "string",
"browserRequireHighSecurityForRestrictedSites": true,
"browserRequireFirewall": true,
"browserRequireFraudWarning": true,
"browserTrustedSitesSecurityLevel": {
"@odata.type": "microsoft.graph.siteSecurityLevel"
},
"cellularBlockDataRoaming": true,
"diagnosticsBlockDataSubmission": true,
"passwordBlockPicturePasswordAndPin": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeScreenTimeout": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordSignInFailureCountBeforeFactoryReset": "integer",
"storageRequireDeviceEncryption": true,
"updatesRequireAutomaticUpdates": true,
"userAccountControlSettings": {
"@odata.type": "microsoft.graph.windowsUserAccountControlSettings"
},
"workFoldersUrl": "string"
}
},
"microsoft.graph.windowsDefenderAdvancedThreatProtectionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windowsDefenderAdvancedThreatProtectionConfiguration",
"type": "object",
"properties": {
"allowSampleSharing": {
"type": "boolean",
"description": "Windows Defender AdvancedThreatProtection 'Allow Sample Sharing' Rule",
"nullable": true
},
"enableExpeditedTelemetryReporting": {
"type": "boolean",
"description": "Expedite Windows Defender Advanced Threat Protection telemetry reporting frequency.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"allowSampleSharing": true,
"enableExpeditedTelemetryReporting": true
}
},
"microsoft.graph.windowsPhone81CompliancePolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCompliancePolicy"
},
{
"title": "windowsPhone81CompliancePolicy",
"type": "object",
"properties": {
"passwordBlockSimple": {
"type": "boolean",
"description": "Whether or not to block syncing the calendar.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires.",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passwords.",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before a password is required.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of character sets required in the password.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "The required password type. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"passwordRequired": {
"type": "boolean",
"description": "Whether or not to require a password.",
"nullable": true
},
"osMinimumVersion": {
"type": "string",
"description": "Minimum Windows Phone version.",
"nullable": true
},
"osMaximumVersion": {
"type": "string",
"description": "Maximum Windows Phone version.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Require encryption on windows phone devices.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"description": "string",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"version": "integer",
"scheduledActionsForRule": [
{
"@odata.type": "microsoft.graph.deviceComplianceScheduledActionForRule"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceComplianceUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceComplianceUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.deviceCompliancePolicyAssignment"
}
],
"passwordBlockSimple": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeLock": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordPreviousPasswordBlockCount": "integer",
"passwordRequired": true,
"osMinimumVersion": "string",
"osMaximumVersion": "string",
"storageRequireEncryption": true
}
},
"microsoft.graph.windowsPhone81CustomConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windowsPhone81CustomConfiguration",
"type": "object",
"properties": {
"omaSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.omaSetting"
}
],
"nullable": true
},
"description": "OMA settings. This collection can contain a maximum of 1000 elements."
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"omaSettings": [
{
"@odata.type": "microsoft.graph.omaSetting"
}
]
}
},
"microsoft.graph.windowsPhone81GeneralConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windowsPhone81GeneralConfiguration",
"type": "object",
"properties": {
"applyOnlyToWindowsPhone81": {
"type": "boolean",
"description": "Value indicating whether this policy only applies to Windows Phone 8.1. This property is read-only.",
"nullable": true
},
"appsBlockCopyPaste": {
"type": "boolean",
"description": "Indicates whether or not to block copy paste.",
"nullable": true
},
"bluetoothBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block bluetooth.",
"nullable": true
},
"cameraBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block camera.",
"nullable": true
},
"cellularBlockWifiTethering": {
"type": "boolean",
"description": "Indicates whether or not to block Wi-Fi tethering. Has no impact if Wi-Fi is blocked.",
"nullable": true
},
"compliantAppsList": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListItem"
}
],
"nullable": true
},
"description": "List of apps in the compliance (either allow list or block list, controlled by CompliantAppListType). This collection can contain a maximum of 10000 elements."
},
"compliantAppListType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.appListType"
}
],
"description": "List that is in the AppComplianceList. Possible values are: none, appsInListCompliant, appsNotInListCompliant.",
"nullable": true
},
"diagnosticDataBlockSubmission": {
"type": "boolean",
"description": "Indicates whether or not to block diagnostic data submission.",
"nullable": true
},
"emailBlockAddingAccounts": {
"type": "boolean",
"description": "Indicates whether or not to block custom email accounts.",
"nullable": true
},
"locationServicesBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block location services.",
"nullable": true
},
"microsoftAccountBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block using a Microsoft Account.",
"nullable": true
},
"nfcBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block Near-Field Communication.",
"nullable": true
},
"passwordBlockSimple": {
"type": "boolean",
"description": "Indicates whether or not to block syncing the calendar.",
"nullable": true
},
"passwordExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of days before the password expires.",
"format": "int32",
"nullable": true
},
"passwordMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum length of passwords.",
"format": "int32",
"nullable": true
},
"passwordMinutesOfInactivityBeforeScreenTimeout": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minutes of inactivity before screen timeout.",
"format": "int32",
"nullable": true
},
"passwordMinimumCharacterSetCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of character sets a password must contain.",
"format": "int32",
"nullable": true
},
"passwordPreviousPasswordBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of previous passwords to block. Valid values 0 to 24",
"format": "int32",
"nullable": true
},
"passwordSignInFailureCountBeforeFactoryReset": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Number of sign in failures allowed before factory reset.",
"format": "int32",
"nullable": true
},
"passwordRequiredType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.requiredPasswordType"
}
],
"description": "Password type that is required. Possible values are: deviceDefault, alphanumeric, numeric.",
"nullable": true
},
"passwordRequired": {
"type": "boolean",
"description": "Indicates whether or not to require a password.",
"nullable": true
},
"screenCaptureBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block screenshots.",
"nullable": true
},
"storageBlockRemovableStorage": {
"type": "boolean",
"description": "Indicates whether or not to block removable storage.",
"nullable": true
},
"storageRequireEncryption": {
"type": "boolean",
"description": "Indicates whether or not to require encryption.",
"nullable": true
},
"webBrowserBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the web browser.",
"nullable": true
},
"wifiBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block Wi-Fi.",
"nullable": true
},
"wifiBlockAutomaticConnectHotspots": {
"type": "boolean",
"description": "Indicates whether or not to block automatically connecting to Wi-Fi hotspots. Has no impact if Wi-Fi is blocked.",
"nullable": true
},
"wifiBlockHotspotReporting": {
"type": "boolean",
"description": "Indicates whether or not to block Wi-Fi hotspot reporting. Has no impact if Wi-Fi is blocked.",
"nullable": true
},
"windowsStoreBlocked": {
"type": "boolean",
"description": "Indicates whether or not to block the Windows Store.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"applyOnlyToWindowsPhone81": true,
"appsBlockCopyPaste": true,
"bluetoothBlocked": true,
"cameraBlocked": true,
"cellularBlockWifiTethering": true,
"compliantAppsList": [
{
"@odata.type": "microsoft.graph.appListItem"
}
],
"compliantAppListType": {
"@odata.type": "microsoft.graph.appListType"
},
"diagnosticDataBlockSubmission": true,
"emailBlockAddingAccounts": true,
"locationServicesBlocked": true,
"microsoftAccountBlocked": true,
"nfcBlocked": true,
"passwordBlockSimple": true,
"passwordExpirationDays": "integer",
"passwordMinimumLength": "integer",
"passwordMinutesOfInactivityBeforeScreenTimeout": "integer",
"passwordMinimumCharacterSetCount": "integer",
"passwordPreviousPasswordBlockCount": "integer",
"passwordSignInFailureCountBeforeFactoryReset": "integer",
"passwordRequiredType": {
"@odata.type": "microsoft.graph.requiredPasswordType"
},
"passwordRequired": true,
"screenCaptureBlocked": true,
"storageBlockRemovableStorage": true,
"storageRequireEncryption": true,
"webBrowserBlocked": true,
"wifiBlocked": true,
"wifiBlockAutomaticConnectHotspots": true,
"wifiBlockHotspotReporting": true,
"windowsStoreBlocked": true
}
},
"microsoft.graph.windowsUpdateForBusinessConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceConfiguration"
},
{
"title": "windowsUpdateForBusinessConfiguration",
"type": "object",
"properties": {
"deliveryOptimizationMode": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsDeliveryOptimizationMode"
}
],
"description": "Delivery Optimization Mode. Possible values are: userDefined, httpOnly, httpWithPeeringNat, httpWithPeeringPrivateGroup, httpWithInternetPeering, simpleDownload, bypassMode.",
"nullable": true
},
"prereleaseFeatures": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.prereleaseFeatures"
}
],
"description": "The pre-release features. Possible values are: userDefined, settingsOnly, settingsAndExperimentations, notAllowed.",
"nullable": true
},
"automaticUpdateMode": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.automaticUpdateMode"
}
],
"description": "Automatic update mode. Possible values are: userDefined, notifyDownload, autoInstallAtMaintenanceTime, autoInstallAndRebootAtMaintenanceTime, autoInstallAndRebootAtScheduledTime, autoInstallAndRebootWithoutEndUserControl.",
"nullable": true
},
"microsoftUpdateServiceAllowed": {
"type": "boolean",
"description": "Allow Microsoft Update Service",
"nullable": true
},
"driversExcluded": {
"type": "boolean",
"description": "Exclude Windows update Drivers",
"nullable": true
},
"installationSchedule": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsUpdateInstallScheduleType"
}
],
"description": "Installation schedule",
"nullable": true
},
"qualityUpdatesDeferralPeriodInDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Defer Quality Updates by these many days",
"format": "int32",
"nullable": true
},
"featureUpdatesDeferralPeriodInDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Defer Feature Updates by these many days",
"format": "int32",
"nullable": true
},
"qualityUpdatesPaused": {
"type": "boolean",
"description": "Pause Quality Updates",
"nullable": true
},
"featureUpdatesPaused": {
"type": "boolean",
"description": "Pause Feature Updates",
"nullable": true
},
"qualityUpdatesPauseExpiryDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Quality Updates Pause Expiry datetime",
"format": "date-time",
"nullable": true
},
"featureUpdatesPauseExpiryDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Feature Updates Pause Expiry datetime",
"format": "date-time",
"nullable": true
},
"businessReadyUpdatesOnly": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsUpdateType"
}
],
"description": "Determines which branch devices will receive their updates from. Possible values are: userDefined, all, businessReadyOnly, windowsInsiderBuildFast, windowsInsiderBuildSlow, windowsInsiderBuildRelease.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"createdDateTime": "string (timestamp)",
"description": "string",
"displayName": "string",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.deviceConfigurationAssignment"
}
],
"deviceStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationDeviceStatus"
}
],
"userStatuses": [
{
"@odata.type": "microsoft.graph.deviceConfigurationUserStatus"
}
],
"deviceStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationDeviceOverview"
},
"userStatusOverview": {
"@odata.type": "microsoft.graph.deviceConfigurationUserOverview"
},
"deviceSettingStateSummaries": [
{
"@odata.type": "microsoft.graph.settingStateDeviceSummary"
}
],
"deliveryOptimizationMode": {
"@odata.type": "microsoft.graph.windowsDeliveryOptimizationMode"
},
"prereleaseFeatures": {
"@odata.type": "microsoft.graph.prereleaseFeatures"
},
"automaticUpdateMode": {
"@odata.type": "microsoft.graph.automaticUpdateMode"
},
"microsoftUpdateServiceAllowed": true,
"driversExcluded": true,
"installationSchedule": {
"@odata.type": "microsoft.graph.windowsUpdateInstallScheduleType"
},
"qualityUpdatesDeferralPeriodInDays": "integer",
"featureUpdatesDeferralPeriodInDays": "integer",
"qualityUpdatesPaused": true,
"featureUpdatesPaused": true,
"qualityUpdatesPauseExpiryDateTime": "string (timestamp)",
"featureUpdatesPauseExpiryDateTime": "string (timestamp)",
"businessReadyUpdatesOnly": {
"@odata.type": "microsoft.graph.windowsUpdateType"
}
}
},
"microsoft.graph.applePushNotificationCertificate": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "applePushNotificationCertificate",
"type": "object",
"properties": {
"appleIdentifier": {
"type": "string",
"description": "Apple Id of the account used to create the MDM push certificate.",
"nullable": true
},
"topicIdentifier": {
"type": "string",
"description": "Topic Id.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modified date and time for Apple push notification certificate.",
"format": "date-time",
"nullable": true
},
"expirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The expiration date and time for Apple push notification certificate.",
"format": "date-time",
"nullable": true
},
"certificate": {
"type": "string",
"description": "Not yet documented",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"appleIdentifier": "string",
"topicIdentifier": "string",
"lastModifiedDateTime": "string (timestamp)",
"expirationDateTime": "string (timestamp)",
"certificate": "string"
}
},
"microsoft.graph.detectedApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "detectedApp",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Name of the discovered application. Read-only",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the discovered application. Read-only",
"nullable": true
},
"sizeInByte": {
"type": "integer",
"description": "Discovered application size in bytes. Read-only",
"format": "int64",
"nullable": true
},
"deviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of devices that have installed this application",
"format": "int32",
"nullable": true
},
"managedDevices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedDevice"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"version": "string",
"sizeInByte": "integer",
"deviceCount": "integer",
"managedDevices": [
{
"@odata.type": "microsoft.graph.managedDevice"
}
]
}
},
"microsoft.graph.managedDevice": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDevice",
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Unique Identifier for the user associated with the device",
"nullable": true
},
"deviceName": {
"type": "string",
"description": "Name of the device",
"nullable": true
},
"managedDeviceOwnerType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedDeviceOwnerType"
}
],
"description": "Ownership of the device. Can be 'company' or 'personal'. Possible values are: unknown, company, personal.",
"nullable": true
},
"deviceActionResults": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceActionResult"
}
],
"nullable": true
},
"description": "List of ComplexType deviceActionResult objects."
},
"enrolledDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Enrollment time of the device.",
"format": "date-time",
"nullable": true
},
"lastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time that the device last completed a successful sync with Intune.",
"format": "date-time",
"nullable": true
},
"operatingSystem": {
"type": "string",
"description": "Operating system of the device. Windows, iOS, etc.",
"nullable": true
},
"complianceState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.complianceState"
}
],
"description": "Compliance state of the device. Possible values are: unknown, compliant, noncompliant, conflict, error, inGracePeriod, configManager.",
"nullable": true
},
"jailBroken": {
"type": "string",
"description": "whether the device is jail broken or rooted.",
"nullable": true
},
"managementAgent": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managementAgentType"
}
],
"description": "Management channel of the device. Intune, EAS, etc. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.",
"nullable": true
},
"osVersion": {
"type": "string",
"description": "Operating system version of the device.",
"nullable": true
},
"easActivated": {
"type": "boolean",
"description": "Whether the device is Exchange ActiveSync activated.",
"nullable": true
},
"easDeviceId": {
"type": "string",
"description": "Exchange ActiveSync Id of the device.",
"nullable": true
},
"easActivationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Exchange ActivationSync activation time of the device.",
"format": "date-time",
"nullable": true
},
"azureADRegistered": {
"type": "boolean",
"description": "Whether the device is Azure Active Directory registered.",
"nullable": true
},
"deviceEnrollmentType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentType"
}
],
"description": "Enrollment type of the device. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement.",
"nullable": true
},
"activationLockBypassCode": {
"type": "string",
"description": "Code that allows the Activation Lock on a device to be bypassed.",
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "Email(s) for the user associated with the device",
"nullable": true
},
"azureADDeviceId": {
"type": "string",
"description": "The unique identifier for the Azure Active Directory device. Read only.",
"nullable": true
},
"deviceRegistrationState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceRegistrationState"
}
],
"description": "Device registration state. Possible values are: notRegistered, registered, revoked, keyConflict, approvalPending, certificateReset, notRegisteredPendingEnrollment, unknown.",
"nullable": true
},
"deviceCategoryDisplayName": {
"type": "string",
"description": "Device category display name",
"nullable": true
},
"isSupervised": {
"type": "boolean",
"description": "Device supervised status",
"nullable": true
},
"exchangeLastSuccessfulSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last time the device contacted Exchange.",
"format": "date-time",
"nullable": true
},
"exchangeAccessState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceManagementExchangeAccessState"
}
],
"description": "The Access State of the device in Exchange. Possible values are: none, unknown, allowed, blocked, quarantined.",
"nullable": true
},
"exchangeAccessStateReason": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceManagementExchangeAccessStateReason"
}
],
"description": "The reason for the device's access state in Exchange. Possible values are: none, unknown, exchangeGlobalRule, exchangeIndividualRule, exchangeDeviceRule, exchangeUpgrade, exchangeMailboxPolicy, other, compliant, notCompliant, notEnrolled, unknownLocation, mfaRequired, azureADBlockDueToAccessPolicy, compromisedPassword, deviceNotKnownWithManagedApp.",
"nullable": true
},
"remoteAssistanceSessionUrl": {
"type": "string",
"description": "Url that allows a Remote Assistance session to be established with the device.",
"nullable": true
},
"remoteAssistanceSessionErrorDetails": {
"type": "string",
"description": "An error string that identifies issues when creating Remote Assistance session objects.",
"nullable": true
},
"isEncrypted": {
"type": "boolean",
"description": "Device encryption status",
"nullable": true
},
"userPrincipalName": {
"type": "string",
"description": "Device user principal name",
"nullable": true
},
"model": {
"type": "string",
"description": "Model of the device",
"nullable": true
},
"manufacturer": {
"type": "string",
"description": "Manufacturer of the device",
"nullable": true
},
"imei": {
"type": "string",
"description": "IMEI",
"nullable": true
},
"complianceGracePeriodExpirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The DateTime when device compliance grace period expires",
"format": "date-time",
"nullable": true
},
"serialNumber": {
"type": "string",
"description": "SerialNumber",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "Phone number of the device",
"nullable": true
},
"androidSecurityPatchLevel": {
"type": "string",
"description": "Android security patch level",
"nullable": true
},
"userDisplayName": {
"type": "string",
"description": "User display name",
"nullable": true
},
"configurationManagerClientEnabledFeatures": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.configurationManagerClientEnabledFeatures"
}
],
"description": "ConfigrMgr client enabled features",
"nullable": true
},
"wiFiMacAddress": {
"type": "string",
"description": "Wi-Fi MAC",
"nullable": true
},
"deviceHealthAttestationState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceHealthAttestationState"
}
],
"description": "The device health attestation state.",
"nullable": true
},
"subscriberCarrier": {
"type": "string",
"description": "Subscriber Carrier",
"nullable": true
},
"meid": {
"type": "string",
"description": "MEID",
"nullable": true
},
"totalStorageSpaceInBytes": {
"type": "integer",
"description": "Total Storage in Bytes",
"format": "int64",
"nullable": true
},
"freeStorageSpaceInBytes": {
"type": "integer",
"description": "Free Storage in Bytes",
"format": "int64",
"nullable": true
},
"managedDeviceName": {
"type": "string",
"description": "Automatically generated name to identify a device. Can be overwritten to a user friendly name.",
"nullable": true
},
"partnerReportedThreatState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedDevicePartnerReportedHealthState"
}
],
"description": "Indicates the threat state of a device when a Mobile Threat Defense partner is in use by the account and device. Read Only. Possible values are: unknown, activated, deactivated, secured, lowSeverity, mediumSeverity, highSeverity, unresponsive, compromised, misconfigured.",
"nullable": true
},
"deviceCategory": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceCategory"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"userId": "string",
"deviceName": "string",
"managedDeviceOwnerType": {
"@odata.type": "microsoft.graph.managedDeviceOwnerType"
},
"deviceActionResults": [
{
"@odata.type": "microsoft.graph.deviceActionResult"
}
],
"enrolledDateTime": "string (timestamp)",
"lastSyncDateTime": "string (timestamp)",
"operatingSystem": "string",
"complianceState": {
"@odata.type": "microsoft.graph.complianceState"
},
"jailBroken": "string",
"managementAgent": {
"@odata.type": "microsoft.graph.managementAgentType"
},
"osVersion": "string",
"easActivated": true,
"easDeviceId": "string",
"easActivationDateTime": "string (timestamp)",
"azureADRegistered": true,
"deviceEnrollmentType": {
"@odata.type": "microsoft.graph.deviceEnrollmentType"
},
"activationLockBypassCode": "string",
"emailAddress": "string",
"azureADDeviceId": "string",
"deviceRegistrationState": {
"@odata.type": "microsoft.graph.deviceRegistrationState"
},
"deviceCategoryDisplayName": "string",
"isSupervised": true,
"exchangeLastSuccessfulSyncDateTime": "string (timestamp)",
"exchangeAccessState": {
"@odata.type": "microsoft.graph.deviceManagementExchangeAccessState"
},
"exchangeAccessStateReason": {
"@odata.type": "microsoft.graph.deviceManagementExchangeAccessStateReason"
},
"remoteAssistanceSessionUrl": "string",
"remoteAssistanceSessionErrorDetails": "string",
"isEncrypted": true,
"userPrincipalName": "string",
"model": "string",
"manufacturer": "string",
"imei": "string",
"complianceGracePeriodExpirationDateTime": "string (timestamp)",
"serialNumber": "string",
"phoneNumber": "string",
"androidSecurityPatchLevel": "string",
"userDisplayName": "string",
"configurationManagerClientEnabledFeatures": {
"@odata.type": "microsoft.graph.configurationManagerClientEnabledFeatures"
},
"wiFiMacAddress": "string",
"deviceHealthAttestationState": {
"@odata.type": "microsoft.graph.deviceHealthAttestationState"
},
"subscriberCarrier": "string",
"meid": "string",
"totalStorageSpaceInBytes": "integer",
"freeStorageSpaceInBytes": "integer",
"managedDeviceName": "string",
"partnerReportedThreatState": {
"@odata.type": "microsoft.graph.managedDevicePartnerReportedHealthState"
},
"deviceCategory": {
"@odata.type": "microsoft.graph.deviceCategory"
}
}
},
"microsoft.graph.managedDeviceOverview": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedDeviceOverview",
"type": "object",
"properties": {
"enrolledDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Total enrolled device count. Does not include PC devices managed via Intune PC Agent",
"format": "int32",
"nullable": true
},
"mdmEnrolledCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of devices enrolled in MDM",
"format": "int32",
"nullable": true
},
"dualEnrolledDeviceCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of devices enrolled in both MDM and EAS",
"format": "int32",
"nullable": true
},
"deviceOperatingSystemSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceOperatingSystemSummary"
}
],
"description": "Device operating system summary.",
"nullable": true
},
"deviceExchangeAccessStateSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceExchangeAccessStateSummary"
}
],
"description": "Distribution of Exchange Access State in Intune",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"enrolledDeviceCount": "integer",
"mdmEnrolledCount": "integer",
"dualEnrolledDeviceCount": "integer",
"deviceOperatingSystemSummary": {
"@odata.type": "microsoft.graph.deviceOperatingSystemSummary"
},
"deviceExchangeAccessStateSummary": {
"@odata.type": "microsoft.graph.deviceExchangeAccessStateSummary"
}
}
},
"microsoft.graph.importedWindowsAutopilotDeviceIdentity": {
"title": "importedWindowsAutopilotDeviceIdentity",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The GUID for the object",
"nullable": true
},
"orderIdentifier": {
"type": "string",
"description": "Order Id of the Windows autopilot device.",
"nullable": true
},
"serialNumber": {
"type": "string",
"description": "Serial number of the Windows autopilot device.",
"nullable": true
},
"productKey": {
"type": "string",
"description": "Product Key of the Windows autopilot device.",
"nullable": true
},
"hardwareIdentifier": {
"type": "string",
"description": "Hardware Blob of the Windows autopilot device.",
"format": "base64url",
"nullable": true
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.importedWindowsAutopilotDeviceIdentityState"
}
],
"description": "Current state of the imported device.",
"nullable": true
}
},
"example": {
"id": "string (identifier)",
"orderIdentifier": "string",
"serialNumber": "string",
"productKey": "string",
"hardwareIdentifier": "string",
"state": {
"@odata.type": "microsoft.graph.importedWindowsAutopilotDeviceIdentityState"
}
}
},
"microsoft.graph.importedWindowsAutopilotDeviceIdentityUpload": {
"title": "importedWindowsAutopilotDeviceIdentityUpload",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The GUID for the object",
"nullable": true
},
"createdDateTimeUtc": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime when the entity is created.",
"format": "date-time",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.importedWindowsAutopilotDeviceIdentityUploadStatus"
}
],
"description": "Upload status. Possible values are: noUpload, pending, complete, error.",
"nullable": true
},
"deviceIdentities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.importedWindowsAutopilotDeviceIdentity"
}
}
},
"example": {
"id": "string (identifier)",
"createdDateTimeUtc": "string (timestamp)",
"status": {
"@odata.type": "microsoft.graph.importedWindowsAutopilotDeviceIdentityUploadStatus"
},
"deviceIdentities": [
{
"@odata.type": "microsoft.graph.importedWindowsAutopilotDeviceIdentity"
}
]
}
},
"microsoft.graph.managedAppPolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedAppPolicy",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Policy display name.",
"nullable": true
},
"description": {
"type": "string",
"description": "The policy's description.",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The date and time the policy was created.",
"format": "date-time",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last time the policy was modified.",
"format": "date-time",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string"
}
},
"microsoft.graph.managedAppProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicy"
},
{
"title": "managedAppProtection",
"type": "object",
"properties": {
"periodOfflineBeforeAccessCheck": {
"pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
"type": "string",
"description": "The period after which access is checked when the device is not connected to the internet.",
"format": "duration",
"nullable": true
},
"periodOnlineBeforeAccessCheck": {
"pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
"type": "string",
"description": "The period after which access is checked when the device is connected to the internet.",
"format": "duration",
"nullable": true
},
"allowedInboundDataTransferSources": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppDataTransferLevel"
}
],
"description": "Sources from which data is allowed to be transferred. Possible values are: allApps, managedApps, none.",
"nullable": true
},
"allowedOutboundDataTransferDestinations": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppDataTransferLevel"
}
],
"description": "Destinations to which data is allowed to be transferred. Possible values are: allApps, managedApps, none.",
"nullable": true
},
"organizationalCredentialsRequired": {
"type": "boolean",
"description": "Indicates whether organizational credentials are required for app use.",
"nullable": true
},
"allowedOutboundClipboardSharingLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppClipboardSharingLevel"
}
],
"description": "The level to which the clipboard may be shared between apps on the managed device. Possible values are: allApps, managedAppsWithPasteIn, managedApps, blocked.",
"nullable": true
},
"dataBackupBlocked": {
"type": "boolean",
"description": "Indicates whether the backup of a managed app's data is blocked.",
"nullable": true
},
"deviceComplianceRequired": {
"type": "boolean",
"description": "Indicates whether device compliance is required.",
"nullable": true
},
"managedBrowserToOpenLinksRequired": {
"type": "boolean",
"description": "Indicates whether internet links should be opened in the managed browser app.",
"nullable": true
},
"saveAsBlocked": {
"type": "boolean",
"description": "Indicates whether users may use the 'Save As' menu item to save a copy of protected files.",
"nullable": true
},
"periodOfflineBeforeWipeIsEnforced": {
"pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
"type": "string",
"description": "The amount of time an app is allowed to remain disconnected from the internet before all managed data it is wiped.",
"format": "duration",
"nullable": true
},
"pinRequired": {
"type": "boolean",
"description": "Indicates whether an app-level pin is required.",
"nullable": true
},
"maximumPinRetries": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Maximum number of incorrect pin retry attempts before the managed app is either blocked or wiped.",
"format": "int32",
"nullable": true
},
"simplePinBlocked": {
"type": "boolean",
"description": "Indicates whether simplePin is blocked.",
"nullable": true
},
"minimumPinLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Minimum pin length required for an app-level pin if PinRequired is set to True",
"format": "int32",
"nullable": true
},
"pinCharacterSet": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPinCharacterSet"
}
],
"description": "Character set which may be used for an app-level pin if PinRequired is set to True. Possible values are: numeric, alphanumericAndSymbol.",
"nullable": true
},
"periodBeforePinReset": {
"pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
"type": "string",
"description": "TimePeriod before the all-level pin must be reset if PinRequired is set to True.",
"format": "duration",
"nullable": true
},
"allowedDataStorageLocations": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppDataStorageLocation"
}
],
"nullable": true
},
"description": "Data storage locations where a user may store managed data."
},
"contactSyncBlocked": {
"type": "boolean",
"description": "Indicates whether contacts can be synced to the user's device.",
"nullable": true
},
"printBlocked": {
"type": "boolean",
"description": "Indicates whether printing is allowed from managed apps.",
"nullable": true
},
"fingerprintBlocked": {
"type": "boolean",
"description": "Indicates whether use of the fingerprint reader is allowed in place of a pin if PinRequired is set to True.",
"nullable": true
},
"disableAppPinIfDevicePinIsSet": {
"type": "boolean",
"description": "Indicates whether use of the app pin is required if the device pin is set.",
"nullable": true
},
"minimumRequiredOsVersion": {
"type": "string",
"description": "Versions less than the specified version will block the managed app from accessing company data.",
"nullable": true
},
"minimumWarningOsVersion": {
"type": "string",
"description": "Versions less than the specified version will result in warning message on the managed app from accessing company data.",
"nullable": true
},
"minimumRequiredAppVersion": {
"type": "string",
"description": "Versions less than the specified version will block the managed app from accessing company data.",
"nullable": true
},
"minimumWarningAppVersion": {
"type": "string",
"description": "Versions less than the specified version will result in warning message on the managed app.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"periodOfflineBeforeAccessCheck": "string",
"periodOnlineBeforeAccessCheck": "string",
"allowedInboundDataTransferSources": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"allowedOutboundDataTransferDestinations": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"organizationalCredentialsRequired": true,
"allowedOutboundClipboardSharingLevel": {
"@odata.type": "microsoft.graph.managedAppClipboardSharingLevel"
},
"dataBackupBlocked": true,
"deviceComplianceRequired": true,
"managedBrowserToOpenLinksRequired": true,
"saveAsBlocked": true,
"periodOfflineBeforeWipeIsEnforced": "string",
"pinRequired": true,
"maximumPinRetries": "integer",
"simplePinBlocked": true,
"minimumPinLength": "integer",
"pinCharacterSet": {
"@odata.type": "microsoft.graph.managedAppPinCharacterSet"
},
"periodBeforePinReset": "string",
"allowedDataStorageLocations": [
{
"@odata.type": "microsoft.graph.managedAppDataStorageLocation"
}
],
"contactSyncBlocked": true,
"printBlocked": true,
"fingerprintBlocked": true,
"disableAppPinIfDevicePinIsSet": true,
"minimumRequiredOsVersion": "string",
"minimumWarningOsVersion": "string",
"minimumRequiredAppVersion": "string",
"minimumWarningAppVersion": "string"
}
},
"microsoft.graph.targetedManagedAppProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppProtection"
},
{
"title": "targetedManagedAppProtection",
"type": "object",
"properties": {
"isAssigned": {
"type": "boolean",
"description": "Indicates if the policy is deployed to any inclusion groups or not.",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"periodOfflineBeforeAccessCheck": "string",
"periodOnlineBeforeAccessCheck": "string",
"allowedInboundDataTransferSources": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"allowedOutboundDataTransferDestinations": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"organizationalCredentialsRequired": true,
"allowedOutboundClipboardSharingLevel": {
"@odata.type": "microsoft.graph.managedAppClipboardSharingLevel"
},
"dataBackupBlocked": true,
"deviceComplianceRequired": true,
"managedBrowserToOpenLinksRequired": true,
"saveAsBlocked": true,
"periodOfflineBeforeWipeIsEnforced": "string",
"pinRequired": true,
"maximumPinRetries": "integer",
"simplePinBlocked": true,
"minimumPinLength": "integer",
"pinCharacterSet": {
"@odata.type": "microsoft.graph.managedAppPinCharacterSet"
},
"periodBeforePinReset": "string",
"allowedDataStorageLocations": [
{
"@odata.type": "microsoft.graph.managedAppDataStorageLocation"
}
],
"contactSyncBlocked": true,
"printBlocked": true,
"fingerprintBlocked": true,
"disableAppPinIfDevicePinIsSet": true,
"minimumRequiredOsVersion": "string",
"minimumWarningOsVersion": "string",
"minimumRequiredAppVersion": "string",
"minimumWarningAppVersion": "string",
"isAssigned": true,
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
]
}
},
"microsoft.graph.androidManagedAppProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.targetedManagedAppProtection"
},
{
"title": "androidManagedAppProtection",
"type": "object",
"properties": {
"screenCaptureBlocked": {
"type": "boolean",
"description": "Indicates whether a managed user can take screen captures of managed apps",
"nullable": true
},
"disableAppEncryptionIfDeviceEncryptionIsEnabled": {
"type": "boolean",
"description": "When this setting is enabled, app level encryption is disabled if device level encryption is enabled",
"nullable": true
},
"encryptAppData": {
"type": "boolean",
"description": "Indicates whether application data for managed apps should be encrypted",
"nullable": true
},
"deployedAppCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Count of apps to which the current policy is deployed.",
"format": "int32",
"nullable": true
},
"minimumRequiredPatchVersion": {
"type": "string",
"description": "Define the oldest required Android security patch level a user can have to gain secure access to the app.",
"nullable": true
},
"minimumWarningPatchVersion": {
"type": "string",
"description": "Define the oldest recommended Android security patch level a user can have for secure access to the app.",
"nullable": true
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedMobileApp"
}
},
"deploymentSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"periodOfflineBeforeAccessCheck": "string",
"periodOnlineBeforeAccessCheck": "string",
"allowedInboundDataTransferSources": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"allowedOutboundDataTransferDestinations": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"organizationalCredentialsRequired": true,
"allowedOutboundClipboardSharingLevel": {
"@odata.type": "microsoft.graph.managedAppClipboardSharingLevel"
},
"dataBackupBlocked": true,
"deviceComplianceRequired": true,
"managedBrowserToOpenLinksRequired": true,
"saveAsBlocked": true,
"periodOfflineBeforeWipeIsEnforced": "string",
"pinRequired": true,
"maximumPinRetries": "integer",
"simplePinBlocked": true,
"minimumPinLength": "integer",
"pinCharacterSet": {
"@odata.type": "microsoft.graph.managedAppPinCharacterSet"
},
"periodBeforePinReset": "string",
"allowedDataStorageLocations": [
{
"@odata.type": "microsoft.graph.managedAppDataStorageLocation"
}
],
"contactSyncBlocked": true,
"printBlocked": true,
"fingerprintBlocked": true,
"disableAppPinIfDevicePinIsSet": true,
"minimumRequiredOsVersion": "string",
"minimumWarningOsVersion": "string",
"minimumRequiredAppVersion": "string",
"minimumWarningAppVersion": "string",
"isAssigned": true,
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
],
"screenCaptureBlocked": true,
"disableAppEncryptionIfDeviceEncryptionIsEnabled": true,
"encryptAppData": true,
"deployedAppCount": "integer",
"minimumRequiredPatchVersion": "string",
"minimumWarningPatchVersion": "string",
"apps": [
{
"@odata.type": "microsoft.graph.managedMobileApp"
}
],
"deploymentSummary": {
"@odata.type": "microsoft.graph.managedAppPolicyDeploymentSummary"
}
}
},
"microsoft.graph.managedAppRegistration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedAppRegistration",
"type": "object",
"properties": {
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Date and time of creation",
"format": "date-time",
"nullable": true
},
"lastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Date and time of last the app synced with management service.",
"format": "date-time",
"nullable": true
},
"applicationVersion": {
"type": "string",
"description": "App version",
"nullable": true
},
"managementSdkVersion": {
"type": "string",
"description": "App management SDK version",
"nullable": true
},
"platformVersion": {
"type": "string",
"description": "Operating System version",
"nullable": true
},
"deviceType": {
"type": "string",
"description": "Host device type",
"nullable": true
},
"deviceTag": {
"type": "string",
"description": "App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.",
"nullable": true
},
"deviceName": {
"type": "string",
"description": "Host device name",
"nullable": true
},
"flaggedReasons": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppFlaggedReason"
}
],
"nullable": true
},
"description": "Zero or more reasons an app registration is flagged. E.g. app running on rooted device"
},
"userId": {
"type": "string",
"description": "The user Id to who this app registration belongs.",
"nullable": true
},
"appIdentifier": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileAppIdentifier"
}
],
"description": "The app package Identifier",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
},
"appliedPolicies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicy"
}
},
"intendedPolicies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicy"
}
},
"operations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedAppOperation"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"lastSyncDateTime": "string (timestamp)",
"applicationVersion": "string",
"managementSdkVersion": "string",
"platformVersion": "string",
"deviceType": "string",
"deviceTag": "string",
"deviceName": "string",
"flaggedReasons": [
{
"@odata.type": "microsoft.graph.managedAppFlaggedReason"
}
],
"userId": "string",
"appIdentifier": {
"@odata.type": "microsoft.graph.mobileAppIdentifier"
},
"version": "string",
"appliedPolicies": [
{
"@odata.type": "microsoft.graph.managedAppPolicy"
}
],
"intendedPolicies": [
{
"@odata.type": "microsoft.graph.managedAppPolicy"
}
],
"operations": [
{
"@odata.type": "microsoft.graph.managedAppOperation"
}
]
}
},
"microsoft.graph.androidManagedAppRegistration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppRegistration"
},
{
"title": "androidManagedAppRegistration",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"lastSyncDateTime": "string (timestamp)",
"applicationVersion": "string",
"managementSdkVersion": "string",
"platformVersion": "string",
"deviceType": "string",
"deviceTag": "string",
"deviceName": "string",
"flaggedReasons": [
{
"@odata.type": "microsoft.graph.managedAppFlaggedReason"
}
],
"userId": "string",
"appIdentifier": {
"@odata.type": "microsoft.graph.mobileAppIdentifier"
},
"version": "string",
"appliedPolicies": [
{
"@odata.type": "microsoft.graph.managedAppPolicy"
}
],
"intendedPolicies": [
{
"@odata.type": "microsoft.graph.managedAppPolicy"
}
],
"operations": [
{
"@odata.type": "microsoft.graph.managedAppOperation"
}
]
}
},
"microsoft.graph.defaultManagedAppProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppProtection"
},
{
"title": "defaultManagedAppProtection",
"type": "object",
"properties": {
"appDataEncryptionType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppDataEncryptionType"
}
],
"description": "Type of encryption which should be used for data in a managed app. (iOS Only). Possible values are: useDeviceSettings, afterDeviceRestart, whenDeviceLockedExceptOpenFiles, whenDeviceLocked.",
"nullable": true
},
"screenCaptureBlocked": {
"type": "boolean",
"description": "Indicates whether screen capture is blocked. (Android only)",
"nullable": true
},
"encryptAppData": {
"type": "boolean",
"description": "Indicates whether managed-app data should be encrypted. (Android only)",
"nullable": true
},
"disableAppEncryptionIfDeviceEncryptionIsEnabled": {
"type": "boolean",
"description": "When this setting is enabled, app level encryption is disabled if device level encryption is enabled. (Android only)",
"nullable": true
},
"minimumRequiredSdkVersion": {
"type": "string",
"description": "Versions less than the specified version will block the managed app from accessing company data. (iOS Only)",
"nullable": true
},
"customSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.keyValuePair"
}
],
"nullable": true
},
"description": "A set of string key and string value pairs to be sent to the affected users, unalterned by this service"
},
"deployedAppCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Count of apps to which the current policy is deployed.",
"format": "int32",
"nullable": true
},
"minimumRequiredPatchVersion": {
"type": "string",
"description": "Define the oldest required Android security patch level a user can have to gain secure access to the app. (Android only)",
"nullable": true
},
"minimumWarningPatchVersion": {
"type": "string",
"description": "Define the oldest recommended Android security patch level a user can have for secure access to the app. (Android only)",
"nullable": true
},
"faceIdBlocked": {
"type": "boolean",
"description": "Indicates whether use of the FaceID is allowed in place of a pin if PinRequired is set to True. (iOS Only)",
"nullable": true
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedMobileApp"
}
},
"deploymentSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"periodOfflineBeforeAccessCheck": "string",
"periodOnlineBeforeAccessCheck": "string",
"allowedInboundDataTransferSources": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"allowedOutboundDataTransferDestinations": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"organizationalCredentialsRequired": true,
"allowedOutboundClipboardSharingLevel": {
"@odata.type": "microsoft.graph.managedAppClipboardSharingLevel"
},
"dataBackupBlocked": true,
"deviceComplianceRequired": true,
"managedBrowserToOpenLinksRequired": true,
"saveAsBlocked": true,
"periodOfflineBeforeWipeIsEnforced": "string",
"pinRequired": true,
"maximumPinRetries": "integer",
"simplePinBlocked": true,
"minimumPinLength": "integer",
"pinCharacterSet": {
"@odata.type": "microsoft.graph.managedAppPinCharacterSet"
},
"periodBeforePinReset": "string",
"allowedDataStorageLocations": [
{
"@odata.type": "microsoft.graph.managedAppDataStorageLocation"
}
],
"contactSyncBlocked": true,
"printBlocked": true,
"fingerprintBlocked": true,
"disableAppPinIfDevicePinIsSet": true,
"minimumRequiredOsVersion": "string",
"minimumWarningOsVersion": "string",
"minimumRequiredAppVersion": "string",
"minimumWarningAppVersion": "string",
"appDataEncryptionType": {
"@odata.type": "microsoft.graph.managedAppDataEncryptionType"
},
"screenCaptureBlocked": true,
"encryptAppData": true,
"disableAppEncryptionIfDeviceEncryptionIsEnabled": true,
"minimumRequiredSdkVersion": "string",
"customSettings": [
{
"@odata.type": "microsoft.graph.keyValuePair"
}
],
"deployedAppCount": "integer",
"minimumRequiredPatchVersion": "string",
"minimumWarningPatchVersion": "string",
"faceIdBlocked": true,
"apps": [
{
"@odata.type": "microsoft.graph.managedMobileApp"
}
],
"deploymentSummary": {
"@odata.type": "microsoft.graph.managedAppPolicyDeploymentSummary"
}
}
},
"microsoft.graph.iosManagedAppProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.targetedManagedAppProtection"
},
{
"title": "iosManagedAppProtection",
"type": "object",
"properties": {
"appDataEncryptionType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppDataEncryptionType"
}
],
"description": "Type of encryption which should be used for data in a managed app. Possible values are: useDeviceSettings, afterDeviceRestart, whenDeviceLockedExceptOpenFiles, whenDeviceLocked.",
"nullable": true
},
"minimumRequiredSdkVersion": {
"type": "string",
"description": "Versions less than the specified version will block the managed app from accessing company data.",
"nullable": true
},
"deployedAppCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Count of apps to which the current policy is deployed.",
"format": "int32",
"nullable": true
},
"faceIdBlocked": {
"type": "boolean",
"description": "Indicates whether use of the FaceID is allowed in place of a pin if PinRequired is set to True.",
"nullable": true
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedMobileApp"
}
},
"deploymentSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"periodOfflineBeforeAccessCheck": "string",
"periodOnlineBeforeAccessCheck": "string",
"allowedInboundDataTransferSources": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"allowedOutboundDataTransferDestinations": {
"@odata.type": "microsoft.graph.managedAppDataTransferLevel"
},
"organizationalCredentialsRequired": true,
"allowedOutboundClipboardSharingLevel": {
"@odata.type": "microsoft.graph.managedAppClipboardSharingLevel"
},
"dataBackupBlocked": true,
"deviceComplianceRequired": true,
"managedBrowserToOpenLinksRequired": true,
"saveAsBlocked": true,
"periodOfflineBeforeWipeIsEnforced": "string",
"pinRequired": true,
"maximumPinRetries": "integer",
"simplePinBlocked": true,
"minimumPinLength": "integer",
"pinCharacterSet": {
"@odata.type": "microsoft.graph.managedAppPinCharacterSet"
},
"periodBeforePinReset": "string",
"allowedDataStorageLocations": [
{
"@odata.type": "microsoft.graph.managedAppDataStorageLocation"
}
],
"contactSyncBlocked": true,
"printBlocked": true,
"fingerprintBlocked": true,
"disableAppPinIfDevicePinIsSet": true,
"minimumRequiredOsVersion": "string",
"minimumWarningOsVersion": "string",
"minimumRequiredAppVersion": "string",
"minimumWarningAppVersion": "string",
"isAssigned": true,
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
],
"appDataEncryptionType": {
"@odata.type": "microsoft.graph.managedAppDataEncryptionType"
},
"minimumRequiredSdkVersion": "string",
"deployedAppCount": "integer",
"faceIdBlocked": true,
"apps": [
{
"@odata.type": "microsoft.graph.managedMobileApp"
}
],
"deploymentSummary": {
"@odata.type": "microsoft.graph.managedAppPolicyDeploymentSummary"
}
}
},
"microsoft.graph.iosManagedAppRegistration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppRegistration"
},
{
"title": "iosManagedAppRegistration",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"createdDateTime": "string (timestamp)",
"lastSyncDateTime": "string (timestamp)",
"applicationVersion": "string",
"managementSdkVersion": "string",
"platformVersion": "string",
"deviceType": "string",
"deviceTag": "string",
"deviceName": "string",
"flaggedReasons": [
{
"@odata.type": "microsoft.graph.managedAppFlaggedReason"
}
],
"userId": "string",
"appIdentifier": {
"@odata.type": "microsoft.graph.mobileAppIdentifier"
},
"version": "string",
"appliedPolicies": [
{
"@odata.type": "microsoft.graph.managedAppPolicy"
}
],
"intendedPolicies": [
{
"@odata.type": "microsoft.graph.managedAppPolicy"
}
],
"operations": [
{
"@odata.type": "microsoft.graph.managedAppOperation"
}
]
}
},
"microsoft.graph.managedAppConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicy"
},
{
"title": "managedAppConfiguration",
"type": "object",
"properties": {
"customSettings": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.keyValuePair"
}
],
"nullable": true
},
"description": "A set of string key and string value pairs to be sent to apps for users to whom the configuration is scoped, unalterned by this service"
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"customSettings": [
{
"@odata.type": "microsoft.graph.keyValuePair"
}
]
}
},
"microsoft.graph.managedAppOperation": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedAppOperation",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The operation name.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The last time the app operation was modified.",
"format": "date-time",
"nullable": true
},
"state": {
"type": "string",
"description": "The current state of the operation",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"lastModifiedDateTime": "string (timestamp)",
"state": "string",
"version": "string"
}
},
"microsoft.graph.managedAppPolicyDeploymentSummary": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedAppPolicyDeploymentSummary",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Not yet documented",
"nullable": true
},
"configurationDeployedUserCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"lastRefreshTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Not yet documented",
"format": "date-time",
"nullable": true
},
"configurationDeploymentSummaryPerApp": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummaryPerApp"
}
],
"nullable": true
},
"description": "Not yet documented"
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"configurationDeployedUserCount": "integer",
"lastRefreshTime": "string (timestamp)",
"configurationDeploymentSummaryPerApp": [
{
"@odata.type": "microsoft.graph.managedAppPolicyDeploymentSummaryPerApp"
}
],
"version": "string"
}
},
"microsoft.graph.managedAppStatus": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedAppStatus",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Friendly name of the status report.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"version": "string"
}
},
"microsoft.graph.managedAppStatusRaw": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppStatus"
},
{
"title": "managedAppStatusRaw",
"type": "object",
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.Json"
}
],
"description": "Status report content.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"version": "string",
"content": {
"@odata.type": "microsoft.graph.Json"
}
}
},
"microsoft.graph.managedMobileApp": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "managedMobileApp",
"type": "object",
"properties": {
"mobileAppIdentifier": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileAppIdentifier"
}
],
"description": "The identifier for an app with it's operating system type.",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"mobileAppIdentifier": {
"@odata.type": "microsoft.graph.mobileAppIdentifier"
},
"version": "string"
}
},
"microsoft.graph.windowsInformationProtection": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicy"
},
{
"title": "windowsInformationProtection",
"type": "object",
"properties": {
"enforcementLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionEnforcementLevel"
}
],
"description": "WIP enforcement level.See the Enum definition for supported values. Possible values are: noProtection, encryptAndAuditOnly, encryptAuditAndPrompt, encryptAuditAndBlock.",
"nullable": true
},
"enterpriseDomain": {
"type": "string",
"description": "Primary enterprise domain",
"nullable": true
},
"enterpriseProtectedDomainNames": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"nullable": true
},
"description": "List of enterprise domains to be protected"
},
"protectionUnderLockConfigRequired": {
"type": "boolean",
"description": "Specifies whether the protection under lock feature (also known as encrypt under pin) should be configured",
"nullable": true
},
"dataRecoveryCertificate": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionDataRecoveryCertificate"
}
],
"description": "Specifies a recovery certificate that can be used for data recovery of encrypted files. This is the same as the data recovery agent(DRA) certificate for encrypting file system(EFS)",
"nullable": true
},
"revokeOnUnenrollDisabled": {
"type": "boolean",
"description": "This policy controls whether to revoke the WIP keys when a device unenrolls from the management service. If set to 1 (Don't revoke keys), the keys will not be revoked and the user will continue to have access to protected files after unenrollment. If the keys are not revoked, there will be no revoked file cleanup subsequently.",
"nullable": true
},
"rightsManagementServicesTemplateId": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"description": "TemplateID GUID to use for RMS encryption. The RMS template allows the IT admin to configure the details about who has access to RMS-protected file and how long they have access",
"format": "uuid",
"nullable": true
},
"azureRightsManagementServicesAllowed": {
"type": "boolean",
"description": "Specifies whether to allow Azure RMS encryption for WIP",
"nullable": true
},
"iconsVisible": {
"type": "boolean",
"description": "Determines whether overlays are added to icons for WIP protected files in Explorer and enterprise only app tiles in the Start menu. Starting in Windows 10, version 1703 this setting also configures the visibility of the WIP icon in the title bar of a WIP-protected app",
"nullable": true
},
"protectedApps": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionApp"
}
],
"nullable": true
},
"description": "Protected applications can access enterprise data and the data handled by those applications are protected with encryption"
},
"exemptApps": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionApp"
}
],
"nullable": true
},
"description": "Exempt applications can also access enterprise data, but the data handled by those applications are not protected. This is because some critical enterprise applications may have compatibility problems with encrypted data."
},
"enterpriseNetworkDomainNames": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"nullable": true
},
"description": "This is the list of domains that comprise the boundaries of the enterprise. Data from one of these domains that is sent to a device will be considered enterprise data and protected These locations will be considered a safe destination for enterprise data to be shared to"
},
"enterpriseProxiedDomains": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionProxiedDomainCollection"
}
],
"nullable": true
},
"description": "Contains a list of Enterprise resource domains hosted in the cloud that need to be protected. Connections to these resources are considered enterprise data. If a proxy is paired with a cloud resource, traffic to the cloud resource will be routed through the enterprise network via the denoted proxy server (on Port 80). A proxy server used for this purpose must also be configured using the EnterpriseInternalProxyServers policy"
},
"enterpriseIPRanges": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionIPRangeCollection"
}
],
"nullable": true
},
"description": "Sets the enterprise IP ranges that define the computers in the enterprise network. Data that comes from those computers will be considered part of the enterprise and protected. These locations will be considered a safe destination for enterprise data to be shared to"
},
"enterpriseIPRangesAreAuthoritative": {
"type": "boolean",
"description": "Boolean value that tells the client to accept the configured list and not to use heuristics to attempt to find other subnets. Default is false",
"nullable": true
},
"enterpriseProxyServers": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"nullable": true
},
"description": "This is a list of proxy servers. Any server not on this list is considered non-enterprise"
},
"enterpriseInternalProxyServers": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"nullable": true
},
"description": "This is the comma-separated list of internal proxy servers. For example, '157.54.14.28, 157.54.11.118, 10.202.14.167, 157.53.14.163, 157.69.210.59'. These proxies have been configured by the admin to connect to specific resources on the Internet. They are considered to be enterprise network locations. The proxies are only leveraged in configuring the EnterpriseProxiedDomains policy to force traffic to the matched domains through these proxies"
},
"enterpriseProxyServersAreAuthoritative": {
"type": "boolean",
"description": "Boolean value that tells the client to accept the configured list of proxies and not try to detect other work proxies. Default is false",
"nullable": true
},
"neutralDomainResources": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"nullable": true
},
"description": "List of domain names that can used for work or personal resource"
},
"indexingEncryptedStoresOrItemsBlocked": {
"type": "boolean",
"description": "This switch is for the Windows Search Indexer, to allow or disallow indexing of items",
"nullable": true
},
"smbAutoEncryptedFileExtensions": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"nullable": true
},
"description": "Specifies a list of file extensions, so that files with these extensions are encrypted when copying from an SMB share within the corporate boundary"
},
"isAssigned": {
"type": "boolean",
"description": "Indicates if the policy is deployed to any inclusion groups or not.",
"nullable": true
},
"protectedAppLockerFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionAppLockerFile"
}
},
"exemptAppLockerFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionAppLockerFile"
}
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"enforcementLevel": {
"@odata.type": "microsoft.graph.windowsInformationProtectionEnforcementLevel"
},
"enterpriseDomain": "string",
"enterpriseProtectedDomainNames": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"protectionUnderLockConfigRequired": true,
"dataRecoveryCertificate": {
"@odata.type": "microsoft.graph.windowsInformationProtectionDataRecoveryCertificate"
},
"revokeOnUnenrollDisabled": true,
"rightsManagementServicesTemplateId": "string",
"azureRightsManagementServicesAllowed": true,
"iconsVisible": true,
"protectedApps": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionApp"
}
],
"exemptApps": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionApp"
}
],
"enterpriseNetworkDomainNames": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseProxiedDomains": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionProxiedDomainCollection"
}
],
"enterpriseIPRanges": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionIPRangeCollection"
}
],
"enterpriseIPRangesAreAuthoritative": true,
"enterpriseProxyServers": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseInternalProxyServers": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseProxyServersAreAuthoritative": true,
"neutralDomainResources": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"indexingEncryptedStoresOrItemsBlocked": true,
"smbAutoEncryptedFileExtensions": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"isAssigned": true,
"protectedAppLockerFiles": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionAppLockerFile"
}
],
"exemptAppLockerFiles": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionAppLockerFile"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
]
}
},
"microsoft.graph.mdmWindowsInformationProtectionPolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtection"
},
{
"title": "mdmWindowsInformationProtectionPolicy",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"enforcementLevel": {
"@odata.type": "microsoft.graph.windowsInformationProtectionEnforcementLevel"
},
"enterpriseDomain": "string",
"enterpriseProtectedDomainNames": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"protectionUnderLockConfigRequired": true,
"dataRecoveryCertificate": {
"@odata.type": "microsoft.graph.windowsInformationProtectionDataRecoveryCertificate"
},
"revokeOnUnenrollDisabled": true,
"rightsManagementServicesTemplateId": "string",
"azureRightsManagementServicesAllowed": true,
"iconsVisible": true,
"protectedApps": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionApp"
}
],
"exemptApps": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionApp"
}
],
"enterpriseNetworkDomainNames": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseProxiedDomains": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionProxiedDomainCollection"
}
],
"enterpriseIPRanges": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionIPRangeCollection"
}
],
"enterpriseIPRangesAreAuthoritative": true,
"enterpriseProxyServers": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseInternalProxyServers": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseProxyServersAreAuthoritative": true,
"neutralDomainResources": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"indexingEncryptedStoresOrItemsBlocked": true,
"smbAutoEncryptedFileExtensions": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"isAssigned": true,
"protectedAppLockerFiles": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionAppLockerFile"
}
],
"exemptAppLockerFiles": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionAppLockerFile"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
]
}
},
"microsoft.graph.targetedManagedAppConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppConfiguration"
},
{
"title": "targetedManagedAppConfiguration",
"type": "object",
"properties": {
"deployedAppCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Count of apps to which the current policy is deployed.",
"format": "int32",
"nullable": true
},
"isAssigned": {
"type": "boolean",
"description": "Indicates if the policy is deployed to any inclusion groups or not.",
"nullable": true
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.managedMobileApp"
}
},
"deploymentSummary": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.managedAppPolicyDeploymentSummary"
}
],
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.targetedManagedAppPolicyAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"customSettings": [
{
"@odata.type": "microsoft.graph.keyValuePair"
}
],
"deployedAppCount": "integer",
"isAssigned": true,
"apps": [
{
"@odata.type": "microsoft.graph.managedMobileApp"
}
],
"deploymentSummary": {
"@odata.type": "microsoft.graph.managedAppPolicyDeploymentSummary"
},
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
]
}
},
"microsoft.graph.targetedManagedAppPolicyAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "targetedManagedAppPolicyAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "Identifier for deployment of a group or app",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
}
},
"microsoft.graph.windowsInformationProtectionAppLockerFile": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "windowsInformationProtectionAppLockerFile",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The friendly name",
"nullable": true
},
"fileHash": {
"type": "string",
"description": "SHA256 hash of the file",
"nullable": true
},
"file": {
"type": "string",
"description": "File as a byte array",
"format": "base64url",
"nullable": true
},
"version": {
"type": "string",
"description": "Version of the entity.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"fileHash": "string",
"file": "string",
"version": "string"
}
},
"microsoft.graph.windowsInformationProtectionPolicy": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtection"
},
{
"title": "windowsInformationProtectionPolicy",
"type": "object",
"properties": {
"revokeOnMdmHandoffDisabled": {
"type": "boolean",
"description": "New property in RS2, pending documentation",
"nullable": true
},
"mdmEnrollmentUrl": {
"type": "string",
"description": "Enrollment url for the MDM",
"nullable": true
},
"windowsHelloForBusinessBlocked": {
"type": "boolean",
"description": "Boolean value that sets Windows Hello for Business as a method for signing into Windows.",
"nullable": true
},
"pinMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Integer value that sets the minimum number of characters required for the PIN. Default value is 4. The lowest number you can configure for this policy setting is 4. The largest number you can configure must be less than the number configured in the Maximum PIN length policy setting or the number 127, whichever is the lowest.",
"format": "int32",
"nullable": true
},
"pinUppercaseLetters": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionPinCharacterRequirements"
}
],
"description": "Integer value that configures the use of uppercase letters in the Windows Hello for Business PIN. Default is NotAllow. Possible values are: notAllow, requireAtLeastOne, allow.",
"nullable": true
},
"pinLowercaseLetters": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionPinCharacterRequirements"
}
],
"description": "Integer value that configures the use of lowercase letters in the Windows Hello for Business PIN. Default is NotAllow. Possible values are: notAllow, requireAtLeastOne, allow.",
"nullable": true
},
"pinSpecialCharacters": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsInformationProtectionPinCharacterRequirements"
}
],
"description": "Integer value that configures the use of special characters in the Windows Hello for Business PIN. Valid special characters for Windows Hello for Business PIN gestures include: ! ' # $ % & ' ( ) + , - . / : ; < = > ? @ [ / ] ^ ` {",
"nullable": true
},
"pinExpirationDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Integer value specifies the period of time (in days) that a PIN can be used before the system requires the user to change it. The largest number you can configure for this policy setting is 730. The lowest number you can configure for this policy setting is 0. If this policy is set to 0, then the user's PIN will never expire. This node was added in Windows 10, version 1511. Default is 0.",
"format": "int32",
"nullable": true
},
"numberOfPastPinsRemembered": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Integer value that specifies the number of past PINs that can be associated to a user account that can't be reused. The largest number you can configure for this policy setting is 50. The lowest number you can configure for this policy setting is 0. If this policy is set to 0, then storage of previous PINs is not required. This node was added in Windows 10, version 1511. Default is 0.",
"format": "int32",
"nullable": true
},
"passwordMaximumAttemptCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "The number of authentication failures allowed before the device will be wiped. A value of 0 disables device wipe functionality. Range is an integer X where 4 <= X <= 16 for desktop and 0 <= X <= 999 for mobile devices.",
"format": "int32",
"nullable": true
},
"minutesOfInactivityBeforeDeviceLock": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Specifies the maximum amount of time (in minutes) allowed after the device is idle that will cause the device to become PIN or password locked. Range is an integer X where 0 <= X <= 999.",
"format": "int32",
"nullable": true
},
"daysWithoutContactBeforeUnenroll": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Offline interval before app data is wiped (days)",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "string",
"enforcementLevel": {
"@odata.type": "microsoft.graph.windowsInformationProtectionEnforcementLevel"
},
"enterpriseDomain": "string",
"enterpriseProtectedDomainNames": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"protectionUnderLockConfigRequired": true,
"dataRecoveryCertificate": {
"@odata.type": "microsoft.graph.windowsInformationProtectionDataRecoveryCertificate"
},
"revokeOnUnenrollDisabled": true,
"rightsManagementServicesTemplateId": "string",
"azureRightsManagementServicesAllowed": true,
"iconsVisible": true,
"protectedApps": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionApp"
}
],
"exemptApps": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionApp"
}
],
"enterpriseNetworkDomainNames": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseProxiedDomains": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionProxiedDomainCollection"
}
],
"enterpriseIPRanges": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionIPRangeCollection"
}
],
"enterpriseIPRangesAreAuthoritative": true,
"enterpriseProxyServers": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseInternalProxyServers": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"enterpriseProxyServersAreAuthoritative": true,
"neutralDomainResources": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"indexingEncryptedStoresOrItemsBlocked": true,
"smbAutoEncryptedFileExtensions": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionResourceCollection"
}
],
"isAssigned": true,
"protectedAppLockerFiles": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionAppLockerFile"
}
],
"exemptAppLockerFiles": [
{
"@odata.type": "microsoft.graph.windowsInformationProtectionAppLockerFile"
}
],
"assignments": [
{
"@odata.type": "microsoft.graph.targetedManagedAppPolicyAssignment"
}
],
"revokeOnMdmHandoffDisabled": true,
"mdmEnrollmentUrl": "string",
"windowsHelloForBusinessBlocked": true,
"pinMinimumLength": "integer",
"pinUppercaseLetters": {
"@odata.type": "microsoft.graph.windowsInformationProtectionPinCharacterRequirements"
},
"pinLowercaseLetters": {
"@odata.type": "microsoft.graph.windowsInformationProtectionPinCharacterRequirements"
},
"pinSpecialCharacters": {
"@odata.type": "microsoft.graph.windowsInformationProtectionPinCharacterRequirements"
},
"pinExpirationDays": "integer",
"numberOfPastPinsRemembered": "integer",
"passwordMaximumAttemptCount": "integer",
"minutesOfInactivityBeforeDeviceLock": "integer",
"daysWithoutContactBeforeUnenroll": "integer"
}
},
"microsoft.graph.localizedNotificationMessage": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "localizedNotificationMessage",
"type": "object",
"properties": {
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was last modified.",
"format": "date-time",
"nullable": true
},
"locale": {
"type": "string",
"description": "The Locale for which this message is destined.",
"nullable": true
},
"subject": {
"type": "string",
"description": "The Message Template Subject.",
"nullable": true
},
"messageTemplate": {
"type": "string",
"description": "The Message Template content.",
"nullable": true
},
"isDefault": {
"type": "boolean",
"description": "Flag to indicate whether or not this is the default locale for language fallback. This flag can only be set. To unset, set this property to true on another Localized Notification Message.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"locale": "string",
"subject": "string",
"messageTemplate": "string",
"isDefault": true
}
},
"microsoft.graph.notificationMessageTemplate": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "notificationMessageTemplate",
"type": "object",
"properties": {
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime the object was last modified.",
"format": "date-time",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Display name for the Notification Message Template.",
"nullable": true
},
"defaultLocale": {
"type": "string",
"description": "The default locale to fallback onto when the requested locale is not available.",
"nullable": true
},
"brandingOptions": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.notificationTemplateBrandingOptions"
}
],
"description": "The Message Template Branding Options. Branding is defined in the Intune Admin Console. Possible values are: none, includeCompanyLogo, includeCompanyName, includeContactInformation.",
"nullable": true
},
"localizedNotificationMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.localizedNotificationMessage"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"lastModifiedDateTime": "string (timestamp)",
"displayName": "string",
"defaultLocale": "string",
"brandingOptions": {
"@odata.type": "microsoft.graph.notificationTemplateBrandingOptions"
},
"localizedNotificationMessages": [
{
"@odata.type": "microsoft.graph.localizedNotificationMessage"
}
]
}
},
"microsoft.graph.deviceEnrollmentConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceEnrollmentConfiguration",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Not yet documented",
"nullable": true
},
"description": {
"type": "string",
"description": "Not yet documented",
"nullable": true
},
"priority": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"createdDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Not yet documented",
"format": "date-time",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Not yet documented",
"format": "date-time",
"nullable": true
},
"version": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"assignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.enrollmentConfigurationAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"priority": "integer",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.enrollmentConfigurationAssignment"
}
]
}
},
"microsoft.graph.deviceEnrollmentLimitConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration"
},
{
"title": "deviceEnrollmentLimitConfiguration",
"type": "object",
"properties": {
"limit": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"priority": "integer",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.enrollmentConfigurationAssignment"
}
],
"limit": "integer"
}
},
"microsoft.graph.deviceEnrollmentPlatformRestrictionsConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration"
},
{
"title": "deviceEnrollmentPlatformRestrictionsConfiguration",
"type": "object",
"properties": {
"iosRestriction": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentPlatformRestriction"
}
],
"description": "Not yet documented",
"nullable": true
},
"windowsRestriction": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentPlatformRestriction"
}
],
"description": "Not yet documented",
"nullable": true
},
"windowsMobileRestriction": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentPlatformRestriction"
}
],
"description": "Not yet documented",
"nullable": true
},
"androidRestriction": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentPlatformRestriction"
}
],
"description": "Not yet documented",
"nullable": true
},
"macOSRestriction": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentPlatformRestriction"
}
],
"description": "Not yet documented",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"priority": "integer",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.enrollmentConfigurationAssignment"
}
],
"iosRestriction": {
"@odata.type": "microsoft.graph.deviceEnrollmentPlatformRestriction"
},
"windowsRestriction": {
"@odata.type": "microsoft.graph.deviceEnrollmentPlatformRestriction"
},
"windowsMobileRestriction": {
"@odata.type": "microsoft.graph.deviceEnrollmentPlatformRestriction"
},
"androidRestriction": {
"@odata.type": "microsoft.graph.deviceEnrollmentPlatformRestriction"
},
"macOSRestriction": {
"@odata.type": "microsoft.graph.deviceEnrollmentPlatformRestriction"
}
}
},
"microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration"
},
{
"title": "deviceEnrollmentWindowsHelloForBusinessConfiguration",
"type": "object",
"properties": {
"pinMinimumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"pinMaximumLength": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"pinUppercaseCharactersUsage": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsHelloForBusinessPinUsage"
}
],
"description": "Not yet documented. Possible values are: allowed, required, disallowed.",
"nullable": true
},
"pinLowercaseCharactersUsage": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsHelloForBusinessPinUsage"
}
],
"description": "Not yet documented. Possible values are: allowed, required, disallowed.",
"nullable": true
},
"pinSpecialCharactersUsage": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.windowsHelloForBusinessPinUsage"
}
],
"description": "Not yet documented. Possible values are: allowed, required, disallowed.",
"nullable": true
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.enablement"
}
],
"description": "Not yet documented. Possible values are: notConfigured, enabled, disabled.",
"nullable": true
},
"securityDeviceRequired": {
"type": "boolean",
"description": "Not yet documented",
"nullable": true
},
"unlockWithBiometricsEnabled": {
"type": "boolean",
"description": "Not yet documented",
"nullable": true
},
"remotePassportEnabled": {
"type": "boolean",
"description": "Not yet documented",
"nullable": true
},
"pinPreviousBlockCount": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"pinExpirationInDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Not yet documented",
"format": "int32",
"nullable": true
},
"enhancedBiometricsState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.enablement"
}
],
"description": "Not yet documented. Possible values are: notConfigured, enabled, disabled.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"priority": "integer",
"createdDateTime": "string (timestamp)",
"lastModifiedDateTime": "string (timestamp)",
"version": "integer",
"assignments": [
{
"@odata.type": "microsoft.graph.enrollmentConfigurationAssignment"
}
],
"pinMinimumLength": "integer",
"pinMaximumLength": "integer",
"pinUppercaseCharactersUsage": {
"@odata.type": "microsoft.graph.windowsHelloForBusinessPinUsage"
},
"pinLowercaseCharactersUsage": {
"@odata.type": "microsoft.graph.windowsHelloForBusinessPinUsage"
},
"pinSpecialCharactersUsage": {
"@odata.type": "microsoft.graph.windowsHelloForBusinessPinUsage"
},
"state": {
"@odata.type": "microsoft.graph.enablement"
},
"securityDeviceRequired": true,
"unlockWithBiometricsEnabled": true,
"remotePassportEnabled": true,
"pinPreviousBlockCount": "integer",
"pinExpirationInDays": "integer",
"enhancedBiometricsState": {
"@odata.type": "microsoft.graph.enablement"
}
}
},
"microsoft.graph.deviceManagementExchangeConnector": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceManagementExchangeConnector",
"type": "object",
"properties": {
"lastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last sync time for the Exchange Connector",
"format": "date-time",
"nullable": true
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceManagementExchangeConnectorStatus"
}
],
"description": "Exchange Connector Status. Possible values are: none, connectionPending, connected, disconnected.",
"nullable": true
},
"primarySmtpAddress": {
"type": "string",
"description": "Email address used to configure the Service To Service Exchange Connector.",
"nullable": true
},
"serverName": {
"type": "string",
"description": "The name of the Exchange server.",
"nullable": true
},
"connectorServerName": {
"type": "string",
"description": "The name of the server hosting the Exchange Connector.",
"nullable": true
},
"exchangeConnectorType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceManagementExchangeConnectorType"
}
],
"description": "The type of Exchange Connector Configured. Possible values are: onPremises, hosted, serviceToService, dedicated.",
"nullable": true
},
"version": {
"type": "string",
"description": "The version of the ExchangeConnectorAgent",
"nullable": true
},
"exchangeAlias": {
"type": "string",
"description": "An alias assigned to the Exchange server",
"nullable": true
},
"exchangeOrganization": {
"type": "string",
"description": "Exchange Organization to the Exchange server",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastSyncDateTime": "string (timestamp)",
"status": {
"@odata.type": "microsoft.graph.deviceManagementExchangeConnectorStatus"
},
"primarySmtpAddress": "string",
"serverName": "string",
"connectorServerName": "string",
"exchangeConnectorType": {
"@odata.type": "microsoft.graph.deviceManagementExchangeConnectorType"
},
"version": "string",
"exchangeAlias": "string",
"exchangeOrganization": "string"
}
},
"microsoft.graph.deviceManagementPartner": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceManagementPartner",
"type": "object",
"properties": {
"lastHeartbeatDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Timestamp of last heartbeat after admin enabled option Connect to Device management Partner",
"format": "date-time",
"nullable": true
},
"partnerState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceManagementPartnerTenantState"
}
],
"description": "Partner state of this tenant. Possible values are: unknown, unavailable, enabled, terminated, rejected, unresponsive.",
"nullable": true
},
"partnerAppType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceManagementPartnerAppType"
}
],
"description": "Partner App type. Possible values are: unknown, singleTenantApp, multiTenantApp.",
"nullable": true
},
"singleTenantAppId": {
"type": "string",
"description": "Partner Single tenant App id",
"nullable": true
},
"displayName": {
"type": "string",
"description": "Partner display name",
"nullable": true
},
"isConfigured": {
"type": "boolean",
"description": "Whether device management partner is configured or not",
"nullable": true
},
"whenPartnerDevicesWillBeRemovedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime in UTC when PartnerDevices will be removed",
"format": "date-time",
"nullable": true
},
"whenPartnerDevicesWillBeMarkedAsNonCompliantDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime in UTC when PartnerDevices will be marked as NonCompliant",
"format": "date-time",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastHeartbeatDateTime": "string (timestamp)",
"partnerState": {
"@odata.type": "microsoft.graph.deviceManagementPartnerTenantState"
},
"partnerAppType": {
"@odata.type": "microsoft.graph.deviceManagementPartnerAppType"
},
"singleTenantAppId": "string",
"displayName": "string",
"isConfigured": true,
"whenPartnerDevicesWillBeRemovedDateTime": "string (timestamp)",
"whenPartnerDevicesWillBeMarkedAsNonCompliantDateTime": "string (timestamp)"
}
},
"microsoft.graph.enrollmentConfigurationAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "enrollmentConfigurationAssignment",
"type": "object",
"properties": {
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
],
"description": "Not yet documented",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"target": {
"@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget"
}
}
},
"microsoft.graph.mobileThreatDefenseConnector": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "mobileThreatDefenseConnector",
"type": "object",
"properties": {
"lastHeartbeatDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "DateTime of last Heartbeat recieved from the Data Sync Partner",
"format": "date-time",
"nullable": true
},
"partnerState": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mobileThreatPartnerTenantState"
}
],
"description": "Data Sync Partner state for this account. Possible values are: unavailable, available, enabled, unresponsive.",
"nullable": true
},
"androidEnabled": {
"type": "boolean",
"description": "For Android, set whether data from the data sync partner should be used during compliance evaluations",
"nullable": true
},
"iosEnabled": {
"type": "boolean",
"description": "For IOS, get or set whether data from the data sync partner should be used during compliance evaluations",
"nullable": true
},
"androidDeviceBlockedOnMissingPartnerData": {
"type": "boolean",
"description": "For Android, set whether Intune must receive data from the data sync partner prior to marking a device compliant",
"nullable": true
},
"iosDeviceBlockedOnMissingPartnerData": {
"type": "boolean",
"description": "For IOS, set whether Intune must receive data from the data sync partner prior to marking a device compliant",
"nullable": true
},
"partnerUnsupportedOsVersionBlocked": {
"type": "boolean",
"description": "Get or set whether to block devices on the enabled platforms that do not meet the minimum version requirements of the Data Sync Partner",
"nullable": true
},
"partnerUnresponsivenessThresholdInDays": {
"maximum": 2147483647,
"minimum": -2147483648,
"type": "integer",
"description": "Get or Set days the per tenant tolerance to unresponsiveness for this partner integration",
"format": "int32",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"lastHeartbeatDateTime": "string (timestamp)",
"partnerState": {
"@odata.type": "microsoft.graph.mobileThreatPartnerTenantState"
},
"androidEnabled": true,
"iosEnabled": true,
"androidDeviceBlockedOnMissingPartnerData": true,
"iosDeviceBlockedOnMissingPartnerData": true,
"partnerUnsupportedOsVersionBlocked": true,
"partnerUnresponsivenessThresholdInDays": "integer"
}
},
"microsoft.graph.onPremisesConditionalAccessSettings": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "onPremisesConditionalAccessSettings",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates if on premises conditional access is enabled for this organization",
"nullable": true
},
"includedGroups": {
"type": "array",
"items": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"format": "uuid",
"nullable": true
},
"description": "User groups that will be targeted by on premises conditional access. All users in these groups will be required to have mobile device managed and compliant for mail access."
},
"excludedGroups": {
"type": "array",
"items": {
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"type": "string",
"format": "uuid",
"nullable": true
},
"description": "User groups that will be exempt by on premises conditional access. All users in these groups will be exempt from the conditional access policy."
},
"overrideDefaultRule": {
"type": "boolean",
"description": "Override the default access rule when allowing a device to ensure access is granted.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"enabled": true,
"includedGroups": [
"string"
],
"excludedGroups": [
"string"
],
"overrideDefaultRule": true
}
},
"microsoft.graph.organization": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.directoryObject"
},
{
"title": "organization",
"type": "object",
"properties": {
"mobileDeviceManagementAuthority": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.mdmAuthority"
}
],
"description": "Mobile device management authority. Possible values are: unknown, intune, sccm, office365.",
"nullable": true
},
"assignedPlans": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.assignedPlan"
}
],
"nullable": true
},
"description": "The collection of service plans associated with the tenant. Not nullable."
},
"businessPhones": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"city": {
"type": "string",
"description": "City name of the address for the organization",
"nullable": true
},
"companyLastDirSyncTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The time and date at which the tenant was last synced with the on-premise directory.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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"country": {
"type": "string",
"description": "Country/region name of the address for the organization",
"nullable": true
},
"countryLetterCode": {
"type": "string",
"description": "Country/region abbreviation for the organization",
"nullable": true
},
"deletionTimestamp": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "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 would look like this: '2014-01-01T00:00:00Z'",
"format": "date-time",
"nullable": true
},
"dirSyncEnabled": {
"type": "boolean",
"description": "true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default).",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name for the tenant.",
"nullable": true
},
"marketingNotificationEmails": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Not nullable."
},
"objectType": {
"type": "string",
"description": "A string that identifies the object type. For tenants the value is always 'Company'.",
"nullable": true
},
"onPremisesLastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"format": "date-time",
"nullable": true
},
"onPremisesSyncEnabled": {
"type": "boolean",
"nullable": true
},
"postalCode": {
"type": "string",
"description": "Postal code of the address for the organization",
"nullable": true
},
"preferredLanguage": {
"type": "string",
"description": "The preferred language for the organization. Should follow ISO 639-1 Code; for example 'en'.",
"nullable": true
},
"privacyProfile": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.privacyProfile"
}
],
"description": "The privacy profile of an organization.",
"nullable": true
},
"provisionedPlans": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.provisionedPlan"
}
],
"nullable": true
},
"description": "Not nullable."
},
"securityComplianceNotificationMails": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"securityComplianceNotificationPhones": {
"type": "array",
"items": {
"type": "string",
"nullable": true
}
},
"state": {
"type": "string",
"description": "State name of the address for the organization",
"nullable": true
},
"street": {
"type": "string",
"description": "Street name of the address for organization",
"nullable": true
},
"technicalNotificationMails": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "Not nullable."
},
"telephoneNumber": {
"type": "string",
"description": "Telephone number for the organization",
"nullable": true
},
"verifiedDomains": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.verifiedDomain"
}
],
"nullable": true
},
"description": "The collection of domains associated with this tenant. Not nullable."
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.extension"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"mobileDeviceManagementAuthority": {
"@odata.type": "microsoft.graph.mdmAuthority"
},
"assignedPlans": [
{
"@odata.type": "microsoft.graph.assignedPlan"
}
],
"businessPhones": [
"string"
],
"city": "string",
"companyLastDirSyncTime": "string (timestamp)",
"country": "string",
"countryLetterCode": "string",
"deletionTimestamp": "string (timestamp)",
"dirSyncEnabled": true,
"displayName": "string",
"marketingNotificationEmails": [
"string"
],
"objectType": "string",
"onPremisesLastSyncDateTime": "string (timestamp)",
"onPremisesSyncEnabled": true,
"postalCode": "string",
"preferredLanguage": "string",
"privacyProfile": {
"@odata.type": "microsoft.graph.privacyProfile"
},
"provisionedPlans": [
{
"@odata.type": "microsoft.graph.provisionedPlan"
}
],
"securityComplianceNotificationMails": [
"string"
],
"securityComplianceNotificationPhones": [
"string"
],
"state": "string",
"street": "string",
"technicalNotificationMails": [
"string"
],
"telephoneNumber": "string",
"verifiedDomains": [
{
"@odata.type": "microsoft.graph.verifiedDomain"
}
],
"extensions": [
{
"@odata.type": "microsoft.graph.extension"
}
]
}
},
"microsoft.graph.vppToken": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "vppToken",
"type": "object",
"properties": {
"organizationName": {
"type": "string",
"description": "The organization associated with the Apple Volume Purchase Program Token",
"nullable": true
},
"vppTokenAccountType": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.vppTokenAccountType"
}
],
"description": "The type of volume purchase program which the given Apple Volume Purchase Program Token is associated with. Possible values are: business, education. Possible values are: business, education.",
"nullable": true
},
"appleId": {
"type": "string",
"description": "The apple Id associated with the given Apple Volume Purchase Program Token.",
"nullable": true
},
"expirationDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The expiration date time of the Apple Volume Purchase Program Token.",
"format": "date-time",
"nullable": true
},
"lastSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The last time when an application sync was done with the Apple volume purchase program service using the the Apple Volume Purchase Program Token.",
"format": "date-time",
"nullable": true
},
"token": {
"type": "string",
"description": "The Apple Volume Purchase Program Token string downloaded from the Apple Volume Purchase Program.",
"nullable": true
},
"lastModifiedDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Last modification date time associated with the Apple Volume Purchase Program Token.",
"format": "date-time",
"nullable": true
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.vppTokenState"
}
],
"description": "Current state of the Apple Volume Purchase Program Token. Possible values are: unknown, valid, expired, invalid, assignedToExternalMDM. Possible values are: unknown, valid, expired, invalid, assignedToExternalMDM.",
"nullable": true
},
"lastSyncStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.vppTokenSyncStatus"
}
],
"description": "Current sync status of the last application sync which was triggered using the Apple Volume Purchase Program Token. Possible values are: none, inProgress, completed, failed. Possible values are: none, inProgress, completed, failed.",
"nullable": true
},
"automaticallyUpdateApps": {
"type": "boolean",
"description": "Whether or not apps for the VPP token will be automatically updated.",
"nullable": true
},
"countryOrRegion": {
"type": "string",
"description": "Whether or not apps for the VPP token will be automatically updated.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"organizationName": "string",
"vppTokenAccountType": {
"@odata.type": "microsoft.graph.vppTokenAccountType"
},
"appleId": "string",
"expirationDateTime": "string (timestamp)",
"lastSyncDateTime": "string (timestamp)",
"token": "string",
"lastModifiedDateTime": "string (timestamp)",
"state": {
"@odata.type": "microsoft.graph.vppTokenState"
},
"lastSyncStatus": {
"@odata.type": "microsoft.graph.vppTokenSyncStatus"
},
"automaticallyUpdateApps": true,
"countryOrRegion": "string"
}
},
"microsoft.graph.roleAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "roleAssignment",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display or friendly name of the role Assignment.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the Role Assignment.",
"nullable": true
},
"resourceScopes": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "List of ids of role scope member security groups. These are IDs from Azure Active Directory."
},
"roleDefinition": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.roleDefinition"
}
],
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"resourceScopes": [
"string"
],
"roleDefinition": {
"@odata.type": "microsoft.graph.roleDefinition"
}
}
},
"microsoft.graph.deviceAndAppManagementRoleAssignment": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.roleAssignment"
},
{
"title": "deviceAndAppManagementRoleAssignment",
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "The list of ids of role member security groups. These are IDs from Azure Active Directory."
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"resourceScopes": [
"string"
],
"roleDefinition": {
"@odata.type": "microsoft.graph.roleDefinition"
},
"members": [
"string"
]
}
},
"microsoft.graph.roleDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "roleDefinition",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Display Name of the Role definition.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the Role definition.",
"nullable": true
},
"rolePermissions": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.rolePermission"
}
],
"nullable": true
},
"description": "List of Role Permissions this role is allowed to perform. These must match the actionName that is defined as part of the rolePermission."
},
"isBuiltIn": {
"type": "boolean",
"description": "Type of Role. Set to True if it is built-in, or set to False if it is a custom role definition.",
"nullable": true
},
"roleAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/microsoft.graph.roleAssignment"
}
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"rolePermissions": [
{
"@odata.type": "microsoft.graph.rolePermission"
}
],
"isBuiltIn": true,
"roleAssignments": [
{
"@odata.type": "microsoft.graph.roleAssignment"
}
]
}
},
"microsoft.graph.deviceAndAppManagementRoleDefinition": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.roleDefinition"
},
{
"title": "deviceAndAppManagementRoleDefinition",
"type": "object"
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"description": "string",
"rolePermissions": [
{
"@odata.type": "microsoft.graph.rolePermission"
}
],
"isBuiltIn": true,
"roleAssignments": [
{
"@odata.type": "microsoft.graph.roleAssignment"
}
]
}
},
"microsoft.graph.resourceOperation": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "resourceOperation",
"type": "object",
"properties": {
"resourceName": {
"type": "string",
"description": "Name of the Resource this operation is performed on.",
"nullable": true
},
"actionName": {
"type": "string",
"description": "Type of action this operation is going to perform. The actionName should be concise and limited to as few words as possible.",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the resource operation. The description is used in mouse-over text for the operation when shown in the Azure Portal.",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"resourceName": "string",
"actionName": "string",
"description": "string"
}
},
"microsoft.graph.remoteAssistancePartner": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "remoteAssistancePartner",
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Display name of the partner.",
"nullable": true
},
"onboardingUrl": {
"type": "string",
"description": "URL of the partner's onboarding portal, where an administrator can configure their Remote Assistance service.",
"nullable": true
},
"onboardingStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/microsoft.graph.remoteAssistanceOnboardingStatus"
}
],
"description": "TBD. Possible values are: notOnboarded, onboarding, onboarded.",
"nullable": true
},
"lastConnectionDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "Timestamp of the last request sent to Intune by the TEM partner.",
"format": "date-time",
"nullable": true
}
}
}
],
"example": {
"id": "string (identifier)",
"displayName": "string",
"onboardingUrl": "string",
"onboardingStatus": {
"@odata.type": "microsoft.graph.remoteAssistanceOnboardingStatus"
},
"lastConnectionDateTime": "string (timestamp)"
}
},
"microsoft.graph.deviceAppManagement": {
"allOf": [
{
"$ref": "#/components/schemas/microsoft.graph.entity"
},
{
"title": "deviceAppManagement",
"type": "object",
"properties": {
"microsoftStoreForBusinessLastSuccessfulSyncDateTime": {
"pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
"type": "string",
"description": "The last time the apps from the Microsoft Store for Business were synced successfully for the account.",
"format": "date-time",
"nullable": true
},
"isEnabledForMicrosoftStoreForBusiness": {
"type": "boolean",
"description": "Whether the account is enabled for syncing applications from the Microsoft Store for Business.",
"nullable": true
},
"microsoftStoreForBusinessLanguage": {
"type": "string",
"description": "The locale information used to sync applications from the Microsoft Store for Business. Cultures that are specific to a country/region. The names of these cultures follow RFC 4646 (Windows Vista and later). The format is -