Microsoft Intune Component
Use the Microsoft Intune component to manage users, devices, and applications.
Component key: ms-intune
Description
Microsoft Intune is a cloud-based service that focuses on device management and application management.
API Documentation
This component was built using the Microsoft Graph REST API v1.0.
Connections
OAuth 2.0
To create an new Microsoft Intune App Registration:
- Navigate to the Microsoft Entra Identity > Applications > App registrations and select New registration.
- Set the Supported Account types to Accounts in any organizational directory (Any Azure AD directory - Multitenant) so that users outside of your organization (i.e. your customers) can authenticate.
- Set the Redirect URI dropdown as a "Web" platform. In that section add the Prismatic's OAuth callback URL https://oauth2.prismatic.io/callback - as a Redirect URI.
- Select Register to complete.
- From the App menu navigate to Certificates & Secrets for the app and add a new Client Secret. Save the Value for the Client Secret in the Prismatic Connection Configuration.
- Navigate to the Overview page save the value listed as the Application (client) ID. This will be your Client ID for the Prismatic Connection Configuration.
- Navigate to API Permissions and select Add Permission, select the square labeled Microsoft Graph, and then Delegated permissions. Under the DeviceManagementManagedDevices section select DeviceManagementManagedDevices.PrivilegedOperations, DeviceManagementManagedDevices.Read.All. In addition to any other permissions that will be required by your integration. You can use DeviceManagementManagedDevices.ReadWrite.All to get started building and choose a more refined set at a later time.
To configure the OAuth 2.0 connection in Prismatic:
- Add a Microsoft Intune OAuth 2.0 connection config var:
- Use the Application (client) ID value for the Client ID field.
- Use the Client Secret for the same named field.
- Use the default Authorize URL.
Input | Default | Notes |
---|---|---|
Authorize URL string / Required Hidden Field authorizeUrl | https://login.microsoftonline.com/common/oauth2/v2.0/authorize | The OAuth 2.0 Authorization URL for Microsoft Intune |
Client ID string / Required clientId | Get this value from your App Registration in the Azure Portal | |
Client Secret password / Required clientSecret | Get this value from your App Registration in the Azure Portal | |
Scopes string scopes | DeviceManagementManagedDevices.PrivilegedOperations.All DeviceManagementApps.ReadWrite.All DeviceManagementManagedDevices.ReadWrite.All Group.ReadWrite.All Domain.ReadWrite.All User.ReadWrite.All Directory.ReadWrite.All AuditLog.Read.All DeviceManagementConfiguration.ReadWrite.All offline_access | Microsoft Intune Scopes. |
Token URL string / Required Hidden Field tokenUrl | https://login.microsoftonline.com/common/oauth2/v2.0/token | The OAuth 2.0 Token URL for Microsoft Intune |
Triggers
Resource Trigger
Get notified to this flow when the specified resource changes. | key: resourceTrigger
Input | Notes | Example |
---|---|---|
Change Type string / Required Value List changeType | Indicates the type of change in the subscribed resource that raises a change notification. | |
Connection connection / Required connection | ||
Expiration Date Time string expirationDateTime | Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. | 2016-11-20T18:23:45.9356913Z |
Resource string / Required resource | The resource that will be monitored for changes. See https://learn.microsoft.com/en-us/graph/api/resources/change-notifications-api-overview?view=graph-rest-1.0 | users |
Data Sources
Select Detected App
Select a detected app from the list of detected apps | key: selectDetectedApp | type: picklist
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Select Detected App
{
"result": [
{
"label": "Display Name value",
"key": "caf60db6-0db6-caf6-b60d-f6cab60df6ca"
}
]
}
Select Group
Select a group app from the list of groups | key: selectGroup | type: picklist
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Select Group
{
"result": [
{
"label": "Display Name value",
"key": "0177548a-548a-0177-8a54-77018a547701"
}
]
}
Select Managed Device
Select a managed device from the list of managed devices | key: selectManagedDevice | type: picklist
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Select Managed Device
{
"result": [
{
"label": "Device Name value",
"key": "705c034c-034c-705c-4c03-5c704c035c70"
}
]
}
Select Mobile App
Select a mobile app from the list of mobile apps | key: selectMobileApp | type: picklist
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Select Mobile App
{
"result": [
{
"label": "Display Name value",
"key": "0177548a-548a-0177-8a54-77018a547701"
}
]
}
Select Mobile App Assignment
Select a mobile app assignment from the list of mobile apps assignments | key: selectMobileAppAssignment | type: picklist
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Mobile App Id string / Required mobileAppId | Unique Identifier for the mobile app to get. | 0177548a-548a-0177-8a54-77018a547701 |
Example Payload for Select Mobile App Assignment
{
"result": [
{
"label": "required",
"key": "591620b7-20b7-5916-b720-1659b7201659"
}
]
}
Actions
Assign Device Compliance Policy
Assign a device compliance policy by ID. | key: assignDeviceCompliancePolicy
Input | Default | Notes | Example |
---|---|---|---|
Assign Id string / Required assignId | Key of the entity. | 705c034c-034c-705c-4c03-5c704c035c70 | |
Collection Id string / Required collectionId | Unique Identifier for the target collection. | 705c034c-034c-705c-4c03-5c704c035c70 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Device Compliance Policy Id string / Required deviceCompliancePolicyId | Unique Identifier for the device to assign the compliance policy. | 705c034c-034c-705c-4c03-5c704c035c70 | |
Target string / Required target | The device compliance policy assignment target | #microsoft.graph.deviceAndAppManagementAssignmentTarget |
Example Payload for Assign Device Compliance Policy
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.deviceCompliancePolicyAssignment",
"id": "92dc3fef-3fef-92dc-ef3f-dc92ef3fdc92",
"target": {
"@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget",
"collectionId": "Collection Id value"
}
}
]
}
}
Assign Mobile App
Assign a mobile app to a group. | key: assignMobileApp
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Group Id string / Required groupId | The unique identifier of the group that you want to assign the app to. | caf60db6-0db6-caf6-b60d-f6cab60df6ca | |
Intent string / Required intent | The intent of the assignment for the managed app. A 'Required' option will force the app to be installed on the device. An 'Available' option will make the app available for the user to install. An 'Uninstall' option will remove the app from the device. An 'Available Without Enrollment' option will make the app available for the user to install without enrolling the device. | available | |
Mobile App Id string / Required mobileAppId | Unique Identifier for the mobile app to assign. | 0177548a-548a-0177-8a54-77018a547701 | |
Settings string / Required settings | The mobile app assignment settings | microsoft.graph.windowsUniversalAppXAppAssignmentSettings | |
Target string / Required target | The mobile app assignment target | microsoft.graph.allLicensedUsersAssignmentTarget |
Example Payload for Assign Mobile App
{
"data": {
"data": "Action successfully completed."
}
}
Create Group
Create a group. | key: createGroup
Input | Default | Notes | Example |
---|---|---|---|
Assigned Labels code assignedLabels | The list of sensitivity label pairs (label ID, label name) associated with a group | ||
Body Fields code bodyFields | Extra fields to include in the request body. | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | A description for the group. | Self help community for library | |
Display Name string / Required displayName | The name to display in the address book for the group. | Library Assist | |
Mail Enabled boolean / Required mailEnabled | false | Set to true for mail-enabled groups. | |
Mail Nickname string / Required mailNickname | The mail alias for the group, unique for Microsoft 365 groups in the organization. | library | |
Security Enabled boolean / Required securityEnabled | false | Specifies whether the group is a security group. | |
Visibility string visibility | The display name for the group | The best group ever |
Example Payload for Create Group
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
"id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2017-07-31T18:56:16Z",
"description": "Welcome to the HR Taskforce team.",
"displayName": "HR Taskforce",
"expirationDateTime": null,
"groupTypes": [
"Unified"
],
"isAssignableToRole": null,
"mail": "HRTaskforce@contoso.com",
"mailEnabled": true,
"mailNickname": "HRTaskforce",
"membershipRule": null,
"membershipRuleProcessingState": null,
"onPremisesDomainName": null,
"onPremisesLastSyncDateTime": null,
"onPremisesNetBiosName": null,
"onPremisesSamAccountName": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": null,
"preferredLanguage": null,
"proxyAddresses": [
"SMTP:HRTaskforce@contoso.com",
"SPO:SPO_896cf652-b200-4b74-8111-c013f64406cf@SPO_dcd219dd-bc68-4b9b-bf0b-4a33a796be35"
],
"renewedDateTime": "2020-01-24T19:01:14Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [
"Team"
],
"securityEnabled": false,
"securityIdentifier": "S-1-12-1-45981654-1196986259-3072312199-363020343",
"serviceProvisioningErrors": [],
"theme": null,
"visibility": "Private",
"onPremisesProvisioningErrors": []
}
}
Create Managed App
Create a new App object. | key: createManagedApp
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string / Required description | Help your device users understand what the app is and/or what they can do in the app. This comments will be visible to them in Company Portal. | This is an Office Suite app. | |
Developer string developer | The name of the company or Individual that developed the app. This information will be visible to people signed into the admin center. | Microsoft | |
Display Name string / Required displayName | Add a name for the app. This name will be visible in the Intune apps list and to users in the Company Portal. | Office Suite App | |
Information URL string informationUrl | Link people to a website or documentation that has more information about the app. The information URL will be visible to users in Company Portal. | https://example.com/informationUrl/ | |
Is Featured boolean / Required isFeatured | false | Show this as a featured app in the Company Portal. Featured apps are prominently placed in Company Portal so that users can quickly get to them. | |
Icon Image Type string largeIconType | The type of the Icon image. This field is required if the Icon Image Data is provided. | image/png | |
Icon Image Data string largeIconValue | The base64 encoded image data for the Icon image. This field is required if the Icon Image Type is provided. | dmFsdWU= | |
Notes string notes | Add additional notes about the app. Notes will be visible to people signed in to the admin center. | An example note. | |
OData App Type string / Required odataTypeApp | The type of app to create. This depends on the platform of the app. Check the Microsoft Graph API documentation for the correct type. Documentation for an Office Suite app can be found here https://learn.microsoft.com/en-us/graph/api/intune-apps-officesuiteapp-create?view=graph-rest-beta | #microsoft.graph.officeSuiteApp | |
Owner string owner | The name of the person in your organization who manages licensing or is the point-of-contact for this app. This name will be visible to people signed in to the admin center. | John Doe | |
Privacy Information URL string privacyInformationUrl | Provide a link for people who want to learn more about the app's privacy settings and terms. The privacy URL will be visible to users in Company Portal. | https://example.com/privacyInformationUrl/ | |
Publisher string publisher | The name of the developer or company that distributes the app. This information will be visible to users in Company Portal. | Microsoft | |
Specific Platform Properties code / Required specificPlatformProperties | The specific properties for the app to be created, generic properties like '@odata.type', 'displayName', 'description', etc. are alredy covered by the other inputs. This input should be a JSON object with the specific properties for the app to be created. Check the Microsoft Graph API documentation for the correct properties for the app type you are creating. Documentation for an Office Suite app can be found here https://learn.microsoft.com/en-us/graph/api/intune-apps-officesuiteapp-create?view=graph-rest-beta |
Example Payload for Create Managed App
{
"data": {
"@odata.type": "#microsoft.graph.officeSuiteApp",
"id": "9b263b46-3b46-9b26-463b-269b463b269b",
"displayName": "Display Name value",
"description": "Description value",
"publisher": "Publisher value",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent",
"type": "Type value",
"value": "dmFsdWU="
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"isFeatured": true,
"privacyInformationUrl": "https://example.com/privacyInformationUrl/",
"informationUrl": "https://example.com/informationUrl/",
"owner": "Owner value",
"developer": "Developer value",
"notes": "Notes value",
"uploadState": 11,
"publishingState": "processing",
"isAssigned": true,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"dependentAppCount": 1,
"supersedingAppCount": 3,
"supersededAppCount": 2,
"autoAcceptEula": true,
"productIds": [
"o365BusinessRetail"
],
"excludedApps": {
"@odata.type": "microsoft.graph.excludedApps",
"access": true,
"bing": true,
"excel": true,
"groove": true,
"infoPath": true,
"lync": true,
"oneDrive": true,
"oneNote": true,
"outlook": true,
"powerPoint": true,
"publisher": true,
"sharePointDesigner": true,
"teams": true,
"visio": true,
"word": true
},
"useSharedComputerActivation": true,
"updateChannel": "current",
"officeSuiteAppDefaultFileFormat": "officeOpenXMLFormat",
"officePlatformArchitecture": "x86",
"localesToInstall": [
"Locales To Install value"
],
"installProgressDisplayLevel": "full",
"shouldUninstallOlderVersionsOfOffice": true,
"targetVersion": "Target Version value",
"updateVersion": "Update Version value",
"officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}
}
Create Mobile App Assignment
Create a mobile app assignment. | key: createMobileAppAssignment
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Intent string / Required intent | The intent of the assignment for the managed app. A 'Required' option will force the app to be installed on the device. An 'Available' option will make the app available for the user to install. An 'Uninstall' option will remove the app from the device. An 'Available Without Enrollment' option will make the app available for the user to install without enrolling the device. | available | |
Mobile App Id string / Required mobileAppId | The ID of the mobile app to create the assignment for. | 0177548a-548a-0177-8a54-77018a547701 | |
Settings string / Required settings | The mobile app assignment settings | microsoft.graph.windowsUniversalAppXAppAssignmentSettings | |
Target string / Required target | The mobile app assignment target | microsoft.graph.allLicensedUsersAssignmentTarget |
Example Payload for Create Mobile App Assignment
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.mobileAppAssignment",
"id": "591620b7-20b7-5916-b720-1659b7201659",
"intent": "required",
"target": {
"@odata.type": "microsoft.graph.allLicensedUsersAssignmentTarget"
},
"settings": {
"@odata.type": "microsoft.graph.windowsUniversalAppXAppAssignmentSettings",
"useDeviceContext": true
}
}
}
}
Create Subscription
Create a subscription. | key: createSubscription
Input | Default | Notes | Example |
---|---|---|---|
Body Fields code bodyFields | Extra fields to include in the request body. | ||
Change Type string / Required Value List changeType | Indicates the type of change in the subscribed resource that raises a change notification. | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Expiration Date Time string expirationDateTime | Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. | 2016-11-20T18:23:45.9356913Z | |
Lifecycle Notification URL string lifecycleNotificationUrl | Required for Teams resources if the expirationDateTime value is more than 1 hour from now; optional otherwise. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. | https://example.com | |
Notification URL string / Required notificationUrl | The URL to send notifications to. | https://example.com | |
Resource string / Required resource | The resource that will be monitored for changes. See https://learn.microsoft.com/en-us/graph/api/resources/change-notifications-api-overview?view=graph-rest-1.0 | users |
Example Payload for Create Subscription
{
"data": [
{
"id": "7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
"resource": "me/messages",
"applicationId": "string",
"changeType": "created,updated",
"clientState": "secretClientValue",
"notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
"lifecycleNotificationUrl": "https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
"expirationDateTime": "2016-11-20T18:23:45.9356913Z",
"creatorId": "string",
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": "",
"encryptionCertificateId": "",
"includeResourceData": false,
"notificationContentType": "application/json"
}
]
}
Create User
Create a new user. | key: createUser
Input | Default | Notes | Example |
---|---|---|---|
Account Enabled boolean / Required accountEnabled | true | Indicates if the account is enabled. | |
Additional Properties code additionalProperties | Additional properties that are not covered by the other inputs. This should be a JSON object and will be merged with the other inputs. You can get additional properties from the Microsoft Graph API documentation https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#json-representation | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Display Name string / Required displayName | The display name of the user. | John | |
Domain string / Required domain | The domain for the user, this must be an existing domain in the tenant, you can list them using the 'List Domains' action. | Prismatic690.onmicrosoft.com | |
Force Change Password Next Sign In boolean / Required forceChangePasswordNextSignIn | true | Indicates if the user is forced to change their password on next sign in. | |
Password password / Required password | The password of the user. | Jaka889740 | |
User Principal Name string / Required userPrincipalName | The user principal name of the user. | John |
Example Payload for Create User
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
"businessPhones": [],
"displayName": "Adele Vance",
"givenName": "Adele",
"jobTitle": "Product Marketing Manager",
"mail": "AdeleV@contoso.com",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "AdeleV@contoso.com"
}
}
Delete Group
Delete a single group. | key: deleteGroup
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Group Id string / Required groupId | The ID of the group delete. | caf60db6-0db6-caf6-b60d-f6cab60df6ca |
Example Payload for Delete Group
{
"data": {
"data": "Action successfully completed."
}
}
Delete Managed App
Deletes an App. | key: deleteManagedApp
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Mobile App ID string / Required mobileAppId | The ID of the app to delete. | e0741df2-bae3-4649-9599-c47026da1234 |
Example Payload for Delete Managed App
{
"data": {}
}
Delete Managed Device
Deletes a Managed Device. | key: deleteManagedDevice
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Managed Device Id string / Required managedDeviceId | Unique Identifier for the device to delete. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Delete Managed Device
{
"data": {}
}
Delete Mobile App Assignment
Delete a single mobile app assignment. | key: deleteMobileAppAssignment
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Mobile App Assignment Id string / Required mobileAppAssignmentId | The ID of the mobile app assignment to delete. | 0177548a-548a-0177-8a54-77018a547701 | |
Mobile App Id string / Required mobileAppId | The ID of the mobile app to delete the assignment from. | 0177548a-548a-0177-8a54-77018a547701 |
Example Payload for Delete Mobile App Assignment
{
"data": {
"data": "Action successfully completed."
}
}
Delete Subscription by Id
Delete a single subscription by its ID. | key: deleteSubscription
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Subscription ID string / Required subscriptionId | The ID of the subscription to delete. | 7f105c7d-2dc5-4530-97cd-4e7ae6534c07 |
Example Payload for Delete Subscription by Id
{
"data": {
"data": "Action successfully completed."
}
}
Delete Subscriptions from an Endpoint
Delete all subscriptions from an endpoint. | key: deleteAllSubscription
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Notification URL string / Required notificationUrl | The URL from which to delete all subscriptions. | https://example.com |
Example Payload for Delete Subscriptions from an Endpoint
{
"data": [
"7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
"0fc0d6db-0073-42e5-a186-853da75fb308"
]
}
Delete User
Deletes a User. | key: deleteUser
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
User Id string / Required userId | Unique Identifier for the user to delete. This can be the user's id or userPrincipalName. | d36894ae-94ae-d368-ae94-68d3ae9468d3 |
Example Payload for Delete User
{
"data": {}
}
Get Detected App
Read properties and relationships of the Detected Apps object. | key: getDetectedApp
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Detected App Id string / Required detectedAppId | Unique Identifier for the detected app to retrieve. | caf60db6-0db6-caf6-b60d-f6cab60df6ca |
Example Payload for Get Detected App
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.detectedApp",
"id": "caf60db6-0db6-caf6-b60d-f6cab60df6ca",
"displayName": "Display Name value",
"version": "Version value",
"sizeInByte": 10,
"deviceCount": 11,
"publisher": "Publisher value",
"platform": "windows"
}
}
}
Get Device Compliance Policy
Get a device compliance policy by ID. | key: getDeviceCompliancePolicy
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Device Compliance Policy Id string / Required deviceCompliancePolicyId | Unique Identifier for the device compliance policy to retrieve. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Get Device Compliance Policy
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.deviceCompliancePolicy",
"id": "4214b716-b716-4214-16b7-144216b71442",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"displayName": "Display Name value",
"version": 7
}
}
}
Get Device Compliance Policy Setting State Summary
Retrieve a device compliance policy setting state summary by its ID. | key: getDeviceCompliancePolicySettingStateSummary
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Device Compliance Policy Setting State Summary Id string / Required deviceCompliancePolicySettingStateSummaryId | Unique Identifier for the device compliance policy setting state summary to retrieve. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Get Device Compliance Policy Setting State Summary
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.deviceCompliancePolicySettingStateSummary",
"id": "7474d6d5-d6d5-7474-d5d6-7474d5d67474",
"setting": "Setting value",
"settingName": "Setting Name value",
"platformType": "iOS",
"unknownDeviceCount": 2,
"notApplicableDeviceCount": 8,
"compliantDeviceCount": 4,
"remediatedDeviceCount": 5,
"nonCompliantDeviceCount": 7,
"errorDeviceCount": 0,
"conflictDeviceCount": 3
}
}
}
Get Device Configuration
Get the device configurations. | key: getDeviceConfigurations
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Device Configuration Id string / Required deviceConfigurationId | Unique Identifier for the device to retrieve. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Get Device Configuration
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.deviceConfiguration",
"id": "34977265-7265-3497-6572-973465729734",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"displayName": "Display Name value",
"version": 7
}
}
}
Get Directory Audit
Get a specific Microsoft Entra audit log item. | key: getDirectoyAudit
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Microsoft Entra Id string / Required microsoftEntraId | The unique identifier for the Microsoft Entra audit log item to retrieve. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Get Directory Audit
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#auditlogs/directoryaudits",
"value": [
{
"id": "id",
"category": "UserManagement",
"correlationId": "da159bfb-54fa-4092-8a38-6e1fa7870e30",
"result": "success",
"resultReason": "Successfully added member to group",
"activityDisplayName": "Add member to group",
"activityDateTime": "2018-01-09T21:20:02.7215374Z",
"loggedByService": "Core Directory",
"initiatedBy": {
"user": {
"id": "728309ae-1a37-4937-9afe-e35d964db09b",
"displayName": "Audry Oliver",
"userPrincipalName": "bob@wingtiptoysonline.com",
"ipAddress": "127.0.0.1"
},
"app": null
},
"targetResource": [
{
"id": "ef7e527d-6c92-4234-8c6d-cf6fdfb57f95",
"displayName": "Example.com",
"Type": "Group",
"modifiedProperties": [
{
"displayName": "Action Client Name",
"oldValue": null,
"newValue": "DirectorySync"
}
],
"groupType": "unifiedGroups"
},
{
"id": "1f0e98f5-3161-4c6b-9b50-d488572f2bb7",
"displayName": null,
"Type": "User",
"modifiedProperties": [],
"userPrincipalName": "example@contoso.com"
}
],
"additionalDetails": [
{
"key": "Additional Detail Name",
"value": "Additional Detail Value"
}
]
}
]
}
}
Get Group
Retrieve a single group. | key: getGroup
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Group Id string / Required groupId | The ID of the group retrieve. | caf60db6-0db6-caf6-b60d-f6cab60df6ca |
Example Payload for Get Group
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
"id": "02bd9fd6-8f93-4758-87c3-1fb73740a315",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2017-07-31T18:56:16Z",
"description": "Welcome to the HR Taskforce team.",
"displayName": "HR Taskforce",
"expirationDateTime": null,
"groupTypes": [
"Unified"
],
"isAssignableToRole": null,
"mail": "HRTaskforce@contoso.com",
"mailEnabled": true,
"mailNickname": "HRTaskforce",
"membershipRule": null,
"membershipRuleProcessingState": null,
"onPremisesDomainName": null,
"onPremisesLastSyncDateTime": null,
"onPremisesNetBiosName": null,
"onPremisesSamAccountName": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": null,
"preferredLanguage": null,
"proxyAddresses": [
"SMTP:HRTaskforce@contoso.com",
"SPO:SPO_896cf652-b200-4b74-8111-c013f64406cf@SPO_dcd219dd-bc68-4b9b-bf0b-4a33a796be35"
],
"renewedDateTime": "2020-01-24T19:01:14Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [
"Team"
],
"securityEnabled": false,
"securityIdentifier": "S-1-12-1-45981654-1196986259-3072312199-363020343",
"serviceProvisioningErrors": [],
"theme": null,
"visibility": "Private",
"onPremisesProvisioningErrors": []
}
}
Get Managed App
Read properties and relationships of an App object. | key: getManagedApp
Input | Default | Notes | Example |
---|---|---|---|
App Id string / Required appId | The unique identifier of a managed app. You can get this from the 'List Managed Apps' action. | caf60db6-0db6-caf6-b60d-f6cab60df6ca | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Get Managed App
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.mobileApp",
"id": "0177548a-548a-0177-8a54-77018a547701",
"displayName": "Display Name value",
"description": "Description value",
"publisher": "Publisher value",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent",
"type": "Type value",
"value": "dmFsdWU="
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"isFeatured": true,
"privacyInformationUrl": "https://example.com/privacyInformationUrl/",
"informationUrl": "https://example.com/informationUrl/",
"owner": "Owner value",
"developer": "Developer value",
"notes": "Notes value",
"publishingState": "processing"
}
}
}
Get Managed Device
Read properties and relationships of the Managed Device object. | key: getManagedDevice
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Managed Device Id string / Required managedDeviceId | Unique Identifier for the device to retrieve. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Get Managed Device
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.managedDevice",
"id": "705c034c-034c-705c-4c03-5c704c035c70",
"userId": "User Id value",
"deviceName": "Device Name value",
"managedDeviceOwnerType": "company",
"deviceActionResults": [
{
"@odata.type": "microsoft.graph.deviceActionResult",
"actionName": "Action Name value",
"actionState": "pending",
"startDateTime": "2016-12-31T23:58:46.7156189-08:00",
"lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00"
}
],
"enrolledDateTime": "2016-12-31T23:59:43.797191-08:00",
"lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00",
"operatingSystem": "Operating System value",
"complianceState": "compliant",
"jailBroken": "Jail Broken value",
"managementAgent": "mdm",
"osVersion": "Os Version value",
"easActivated": true,
"easDeviceId": "Eas Device Id value",
"easActivationDateTime": "2016-12-31T23:59:43.4878784-08:00",
"azureADRegistered": true,
"deviceEnrollmentType": "userEnrollment",
"activationLockBypassCode": "Activation Lock Bypass Code value",
"emailAddress": "Email Address value",
"azureADDeviceId": "Azure ADDevice Id value",
"deviceRegistrationState": "registered",
"deviceCategoryDisplayName": "Device Category Display Name value",
"isSupervised": true,
"exchangeLastSuccessfulSyncDateTime": "2017-01-01T00:00:45.8803083-08:00",
"exchangeAccessState": "unknown",
"exchangeAccessStateReason": "unknown",
"remoteAssistanceSessionUrl": "https://example.com/remoteAssistanceSessionUrl/",
"remoteAssistanceSessionErrorDetails": "Remote Assistance Session Error Details value",
"isEncrypted": true,
"userPrincipalName": "User Principal Name value",
"model": "Model value",
"manufacturer": "Manufacturer value",
"imei": "Imei value",
"complianceGracePeriodExpirationDateTime": "2016-12-31T23:56:44.951111-08:00",
"serialNumber": "Serial Number value",
"phoneNumber": "Phone Number value",
"androidSecurityPatchLevel": "Android Security Patch Level value",
"userDisplayName": "User Display Name value",
"configurationManagerClientEnabledFeatures": {
"@odata.type": "microsoft.graph.configurationManagerClientEnabledFeatures",
"inventory": true,
"modernApps": true,
"resourceAccess": true,
"deviceConfiguration": true,
"compliancePolicy": true,
"windowsUpdateForBusiness": true
},
"wiFiMacAddress": "Wi Fi Mac Address value",
"deviceHealthAttestationState": {
"@odata.type": "microsoft.graph.deviceHealthAttestationState",
"lastUpdateDateTime": "Last Update Date Time value",
"contentNamespaceUrl": "https://example.com/contentNamespaceUrl/",
"deviceHealthAttestationStatus": "Device Health Attestation Status value",
"contentVersion": "Content Version value",
"issuedDateTime": "2016-12-31T23:58:22.1231038-08:00",
"attestationIdentityKey": "Attestation Identity Key value",
"resetCount": 10,
"restartCount": 12,
"dataExcutionPolicy": "Data Excution Policy value",
"bitLockerStatus": "Bit Locker Status value",
"bootManagerVersion": "Boot Manager Version value",
"codeIntegrityCheckVersion": "Code Integrity Check Version value",
"secureBoot": "Secure Boot value",
"bootDebugging": "Boot Debugging value",
"operatingSystemKernelDebugging": "Operating System Kernel Debugging value",
"codeIntegrity": "Code Integrity value",
"testSigning": "Test Signing value",
"safeMode": "Safe Mode value",
"windowsPE": "Windows PE value",
"earlyLaunchAntiMalwareDriverProtection": "Early Launch Anti Malware Driver Protection value",
"virtualSecureMode": "Virtual Secure Mode value",
"pcrHashAlgorithm": "Pcr Hash Algorithm value",
"bootAppSecurityVersion": "Boot App Security Version value",
"bootManagerSecurityVersion": "Boot Manager Security Version value",
"tpmVersion": "Tpm Version value",
"pcr0": "Pcr0 value",
"secureBootConfigurationPolicyFingerPrint": "Secure Boot Configuration Policy Finger Print value",
"codeIntegrityPolicy": "Code Integrity Policy value",
"bootRevisionListInfo": "Boot Revision List Info value",
"operatingSystemRevListInfo": "Operating System Rev List Info value",
"healthStatusMismatchInfo": "Health Status Mismatch Info value",
"healthAttestationSupportedStatus": "Health Attestation Supported Status value"
},
"subscriberCarrier": "Subscriber Carrier value",
"meid": "Meid value",
"totalStorageSpaceInBytes": 8,
"freeStorageSpaceInBytes": 7,
"managedDeviceName": "Managed Device Name value",
"partnerReportedThreatState": "activated",
"requireUserEnrollmentApproval": true,
"managementCertificateExpirationDate": "2016-12-31T23:57:59.9789653-08:00",
"iccid": "Iccid value",
"udid": "Udid value",
"notes": "Notes value",
"ethernetMacAddress": "Ethernet Mac Address value",
"physicalMemoryInBytes": 5,
"enrollmentProfileName": "Enrollment Profile Name value"
}
}
}
Get Mobile App
Retrieve a single mobile app. | key: getMobileApp
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Mobile App Id string / Required mobileAppId | Unique Identifier for the mobile app to get. | 0177548a-548a-0177-8a54-77018a547701 |
Example Payload for Get Mobile App
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.mobileApp",
"id": "0177548a-548a-0177-8a54-77018a547701",
"displayName": "Display Name value",
"description": "Description value",
"publisher": "Publisher value",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent",
"type": "Type value",
"value": "dmFsdWU="
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"isFeatured": true,
"privacyInformationUrl": "https://example.com/privacyInformationUrl/",
"informationUrl": "https://example.com/informationUrl/",
"owner": "Owner value",
"developer": "Developer value",
"notes": "Notes value",
"publishingState": "processing"
}
}
}
Get Mobile App Assignment
Retrieve a single mobile app assignment. | key: getMobileAppAssignment
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Mobile App Assignment Id string / Required mobileAppAssignmentId | Unique Identifier for the mobile app assignment to get. | 0177548a-548a-0177-8a54-77018a547701 | |
Mobile App Id string / Required mobileAppId | Unique Identifier for the mobile app to get. | 0177548a-548a-0177-8a54-77018a547701 |
Example Payload for Get Mobile App Assignment
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.mobileAppAssignment",
"id": "591620b7-20b7-5916-b720-1659b7201659",
"intent": "required",
"target": {
"@odata.type": "microsoft.graph.allLicensedUsersAssignmentTarget"
},
"settings": {
"@odata.type": "microsoft.graph.windowsUniversalAppXAppAssignmentSettings",
"useDeviceContext": true
}
}
}
}
Get Subscription
Retrieve a single subscription. | key: getSubscription
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Subscription ID string / Required subscriptionId | The ID of the subscription to retrieve. | 7f105c7d-2dc5-4530-97cd-4e7ae6534c07 |
Example Payload for Get Subscription
{
"data": [
{
"id": "7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
"resource": "me/messages",
"applicationId": "string",
"changeType": "created,updated",
"clientState": "secretClientValue",
"notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
"lifecycleNotificationUrl": "https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
"expirationDateTime": "2016-11-20T18:23:45.9356913Z",
"creatorId": "string",
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": "",
"encryptionCertificateId": "",
"includeResourceData": false,
"notificationContentType": "application/json"
}
]
}
Get User
Read properties and relationships of the User object. | key: getUser
Input | Default | Notes | Example |
---|---|---|---|
Select string $select | Filters properties (columns). | givenName,surname | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
User Id string / Required userId | Unique Identifier for the user to get. This can be the user's id or userPrincipalName. | d36894ae-94ae-d368-ae94-68d3ae9468d3 |
Example Payload for Get User
{
"data": {
"businessPhones": [
"+1 425 555 0109"
],
"displayName": "Adele Vance",
"givenName": "Adele",
"jobTitle": "Retail Manager",
"mail": "AdeleV@contoso.com",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "AdeleV@contoso.com",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
}
}
List Detected Apps
List properties and relationships of the Detected Apps objects. | key: listDetectedApps
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Detected Apps
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.detectedApp",
"id": "caf60db6-0db6-caf6-b60d-f6cab60df6ca",
"displayName": "Display Name value",
"version": "Version value",
"sizeInByte": 10,
"deviceCount": 11,
"publisher": "Publisher value",
"platform": "windows"
}
]
}
}
List Device Compliance Policies
List all device compliance policies. | key: listDeviceCompliancePolicies
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Device Compliance Policies
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.deviceCompliancePolicy",
"id": "4214b716-b716-4214-16b7-144216b71442",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"displayName": "Display Name value",
"version": 7
}
]
}
}
List Device Compliance Policy Setting State Summaries
Retrieve a list of device compliance policy setting state summaries. | key: listDeviceCompliancePolicySettingStateSummaries
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Device Compliance Policy Setting State Summaries
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.deviceCompliancePolicySettingStateSummary",
"id": "7474d6d5-d6d5-7474-d5d6-7474d5d67474",
"setting": "Setting value",
"settingName": "Setting Name value",
"platformType": "iOS",
"unknownDeviceCount": 2,
"notApplicableDeviceCount": 8,
"compliantDeviceCount": 4,
"remediatedDeviceCount": 5,
"nonCompliantDeviceCount": 7,
"errorDeviceCount": 0,
"conflictDeviceCount": 3
}
]
}
}
List Device Configurations
List all device configurations. | key: listDeviceConfigurations
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Device Configurations
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.deviceConfiguration",
"id": "34977265-7265-3497-6572-973465729734",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"displayName": "Display Name value",
"version": 7
}
]
}
}
List Directory Audits
Retrieve a list of directory audits. | key: listDirectoryAudits
Input | Default | Notes | Example |
---|---|---|---|
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Order By string $orderBy | Orders results. | displayName desc | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. |
Example Payload for List Directory Audits
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#auditlogs/directoryaudits",
"value": [
{
"id": "id",
"category": "UserManagement",
"correlationId": "da159bfb-54fa-4092-8a38-6e1fa7870e30",
"result": "success",
"resultReason": "Successfully added member to group",
"activityDisplayName": "Add member to group",
"activityDateTime": "2018-01-09T21:20:02.7215374Z",
"loggedByService": "Core Directory",
"initiatedBy": {
"user": {
"id": "728309ae-1a37-4937-9afe-e35d964db09b",
"displayName": "Audry Oliver",
"userPrincipalName": "bob@wingtiptoysonline.com",
"ipAddress": "127.0.0.1"
},
"app": null
},
"targetResources": [
{
"id": "ef7e527d-6c92-4234-8c6d-cf6fdfb57f95",
"displayName": "Example.com",
"Type": "Group",
"modifiedProperties": [
{
"displayName": "Action Client Name",
"oldValue": null,
"newValue": "DirectorySync"
}
],
"groupType": "unifiedGroups"
},
{
"id": "1f0e98f5-3161-4c6b-9b50-d488572f2bb7",
"displayName": null,
"Type": "User",
"modifiedProperties": [],
"userPrincipalName": "bob@contoso.com"
}
],
"additionalDetails": [
{
"key": "Additional Detail Name",
"value": "Additional Detail Value"
}
]
}
]
}
}
List Domains
Retrieve a list of domain objects. | key: listDomains
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Domains
{
"data": {
"value": [
{
"authenticationType": "authenticationType-value",
"availabilityStatus": "availabilityStatus-value",
"isAdminManaged": true,
"isDefault": true,
"isInitial": true,
"isRoot": true,
"id": "contoso.com",
"supportedServices": [
"Email",
"OfficeCommunicationsOnline"
]
}
]
}
}
List Groups
List all groups. | key: listGroups
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. |
Example Payload for List Groups
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups",
"value": [
{
"id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2018-12-22T02:21:05Z",
"description": "Self help community for golf",
"displayName": "Golf Assist",
"expirationDateTime": null,
"groupTypes": [
"Unified"
],
"isAssignableToRole": null,
"mail": "golfassist@contoso.com",
"mailEnabled": true,
"mailNickname": "golfassist",
"membershipRule": null,
"membershipRuleProcessingState": null,
"onPremisesLastSyncDateTime": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": "CAN",
"preferredLanguage": null,
"proxyAddresses": [
"smtp:golfassist@contoso.com",
"SMTP:golfassist@contoso.com"
],
"renewedDateTime": "2018-12-22T02:21:05Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [],
"securityEnabled": false,
"theme": null,
"visibility": "Public",
"onPremisesProvisioningErrors": []
},
{
"id": "d7797254-3084-44d0-99c9-a3b5ab149538",
"deletedDateTime": null,
"classification": null,
"createdDateTime": "2018-11-19T20:29:40Z",
"description": "Talk about golf",
"displayName": "Golf Discussion",
"expirationDateTime": null,
"groupTypes": [],
"isAssignableToRole": null,
"mail": "golftalk@contoso.com",
"mailEnabled": true,
"mailNickname": "golftalk",
"membershipRule": null,
"membershipRuleProcessingState": null,
"onPremisesLastSyncDateTime": null,
"onPremisesSecurityIdentifier": null,
"onPremisesSyncEnabled": null,
"preferredDataLocation": "CAN",
"preferredLanguage": null,
"proxyAddresses": [
"smtp:golftalk@contoso.com",
"SMTP:golftalk@contoso.com"
],
"renewedDateTime": "2018-11-19T20:29:40Z",
"resourceBehaviorOptions": [],
"resourceProvisioningOptions": [],
"securityEnabled": false,
"serviceProvisioningErrors": [],
"theme": null,
"visibility": null,
"onPremisesProvisioningErrors": []
}
]
}
}
List Managed Apps
List all managed apps in Intune. | key: listManagedApps
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | (microsoft.graph.managedApp/appAvailability eq null or microsoft.graph.managedApp/appAvailability eq 'lineOfBusiness' or isAssigned eq true) | Filters results (rows). | startswith(givenName,'J') |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Managed Apps
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.webApp",
"id": "4bdc5d30-5d30-4bdc-305d-dc4b305ddc4b",
"displayName": "Display Name value",
"description": "Description value",
"publisher": "Publisher value",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent",
"type": "Type value",
"value": "dmFsdWU="
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"isFeatured": true,
"privacyInformationUrl": "https://example.com/privacyInformationUrl/",
"informationUrl": "https://example.com/informationUrl/",
"owner": "Owner value",
"developer": "Developer value",
"notes": "Notes value",
"publishingState": "processing",
"appUrl": "https://example.com/appUrl/",
"useManagedBrowser": true
}
]
}
}
List Managed Devices
List properties and relationships of the Managed Device objects. | key: listManagedDevices
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Managed Devices
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.managedDevice",
"id": "705c034c-034c-705c-4c03-5c704c035c70",
"userId": "User Id value",
"deviceName": "Device Name value",
"managedDeviceOwnerType": "company",
"deviceActionResults": [
{
"@odata.type": "microsoft.graph.deviceActionResult",
"actionName": "Action Name value",
"actionState": "pending",
"startDateTime": "2016-12-31T23:58:46.7156189-08:00",
"lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00"
}
],
"enrolledDateTime": "2016-12-31T23:59:43.797191-08:00",
"lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00",
"operatingSystem": "Operating System value",
"complianceState": "compliant",
"jailBroken": "Jail Broken value",
"managementAgent": "mdm",
"osVersion": "Os Version value",
"easActivated": true,
"easDeviceId": "Eas Device Id value",
"easActivationDateTime": "2016-12-31T23:59:43.4878784-08:00",
"azureADRegistered": true,
"deviceEnrollmentType": "userEnrollment",
"activationLockBypassCode": "Activation Lock Bypass Code value",
"emailAddress": "Email Address value",
"azureADDeviceId": "Azure ADDevice Id value",
"deviceRegistrationState": "registered",
"deviceCategoryDisplayName": "Device Category Display Name value",
"isSupervised": true,
"exchangeLastSuccessfulSyncDateTime": "2017-01-01T00:00:45.8803083-08:00",
"exchangeAccessState": "unknown",
"exchangeAccessStateReason": "unknown",
"remoteAssistanceSessionUrl": "https://example.com/remoteAssistanceSessionUrl/",
"remoteAssistanceSessionErrorDetails": "Remote Assistance Session Error Details value",
"isEncrypted": true,
"userPrincipalName": "User Principal Name value",
"model": "Model value",
"manufacturer": "Manufacturer value",
"imei": "Imei value",
"complianceGracePeriodExpirationDateTime": "2016-12-31T23:56:44.951111-08:00",
"serialNumber": "Serial Number value",
"phoneNumber": "Phone Number value",
"androidSecurityPatchLevel": "Android Security Patch Level value",
"userDisplayName": "User Display Name value",
"configurationManagerClientEnabledFeatures": {
"@odata.type": "microsoft.graph.configurationManagerClientEnabledFeatures",
"inventory": true,
"modernApps": true,
"resourceAccess": true,
"deviceConfiguration": true,
"compliancePolicy": true,
"windowsUpdateForBusiness": true
},
"wiFiMacAddress": "Wi Fi Mac Address value",
"deviceHealthAttestationState": {
"@odata.type": "microsoft.graph.deviceHealthAttestationState",
"lastUpdateDateTime": "Last Update Date Time value",
"contentNamespaceUrl": "https://example.com/contentNamespaceUrl/",
"deviceHealthAttestationStatus": "Device Health Attestation Status value",
"contentVersion": "Content Version value",
"issuedDateTime": "2016-12-31T23:58:22.1231038-08:00",
"attestationIdentityKey": "Attestation Identity Key value",
"resetCount": 10,
"restartCount": 12,
"dataExcutionPolicy": "Data Excution Policy value",
"bitLockerStatus": "Bit Locker Status value",
"bootManagerVersion": "Boot Manager Version value",
"codeIntegrityCheckVersion": "Code Integrity Check Version value",
"secureBoot": "Secure Boot value",
"bootDebugging": "Boot Debugging value",
"operatingSystemKernelDebugging": "Operating System Kernel Debugging value",
"codeIntegrity": "Code Integrity value",
"testSigning": "Test Signing value",
"safeMode": "Safe Mode value",
"windowsPE": "Windows PE value",
"earlyLaunchAntiMalwareDriverProtection": "Early Launch Anti Malware Driver Protection value",
"virtualSecureMode": "Virtual Secure Mode value",
"pcrHashAlgorithm": "Pcr Hash Algorithm value",
"bootAppSecurityVersion": "Boot App Security Version value",
"bootManagerSecurityVersion": "Boot Manager Security Version value",
"tpmVersion": "Tpm Version value",
"pcr0": "Pcr0 value",
"secureBootConfigurationPolicyFingerPrint": "Secure Boot Configuration Policy Finger Print value",
"codeIntegrityPolicy": "Code Integrity Policy value",
"bootRevisionListInfo": "Boot Revision List Info value",
"operatingSystemRevListInfo": "Operating System Rev List Info value",
"healthStatusMismatchInfo": "Health Status Mismatch Info value",
"healthAttestationSupportedStatus": "Health Attestation Supported Status value"
},
"subscriberCarrier": "Subscriber Carrier value",
"meid": "Meid value",
"totalStorageSpaceInBytes": 8,
"freeStorageSpaceInBytes": 7,
"managedDeviceName": "Managed Device Name value",
"partnerReportedThreatState": "activated",
"requireUserEnrollmentApproval": true,
"managementCertificateExpirationDate": "2016-12-31T23:57:59.9789653-08:00",
"iccid": "Iccid value",
"udid": "Udid value",
"notes": "Notes value",
"ethernetMacAddress": "Ethernet Mac Address value",
"physicalMemoryInBytes": 5,
"enrollmentProfileName": "Enrollment Profile Name value"
}
]
}
}
List Mobile App Assignments
List all assignments for a mobile app. | key: listMobileAppAssignments
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Mobile App Id string / Required mobileAppId | Unique Identifier for the mobile app to get. | 0177548a-548a-0177-8a54-77018a547701 |
Example Payload for List Mobile App Assignments
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.mobileAppAssignment",
"id": "591620b7-20b7-5916-b720-1659b7201659",
"intent": "required",
"target": {
"@odata.type": "microsoft.graph.allLicensedUsersAssignmentTarget"
},
"settings": {
"@odata.type": "microsoft.graph.windowsUniversalAppXAppAssignmentSettings",
"useDeviceContext": true
}
}
]
}
}
List Mobile Apps
Retrieve a list of mobile apps. | key: listMobileApps
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. |
Example Payload for List Mobile Apps
{
"data": {
"value": [
{
"@odata.type": "#microsoft.graph.mobileApp",
"id": "0177548a-548a-0177-8a54-77018a547701",
"displayName": "Display Name value",
"description": "Description value",
"publisher": "Publisher value",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent",
"type": "Type value",
"value": "dmFsdWU="
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"isFeatured": true,
"privacyInformationUrl": "https://example.com/privacyInformationUrl/",
"informationUrl": "https://example.com/informationUrl/",
"owner": "Owner value",
"developer": "Developer value",
"notes": "Notes value",
"publishingState": "processing"
}
]
}
}
List Software Update Status Summary
List the status summary of a software update. | key: listSoftwareUpdateStatusSummary
Input | Default | Notes | Example |
---|---|---|---|
Expand string $expand | Retrieves related resources. | members | |
Format string $format | Returns the results in the specified media format. | json | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. |
Example Payload for List Software Update Status Summary
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.detectedApp",
"id": "caf60db6-0db6-caf6-b60d-f6cab60df6ca",
"displayName": "Display Name value",
"version": "Version value",
"sizeInByte": 10,
"deviceCount": 11,
"publisher": "Publisher value",
"platform": "windows"
}
}
}
List Subscriptions
List all Subscriptions. | key: listSubscriptions
Input | Default | Notes | Example |
---|---|---|---|
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. |
Example Payload for List Subscriptions
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions",
"value": [
{
"id": "0fc0d6db-0073-42e5-a186-853da75fb308",
"resource": "Users",
"applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
"changeType": "updated,deleted",
"clientState": null,
"notificationUrl": "https://webhookappexample.azurewebsites.net/api/notifications",
"lifecycleNotificationUrl": "https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
"expirationDateTime": "2018-03-12T05:00:00Z",
"creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": "",
"encryptionCertificateId": "",
"includeResourceData": false,
"notificationContentType": "application/json"
}
]
}
}
List Users
Retrieve a list of user objects. | key: listUsers
Input | Default | Notes | Example |
---|---|---|---|
Count boolean $count | false | Retrieves the total count of matching resources. | |
Expand string $expand | Retrieves related resources. | members | |
Filter string $filter | Filters results (rows). | startswith(givenName,'J') | |
Format string $format | Returns the results in the specified media format. | json | |
Order By string $orderBy | Orders results. | displayName desc | |
Search string $search | Returns results based on search criteria. | pizza | |
Select string $select | Filters properties (columns). | givenName,surname | |
Skip string $skip | Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results. | 10 | |
Skip Token string $skipToken | Retrieves the next page of results from result sets that span multiple pages. | X%274453707402000100000017... | |
Top string $top | Sets the page size of results. | 10 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for List Users
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users",
"value": [
{
"businessPhones": [],
"displayName": "Conf Room Adams",
"givenName": null,
"jobTitle": null,
"mail": "Adams@contoso.com",
"mobilePhone": null,
"officeLocation": null,
"preferredLanguage": null,
"surname": null,
"userPrincipalName": "Adams@contoso.com",
"id": "6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0"
},
{
"businessPhones": [
"425-555-0100"
],
"displayName": "MOD Administrator",
"givenName": "MOD",
"jobTitle": null,
"mail": null,
"mobilePhone": "425-555-0101",
"officeLocation": null,
"preferredLanguage": "en-US",
"surname": "Administrator",
"userPrincipalName": "admin@contoso.com",
"id": "4562bcc8-c436-4f95-b7c0-4f8ce89dca5e"
}
]
}
}
Raw Request
Send raw HTTP request to Microsoft Intune API | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersion | The version of the API to use. | ||
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enable this to log the request and response | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/deviceManagement/detectedApps), The base URL is already included (https://graph.microsoft.com/v1.0). For example, to connect to https://graph.microsoft.com/v1.0/deviceManagement/detectedApps, only /deviceManagement/detectedApps is entered in this field. e.g. /deviceManagement/detectedApps | /sobjects/Account | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. |
Reprocess User License Assignment
Reprocess all group-based license assignments for the user. | key: reprocessUserLicenseAssignment
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
User Id string / Required userId | Unique Identifier for the user to reprocess the license assignment. This can be the user's id or userPrincipalName. | d36894ae-94ae-d368-ae94-68d3ae9468d3 |
Example Payload for Reprocess User License Assignment
{
"data": {
"accountEnabled": true,
"assignedLicenses": [
{
"disabledPlans": [
"11b0131d-43c8-4bbb-b2c8-e80f9a50834a"
],
"skuId": "skuId-value"
}
],
"assignedPlans": [
{
"assignedDateTime": "2016-10-19T10:37:00Z",
"capabilityStatus": "capabilityStatus-value",
"service": "service-value",
"servicePlanId": "bea13e0c-3828-4daa-a392-28af7ff61a0f"
}
],
"businessPhones": [
"businessPhones-value"
],
"city": "city-value",
"companyName": "companyName-value"
}
}
Retire Managed Device
Retire a device from Intune management upon employee offboarding. | key: retireDevice
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Managed Device Id string / Required managedDeviceId | Unique Identifier for the device to retire. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Retire Managed Device
{
"data": {
"data": "Action successfully completed."
}
}
Update Group
Update a single group. | key: updateGroup
Input | Default | Notes | Example |
---|---|---|---|
Assigned Labels code assignedLabels | The list of sensitivity label pairs (label ID, label name) associated with a group | ||
Body Fields code bodyFields | Extra fields to include in the request body. | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | A description for the group. | Self help community for library | |
Display Name string displayName | The name to display in the address book for the group. | Library Assist | |
Group Id string / Required groupId | The ID of the group update. | caf60db6-0db6-caf6-b60d-f6cab60df6ca | |
Mail Nickname string mailNickname | The mail alias for the group, unique for Microsoft 365 groups in the organization. | library | |
Security Enabled string securityEnabled | Set to true for mail-enabled groups. If Not Set the input will not be included in the request. | ||
Visibility string visibility | The display name for the group | The best group ever |
Example Payload for Update Group
{
"data": {
"data": "Action successfully completed."
}
}
Update Managed App
Update an App object. | key: updateManagedApp
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | Update the description to help your device users understand what the app is and/or what they can do in the app. This comments will be visible to them in Company Portal. | This is an Office Suite app. | |
Developer string developer | Update the developer of the app. This information will be visible to users in Company Portal. | Microsoft | |
Display Name string displayName | Update the name for the app. This name will be visible in the Intune apps list and to users in the Company Portal. | Office Suite App | |
Information URL string informationUrl | Update the URL that links to more information about the app. This URL will be visible to users in Company Portal. | https://example.com/informationUrl/ | |
Is Featured boolean / Required isFeatured | false | Update whether the app is featured. Featured apps are displayed prominently in the Company Portal. | |
Icon Image Type string largeIconType | Update the type of the Icon image. This field is required if the Icon Image Data is provided. | image/png | |
Icon Image Data string largeIconValue | Update the base64 encoded image data for the Icon image. This field is required if the Icon Image Type is provided. | dmFsdWU= | |
Mobile App ID string / Required mobileAppId | The ID of the app to update. | e0741df2-bae3-4649-9599-c47026da1234 | |
Notes string notes | Update any notes about the app. This information will be visible to people signed into the admin center. | An example note. | |
OData App Type string / Required odataTypeApp | The type of app to update. This depends on the platform of the app. Check the Microsoft Graph API documentation for the correct type. Documentation for an Office Suite app can be found here https://learn.microsoft.com/en-us/graph/api/intune-apps-officesuiteapp-update?view=graph-rest-beta | #microsoft.graph.officeSuiteApp | |
Owner string owner | Update the name of the person or company that owns the app. This information will be visible to people signed into the admin center. | John Doe | |
Privacy Information URL string privacyInformationUrl | Update the URL that links to the privacy information for the app. The privacy information URL will be visible to users in Company Portal. | https://example.com/privacyInformationUrl/ | |
Publisher string publisher | Update the name of the developer or company that distributes the app. This information will be visible to users in Company Portal. | Microsoft | |
Specific Platform Properties code specificPlatformProperties | The specific properties for the app to be updated, generic properties like '@odata.type', 'displayName', 'description', etc. are alredy covered by the other inputs. This input should be a JSON object with the specific properties for the app to be updated. Check the Microsoft Graph API documentation for the correct properties for the app type you are updating. Documentation for an Office Suite app can be found here https://learn.microsoft.com/en-us/graph/api/intune-apps-officesuiteapp-update?view=graph-rest-beta |
Example Payload for Update Managed App
{
"data": {
"@odata.type": "#microsoft.graph.officeSuiteApp",
"id": "9b263b46-3b46-9b26-463b-269b463b269b",
"displayName": "Display Name value",
"description": "Description value",
"publisher": "Publisher value",
"largeIcon": {
"@odata.type": "microsoft.graph.mimeContent",
"type": "Type value",
"value": "dmFsdWU="
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"isFeatured": true,
"privacyInformationUrl": "https://example.com/privacyInformationUrl/",
"informationUrl": "https://example.com/informationUrl/",
"owner": "Owner value",
"developer": "Developer value",
"notes": "Notes value",
"uploadState": 11,
"publishingState": "processing",
"isAssigned": true,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"dependentAppCount": 1,
"supersedingAppCount": 3,
"supersededAppCount": 2,
"autoAcceptEula": true,
"productIds": [
"o365BusinessRetail"
],
"excludedApps": {
"@odata.type": "microsoft.graph.excludedApps",
"access": true,
"bing": true,
"excel": true,
"groove": true,
"infoPath": true,
"lync": true,
"oneDrive": true,
"oneNote": true,
"outlook": true,
"powerPoint": true,
"publisher": true,
"sharePointDesigner": true,
"teams": true,
"visio": true,
"word": true
},
"useSharedComputerActivation": true,
"updateChannel": "current",
"officeSuiteAppDefaultFileFormat": "officeOpenXMLFormat",
"officePlatformArchitecture": "x86",
"localesToInstall": [
"Locales To Install value"
],
"installProgressDisplayLevel": "full",
"shouldUninstallOlderVersionsOfOffice": true,
"targetVersion": "Target Version value",
"updateVersion": "Update Version value",
"officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}
}
Update Managed Device
Update the properties of a Managed Device object. | key: updateManagedDevice
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Extra Fields code extraFields | Additional fields to update on the device. This is an object that can contain any additional fields that might not be covered by the other inputs. | ||
Managed Device Id string / Required managedDeviceId | Unique Identifier for the device to update. | 705c034c-034c-705c-4c03-5c704c035c70 | |
Managed Device Name string managedDeviceName | Update the automatically generated name to identify a device. | Managed Device Name value | |
Notes string notes | Updated notes for the device. Intended to be used for additional information about the device. | Notes value |
Example Payload for Update Managed Device
{
"data": {}
}
Update Mobile App Assignment
Update a mobile app assignment. | key: updateMobileAppAssignment
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Intent string / Required intent | The intent of the assignment for the managed app. A 'Required' option will force the app to be installed on the device. An 'Available' option will make the app available for the user to install. An 'Uninstall' option will remove the app from the device. An 'Available Without Enrollment' option will make the app available for the user to install without enrolling the device. | available | |
Mobile App Assignment Id string / Required mobileAppAssignmentId | The ID of the mobile app assignment to update. | 0177548a-548a-0177-8a54-77018a547701 | |
Mobile App Id string / Required mobileAppId | The ID of the mobile app to update the assignment from. | 0177548a-548a-0177-8a54-77018a547701 | |
Settings string / Required settings | The mobile app assignment settings | microsoft.graph.windowsUniversalAppXAppAssignmentSettings | |
Target string / Required target | The mobile app assignment target | microsoft.graph.allLicensedUsersAssignmentTarget |
Example Payload for Update Mobile App Assignment
{
"data": {
"value": {
"@odata.type": "#microsoft.graph.mobileAppAssignment",
"id": "591620b7-20b7-5916-b720-1659b7201659",
"intent": "required",
"target": {
"@odata.type": "microsoft.graph.allLicensedUsersAssignmentTarget"
},
"settings": {
"@odata.type": "microsoft.graph.windowsUniversalAppXAppAssignmentSettings",
"useDeviceContext": true
}
}
}
}
Update Software Update Status Summary
Update the status summary of a software update. | key: updateSoftwareUpdateStatusSummary
Input | Default | Notes | Example |
---|---|---|---|
Compliant Device Count string compliantDeviceCount | The number of devices that are compliant with the software update. | 1 | |
Compliant User Count string compliantUserCount | The number of users that are compliant with the software update. | 1 | |
Conflict Device Count string conflictDeviceCount | The number of devices that have a conflict with the software update. | 1 | |
Conflict User Count string conflictUserCount | The number of users that have a conflict with the software update. | 1 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Display Name string displayName | The display name of the software update status summary. | Software Update Status Summary | |
Error Device Count string errorDeviceCount | The number of devices that have an error with the software update. | 1 | |
Error User Count string errorUserCount | The number of users that have an error with the software update. | 1 | |
Non-Compliant Device Count string nonCompliantDeviceCount | The number of devices that are not compliant with the software update. | 1 | |
Non-Compliant User Count string nonCompliantUserCount | The number of users that are not compliant with the software update. | 1 | |
Not Applicable Device Count string notApplicableDeviceCount | The number of devices that are not applicable for the software update. | 1 | |
Not Applicable User Count string notApplicableUserCount | The number of users that are not applicable for the software update. | 1 | |
Remediated Device Count string remediatedDeviceCount | The number of devices that have been remediated. | 1 | |
Remediated User Count string remediatedUserCount | The number of users that have been remediated. | 1 | |
Unknown Device Count string unknownDeviceCount | The number of devices that have an unknown status with the software update. | 1 | |
Unknown User Count string unknownUserCount | The number of users that have an unknown status with the software update. | 1 |
Example Payload for Update Software Update Status Summary
{
"data": {
"@odata.type": "#microsoft.graph.softwareUpdateStatusSummary",
"id": "4f71421f-421f-4f71-1f42-714f1f42714f",
"displayName": "Display Name value",
"compliantDeviceCount": 4,
"nonCompliantDeviceCount": 7,
"remediatedDeviceCount": 5,
"errorDeviceCount": 0,
"unknownDeviceCount": 2,
"conflictDeviceCount": 3,
"notApplicableDeviceCount": 8,
"compliantUserCount": 2,
"nonCompliantUserCount": 5,
"remediatedUserCount": 3,
"errorUserCount": 14,
"unknownUserCount": 0,
"conflictUserCount": 1,
"notApplicableUserCount": 6
}
}
Update Subscription
Update a single subscription. | key: updateSubscription
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Expiration Date Time string expirationDateTime | Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. | 2016-11-20T18:23:45.9356913Z | |
Notification URL string notificationUrl | The URL to send notifications to. | https://example.com | |
Subscription ID string / Required subscriptionId | The ID of the subscription to update. | 7f105c7d-2dc5-4530-97cd-4e7ae6534c07 |
Example Payload for Update Subscription
{
"data": [
{
"id": "7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
"resource": "me/messages",
"applicationId": "string",
"changeType": "created,updated",
"clientState": "secretClientValue",
"notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
"lifecycleNotificationUrl": "https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
"expirationDateTime": "2016-11-20T18:23:45.9356913Z",
"creatorId": "string",
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": "",
"encryptionCertificateId": "",
"includeResourceData": false,
"notificationContentType": "application/json"
}
]
}
Update User
Update the properties of a User object. | key: updateUser
Input | Default | Notes | Example |
---|---|---|---|
Account Enabled boolean / Required accountEnabled | true | Indicates if the account is enabled. | |
Additional Properties code additionalProperties | Additional properties to update that are not covered by the other inputs. This should be a JSON object and will be merged with the other inputs. You can get additional properties from the Microsoft Graph API documentation https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#json-representation | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Display Name string / Required displayName | The display name of the user. | John | |
Domain string domain | The updated domain for the user, this must be an existing domain in the tenant, you can list them using the 'List Domains' action. Required if 'User Principal Name' input is provided. | Prismatic690.onmicrosoft.com | |
First Name string givenName | The updated first name of the user. | John | |
Job Title string jobTitle | The updated job title of the user. | Software Engineer | |
Last Name string surname | The updated last name of the user. | Doe | |
User Id string / Required userId | Unique Identifier for the user to update. This can be the user's id or userPrincipalName. | d36894ae-94ae-d368-ae94-68d3ae9468d3 | |
User Principal Name string userPrincipalName | The updated user principal name of the user. Required if 'Domain' input is provided. | John |
Example Payload for Update User
{
"data": {}
}
Wipe Device
Remotely wipe a compromised or lost device. | key: wipeDevice
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Managed Device Id string / Required managedDeviceId | Unique Identifier for the device to wipe. | 705c034c-034c-705c-4c03-5c704c035c70 |
Example Payload for Wipe Device
{
"data": {
"keepEnrollmentData": true,
"keepUserData": true,
"macOsUnlockCode": "Mac Os Unlock Code value",
"persistEsimDataPlan": true
}
}