diff --git a/config/ModuleMetadata.json b/config/ModuleMetadata.json
index 33eecf9626..f5763eca1a 100644
--- a/config/ModuleMetadata.json
+++ b/config/ModuleMetadata.json
@@ -27,15 +27,15 @@
"versions": {
"authentication": {
"prerelease": "",
- "version": "2.10.0"
+ "version": "2.11.0"
},
"beta": {
"prerelease": "",
- "version": "2.10.0"
+ "version": "2.11.0"
},
"v1.0": {
"prerelease": "",
- "version": "2.10.0"
+ "version": "2.11.0"
}
}
}
diff --git a/openApiDocs/beta/Applications.yml b/openApiDocs/beta/Applications.yml
index dabfec04e0..292dc1ed0f 100644
--- a/openApiDocs/beta/Applications.yml
+++ b/openApiDocs/beta/Applications.yml
@@ -11,7 +11,7 @@ paths:
tags:
- applications.application
summary: List applications
- description: Get the list of applications in this organization. This API is available in the following national cloud deployments.
+ description: Get the list of applications in this organization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list?view=graph-rest-1.0
@@ -82,6 +82,8 @@ paths:
- logo desc
- notes
- notes desc
+ - onPremisesPublishing
+ - onPremisesPublishing desc
- optionalClaims
- optionalClaims desc
- parentalControlSettings
@@ -118,8 +120,6 @@ paths:
- web desc
- windows
- windows desc
- - onPremisesPublishing
- - onPremisesPublishing desc
type: string
- name: $select
in: query
@@ -151,6 +151,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -169,17 +170,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $expand
in: query
@@ -193,15 +193,15 @@ paths:
enum:
- '*'
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
responses:
2XX:
@@ -216,7 +216,7 @@ paths:
tags:
- applications.application
summary: Create application
- description: Create a new application object. This API is available in the following national cloud deployments.
+ description: Create a new application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-applications?view=graph-rest-1.0
@@ -243,7 +243,7 @@ paths:
tags:
- applications.application
summary: Get application
- description: Get the properties and relationships of an application object. This API is available in the following national cloud deployments.
+ description: Get the properties and relationships of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
@@ -287,6 +287,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -305,17 +306,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $expand
in: query
@@ -329,15 +329,15 @@ paths:
enum:
- '*'
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
responses:
2XX:
@@ -353,7 +353,7 @@ paths:
tags:
- applications.application
summary: Update application
- description: Update the properties of an application object. This API is available in the following national cloud deployments.
+ description: Update the properties of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-update?view=graph-rest-1.0
@@ -388,7 +388,7 @@ paths:
tags:
- applications.application
summary: Delete application
- description: 'Deletes an application. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This API is available in the following national cloud deployments.'
+ description: 'Deletes an application. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
@@ -503,7 +503,7 @@ paths:
tags:
- applications.appManagementPolicy
summary: Remove appliesTo
- description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. This API is available in the following national cloud deployments.'
+ description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0
@@ -623,7 +623,7 @@ paths:
tags:
- applications.appManagementPolicy
summary: Assign appliesTo
- description: Assign an appManagementPolicy policy object to an application or service principal object. The application or service principal adopts this policy over the tenant-wide tenantAppManagementPolicy setting. Only one policy object can be assigned to an application or service principal. This API is available in the following national cloud deployments.
+ description: Assign an appManagementPolicy policy object to an application or service principal object. The application or service principal adopts this policy over the tenant-wide tenantAppManagementPolicy setting. Only one policy object can be assigned to an application or service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-post-appliesto?view=graph-rest-1.0
@@ -733,7 +733,7 @@ paths:
tags:
- applications.connectorGroup
summary: Assign a connectorGroup to an application
- description: Assign a connectorGroup to an application. This API is available in the following national cloud deployments.
+ description: Assign a connectorGroup to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/connectorgroup-post-applications?view=graph-rest-1.0
@@ -837,7 +837,7 @@ paths:
tags:
- applications.extensionProperty
summary: List extensionProperties (directory extensions)
- description: 'Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application. This API is available in the following national cloud deployments.'
+ description: 'Retrieve the list of directory extension definitions, represented by extensionProperty objects on an application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-extensionproperty?view=graph-rest-1.0
@@ -927,7 +927,7 @@ paths:
tags:
- applications.extensionProperty
summary: Create extensionProperty (directory extension)
- description: 'Create a new directory extension definition, represented by an extensionProperty object. This API is available in the following national cloud deployments.'
+ description: 'Create a new directory extension definition, represented by an extensionProperty object.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-extensionproperty?view=graph-rest-1.0
@@ -963,7 +963,7 @@ paths:
tags:
- applications.extensionProperty
summary: Get extensionProperty (directory extension)
- description: Read a directory extension definition represented by an extensionProperty object. This API is available in the following national cloud deployments.
+ description: Read a directory extension definition represented by an extensionProperty object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/extensionproperty-get?view=graph-rest-1.0
@@ -1069,7 +1069,7 @@ paths:
tags:
- applications.extensionProperty
summary: Delete extensionProperty (directory extension)
- description: Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD). This API is available in the following national cloud deployments.
+ description: Delete a directory extension definition represented by an extensionProperty object. You can delete only directory extensions that aren't synced from on-premises active directory (AD).
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/extensionproperty-delete?view=graph-rest-1.0
@@ -1130,7 +1130,7 @@ paths:
tags:
- applications.federatedIdentityCredential
summary: List federatedIdentityCredentials
- description: Get a list of the federatedIdentityCredential objects and their properties. This API is available in the following national cloud deployments.
+ description: Get a list of the federatedIdentityCredential objects and their properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-federatedidentitycredentials?view=graph-rest-1.0
@@ -1214,7 +1214,7 @@ paths:
tags:
- applications.federatedIdentityCredential
summary: Create federatedIdentityCredential
- description: 'Create a new federatedIdentityCredential object for an application. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application. This API is available in the following national cloud deployments.'
+ description: 'Create a new federatedIdentityCredential object for an application. By configuring a trust relationship between your Microsoft Entra application registration and the identity provider for your compute platform, you can use tokens issued by that platform to authenticate with Microsoft identity platform and call APIs in the Microsoft ecosystem. Maximum of 20 objects can be added to an application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-federatedidentitycredentials?view=graph-rest-1.0
@@ -1250,7 +1250,7 @@ paths:
tags:
- applications.federatedIdentityCredential
summary: Get federatedIdentityCredential
- description: Read the properties and relationships of a federatedIdentityCredential object. This API is available in the following national cloud deployments.
+ description: Read the properties and relationships of a federatedIdentityCredential object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-get?view=graph-rest-1.0
@@ -1315,7 +1315,7 @@ paths:
tags:
- applications.federatedIdentityCredential
summary: Update federatedIdentityCredential
- description: Update the properties of a federatedIdentityCredential object. This API is available in the following national cloud deployments.
+ description: Update the properties of a federatedIdentityCredential object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-update?view=graph-rest-1.0
@@ -1358,7 +1358,7 @@ paths:
tags:
- applications.federatedIdentityCredential
summary: Delete federatedIdentityCredential
- description: Deletes a federatedIdentityCredential object from an application. This API is available in the following national cloud deployments.
+ description: Deletes a federatedIdentityCredential object from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/federatedidentitycredential-delete?view=graph-rest-1.0
@@ -1644,7 +1644,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action addKey
- description: 'Add a key credential to an application. This method, along with removeKey, can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. Applications that don''t have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won''t be able to use this service action. You can use the Update application operation to perform an update instead. This API is available in the following national cloud deployments.'
+ description: 'Add a key credential to an application. This method, along with removeKey, can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. Applications that don''t have any existing valid certificates (no certificates have been added yet, or all certificates have expired), won''t be able to use this service action. You can use the Update application operation to perform an update instead.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-addkey?view=graph-rest-1.0
@@ -1689,7 +1689,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action addPassword
- description: Adds a strong password to an application. This API is available in the following national cloud deployments.
+ description: Adds a strong password to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-addpassword?view=graph-rest-1.0
@@ -1730,7 +1730,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action checkMemberGroups
- description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct. This API is available in the following national cloud deployments.'
+ description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0
@@ -1838,7 +1838,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action getMemberGroups
- description: 'Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the Directory_ResultSizeLimitExceeded error code. As a workaround, use the List group transitive memberOf API. This API is available in the following national cloud deployments.'
+ description: 'Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the Directory_ResultSizeLimitExceeded error code. As a workaround, use the List group transitive memberOf API.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0
@@ -1946,7 +1946,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action removeKey
- description: 'Remove a key credential from an application. This method along with addKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed. This API is available in the following national cloud deployments.'
+ description: 'Remove a key credential from an application. This method along with addKey can be used by an application to automate rolling its expiring keys. As part of the request validation for this method, a proof of possession of an existing key is verified before the action can be performed.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-removekey?view=graph-rest-1.0
@@ -1987,7 +1987,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action removePassword
- description: Removes a password from an application. This API is available in the following national cloud deployments.
+ description: Removes a password from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-removepassword?view=graph-rest-1.0
@@ -2026,7 +2026,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action restore
- description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. This isn''t applicable to security groups, which are deleted permanently. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted. This API is available in the following national cloud deployments.'
+ description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. This isn''t applicable to security groups, which are deleted permanently. Also, restoring an application doesn''t restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0
@@ -2055,7 +2055,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action setVerifiedPublisher
- description: 'Set the the verifiedPublisher on an application. For more information, including prerequisites to setting a verified publisher, see Publisher verification. This API is available in the following national cloud deployments.'
+ description: 'Set the the verifiedPublisher on an application. For more information, including prerequisites to setting a verified publisher, see Publisher verification.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-setverifiedpublisher?view=graph-rest-1.0
@@ -2092,7 +2092,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action unsetVerifiedPublisher
- description: 'Unset the verifiedPublisher previously set on an application, removing all verified publisher properties. For more information, see Publisher verification. This API is available in the following national cloud deployments.'
+ description: 'Unset the verifiedPublisher previously set on an application, removing all verified publisher properties. For more information, see Publisher verification.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-unsetverifiedpublisher?view=graph-rest-1.0
@@ -2200,7 +2200,7 @@ paths:
tags:
- applications.directoryObject
summary: Remove owner
- description: 'Remove an owner from an application. As a recommended best practice, apps should have at least two owners. This API is available in the following national cloud deployments.'
+ description: 'Remove an owner from an application. As a recommended best practice, apps should have at least two owners.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-owners?view=graph-rest-1.0
@@ -2536,7 +2536,7 @@ paths:
tags:
- applications.directoryObject
summary: Add owner
- description: Use this API to add an owner to an application by posting to the owners collection. This API is available in the following national cloud deployments.
+ description: Use this API to add an owner to an application by posting to the owners collection.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-owners?view=graph-rest-1.0
@@ -3005,7 +3005,7 @@ paths:
tags:
- applications.synchronization
summary: List synchronization jobs
- description: List existing jobs for a given application instance (service principal). This API is available in the following national cloud deployments.
+ description: List existing jobs for a given application instance (service principal).
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0
@@ -3090,7 +3090,7 @@ paths:
tags:
- applications.synchronization
summary: Create synchronizationJob
- description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. This API is available in the following national cloud deployments.
+ description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0
@@ -3126,7 +3126,7 @@ paths:
tags:
- applications.synchronization
summary: Get synchronizationJob
- description: Retrieve the existing synchronization job and its properties. This API is available in the following national cloud deployments.
+ description: Retrieve the existing synchronization job and its properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0
@@ -3233,7 +3233,7 @@ paths:
tags:
- applications.synchronization
summary: Delete synchronizationJob
- description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is. This API is available in the following national cloud deployments.'
+ description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0
@@ -3473,7 +3473,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action pause
- description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job continues from where it left off when a start call is made. This API is available in the following national cloud deployments.'
+ description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job continues from where it left off when a start call is made.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0
@@ -3506,7 +3506,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action provisionOnDemand
- description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. No user or group will be provisioned on-demand that would not have been provisioned through the regular provisioning cycles. This API is available in the following national cloud deployments.
+ description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. No user or group will be provisioned on-demand that would not have been provisioned through the regular provisioning cycles.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0
@@ -3557,7 +3557,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action restart
- description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors. This API is available in the following national cloud deployments.'
+ description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0
@@ -3602,7 +3602,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action start
- description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. This API is available in the following national cloud deployments.'
+ description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0
@@ -3635,7 +3635,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action validateCredentials
- description: Validate that the credentials are valid in the tenant. This API is available in the following national cloud deployments.
+ description: Validate that the credentials are valid in the tenant.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0
@@ -3692,7 +3692,7 @@ paths:
tags:
- applications.synchronization
summary: Get synchronizationSchema
- description: Retrieve the schema for a given synchronization job or template. This API is available in the following national cloud deployments.
+ description: Retrieve the schema for a given synchronization job or template.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0
@@ -4127,7 +4127,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action discover
- description: Discover the latest schema definition for provisioning to an application. This API is available in the following national cloud deployments.
+ description: 'Discover the latest schema definition for provisioning to an application. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
@@ -4368,7 +4368,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action parseExpression
- description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID. This API is available in the following national cloud deployments.'
+ description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
@@ -4489,7 +4489,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action acquireAccessToken
- description: Acquire an OAuth Access token to authorize the Microsoft Entra provisioning service to provision users into an application. This API is available in the following national cloud deployments.
+ description: Acquire an OAuth Access token to authorize the Microsoft Entra provisioning service to provision users into an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0
@@ -4616,7 +4616,7 @@ paths:
tags:
- applications.synchronization
summary: List existing synchronization templates
- description: List the synchronization templates associated with a given application or service principal. This API is available in the following national cloud deployments.
+ description: List the synchronization templates associated with a given application or service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0
@@ -4802,7 +4802,7 @@ paths:
tags:
- applications.synchronization
summary: Update synchronizationTemplate
- description: Update (override) the synchronization template associated with a given application. This API is available in the following national cloud deployments.
+ description: Update (override) the synchronization template associated with a given application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0
@@ -5308,7 +5308,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action discover
- description: Discover the latest schema definition for provisioning to an application. This API is available in the following national cloud deployments.
+ description: 'Discover the latest schema definition for provisioning to an application. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
@@ -5549,7 +5549,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action parseExpression
- description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID. This API is available in the following national cloud deployments.'
+ description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
@@ -5625,7 +5625,7 @@ paths:
tags:
- applications.tokenIssuancePolicy
summary: List assigned tokenIssuancePolicies
- description: List the tokenIssuancePolicy objects that are assigned to an application. This API is available in the following national cloud deployments.
+ description: List the tokenIssuancePolicy objects that are assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0
@@ -5712,7 +5712,7 @@ paths:
tags:
- applications.tokenIssuancePolicy
summary: Remove tokenIssuancePolicy
- description: Remove a tokenIssuancePolicy from an application. This API is available in the following national cloud deployments.
+ description: Remove a tokenIssuancePolicy from an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-tokenissuancepolicies?view=graph-rest-1.0
@@ -5780,7 +5780,7 @@ paths:
tags:
- applications.tokenIssuancePolicy
summary: List assigned tokenIssuancePolicies
- description: List the tokenIssuancePolicy objects that are assigned to an application. This API is available in the following national cloud deployments.
+ description: List the tokenIssuancePolicy objects that are assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenissuancepolicies?view=graph-rest-1.0
@@ -5835,7 +5835,7 @@ paths:
tags:
- applications.tokenIssuancePolicy
summary: Assign tokenIssuancePolicy
- description: Assign a tokenIssuancePolicy to an application. This API is available in the following national cloud deployments.
+ description: Assign a tokenIssuancePolicy to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-tokenissuancepolicies?view=graph-rest-1.0
@@ -5862,7 +5862,7 @@ paths:
tags:
- applications.tokenLifetimePolicy
summary: List assigned tokenLifetimePolicy
- description: List the tokenLifetimePolicy objects that are assigned to an application or servicePrincipal. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application. This API is available in the following national cloud deployments.
+ description: List the tokenLifetimePolicy objects that are assigned to an application or servicePrincipal. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0
@@ -5949,7 +5949,7 @@ paths:
tags:
- applications.tokenLifetimePolicy
summary: Remove tokenLifetimePolicy
- description: Remove a tokenLifetimePolicy from an application or servicePrincipal. This API is available in the following national cloud deployments.
+ description: Remove a tokenLifetimePolicy from an application or servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete-tokenlifetimepolicies?view=graph-rest-1.0
@@ -6017,7 +6017,7 @@ paths:
tags:
- applications.tokenLifetimePolicy
summary: List assigned tokenLifetimePolicy
- description: List the tokenLifetimePolicy objects that are assigned to an application or servicePrincipal. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application. This API is available in the following national cloud deployments.
+ description: List the tokenLifetimePolicy objects that are assigned to an application or servicePrincipal. Only one object is returned in the collection because only one tokenLifetimePolicy can be assigned to an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-list-tokenlifetimepolicies?view=graph-rest-1.0
@@ -6072,7 +6072,7 @@ paths:
tags:
- applications.tokenLifetimePolicy
summary: Assign tokenLifetimePolicy
- description: Assign a tokenLifetimePolicy to an application or servicePrincipal. You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per application. This API is available in the following national cloud deployments.
+ description: Assign a tokenLifetimePolicy to an application or servicePrincipal. You can have multiple tokenLifetimePolicy policies in a tenant but can assign only one tokenLifetimePolicy per application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-post-tokenlifetimepolicies?view=graph-rest-1.0
@@ -6099,7 +6099,7 @@ paths:
tags:
- applications.application
summary: Get application
- description: Get the properties and relationships of an application object. This API is available in the following national cloud deployments.
+ description: Get the properties and relationships of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
@@ -6151,6 +6151,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -6169,17 +6170,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $expand
in: query
@@ -6193,15 +6193,15 @@ paths:
enum:
- '*'
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
responses:
2XX:
@@ -6217,7 +6217,7 @@ paths:
tags:
- applications.application
summary: Update application
- description: Update the properties of an application object. This API is available in the following national cloud deployments.
+ description: Update the properties of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-update?view=graph-rest-1.0
@@ -6260,7 +6260,7 @@ paths:
tags:
- applications.application
summary: Delete application
- description: 'Deletes an application. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This API is available in the following national cloud deployments.'
+ description: 'Deletes an application. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
@@ -6299,7 +6299,7 @@ paths:
tags:
- applications.application
summary: Get application
- description: Get the properties and relationships of an application object. This API is available in the following national cloud deployments.
+ description: Get the properties and relationships of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-get?view=graph-rest-1.0
@@ -6351,6 +6351,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -6369,17 +6370,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $expand
in: query
@@ -6393,15 +6393,15 @@ paths:
enum:
- '*'
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
responses:
2XX:
@@ -6417,7 +6417,7 @@ paths:
tags:
- applications.application
summary: Update application
- description: Update the properties of an application object. This API is available in the following national cloud deployments.
+ description: Update the properties of an application object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-update?view=graph-rest-1.0
@@ -6460,7 +6460,7 @@ paths:
tags:
- applications.application
summary: Delete application
- description: 'Deletes an application. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This API is available in the following national cloud deployments.'
+ description: 'Deletes an application. When deleted, apps are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/application-delete?view=graph-rest-1.0
@@ -6560,6 +6560,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -6578,17 +6579,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $orderby
in: query
@@ -6640,6 +6640,8 @@ paths:
- logo desc
- notes
- notes desc
+ - onPremisesPublishing
+ - onPremisesPublishing desc
- optionalClaims
- optionalClaims desc
- parentalControlSettings
@@ -6676,8 +6678,6 @@ paths:
- web desc
- windows
- windows desc
- - onPremisesPublishing
- - onPremisesPublishing desc
type: string
responses:
2XX:
@@ -6711,7 +6711,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action getByIds
- description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to: This API is available in the following national cloud deployments.'
+ description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0
@@ -6764,7 +6764,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action getUserOwnedObjects
- description: 'Retrieve a list of recently deleted application and group objects owned by the specified user. This API returns up to 1,000 deleted objects owned by the user, sorted by ID, and doesn''t support pagination. This API is available in the following national cloud deployments.'
+ description: 'Retrieve a list of recently deleted application and group objects owned by the specified user. This API returns up to 1,000 deleted objects owned by the user, sorted by ID, and doesn''t support pagination.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-getuserownedobjects?view=graph-rest-1.0
@@ -6800,7 +6800,7 @@ paths:
tags:
- applications.Actions
summary: Invoke action validateProperties
- description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. For validating properties of an existing group, use the validateProperties function for groups. The following validations are performed for the display name and mail nickname properties: \n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate the mail nickname is unique This API returns with the first failure encountered. If one or more properties fail multiple validations, only the property with the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. This API is available in the following national cloud deployments."
+ description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. For validating properties of an existing group, use the validateProperties function for groups. The following validations are performed for the display name and mail nickname properties: \n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate the mail nickname is unique This API returns with the first failure encountered. If one or more properties fail multiple validations, only the property with the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0
@@ -6840,7 +6840,7 @@ paths:
tags:
- applicationTemplates.applicationTemplate
summary: List applicationTemplates
- description: Retrieve a list of applicationTemplate objects from the Microsoft Entra application gallery. This API is available in the following national cloud deployments.
+ description: Retrieve a list of applicationTemplate objects from the Microsoft Entra application gallery.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/applicationtemplate-list?view=graph-rest-1.0
@@ -6932,7 +6932,7 @@ paths:
tags:
- applicationTemplates.applicationTemplate
summary: Get applicationTemplate
- description: Retrieve the properties of an applicationTemplate object. This API is available in the following national cloud deployments.
+ description: Retrieve the properties of an applicationTemplate object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/applicationtemplate-get?view=graph-rest-1.0
@@ -6995,7 +6995,7 @@ paths:
tags:
- applicationTemplates.Actions
summary: Invoke action instantiate
- description: 'Add an instance of an application from the Microsoft Entra application gallery into your directory. You can also use this API to instantiate non-gallery apps. Use the following ID for the applicationTemplate object: 8adf8e6e-67b2-4cf2-a259-e3dc5476c621. This API is available in the following national cloud deployments.'
+ description: 'Add an instance of an application from the Microsoft Entra application gallery into your directory. You can also use this API to instantiate non-gallery apps. Use the following ID for the applicationTemplate object: 8adf8e6e-67b2-4cf2-a259-e3dc5476c621.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/applicationtemplate-instantiate?view=graph-rest-1.0
@@ -7151,7 +7151,7 @@ paths:
tags:
- groups.appRoleAssignment
summary: Grant an appRoleAssignment to a group
- description: 'Use this API to assign an app role to a security group. All direct members of the group will be considered assigned. Security groups with dynamic memberships are supported. To grant an app role assignment to a group, you need three identifiers: Additional licenses might be required to use a group to manage access to applications. This API is available in the following national cloud deployments.'
+ description: 'Use this API to assign an app role to a security group. All direct members of the group will be considered assigned. Security groups with dynamic memberships are supported. To grant an app role assignment to a group, you need three identifiers: Additional licenses might be required to use a group to manage access to applications.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-post-approleassignments?view=graph-rest-1.0
@@ -7300,7 +7300,7 @@ paths:
tags:
- groups.appRoleAssignment
summary: Delete appRoleAssignment
- description: Deletes an appRoleAssignment that a group has been granted. This API is available in the following national cloud deployments.
+ description: Deletes an appRoleAssignment that a group has been granted.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/group-delete-approleassignments?view=graph-rest-1.0
@@ -7589,7 +7589,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgentGroup
summary: List onPremisesAgentGroups
- description: Retrieve a list of onPremisesAgentGroup objects. This API is available in the following national cloud deployments.
+ description: Retrieve a list of onPremisesAgentGroup objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagentgroup-list?view=graph-rest-1.0
@@ -7671,7 +7671,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgentGroup
summary: Create onPremisesAgentGroup
- description: Create a new onPremisesAgentGroup object. This API is available in the following national cloud deployments.
+ description: Create a new onPremisesAgentGroup object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagentgroup-post?view=graph-rest-1.0
@@ -7707,7 +7707,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgentGroup
summary: Get onPremisesAgentGroup
- description: Retrieve the properties and relationships of an onPremisesAgentGroup object. This API is available in the following national cloud deployments.
+ description: Retrieve the properties and relationships of an onPremisesAgentGroup object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagentgroup-get?view=graph-rest-1.0
@@ -7774,7 +7774,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgentGroup
summary: Update onPremisesAgentGroup
- description: Update the properties of an onPremisesAgentGroup object. This API is available in the following national cloud deployments.
+ description: Update the properties of an onPremisesAgentGroup object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagentgroup-update?view=graph-rest-1.0
@@ -7817,7 +7817,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgentGroup
summary: Delete onPremisesAgentGroup
- description: Delete an onPremisesAgentGroup object. This API is available in the following national cloud deployments.
+ description: Delete an onPremisesAgentGroup object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagentgroup-delete?view=graph-rest-1.0
@@ -9149,7 +9149,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgent
summary: List onPremisesAgents
- description: Retrieve a list of onPremisesAgent objects. This API is available in the following national cloud deployments.
+ description: Retrieve a list of onPremisesAgent objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagent-list?view=graph-rest-1.0
@@ -9264,7 +9264,7 @@ paths:
tags:
- onPremisesPublishingProfiles.onPremisesAgent
summary: Get onPremisesAgent
- description: Retrieve the properties and relationships of an onPremisesAgent object. This API is available in the following national cloud deployments.
+ description: Retrieve the properties and relationships of an onPremisesAgent object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/onpremisesagent-get?view=graph-rest-1.0
@@ -9766,10 +9766,10 @@ paths:
tags:
- onPremisesPublishingProfiles.connectorGroup
summary: Create connectorGroup
- description: Create a new connectorGroup.
+ description: Create a connectorGroup object.
externalDocs:
description: Find more info here
- url: https://learn.microsoft.com/graph/api/connectorgroup-post-connectorgroups?view=graph-rest-1.0
+ url: https://learn.microsoft.com/graph/api/connectorgroup-post?view=graph-rest-1.0
operationId: onPremisesPublishingProfile_CreateConnectorGroup
parameters:
- name: onPremisesPublishingProfile-id
@@ -10025,6 +10025,8 @@ paths:
- logo desc
- notes
- notes desc
+ - onPremisesPublishing
+ - onPremisesPublishing desc
- optionalClaims
- optionalClaims desc
- parentalControlSettings
@@ -10061,8 +10063,6 @@ paths:
- web desc
- windows
- windows desc
- - onPremisesPublishing
- - onPremisesPublishing desc
type: string
- name: $select
in: query
@@ -10094,6 +10094,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -10112,17 +10113,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $expand
in: query
@@ -10136,15 +10136,15 @@ paths:
enum:
- '*'
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
responses:
2XX:
@@ -10216,6 +10216,7 @@ paths:
- keyCredentials
- logo
- notes
+ - onPremisesPublishing
- optionalClaims
- parentalControlSettings
- passwordCredentials
@@ -10234,17 +10235,16 @@ paths:
- verifiedPublisher
- web
- windows
- - onPremisesPublishing
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
- name: $expand
in: query
@@ -10258,15 +10258,15 @@ paths:
enum:
- '*'
- appManagementPolicies
+ - connectorGroup
- createdOnBehalfOf
- extensionProperties
- federatedIdentityCredentials
- homeRealmDiscoveryPolicies
- owners
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- - connectorGroup
- - synchronization
type: string
responses:
2XX:
@@ -11216,7 +11216,7 @@ paths:
tags:
- onPremisesPublishingProfiles.publishedResource
summary: List publishedResources
- description: Retrieve a list of publishedResource objects. This API is available in the following national cloud deployments.
+ description: Retrieve a list of publishedResource objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/publishedresource-list?view=graph-rest-1.0
@@ -11296,7 +11296,7 @@ paths:
tags:
- onPremisesPublishingProfiles.publishedResource
summary: Create publishedResource
- description: Create a new publishedResource object. This API is available in the following national cloud deployments.
+ description: Create a new publishedResource object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/publishedresource-post?view=graph-rest-1.0
@@ -11332,7 +11332,7 @@ paths:
tags:
- onPremisesPublishingProfiles.publishedResource
summary: Get publishedResource
- description: Retrieve the properties and relationships of publishedResource object. This API is available in the following national cloud deployments.
+ description: Retrieve the properties and relationships of publishedResource object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/publishedresource-get?view=graph-rest-1.0
@@ -11397,7 +11397,7 @@ paths:
tags:
- onPremisesPublishingProfiles.publishedResource
summary: Update publishedResource
- description: Update the properties of published resource publishedResource object. This API is available in the following national cloud deployments.
+ description: Update the properties of published resource publishedResource object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/publishedresource-update?view=graph-rest-1.0
@@ -11805,7 +11805,7 @@ paths:
tags:
- servicePrincipals.servicePrincipal
summary: List servicePrincipals
- description: Retrieve a list of servicePrincipal objects. This API is available in the following national cloud deployments.
+ description: Retrieve a list of servicePrincipal objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list?view=graph-rest-1.0
@@ -11840,8 +11840,6 @@ paths:
- id desc
- deletedDateTime
- deletedDateTime desc
- - passwordSingleSignOnSettings
- - passwordSingleSignOnSettings desc
- accountEnabled
- accountEnabled desc
- addIns
@@ -11888,6 +11886,8 @@ paths:
- notificationEmailAddresses desc
- passwordCredentials
- passwordCredentials desc
+ - passwordSingleSignOnSettings
+ - passwordSingleSignOnSettings desc
- preferredSingleSignOnMode
- preferredSingleSignOnMode desc
- preferredTokenSigningKeyEndDateTime
@@ -11929,7 +11929,6 @@ paths:
enum:
- id
- deletedDateTime
- - passwordSingleSignOnSettings
- accountEnabled
- addIns
- alternativeNames
@@ -11953,6 +11952,7 @@ paths:
- notes
- notificationEmailAddresses
- passwordCredentials
+ - passwordSingleSignOnSettings
- preferredSingleSignOnMode
- preferredTokenSigningKeyEndDateTime
- preferredTokenSigningKeyThumbprint
@@ -11982,10 +11982,10 @@ paths:
- ownedObjects
- owners
- remoteDesktopSecurityConfiguration
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- transitiveMemberOf
- - synchronization
type: string
- name: $expand
in: query
@@ -12013,10 +12013,10 @@ paths:
- ownedObjects
- owners
- remoteDesktopSecurityConfiguration
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- transitiveMemberOf
- - synchronization
type: string
responses:
2XX:
@@ -12031,7 +12031,7 @@ paths:
tags:
- servicePrincipals.servicePrincipal
summary: Create servicePrincipal
- description: Create a new servicePrincipal object. This API is available in the following national cloud deployments.
+ description: Create a new servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0
@@ -12058,7 +12058,7 @@ paths:
tags:
- servicePrincipals.servicePrincipal
summary: Get servicePrincipal
- description: Retrieve the properties and relationships of a servicePrincipal object. This API is available in the following national cloud deployments.
+ description: Retrieve the properties and relationships of a servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-get?view=graph-rest-1.0
@@ -12084,7 +12084,6 @@ paths:
enum:
- id
- deletedDateTime
- - passwordSingleSignOnSettings
- accountEnabled
- addIns
- alternativeNames
@@ -12108,6 +12107,7 @@ paths:
- notes
- notificationEmailAddresses
- passwordCredentials
+ - passwordSingleSignOnSettings
- preferredSingleSignOnMode
- preferredTokenSigningKeyEndDateTime
- preferredTokenSigningKeyThumbprint
@@ -12137,10 +12137,10 @@ paths:
- ownedObjects
- owners
- remoteDesktopSecurityConfiguration
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- transitiveMemberOf
- - synchronization
type: string
- name: $expand
in: query
@@ -12168,10 +12168,10 @@ paths:
- ownedObjects
- owners
- remoteDesktopSecurityConfiguration
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- transitiveMemberOf
- - synchronization
type: string
responses:
2XX:
@@ -12187,7 +12187,7 @@ paths:
tags:
- servicePrincipals.servicePrincipal
summary: Update servicePrincipal
- description: Update the properties of servicePrincipal object. This API is available in the following national cloud deployments.
+ description: Update the properties of servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-update?view=graph-rest-1.0
@@ -12222,7 +12222,7 @@ paths:
tags:
- servicePrincipals.servicePrincipal
summary: Delete servicePrincipal
- description: Delete a servicePrincipal object. This API is available in the following national cloud deployments.
+ description: Delete a servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete?view=graph-rest-1.0
@@ -12401,7 +12401,7 @@ paths:
tags:
- servicePrincipals.appManagementPolicy
summary: Remove appliesTo
- description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. This API is available in the following national cloud deployments.'
+ description: 'Remove an appManagementPolicy policy object from an application or service principal object. When you remove the appManagementPolicy, the application or service principal adopts the tenant-wide tenantAppManagementPolicy setting. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/appmanagementpolicy-delete-appliesto?view=graph-rest-1.0
@@ -12462,7 +12462,7 @@ paths:
tags:
- servicePrincipals.appRoleAssignment
summary: List appRoleAssignments granted for a service principal
- description: 'Retrieve a list of appRoleAssignment that users, groups, or client service principals have been granted for the given resource service principal. For example, if the resource service principal is the service principal for the Microsoft Graph API, this will return all service principals that have been granted any app-only permissions to Microsoft Graph. If the resource service principal is an application that has app roles granted to users and groups, this will return all the users and groups assigned app roles for this application. This API is available in the following national cloud deployments.'
+ description: 'Retrieve a list of appRoleAssignment that users, groups, or client service principals have been granted for the given resource service principal. For example, if the resource service principal is the service principal for the Microsoft Graph API, this will return all service principals that have been granted any app-only permissions to Microsoft Graph. If the resource service principal is an application that has app roles granted to users and groups, this will return all the users and groups assigned app roles for this application.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-approleassignedto?view=graph-rest-1.0
@@ -12552,7 +12552,7 @@ paths:
tags:
- servicePrincipals.appRoleAssignment
summary: Grant an appRoleAssignment for a service principal
- description: 'Assign an app role for a resource service principal, to a user, group, or client service principal. App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience. To grant an app role assignment, you need three identifiers: This API is available in the following national cloud deployments.'
+ description: 'Assign an app role for a resource service principal, to a user, group, or client service principal. App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience. To grant an app role assignment, you need three identifiers:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-approleassignedto?view=graph-rest-1.0
@@ -12691,7 +12691,7 @@ paths:
tags:
- servicePrincipals.appRoleAssignment
summary: Delete appRoleAssignedTo
- description: 'Deletes an appRoleAssignment that a user, group, or client service principal has been granted for a resource service principal. This API is available in the following national cloud deployments.'
+ description: 'Deletes an appRoleAssignment that a user, group, or client service principal has been granted for a resource service principal.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-approleassignedto?view=graph-rest-1.0
@@ -12852,7 +12852,7 @@ paths:
tags:
- servicePrincipals.appRoleAssignment
summary: Grant an appRoleAssignment to a service principal
- description: 'Assign an app role to a client service principal. App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience. To grant an app role assignment to a client service principal, you need three identifiers: This API is available in the following national cloud deployments.'
+ description: 'Assign an app role to a client service principal. App roles that are assigned to service principals are also known as application permissions. Application permissions can be granted directly with app role assignments, or through a consent experience. To grant an app role assignment to a client service principal, you need three identifiers:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-approleassignments?view=graph-rest-1.0
@@ -13001,7 +13001,7 @@ paths:
tags:
- servicePrincipals.appRoleAssignment
summary: Delete appRoleAssignment
- description: Deletes an appRoleAssignment that a service principal has been granted. App roles that are assigned to service principals are also known as application permissions. Deleting an app role assignment for a service principal is equivalent to revoking the app-only permission grant. This API is available in the following national cloud deployments.
+ description: Deletes an appRoleAssignment that a service principal has been granted. App roles that are assigned to service principals are also known as application permissions. Deleting an app role assignment for a service principal is equivalent to revoking the app-only permission grant.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-approleassignments?view=graph-rest-1.0
@@ -13072,7 +13072,7 @@ paths:
tags:
- servicePrincipals.claimsMappingPolicy
summary: List assigned claimsMappingPolicy
- description: List the claimsMappingPolicy objects that are assigned to a servicePrincipal. This API is available in the following national cloud deployments.
+ description: List the claimsMappingPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-claimsmappingpolicies?view=graph-rest-1.0
@@ -13159,7 +13159,7 @@ paths:
tags:
- servicePrincipals.claimsMappingPolicy
summary: Remove claimsMappingPolicy
- description: Remove a claimsMappingPolicy from a servicePrincipal. This API is available in the following national cloud deployments.
+ description: Remove a claimsMappingPolicy from a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-claimsmappingpolicies?view=graph-rest-1.0
@@ -13227,7 +13227,7 @@ paths:
tags:
- servicePrincipals.claimsMappingPolicy
summary: List assigned claimsMappingPolicy
- description: List the claimsMappingPolicy objects that are assigned to a servicePrincipal. This API is available in the following national cloud deployments.
+ description: List the claimsMappingPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-claimsmappingpolicies?view=graph-rest-1.0
@@ -13282,7 +13282,7 @@ paths:
tags:
- servicePrincipals.claimsMappingPolicy
summary: Assign claimsMappingPolicy
- description: Assign a claimsMappingPolicy to a servicePrincipal. This API is available in the following national cloud deployments.
+ description: Assign a claimsMappingPolicy to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-claimsmappingpolicies?view=graph-rest-1.0
@@ -13309,7 +13309,7 @@ paths:
tags:
- servicePrincipals.directoryObject
summary: 'servicePrincipal: List createdObjects'
- description: Retrieve a list of directoryobject objects. This API is available in the following national cloud deployments.
+ description: Retrieve a list of directoryobject objects.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-createdobjects?view=graph-rest-1.0
@@ -13610,7 +13610,7 @@ paths:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: List delegatedPermissionClassifications collection of servicePrincipal
- description: Retrieve the list of delegatedPermissionClassification currently configured for the delegated permissions exposed by an API. This API is available in the following national cloud deployments.
+ description: Retrieve the list of delegatedPermissionClassification currently configured for the delegated permissions exposed by an API.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-delegatedpermissionclassifications?view=graph-rest-1.0
@@ -13688,7 +13688,7 @@ paths:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Create delegatedPermissionClassification
- description: Classify a delegated permission by adding a delegatedPermissionClassification to the servicePrincipal representing the API. This API is available in the following national cloud deployments.
+ description: Classify a delegated permission by adding a delegatedPermissionClassification to the servicePrincipal representing the API.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-delegatedpermissionclassifications?view=graph-rest-1.0
@@ -13823,7 +13823,7 @@ paths:
tags:
- servicePrincipals.delegatedPermissionClassification
summary: Delete delegatedPermissionClassification
- description: Deletes a delegatedPermissionClassification which had previously been set for a delegated permission. This API is available in the following national cloud deployments.
+ description: Deletes a delegatedPermissionClassification which had previously been set for a delegated permission.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-delegatedpermissionclassifications?view=graph-rest-1.0
@@ -14428,7 +14428,7 @@ paths:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: List assigned homeRealmDiscoveryPolicy
- description: List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal. This API is available in the following national cloud deployments.
+ description: List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-homerealmdiscoverypolicies?view=graph-rest-1.0
@@ -14515,7 +14515,7 @@ paths:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: Remove homeRealmDiscoveryPolicy
- description: Remove a homeRealmDiscoveryPolicy from a servicePrincipal. This API is available in the following national cloud deployments.
+ description: Remove a homeRealmDiscoveryPolicy from a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-homerealmdiscoverypolicies?view=graph-rest-1.0
@@ -14583,7 +14583,7 @@ paths:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: List assigned homeRealmDiscoveryPolicy
- description: List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal. This API is available in the following national cloud deployments.
+ description: List the homeRealmDiscoveryPolicy objects that are assigned to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-homerealmdiscoverypolicies?view=graph-rest-1.0
@@ -14638,7 +14638,7 @@ paths:
tags:
- servicePrincipals.homeRealmDiscoveryPolicy
summary: Assign homeRealmDiscoveryPolicy
- description: Assign a homeRealmDiscoveryPolicy to a servicePrincipal. This API is available in the following national cloud deployments.
+ description: Assign a homeRealmDiscoveryPolicy to a servicePrincipal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-homerealmdiscoverypolicies?view=graph-rest-1.0
@@ -15641,7 +15641,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action addTokenSigningCertificate
- description: "Creates a self-signed signing certificate and returns a selfSignedCertificate object, which is the public part of the generated certificate. The self-signed signing certificate is composed of the following objects which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with usage set to Sign.\n + A public key object with usage set to Verify.\n+ The passwordCredentials object. All the objects have the same value of customKeyIdentifier. The passwordCredential is used to open the PFX file (private key). It and the associated private key object have the same value of keyId. Once set during creation through the displayName property, the subject of the certificate cannot be updated. The startDateTime is set to the same time the certificate is created using the action. The endDateTime can be up to three years after the certificate is created. This API is available in the following national cloud deployments."
+ description: "Creates a self-signed signing certificate and returns a selfSignedCertificate object, which is the public part of the generated certificate. The self-signed signing certificate is composed of the following objects which are added to the servicePrincipal: \n+ The keyCredentials object with the following objects:\n + A private key object with usage set to Sign.\n + A public key object with usage set to Verify.\n+ The passwordCredentials object. All the objects have the same value of customKeyIdentifier. The passwordCredential is used to open the PFX file (private key). It and the associated private key object have the same value of keyId. Once set during creation through the displayName property, the subject of the certificate cannot be updated. The startDateTime is set to the same time the certificate is created using the action. The endDateTime can be up to three years after the certificate is created."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-addtokensigningcertificate?view=graph-rest-1.0
@@ -15688,7 +15688,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action checkMemberGroups
- description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct. This API is available in the following national cloud deployments.'
+ description: 'Check for membership in a specified list of group IDs, and return from that list those groups (identified by IDs) of which the specified user, group, service principal, organizational contact, device, or directory object is a member. This function is transitive. You can check up to a maximum of 20 groups per request. This function supports all groups provisioned in Microsoft Entra ID. Because Microsoft 365 groups cannot contain other groups, membership in a Microsoft 365 group is always direct.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-checkmembergroups?view=graph-rest-1.0
@@ -15796,7 +15796,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action createPasswordSingleSignOnCredentials
- description: Create single sign-on credentials using a password for a user or group. This API is available in the following national cloud deployments.
+ description: Create single sign-on credentials using a password for a user or group.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-createpasswordsinglesignoncredentials?view=graph-rest-1.0
@@ -15841,7 +15841,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action deletePasswordSingleSignOnCredentials
- description: Delete single sign-on credentials using a password for a user or group. This API is available in the following national cloud deployments.
+ description: Delete single sign-on credentials using a password for a user or group.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-deletepasswordsinglesignoncredentials?view=graph-rest-1.0
@@ -15878,7 +15878,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action getMemberGroups
- description: 'Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the Directory_ResultSizeLimitExceeded error code. As a workaround, use the List group transitive memberOf API. This API is available in the following national cloud deployments.'
+ description: 'Return all the group IDs for the groups that the specified user, group, service principal, organizational contact, device, or directory object is a member of. This function is transitive. This API returns up to 11,000 group IDs. If more than 11,000 results are available, it returns a 400 Bad Request error with the Directory_ResultSizeLimitExceeded error code. As a workaround, use the List group transitive memberOf API.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getmembergroups?view=graph-rest-1.0
@@ -15986,7 +15986,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action getPasswordSingleSignOnCredentials
- description: Get a list of single sign-on credentials using a password for a user or group. This API is available in the following national cloud deployments.
+ description: Get a list of single sign-on credentials using a password for a user or group.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-getpasswordsinglesignoncredentials?view=graph-rest-1.0
@@ -16027,7 +16027,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action restore
- description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. This isn''t applicable to security groups, which are deleted permanently. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted. This API is available in the following national cloud deployments.'
+ description: 'Restore a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items. If an item was accidentally deleted, you can fully restore the item. This isn''t applicable to security groups, which are deleted permanently. Also, restoring an application doesn''t restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-restore?view=graph-rest-1.0
@@ -16056,7 +16056,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action updatePasswordSingleSignOnCredentials
- description: Update single sign-on credentials using a password for a user or group. This API is available in the following national cloud deployments.
+ description: Update single sign-on credentials using a password for a user or group.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-updatepasswordsinglesignoncredentials?view=graph-rest-1.0
@@ -16097,7 +16097,7 @@ paths:
tags:
- servicePrincipals.oAuth2PermissionGrant
summary: List oauth2PermissionGrants granted to a service principal
- description: 'Retrieve a list of oAuth2PermissionGrant entities, representing delegated permissions granted to the service principal (representing the client application) to access an API on behalf of a user. This API is available in the following national cloud deployments.'
+ description: 'Retrieve a list of oAuth2PermissionGrant entities, representing delegated permissions granted to the service principal (representing the client application) to access an API on behalf of a user.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-oauth2permissiongrants?view=graph-rest-1.0
@@ -16275,7 +16275,7 @@ paths:
tags:
- servicePrincipals.directoryObject
summary: 'servicePrincipals: List ownedObjects'
- description: Retrieve a list of objects owned by the servicePrincipal. This could include applications or groups. This API is available in the following national cloud deployments.
+ description: Retrieve a list of objects owned by the servicePrincipal. This could include applications or groups.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-list-ownedobjects?view=graph-rest-1.0
@@ -17100,7 +17100,7 @@ paths:
tags:
- servicePrincipals.directoryObject
summary: Remove owner
- description: 'Remove an owner from a servicePrincipal object. As a recommended best practice, service principals should have at least two owners. This API is available in the following national cloud deployments.'
+ description: 'Remove an owner from a servicePrincipal object. As a recommended best practice, service principals should have at least two owners.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-owners?view=graph-rest-1.0
@@ -17436,7 +17436,7 @@ paths:
tags:
- servicePrincipals.directoryObject
summary: 'servicePrincipal: Add owner'
- description: 'Add an owner for the servicePrincipal. Service principal owners can be users, the service principal itself, or other service principals. This API is available in the following national cloud deployments.'
+ description: 'Add an owner for the servicePrincipal. Service principal owners can be users, the service principal itself, or other service principals.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-post-owners?view=graph-rest-1.0
@@ -18299,7 +18299,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: List synchronization jobs
- description: List existing jobs for a given application instance (service principal). This API is available in the following national cloud deployments.
+ description: List existing jobs for a given application instance (service principal).
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0
@@ -18384,7 +18384,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: Create synchronizationJob
- description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. This API is available in the following national cloud deployments.
+ description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0
@@ -18420,7 +18420,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: Get synchronizationJob
- description: Retrieve the existing synchronization job and its properties. This API is available in the following national cloud deployments.
+ description: Retrieve the existing synchronization job and its properties.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0
@@ -18527,7 +18527,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: Delete synchronizationJob
- description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is. This API is available in the following national cloud deployments.'
+ description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0
@@ -18767,7 +18767,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action pause
- description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job continues from where it left off when a start call is made. This API is available in the following national cloud deployments.'
+ description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job continues from where it left off when a start call is made.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0
@@ -18800,7 +18800,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action provisionOnDemand
- description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. No user or group will be provisioned on-demand that would not have been provisioned through the regular provisioning cycles. This API is available in the following national cloud deployments.
+ description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. No user or group will be provisioned on-demand that would not have been provisioned through the regular provisioning cycles.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0
@@ -18851,7 +18851,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action restart
- description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors. This API is available in the following national cloud deployments.'
+ description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0
@@ -18896,7 +18896,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action start
- description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. This API is available in the following national cloud deployments.'
+ description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0
@@ -18929,7 +18929,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action validateCredentials
- description: Validate that the credentials are valid in the tenant. This API is available in the following national cloud deployments.
+ description: Validate that the credentials are valid in the tenant.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0
@@ -18986,7 +18986,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: Get synchronizationSchema
- description: Retrieve the schema for a given synchronization job or template. This API is available in the following national cloud deployments.
+ description: Retrieve the schema for a given synchronization job or template.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0
@@ -19421,7 +19421,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action discover
- description: Discover the latest schema definition for provisioning to an application. This API is available in the following national cloud deployments.
+ description: 'Discover the latest schema definition for provisioning to an application. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
@@ -19662,7 +19662,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action parseExpression
- description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID. This API is available in the following national cloud deployments.'
+ description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
@@ -19783,7 +19783,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action acquireAccessToken
- description: Acquire an OAuth Access token to authorize the Microsoft Entra provisioning service to provision users into an application. This API is available in the following national cloud deployments.
+ description: Acquire an OAuth Access token to authorize the Microsoft Entra provisioning service to provision users into an application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0
@@ -19910,7 +19910,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: List existing synchronization templates
- description: List the synchronization templates associated with a given application or service principal. This API is available in the following national cloud deployments.
+ description: List the synchronization templates associated with a given application or service principal.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0
@@ -20096,7 +20096,7 @@ paths:
tags:
- servicePrincipals.synchronization
summary: Update synchronizationTemplate
- description: Update (override) the synchronization template associated with a given application. This API is available in the following national cloud deployments.
+ description: Update (override) the synchronization template associated with a given application.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0
@@ -20602,7 +20602,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action discover
- description: Discover the latest schema definition for provisioning to an application. This API is available in the following national cloud deployments.
+ description: 'Discover the latest schema definition for provisioning to an application. '
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0
@@ -20843,7 +20843,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action parseExpression
- description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID. This API is available in the following national cloud deployments.'
+ description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0
@@ -21974,7 +21974,7 @@ paths:
tags:
- servicePrincipals.servicePrincipal
summary: Get servicePrincipal
- description: Retrieve the properties and relationships of a servicePrincipal object. This API is available in the following national cloud deployments.
+ description: Retrieve the properties and relationships of a servicePrincipal object.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/serviceprincipal-get?view=graph-rest-1.0
@@ -22000,7 +22000,218 @@ paths:
enum:
- id
- deletedDateTime
+ - accountEnabled
+ - addIns
+ - alternativeNames
+ - appDescription
+ - appDisplayName
+ - appId
+ - applicationTemplateId
+ - appOwnerOrganizationId
+ - appRoleAssignmentRequired
+ - appRoles
+ - customSecurityAttributes
+ - description
+ - disabledByMicrosoftStatus
+ - displayName
+ - errorUrl
+ - homepage
+ - info
+ - keyCredentials
+ - loginUrl
+ - logoutUrl
+ - notes
+ - notificationEmailAddresses
+ - passwordCredentials
- passwordSingleSignOnSettings
+ - preferredSingleSignOnMode
+ - preferredTokenSigningKeyEndDateTime
+ - preferredTokenSigningKeyThumbprint
+ - publishedPermissionScopes
+ - publisherName
+ - replyUrls
+ - samlMetadataUrl
+ - samlSingleSignOnSettings
+ - servicePrincipalNames
+ - servicePrincipalType
+ - signInAudience
+ - tags
+ - tokenEncryptionKeyId
+ - verifiedPublisher
+ - appManagementPolicies
+ - appRoleAssignedTo
+ - appRoleAssignments
+ - claimsMappingPolicies
+ - createdObjects
+ - delegatedPermissionClassifications
+ - endpoints
+ - federatedIdentityCredentials
+ - homeRealmDiscoveryPolicies
+ - licenseDetails
+ - memberOf
+ - oauth2PermissionGrants
+ - ownedObjects
+ - owners
+ - remoteDesktopSecurityConfiguration
+ - synchronization
+ - tokenIssuancePolicies
+ - tokenLifetimePolicies
+ - transitiveMemberOf
+ type: string
+ - name: $expand
+ in: query
+ description: Expand related entities
+ style: form
+ explode: false
+ schema:
+ uniqueItems: true
+ type: array
+ items:
+ enum:
+ - '*'
+ - appManagementPolicies
+ - appRoleAssignedTo
+ - appRoleAssignments
+ - claimsMappingPolicies
+ - createdObjects
+ - delegatedPermissionClassifications
+ - endpoints
+ - federatedIdentityCredentials
+ - homeRealmDiscoveryPolicies
+ - licenseDetails
+ - memberOf
+ - oauth2PermissionGrants
+ - ownedObjects
+ - owners
+ - remoteDesktopSecurityConfiguration
+ - synchronization
+ - tokenIssuancePolicies
+ - tokenLifetimePolicies
+ - transitiveMemberOf
+ type: string
+ responses:
+ 2XX:
+ description: Retrieved entity
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
+ default:
+ $ref: '#/components/responses/error'
+ x-ms-docs-operation-type: operation
+ patch:
+ tags:
+ - servicePrincipals.servicePrincipal
+ summary: Update servicePrincipal
+ description: Update the properties of servicePrincipal object.
+ externalDocs:
+ description: Find more info here
+ url: https://learn.microsoft.com/graph/api/serviceprincipal-update?view=graph-rest-1.0
+ operationId: servicePrincipal_UpdateServicePrincipalGraphBPreAppId
+ parameters:
+ - name: appId
+ in: path
+ description: Alternate key of servicePrincipal
+ required: true
+ style: simple
+ schema:
+ type: string
+ nullable: true
+ requestBody:
+ description: New property values
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
+ required: true
+ responses:
+ 2XX:
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
+ default:
+ $ref: '#/components/responses/error'
+ x-ms-docs-operation-type: operation
+ delete:
+ tags:
+ - servicePrincipals.servicePrincipal
+ summary: Delete servicePrincipal
+ description: Delete a servicePrincipal object.
+ externalDocs:
+ description: Find more info here
+ url: https://learn.microsoft.com/graph/api/serviceprincipal-delete?view=graph-rest-1.0
+ operationId: servicePrincipal_DeleteServicePrincipalGraphBPreAppId
+ parameters:
+ - name: appId
+ in: path
+ description: Alternate key of servicePrincipal
+ required: true
+ style: simple
+ schema:
+ type: string
+ nullable: true
+ - name: If-Match
+ in: header
+ description: ETag
+ style: simple
+ schema:
+ type: string
+ responses:
+ 2XX:
+ description: Success
+ default:
+ $ref: '#/components/responses/error'
+ x-ms-docs-operation-type: operation
+ /servicePrincipals/$count:
+ get:
+ tags:
+ - servicePrincipals.servicePrincipal
+ summary: Get the number of the resource
+ operationId: servicePrincipal_GetCount
+ parameters:
+ - name: ConsistencyLevel
+ in: header
+ description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
+ style: simple
+ schema:
+ type: string
+ examples:
+ example-1:
+ description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
+ value: eventual
+ - $ref: '#/components/parameters/search'
+ - $ref: '#/components/parameters/filter'
+ responses:
+ 2XX:
+ $ref: '#/components/responses/ODataCountResponse'
+ default:
+ $ref: '#/components/responses/error'
+ /servicePrincipals/microsoft.graph.delta():
+ get:
+ tags:
+ - servicePrincipals.Functions
+ summary: Invoke function delta
+ operationId: servicePrincipal_delta
+ parameters:
+ - $ref: '#/components/parameters/top'
+ - $ref: '#/components/parameters/skip'
+ - $ref: '#/components/parameters/search'
+ - $ref: '#/components/parameters/filter'
+ - $ref: '#/components/parameters/count'
+ - name: $select
+ in: query
+ description: Select properties to be returned
+ style: form
+ explode: false
+ schema:
+ uniqueItems: true
+ type: array
+ items:
+ enum:
+ - id
+ - deletedDateTime
- accountEnabled
- addIns
- alternativeNames
@@ -22024,218 +22235,7 @@ paths:
- notes
- notificationEmailAddresses
- passwordCredentials
- - preferredSingleSignOnMode
- - preferredTokenSigningKeyEndDateTime
- - preferredTokenSigningKeyThumbprint
- - publishedPermissionScopes
- - publisherName
- - replyUrls
- - samlMetadataUrl
- - samlSingleSignOnSettings
- - servicePrincipalNames
- - servicePrincipalType
- - signInAudience
- - tags
- - tokenEncryptionKeyId
- - verifiedPublisher
- - appManagementPolicies
- - appRoleAssignedTo
- - appRoleAssignments
- - claimsMappingPolicies
- - createdObjects
- - delegatedPermissionClassifications
- - endpoints
- - federatedIdentityCredentials
- - homeRealmDiscoveryPolicies
- - licenseDetails
- - memberOf
- - oauth2PermissionGrants
- - ownedObjects
- - owners
- - remoteDesktopSecurityConfiguration
- - tokenIssuancePolicies
- - tokenLifetimePolicies
- - transitiveMemberOf
- - synchronization
- type: string
- - name: $expand
- in: query
- description: Expand related entities
- style: form
- explode: false
- schema:
- uniqueItems: true
- type: array
- items:
- enum:
- - '*'
- - appManagementPolicies
- - appRoleAssignedTo
- - appRoleAssignments
- - claimsMappingPolicies
- - createdObjects
- - delegatedPermissionClassifications
- - endpoints
- - federatedIdentityCredentials
- - homeRealmDiscoveryPolicies
- - licenseDetails
- - memberOf
- - oauth2PermissionGrants
- - ownedObjects
- - owners
- - remoteDesktopSecurityConfiguration
- - tokenIssuancePolicies
- - tokenLifetimePolicies
- - transitiveMemberOf
- - synchronization
- type: string
- responses:
- 2XX:
- description: Retrieved entity
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
- default:
- $ref: '#/components/responses/error'
- x-ms-docs-operation-type: operation
- patch:
- tags:
- - servicePrincipals.servicePrincipal
- summary: Update servicePrincipal
- description: Update the properties of servicePrincipal object. This API is available in the following national cloud deployments.
- externalDocs:
- description: Find more info here
- url: https://learn.microsoft.com/graph/api/serviceprincipal-update?view=graph-rest-1.0
- operationId: servicePrincipal_UpdateServicePrincipalGraphBPreAppId
- parameters:
- - name: appId
- in: path
- description: Alternate key of servicePrincipal
- required: true
- style: simple
- schema:
- type: string
- nullable: true
- requestBody:
- description: New property values
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
- required: true
- responses:
- 2XX:
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
- default:
- $ref: '#/components/responses/error'
- x-ms-docs-operation-type: operation
- delete:
- tags:
- - servicePrincipals.servicePrincipal
- summary: Delete servicePrincipal
- description: Delete a servicePrincipal object. This API is available in the following national cloud deployments.
- externalDocs:
- description: Find more info here
- url: https://learn.microsoft.com/graph/api/serviceprincipal-delete?view=graph-rest-1.0
- operationId: servicePrincipal_DeleteServicePrincipalGraphBPreAppId
- parameters:
- - name: appId
- in: path
- description: Alternate key of servicePrincipal
- required: true
- style: simple
- schema:
- type: string
- nullable: true
- - name: If-Match
- in: header
- description: ETag
- style: simple
- schema:
- type: string
- responses:
- 2XX:
- description: Success
- default:
- $ref: '#/components/responses/error'
- x-ms-docs-operation-type: operation
- /servicePrincipals/$count:
- get:
- tags:
- - servicePrincipals.servicePrincipal
- summary: Get the number of the resource
- operationId: servicePrincipal_GetCount
- parameters:
- - name: ConsistencyLevel
- in: header
- description: 'Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries'
- style: simple
- schema:
- type: string
- examples:
- example-1:
- description: $search and $count queries require the client to set the ConsistencyLevel HTTP header to 'eventual'.
- value: eventual
- - $ref: '#/components/parameters/search'
- - $ref: '#/components/parameters/filter'
- responses:
- 2XX:
- $ref: '#/components/responses/ODataCountResponse'
- default:
- $ref: '#/components/responses/error'
- /servicePrincipals/microsoft.graph.delta():
- get:
- tags:
- - servicePrincipals.Functions
- summary: Invoke function delta
- operationId: servicePrincipal_delta
- parameters:
- - $ref: '#/components/parameters/top'
- - $ref: '#/components/parameters/skip'
- - $ref: '#/components/parameters/search'
- - $ref: '#/components/parameters/filter'
- - $ref: '#/components/parameters/count'
- - name: $select
- in: query
- description: Select properties to be returned
- style: form
- explode: false
- schema:
- uniqueItems: true
- type: array
- items:
- enum:
- - id
- - deletedDateTime
- passwordSingleSignOnSettings
- - accountEnabled
- - addIns
- - alternativeNames
- - appDescription
- - appDisplayName
- - appId
- - applicationTemplateId
- - appOwnerOrganizationId
- - appRoleAssignmentRequired
- - appRoles
- - customSecurityAttributes
- - description
- - disabledByMicrosoftStatus
- - displayName
- - errorUrl
- - homepage
- - info
- - keyCredentials
- - loginUrl
- - logoutUrl
- - notes
- - notificationEmailAddresses
- - passwordCredentials
- preferredSingleSignOnMode
- preferredTokenSigningKeyEndDateTime
- preferredTokenSigningKeyThumbprint
@@ -22265,10 +22265,10 @@ paths:
- ownedObjects
- owners
- remoteDesktopSecurityConfiguration
+ - synchronization
- tokenIssuancePolicies
- tokenLifetimePolicies
- transitiveMemberOf
- - synchronization
type: string
- name: $orderby
in: query
@@ -22284,8 +22284,6 @@ paths:
- id desc
- deletedDateTime
- deletedDateTime desc
- - passwordSingleSignOnSettings
- - passwordSingleSignOnSettings desc
- accountEnabled
- accountEnabled desc
- addIns
@@ -22332,6 +22330,8 @@ paths:
- notificationEmailAddresses desc
- passwordCredentials
- passwordCredentials desc
+ - passwordSingleSignOnSettings
+ - passwordSingleSignOnSettings desc
- preferredSingleSignOnMode
- preferredSingleSignOnMode desc
- preferredTokenSigningKeyEndDateTime
@@ -22393,7 +22393,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action getByIds
- description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to: This API is available in the following national cloud deployments.'
+ description: 'Return the directory objects specified in a list of IDs. Some common uses for this function are to:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-getbyids?view=graph-rest-1.0
@@ -22446,7 +22446,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action getUserOwnedObjects
- description: 'Retrieve a list of recently deleted application and group objects owned by the specified user. This API returns up to 1,000 deleted objects owned by the user, sorted by ID, and doesn''t support pagination. This API is available in the following national cloud deployments.'
+ description: 'Retrieve a list of recently deleted application and group objects owned by the specified user. This API returns up to 1,000 deleted objects owned by the user, sorted by ID, and doesn''t support pagination.'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directory-deleteditems-getuserownedobjects?view=graph-rest-1.0
@@ -22482,7 +22482,7 @@ paths:
tags:
- servicePrincipals.Actions
summary: Invoke action validateProperties
- description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. For validating properties of an existing group, use the validateProperties function for groups. The following validations are performed for the display name and mail nickname properties: \n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate the mail nickname is unique This API returns with the first failure encountered. If one or more properties fail multiple validations, only the property with the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy. This API is available in the following national cloud deployments."
+ description: "Validate that a Microsoft 365 group's display name or mail nickname complies with naming policies. Clients can use this API to determine whether a display name or mail nickname is valid before trying to create a Microsoft 365 group. For validating properties of an existing group, use the validateProperties function for groups. The following validations are performed for the display name and mail nickname properties: \n1. Validate the prefix and suffix naming policy\n2. Validate the custom banned words policy\n3. Validate the mail nickname is unique This API returns with the first failure encountered. If one or more properties fail multiple validations, only the property with the first validation failure is returned. However, you can validate both the mail nickname and the display name and receive a collection of validation errors if you are only validating the prefix and suffix naming policy."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/directoryobject-validateproperties?view=graph-rest-1.0
@@ -22622,7 +22622,7 @@ paths:
tags:
- users.appRoleAssignment
summary: Grant an appRoleAssignment to a user
- description: 'Use this API to assign an app role to a user. To grant an app role assignment to a user, you need three identifiers: This API is available in the following national cloud deployments.'
+ description: 'Use this API to assign an app role to a user. To grant an app role assignment to a user, you need three identifiers:'
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-post-approleassignments?view=graph-rest-1.0
@@ -22771,7 +22771,7 @@ paths:
tags:
- users.appRoleAssignment
summary: Delete appRoleAssignment
- description: Delete an appRoleAssignment that has been granted to a user. This API is available in the following national cloud deployments.
+ description: Delete an appRoleAssignment that has been granted to a user.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/user-delete-approleassignments?view=graph-rest-1.0
@@ -22914,6 +22914,8 @@ components:
type: string
description: Notes relevant for the management of the application.
nullable: true
+ onPremisesPublishing:
+ $ref: '#/components/schemas/microsoft.graph.onPremisesPublishing'
optionalClaims:
$ref: '#/components/schemas/microsoft.graph.optionalClaims'
parentalControlSettings:
@@ -22973,14 +22975,14 @@ components:
$ref: '#/components/schemas/microsoft.graph.webApplication'
windows:
$ref: '#/components/schemas/microsoft.graph.windowsApplication'
- onPremisesPublishing:
- $ref: '#/components/schemas/microsoft.graph.onPremisesPublishing'
appManagementPolicies:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
description: The appManagementPolicy applied to this application.
x-ms-navigationProperty: true
+ connectorGroup:
+ $ref: '#/components/schemas/microsoft.graph.connectorGroup'
createdOnBehalfOf:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
extensionProperties:
@@ -23006,6 +23008,8 @@ components:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
description: 'Directory objects that are owners of the application. Read-only. Nullable. Supports $expand, $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), and $select nested in $expand.'
x-ms-navigationProperty: true
+ synchronization:
+ $ref: '#/components/schemas/microsoft.graph.synchronization'
tokenIssuancePolicies:
type: array
items:
@@ -23017,10 +23021,6 @@ components:
$ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
description: The tokenLifetimePolicies assigned to this application. Supports $expand.
x-ms-navigationProperty: true
- connectorGroup:
- $ref: '#/components/schemas/microsoft.graph.connectorGroup'
- synchronization:
- $ref: '#/components/schemas/microsoft.graph.synchronization'
additionalProperties:
type: object
microsoft.graph.connectorGroup:
@@ -23247,8 +23247,6 @@ components:
- title: servicePrincipal
type: object
properties:
- passwordSingleSignOnSettings:
- $ref: '#/components/schemas/microsoft.graph.passwordSingleSignOnSettings'
accountEnabled:
type: boolean
description: 'true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).'
@@ -23344,6 +23342,8 @@ components:
items:
$ref: '#/components/schemas/microsoft.graph.passwordCredential'
description: The collection of password credentials associated with the service principal. Not nullable.
+ passwordSingleSignOnSettings:
+ $ref: '#/components/schemas/microsoft.graph.passwordSingleSignOnSettings'
preferredSingleSignOnMode:
type: string
description: 'Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Microsoft Entra My Apps. The supported values are password, saml, notSupported, and oidc.'
@@ -23488,6 +23488,8 @@ components:
x-ms-navigationProperty: true
remoteDesktopSecurityConfiguration:
$ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration'
+ synchronization:
+ $ref: '#/components/schemas/microsoft.graph.synchronization'
tokenIssuancePolicies:
type: array
items:
@@ -23505,8 +23507,6 @@ components:
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
x-ms-navigationProperty: true
- synchronization:
- $ref: '#/components/schemas/microsoft.graph.synchronization'
additionalProperties:
type: object
microsoft.graph.user:
@@ -23515,21 +23515,23 @@ components:
- title: user
type: object
properties:
- signInActivity:
- $ref: '#/components/schemas/microsoft.graph.signInActivity'
+ aboutMe:
+ type: string
+ description: A freeform text entry field for users to describe themselves. Returned only on $select.
+ nullable: true
accountEnabled:
type: boolean
description: 'true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).'
nullable: true
ageGroup:
type: string
- description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. For more information, see legal age group property definitions. Supports $filter (eq, ne, not, and in).'
+ description: 'Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions. Supports $filter (eq, ne, not, and in).'
nullable: true
assignedLicenses:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
- description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn''t differentiate directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Supports $filter (eq, not, /$count eq 0, /$count ne 0).'
+ description: 'The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn''t differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Supports $filter (eq, not, /$count eq 0, /$count ne 0).'
assignedPlans:
type: array
items:
@@ -23537,6 +23539,11 @@ components:
description: The plans that are assigned to the user. Read-only. Not nullable.Supports $filter (eq and not).
authorizationInfo:
$ref: '#/components/schemas/microsoft.graph.authorizationInfo'
+ 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 birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Returned only on $select.'
+ format: date-time
businessPhones:
type: array
items:
@@ -23550,7 +23557,7 @@ components:
$ref: '#/components/schemas/microsoft.graph.cloudRealtimeCommunicationInfo'
companyName:
type: string
- description: 'The name of the company that the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
+ description: 'The name of the company the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
consentProvidedForMinor:
type: string
@@ -23563,7 +23570,7 @@ components:
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 user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Supports $filter (eq, ne, not , ge, le, in).'
+ description: 'The date and time the user was created in ISO 8601 format and UTC. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users synced to Microsoft Entra ID before June 2018. Read-only. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
creationType:
@@ -23574,20 +23581,26 @@ components:
$ref: '#/components/schemas/microsoft.graph.customSecurityAttributeValue'
department:
type: string
- description: 'The name for the department in which the user works. Maximum length is 64 characters.Supports $filter (eq, ne, not , ge, le, in, and eq on null values).'
+ description: 'The name of the department where the user works. Maximum length is 64 characters.Supports $filter (eq, ne, not , ge, le, in, and eq on null values).'
nullable: true
+ deviceEnrollmentLimit:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
+ format: int32
deviceKeys:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.deviceKey'
displayName:
type: string
- description: 'The name displayed in the address book for the user. This value 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. Maximum length is 256 characters. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search.'
+ description: 'The name displayed in the address book for the user. This value 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. Maximum length is 256 characters. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search.'
nullable: true
employeeHireDate:
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 user was hired or will start work in case of a future hire. Supports $filter (eq, ne, not , ge, le, in).'
+ description: 'The date and time when the user was hired or will start work if there is a future hire. Supports $filter (eq, ne, not , ge, le, in).'
format: date-time
nullable: true
employeeId:
@@ -23622,29 +23635,40 @@ components:
type: string
description: 'The given name (first name) of the user. Maximum length is 64 characters. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).'
nullable: true
+ hireDate:
+ 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 hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.'
+ format: date-time
identities:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.objectIdentity'
- description: 'Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.'
+ description: 'Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft and tied to a user account. It may contain multiple items with the same signInType value. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.'
imAddresses:
type: array
items:
type: string
nullable: true
- description: 'The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Supports $filter (eq, not, ge, le, startsWith).'
+ description: 'The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Supports $filter (eq, not, ge, le, startsWith).'
infoCatalogs:
type: array
items:
type: string
description: 'Identifies the info segments assigned to the user. Supports $filter (eq, not, ge, le, startsWith).'
+ interests:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: A list for users to describe their interests. Returned only on $select.
isLicenseReconciliationNeeded:
type: boolean
description: Indicates whether the user is pending an exchange mailbox license assignment. Read-only. Supports $filter (eq where true only).
nullable: true
isManagementRestricted:
type: boolean
- description: 'true if the user is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a user who is a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.'
+ description: 'true if the user is a member of a restricted management administrative unit, which requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a user who is a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.'
nullable: true
isResourceAccount:
type: boolean
@@ -23657,29 +23681,35 @@ components:
lastPasswordChangeDateTime:
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 when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select.'
+ description: 'When this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select.'
format: date-time
nullable: true
legalAgeGroupClassification:
type: string
- description: 'Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. For more information, see legal age group property definitions. Returned only on $select.'
+ description: 'Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select.'
nullable: true
licenseAssignmentStates:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.licenseAssignmentState'
- description: State of license assignments for this user. Also indicates licenses that are directly assigned and those that the user has inherited through group memberships. Read-only. Returned only on $select.
+ description: State of license assignments for this user. It also indicates licenses that are directly assigned and the ones the user inherited through group memberships. Read-only. Returned only on $select.
mail:
type: string
- description: 'The SMTP address for the user, for example, admin@contoso.com. Changes to this property also updates the user''s proxyAddresses collection to include the value as an SMTP address. This property can''t contain accent characters. NOTE: We don''t recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
+ description: 'The SMTP address for the user, for example, admin@contoso.com. Changes to this property also update the user''s proxyAddresses collection to include the value as an SMTP address. This property can''t contain accent characters. NOTE: We don''t recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
nullable: true
+ mailboxSettings:
+ $ref: '#/components/schemas/microsoft.graph.mailboxSettings'
mailNickname:
type: string
description: 'The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
mobilePhone:
type: string
- description: 'The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.'
+ description: 'The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search.'
+ nullable: true
+ mySite:
+ type: string
+ description: The URL for the user's site. Returned only on $select.
nullable: true
officeLocation:
type: string
@@ -23687,22 +23717,22 @@ components:
nullable: true
onPremisesDistinguishedName:
type: string
- description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.
+ description: Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.
nullable: true
onPremisesDomainName:
type: string
- description: 'Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.'
+ description: 'Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.'
nullable: true
onPremisesExtensionAttributes:
$ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
onPremisesImmutableId:
type: string
- description: 'This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you''re using a federated domain for the user''s userPrincipalName (UPN) property. Note: The $ and _ characters can''t be used when specifying this property. Supports $filter (eq, ne, not, ge, le, in).'
+ description: 'This property associates an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you''re using a federated domain for the user''s userPrincipalName (UPN) property. Note: The $ and _ characters can''t be used when specifying this property. Supports $filter (eq, ne, not, ge, le, in).'
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 object was synced with the on-premises directory; for example: ''2013-02-16T03:04:54Z''. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
+ description: 'Indicates the last time at which the object was synced with the on-premises directory; for example: ''2013-02-16T03:04:54Z''. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesProvisioningErrors:
@@ -23712,21 +23742,21 @@ components:
description: 'Errors when using Microsoft synchronization product during provisioning. Supports $filter (eq, not, ge, le).'
onPremisesSamAccountName:
type: string
- description: 'Contains the on-premises sAMAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
+ description: 'Contains the on-premises sAMAccountName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
onPremisesSecurityIdentifier:
type: string
- description: Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Supports $filter (eq including on null values).
+ description: Contains the on-premises security identifier (SID) for the user synchronized from on-premises to the cloud. Read-only. Supports $filter (eq including on null values).
nullable: true
onPremisesSipInfo:
$ref: '#/components/schemas/microsoft.graph.onPremisesSipInfo'
onPremisesSyncEnabled:
type: boolean
- description: 'true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn''t being synced and can be managed in Microsoft Entra ID. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
+ description: 'true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise, the user isn''t being synced and can be managed in Microsoft Entra ID. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).'
nullable: true
onPremisesUserPrincipalName:
type: string
- description: 'Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
+ description: 'Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith).'
nullable: true
otherMails:
type: array
@@ -23739,6 +23769,12 @@ components:
nullable: true
passwordProfile:
$ref: '#/components/schemas/microsoft.graph.passwordProfile'
+ pastProjects:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: A list for users to enumerate their past projects. Returned only on $select.
postalCode:
type: string
description: 'The postal code for the user''s postal address. The postal code is specific to the user''s country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
@@ -23749,8 +23785,14 @@ components:
nullable: true
preferredLanguage:
type: string
- description: 'The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: ''en-US'', or ''es-ES''. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
+ description: 'The preferred language for the user. The preferred language format is based on RFC 4646. The name combines an ISO 639 two-letter lowercase culture code associated with the language and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: ''en-US'', or ''es-ES''. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
+ nullable: true
+ preferredName:
+ type: string
+ description: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.
nullable: true
+ print:
+ $ref: '#/components/schemas/microsoft.graph.userPrint'
provisionedPlans:
type: array
items:
@@ -23760,13 +23802,25 @@ components:
type: array
items:
type: string
- description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
+ description: 'For example: [''SMTP: bob@contoso.com'', ''smtp: bob@sales.contoso.com'']. Changes to the mail property also update this collection to include the value as an SMTP address. For more information, see mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while the ones prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).'
refreshTokensValidFromDateTime:
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: 'Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use invalidateAllRefreshTokens to reset.'
+ description: 'Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If it happens, the application must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use invalidateAllRefreshTokens to reset.'
format: date-time
nullable: true
+ responsibilities:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: A list for the user to enumerate their responsibilities. Returned only on $select.
+ schools:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: A list for the user to enumerate the schools they have attended. Returned only on $select.
securityIdentifier:
type: string
description: 'Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).'
@@ -23775,17 +23829,25 @@ components:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
- description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance).'
+ description: 'Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object.'
showInAddressList:
type: boolean
description: Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
nullable: true
+ signInActivity:
+ $ref: '#/components/schemas/microsoft.graph.signInActivity'
signInSessionsValidFromDateTime:
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: 'Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset.'
+ description: 'Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset.'
format: date-time
nullable: true
+ skills:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: A list for the user to enumerate their skills. Returned only on $select.
state:
type: string
description: 'The state or province in the user''s address. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
@@ -23800,93 +23862,35 @@ components:
nullable: true
usageLocation:
type: string
- description: 'A two letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
+ description: 'A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
userPrincipalName:
type: string
- description: 'The user principal name (UPN) of the user. The UPN is an Internet-style sign-in 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.NOTE: This property can''t contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, '' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.'
+ description: 'The user principal name (UPN) of the user. The UPN is an Internet-style sign-in 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 the domain must be present in the tenant''s verified domain collection. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: This property can''t contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, '' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) 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 (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions for member and guest users, see What are the default user permissions in Microsoft Entra ID?'
nullable: true
- mailboxSettings:
- $ref: '#/components/schemas/microsoft.graph.mailboxSettings'
- deviceEnrollmentLimit:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
- format: int32
- print:
- $ref: '#/components/schemas/microsoft.graph.userPrint'
- aboutMe:
- type: string
- description: A freeform text entry field for the user to describe themselves. Returned only on $select.
- 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 birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Returned only on $select.'
- format: date-time
- hireDate:
- 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 hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.'
- format: date-time
- interests:
- type: array
- items:
- type: string
- nullable: true
- description: A list for the user to describe their interests. Returned only on $select.
- mySite:
- type: string
- description: The URL for the user's personal site. Returned only on $select.
- nullable: true
- pastProjects:
- type: array
- items:
- type: string
- nullable: true
- description: A list for the user to enumerate their past projects. Returned only on $select.
- preferredName:
- type: string
- description: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.
- nullable: true
- responsibilities:
- type: array
- items:
- type: string
- nullable: true
- description: A list for the user to enumerate their responsibilities. Returned only on $select.
- schools:
+ activities:
type: array
items:
- type: string
- nullable: true
- description: A list for the user to enumerate the schools they have attended. Returned only on $select.
- skills:
+ $ref: '#/components/schemas/microsoft.graph.userActivity'
+ description: The user's activities across devices. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ agreementAcceptances:
type: array
items:
- type: string
- nullable: true
- description: A list for the user to enumerate their skills. Returned only on $select.
+ $ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
+ description: The user's terms of use acceptance statuses. Read-only. Nullable.
+ x-ms-navigationProperty: true
analytics:
$ref: '#/components/schemas/microsoft.graph.userAnalytics'
- cloudPCs:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.cloudPC'
- x-ms-navigationProperty: true
- usageRights:
+ appConsentRequestsForApproval:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.usageRight'
- description: Represents the usage rights a user has been granted.
+ $ref: '#/components/schemas/microsoft.graph.appConsentRequest'
x-ms-navigationProperty: true
- informationProtection:
- $ref: '#/components/schemas/microsoft.graph.informationProtection'
appRoleAssignedResources:
type: array
items:
@@ -23898,78 +23902,13 @@ components:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a user has been granted for an application. Supports $expand.
x-ms-navigationProperty: true
- createdObjects:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: Directory objects that the user created. Read-only. Nullable.
- x-ms-navigationProperty: true
- directReports:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
- x-ms-navigationProperty: true
- licenseDetails:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.licenseDetails'
- x-ms-navigationProperty: true
- manager:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- memberOf:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'The groups, directory roles and administrative units that the user is a member of. Read-only. Nullable. Supports $expand.'
- x-ms-navigationProperty: true
- oauth2PermissionGrants:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
- x-ms-navigationProperty: true
- ownedDevices:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: Devices that are owned by the user. Read-only. Nullable. Supports $expand.
- x-ms-navigationProperty: true
- ownedObjects:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'Directory objects that are owned by the user. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
- x-ms-navigationProperty: true
- registeredDevices:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.
- x-ms-navigationProperty: true
- scopedRoleMemberOf:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
- description: The scoped-role administrative unit memberships for this user. Read-only. Nullable.
- x-ms-navigationProperty: true
- sponsors:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'The users and groups that are responsible for this guest user''s privileges in the tenant and keep the guest user''s information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.'
- x-ms-navigationProperty: true
- transitiveMemberOf:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'The groups, including nested groups, and directory roles that a user is a member of. Nullable.'
- x-ms-navigationProperty: true
- transitiveReports:
+ approvals:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: The transitive reports for a user. Read-only.
+ $ref: '#/components/schemas/microsoft.graph.approval'
x-ms-navigationProperty: true
+ authentication:
+ $ref: '#/components/schemas/microsoft.graph.authentication'
calendar:
$ref: '#/components/schemas/microsoft.graph.calendar'
calendarGroups:
@@ -23990,6 +23929,16 @@ components:
$ref: '#/components/schemas/microsoft.graph.event'
description: The calendar view for the calendar. Read-only. Nullable.
x-ms-navigationProperty: true
+ chats:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chat'
+ x-ms-navigationProperty: true
+ cloudPCs:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.cloudPC'
+ x-ms-navigationProperty: true
contactFolders:
type: array
items:
@@ -24002,38 +23951,34 @@ components:
$ref: '#/components/schemas/microsoft.graph.contact'
description: The user's contacts. Read-only. Nullable.
x-ms-navigationProperty: true
- events:
+ createdObjects:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.event'
- description: The user's events. Default is to show events under the Default Calendar. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: Directory objects that the user created. Read-only. Nullable.
x-ms-navigationProperty: true
- inferenceClassification:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassification'
- joinedGroups:
+ deviceEnrollmentConfigurations:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.group'
+ $ref: '#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration'
+ description: Get enrollment configurations targeted to the user
x-ms-navigationProperty: true
- mailFolders:
+ deviceManagementTroubleshootingEvents:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.mailFolder'
- description: The user's mail folders. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent'
+ description: The list of troubleshooting events for this user.
x-ms-navigationProperty: true
- messages:
+ devices:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.message'
- description: The messages in a mailbox or folder. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.device'
x-ms-navigationProperty: true
- outlook:
- $ref: '#/components/schemas/microsoft.graph.outlookUser'
- people:
+ directReports:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.person'
- description: 'Read-only. The most relevant people to the user. The collection is ordered by their relevance to the user, which is determined by the user''s communication, collaboration and business relationships. A person is an aggregation of information from across mail, contacts and social networks.'
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: The users and contacts that report to the user. (The users and contacts with their manager property set to this user.) Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
drive:
$ref: '#/components/schemas/microsoft.graph.drive'
@@ -24043,10 +23988,13 @@ components:
$ref: '#/components/schemas/microsoft.graph.drive'
description: A collection of drives available for this user. Read-only.
x-ms-navigationProperty: true
- followedSites:
+ employeeExperience:
+ $ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
+ events:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.site'
+ $ref: '#/components/schemas/microsoft.graph.event'
+ description: The user's events. The default is to show events under the Default Calendar. Read-only. Nullable.
x-ms-navigationProperty: true
extensions:
type: array
@@ -24054,41 +24002,38 @@ components:
$ref: '#/components/schemas/microsoft.graph.extension'
description: The collection of open extensions defined for the user. Supports $expand. Nullable.
x-ms-navigationProperty: true
- appConsentRequestsForApproval:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.appConsentRequest'
- x-ms-navigationProperty: true
- approvals:
+ followedSites:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.approval'
+ $ref: '#/components/schemas/microsoft.graph.site'
x-ms-navigationProperty: true
- pendingAccessReviewInstances:
+ inferenceClassification:
+ $ref: '#/components/schemas/microsoft.graph.inferenceClassification'
+ informationProtection:
+ $ref: '#/components/schemas/microsoft.graph.informationProtection'
+ insights:
+ $ref: '#/components/schemas/microsoft.graph.itemInsights'
+ joinedGroups:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
- description: Navigation property to get list of access reviews pending approval by reviewer.
+ $ref: '#/components/schemas/microsoft.graph.group'
x-ms-navigationProperty: true
- agreementAcceptances:
+ joinedTeams:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.agreementAcceptance'
- description: The user's terms of use acceptance statuses. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.team'
+ description: The Microsoft Teams teams the user is a member of. Read-only. Nullable.
x-ms-navigationProperty: true
- security:
- $ref: '#/components/schemas/microsoft.graph.security.security'
- deviceEnrollmentConfigurations:
+ licenseDetails:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.deviceEnrollmentConfiguration'
- description: Get enrollment configurations targeted to the user
+ $ref: '#/components/schemas/microsoft.graph.licenseDetails'
x-ms-navigationProperty: true
- managedDevices:
+ mailFolders:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.managedDevice'
- description: The managed devices associated with the user.
+ $ref: '#/components/schemas/microsoft.graph.mailFolder'
+ description: The user's mail folders. Read-only. Nullable.
x-ms-navigationProperty: true
managedAppRegistrations:
type: array
@@ -24096,17 +24041,25 @@ components:
$ref: '#/components/schemas/microsoft.graph.managedAppRegistration'
description: Zero or more managed app registrations that belong to the user.
x-ms-navigationProperty: true
- windowsInformationProtectionDeviceRegistrations:
+ managedDevices:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.windowsInformationProtectionDeviceRegistration'
- description: Zero or more WIP device registrations that belong to the user.
+ $ref: '#/components/schemas/microsoft.graph.managedDevice'
+ description: The managed devices associated with the user.
x-ms-navigationProperty: true
- deviceManagementTroubleshootingEvents:
+ manager:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ memberOf:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent'
- description: The list of troubleshooting events for this user.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'The groups, directory roles, and administrative units that the user is a member of. Read-only. Nullable. Supports $expand.'
+ x-ms-navigationProperty: true
+ messages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.message'
+ description: The messages in a mailbox or folder. Read-only. Nullable.
x-ms-navigationProperty: true
mobileAppIntentAndStates:
type: array
@@ -24125,69 +24078,117 @@ components:
items:
$ref: '#/components/schemas/microsoft.graph.notification'
x-ms-navigationProperty: true
- planner:
- $ref: '#/components/schemas/microsoft.graph.plannerUser'
- insights:
- $ref: '#/components/schemas/microsoft.graph.itemInsights'
- settings:
- $ref: '#/components/schemas/microsoft.graph.userSettings'
+ oauth2PermissionGrants:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
+ x-ms-navigationProperty: true
onenote:
$ref: '#/components/schemas/microsoft.graph.onenote'
- photo:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- photos:
+ onlineMeetings:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
+ $ref: '#/components/schemas/microsoft.graph.onlineMeeting'
+ description: 'Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.'
x-ms-navigationProperty: true
- profile:
- $ref: '#/components/schemas/microsoft.graph.profile'
- activities:
+ outlook:
+ $ref: '#/components/schemas/microsoft.graph.outlookUser'
+ ownedDevices:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.userActivity'
- description: The user's activities across devices. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: Devices owned by the user. Read-only. Nullable. Supports $expand.
x-ms-navigationProperty: true
- devices:
+ ownedObjects:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.device'
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'Directory objects owned by the user. Read-only. Nullable. Supports $expand, $select nested in $expand, and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).'
x-ms-navigationProperty: true
- onlineMeetings:
+ pendingAccessReviewInstances:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onlineMeeting'
- description: 'Information about a meeting, including the URL used to join a meeting, the attendees'' list, and the description.'
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
+ description: Navigation property to get a list of access reviews pending approval by the reviewer.
+ x-ms-navigationProperty: true
+ people:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.person'
+ description: 'Read-only. The most relevant people to the user. The collection is ordered by their relevance to the user, which is determined by the user''s communication, collaboration, and business relationships. A person aggregates information from mail, contacts, and social networks.'
+ x-ms-navigationProperty: true
+ permissionGrants:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
+ description: List all resource-specific permission grants of a user.
+ x-ms-navigationProperty: true
+ photo:
+ $ref: '#/components/schemas/microsoft.graph.profilePhoto'
+ photos:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.profilePhoto'
+ description: The collection of the user's profile photos in different sizes. Read-only.
x-ms-navigationProperty: true
+ planner:
+ $ref: '#/components/schemas/microsoft.graph.plannerUser'
presence:
$ref: '#/components/schemas/microsoft.graph.presence'
- virtualEvents:
- $ref: '#/components/schemas/microsoft.graph.userVirtualEventsRoot'
- authentication:
- $ref: '#/components/schemas/microsoft.graph.authentication'
- chats:
+ profile:
+ $ref: '#/components/schemas/microsoft.graph.profile'
+ registeredDevices:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.chat'
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.
x-ms-navigationProperty: true
- joinedTeams:
+ scopedRoleMemberOf:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.team'
- description: The Microsoft Teams teams that the user is a member of. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
+ description: The scoped-role administrative unit memberships for this user. Read-only. Nullable.
x-ms-navigationProperty: true
- permissionGrants:
+ security:
+ $ref: '#/components/schemas/microsoft.graph.security.security'
+ settings:
+ $ref: '#/components/schemas/microsoft.graph.userSettings'
+ sponsors:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
- description: List all resource-specific permission grants of a user.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'The users and groups responsible for this guest user''s privileges in the tenant and keep the guest user''s information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports $expand.'
x-ms-navigationProperty: true
teamwork:
$ref: '#/components/schemas/microsoft.graph.userTeamwork'
todo:
$ref: '#/components/schemas/microsoft.graph.todo'
- employeeExperience:
- $ref: '#/components/schemas/microsoft.graph.employeeExperienceUser'
+ transitiveMemberOf:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'The groups, including nested groups and directory roles that a user is a member of. Nullable.'
+ x-ms-navigationProperty: true
+ transitiveReports:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: The transitive reports for a user. Read-only.
+ x-ms-navigationProperty: true
+ usageRights:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.usageRight'
+ description: Represents the usage rights a user has been granted.
+ x-ms-navigationProperty: true
+ virtualEvents:
+ $ref: '#/components/schemas/microsoft.graph.userVirtualEventsRoot'
+ windowsInformationProtectionDeviceRegistrations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.windowsInformationProtectionDeviceRegistration'
+ description: Zero or more WIP device registrations that belong to the user.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.synchronization:
@@ -24830,6 +24831,12 @@ components:
type: string
description: 'Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership or Public. If not set, the default behavior is Public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.'
nullable: true
+ extensions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.extension'
+ description: The collection of open extensions defined for this administrative unit. Nullable.
+ x-ms-navigationProperty: true
members:
type: array
items:
@@ -24842,12 +24849,6 @@ components:
$ref: '#/components/schemas/microsoft.graph.scopedRoleMembership'
description: Scoped-role members of this administrative unit.
x-ms-navigationProperty: true
- extensions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.extension'
- description: The collection of open extensions defined for this administrative unit. Nullable.
- x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.directoryRole:
@@ -24888,6 +24889,12 @@ components:
- title: group
type: object
properties:
+ accessType:
+ $ref: '#/components/schemas/microsoft.graph.groupAccessType'
+ allowExternalSenders:
+ type: boolean
+ description: 'Indicates if people external to the organization can send messages to the group. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
+ nullable: true
assignedLabels:
type: array
items:
@@ -24898,6 +24905,10 @@ components:
items:
$ref: '#/components/schemas/microsoft.graph.assignedLicense'
description: The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq). Read-only.
+ autoSubscribeNewMembers:
+ type: boolean
+ description: 'Indicates if new members added to the group are auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; don''t set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
+ 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.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).'
@@ -24909,7 +24920,7 @@ components:
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 is 2014-01-01T00:00:00Z. Returned by default. Read-only.'
+ description: 'Timestamp of when the group was created. The value can''t 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.'
format: date-time
nullable: true
description:
@@ -24923,30 +24934,49 @@ components:
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: 'Timestamp of when the group is set to expire. Is null for security groups but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
+ description: 'Timestamp of when the group is set to expire. It is null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
groupTypes:
type: array
items:
type: string
- description: 'Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it''s either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).'
+ description: 'Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it''s either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).'
hasMembersWithLicenseErrors:
type: boolean
description: 'Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). Supports $filter (eq).'
nullable: true
+ hideFromAddressLists:
+ type: boolean
+ description: 'true if the group isn''t displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups; false otherwise. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
+ nullable: true
+ hideFromOutlookClients:
+ type: boolean
+ description: 'true if the group isn''t displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
+ nullable: true
infoCatalogs:
type: array
items:
type: string
description: 'Identifies the info segments assigned to the group. Returned by default. Supports $filter (eq, not, ge, le, startsWith).'
+ isArchived:
+ type: boolean
+ description: 'When a group is associated with a team, this property determines whether the team is in read-only mode. To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.'
+ nullable: true
isAssignableToRole:
type: boolean
- description: 'Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignmentsUsing this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not).'
+ description: 'Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes can''t contain DynamicMembership). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignmentsUsing this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not).'
+ nullable: true
+ isFavorite:
+ type: boolean
nullable: true
isManagementRestricted:
type: boolean
- description: 'Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only. To manage a group that''s a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.'
+ description: 'Indicates whether the group is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. The default value is false. Read-only. To manage a group member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.'
+ nullable: true
+ isSubscribedByMail:
+ type: boolean
+ description: 'Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
nullable: true
licenseProcessingState:
$ref: '#/components/schemas/microsoft.graph.licenseProcessingState'
@@ -24970,19 +25000,21 @@ components:
type: string
description: 'Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).'
nullable: true
+ membershipRuleProcessingStatus:
+ $ref: '#/components/schemas/microsoft.graph.membershipRuleProcessingStatus'
onPremisesDomainName:
type: string
- description: 'Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.'
+ description: 'Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.'
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 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
+ 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).'
format: date-time
nullable: true
onPremisesNetBiosName:
type: string
- description: Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
+ description: Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
nullable: true
onPremisesProvisioningErrors:
type: array
@@ -24991,11 +25023,11 @@ components:
description: 'Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).'
onPremisesSamAccountName:
type: string
- description: 'Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.'
+ description: 'Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.'
nullable: true
onPremisesSecurityIdentifier:
type: string
- description: Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only.
+ description: Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only.
nullable: true
onPremisesSyncEnabled:
type: boolean
@@ -25006,11 +25038,11 @@ components:
nullable: true
preferredDataLocation:
type: string
- description: 'The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator''s preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned one of the following Microsoft Entra roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo and and Create a Microsoft 365 group with a specific PDL. Nullable. Returned by default.'
+ description: 'The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator''s preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned one of the following Microsoft Entra roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo and Create a Microsoft 365 group with a specific PDL. Nullable. Returned by default.'
nullable: true
preferredLanguage:
type: string
- description: 'The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
+ description: 'The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).'
nullable: true
proxyAddresses:
type: array
@@ -25020,7 +25052,7 @@ components:
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 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
+ 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.'
format: date-time
nullable: true
resourceBehaviorOptions:
@@ -25032,7 +25064,7 @@ components:
type: array
items:
type: string
- description: 'Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith.'
+ description: 'Specifies the group resources that are provisioned as part of Microsoft 365 group creation that isn''t normally part of default group creation. The possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith.'
securityEnabled:
type: boolean
description: 'Specifies whether the group is a security group. Required.Returned by default. Supports $filter (eq, ne, not, in).'
@@ -25045,7 +25077,7 @@ components:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.serviceProvisioningError'
- description: 'Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object . Supports $filter (eq, not, for isResolved and serviceInstance).'
+ description: 'Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object.'
theme:
type: string
description: 'Specifies a Microsoft 365 group''s color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.'
@@ -25053,42 +25085,11 @@ components:
uniqueName:
type: string
nullable: true
- visibility:
- type: string
- description: 'Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can''t be updated later. Other values of visibility can be updated after group creation. If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable.'
- nullable: true
- writebackConfiguration:
- $ref: '#/components/schemas/microsoft.graph.groupWritebackConfiguration'
- accessType:
- $ref: '#/components/schemas/microsoft.graph.groupAccessType'
- allowExternalSenders:
- type: boolean
- description: 'Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
- nullable: true
- autoSubscribeNewMembers:
- type: boolean
- description: '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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
- nullable: true
- hideFromAddressLists:
- type: boolean
- description: 'true if the group is not displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups; false otherwise. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
- nullable: true
- hideFromOutlookClients:
- type: boolean
- description: 'true if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
- nullable: true
- isFavorite:
- type: boolean
- nullable: true
- isSubscribedByMail:
- type: boolean
- description: 'Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).'
- nullable: true
unseenConversationsCount:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: Count of conversations that have been delivered one or more new posts since the signed-in user's last visit to the group. This property is the same as unseenCount. Returned only on $select.
+ description: Count of conversations delivered one or more new posts since the signed-in user's last visit to the group. This property is the same as unseenCount. Returned only on $select.
format: int32
nullable: true
unseenCount:
@@ -25105,119 +25106,125 @@ components:
description: Count of new posts that have been delivered to the group's conversations since the signed-in user's last visit to the group. Returned only on $select.
format: int32
nullable: true
- membershipRuleProcessingStatus:
- $ref: '#/components/schemas/microsoft.graph.membershipRuleProcessingStatus'
- isArchived:
- type: boolean
- description: 'When a group is associated with a team, this property determines whether the team is in read-only mode. To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.'
+ visibility:
+ type: string
+ description: 'Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can''t be updated later. Other values of visibility can be updated after group creation. If visibility value isn''t specified during group creation on Microsoft Graph, a security group is created as Private by default, and Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable.'
nullable: true
+ writebackConfiguration:
+ $ref: '#/components/schemas/microsoft.graph.groupWritebackConfiguration'
+ acceptedSenders:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'The list of users or groups allowed to create posts or calendar events in this group. If this list is non-empty, then only users or groups listed here can post.'
+ x-ms-navigationProperty: true
appRoleAssignments:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
description: Represents the app roles a group has been granted for an application. Supports $expand.
x-ms-navigationProperty: true
- createdOnBehalfOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- endpoints:
+ calendar:
+ $ref: '#/components/schemas/microsoft.graph.calendar'
+ calendarView:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.endpoint'
- description: Endpoints for the group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.event'
+ description: The calendar view for the calendar. Read-only.
x-ms-navigationProperty: true
- memberOf:
+ conversations:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'Groups and administrative units that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.'
+ $ref: '#/components/schemas/microsoft.graph.conversation'
+ description: The group's conversations.
x-ms-navigationProperty: true
- members:
+ createdOnBehalfOf:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ drive:
+ $ref: '#/components/schemas/microsoft.graph.drive'
+ drives:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'Direct members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).'
+ $ref: '#/components/schemas/microsoft.graph.drive'
+ description: The group's drives. Read-only.
x-ms-navigationProperty: true
- membersWithLicenseErrors:
+ endpoints:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: A list of group members with license errors from this group-based license assignment. Read-only.
+ $ref: '#/components/schemas/microsoft.graph.endpoint'
+ description: Endpoints for the group. Read-only. Nullable.
x-ms-navigationProperty: true
- owners:
+ events:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'The owners of the group who can be users or service principals. Nullable. If this property is not specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).'
+ $ref: '#/components/schemas/microsoft.graph.event'
+ description: The group's events.
x-ms-navigationProperty: true
- permissionGrants:
+ extensions:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
- description: The permissions that have been granted for a group to a specific application. Supports $expand.
+ $ref: '#/components/schemas/microsoft.graph.extension'
+ description: The collection of open extensions defined for the group. Read-only. Nullable.
x-ms-navigationProperty: true
- settings:
+ groupLifecyclePolicies:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.directorySetting'
- description: 'Settings that can govern this group''s behavior, like whether members can invite guest users to the group. Nullable.'
+ $ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
+ description: The collection of lifecycle policies for this group. Read-only. Nullable.
x-ms-navigationProperty: true
- transitiveMemberOf:
+ memberOf:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'The groups that a group is a member of, either directly and through nested membership. Nullable.'
+ description: 'Groups and administrative units that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.'
x-ms-navigationProperty: true
- transitiveMembers:
+ members:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: The direct and transitive members of a group. Nullable.
+ description: 'Direct group members, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
- acceptedSenders:
+ membersWithLicenseErrors:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post.
+ description: A list of group members with license errors from this group-based license assignment. Read-only.
x-ms-navigationProperty: true
- calendar:
- $ref: '#/components/schemas/microsoft.graph.calendar'
- calendarView:
+ onenote:
+ $ref: '#/components/schemas/microsoft.graph.onenote'
+ owners:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.event'
- description: The calendar view for the calendar. Read-only.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'The owners of the group who can be users or service principals. Nullable. If this property isn''t specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,''Role'')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).'
x-ms-navigationProperty: true
- conversations:
+ permissionGrants:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.conversation'
- description: The group's conversations.
+ $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
+ description: The permissions granted for a group to a specific application. Supports $expand.
x-ms-navigationProperty: true
- events:
+ photo:
+ $ref: '#/components/schemas/microsoft.graph.profilePhoto'
+ photos:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.event'
- description: The group's events.
+ $ref: '#/components/schemas/microsoft.graph.profilePhoto'
+ description: The profile photos owned by the group. Read-only. Nullable.
x-ms-navigationProperty: true
+ planner:
+ $ref: '#/components/schemas/microsoft.graph.plannerGroup'
rejectedSenders:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable
+ description: The list of users or groups not allowed to create posts or calendar events in this group. Nullable
x-ms-navigationProperty: true
- threads:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.conversationThread'
- description: The group's conversation threads. Nullable.
- x-ms-navigationProperty: true
- drive:
- $ref: '#/components/schemas/microsoft.graph.drive'
- drives:
+ settings:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.drive'
- description: The group's drives. Read-only.
+ $ref: '#/components/schemas/microsoft.graph.directorySetting'
+ description: 'Settings that can govern this group''s behavior, like whether members can invite guest users to the group. Nullable.'
x-ms-navigationProperty: true
sites:
type: array
@@ -25225,32 +25232,26 @@ components:
$ref: '#/components/schemas/microsoft.graph.site'
description: The list of SharePoint sites in this group. Access the default site with /sites/root.
x-ms-navigationProperty: true
- extensions:
+ team:
+ $ref: '#/components/schemas/microsoft.graph.team'
+ threads:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.extension'
- description: The collection of open extensions defined for the group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.conversationThread'
+ description: The group's conversation threads. Nullable.
x-ms-navigationProperty: true
- groupLifecyclePolicies:
+ transitiveMemberOf:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.groupLifecyclePolicy'
- description: The collection of lifecycle policies for this group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'The groups a group is a member of, either directly or through nested membership. Nullable.'
x-ms-navigationProperty: true
- planner:
- $ref: '#/components/schemas/microsoft.graph.plannerGroup'
- onenote:
- $ref: '#/components/schemas/microsoft.graph.onenote'
- photo:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- photos:
+ transitiveMembers:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- description: The profile photos owned by the group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: The direct and transitive members of a group. Nullable.
x-ms-navigationProperty: true
- team:
- $ref: '#/components/schemas/microsoft.graph.team'
additionalProperties:
type: object
microsoft.graph.selfSignedCertificate:
@@ -25558,6 +25559,89 @@ components:
nullable: true
additionalProperties:
type: object
+ microsoft.graph.onPremisesPublishing:
+ title: onPremisesPublishing
+ type: object
+ properties:
+ alternateUrl:
+ type: string
+ description: 'If you''re configuring a traffic manager in front of multiple App Proxy applications, the alternateUrl is the user-friendly URL that points to the traffic manager.'
+ nullable: true
+ applicationServerTimeout:
+ type: string
+ description: 'The duration the connector waits for a response from the backend application before closing the connection. Possible values are default, long. When set to default, the backend application timeout has a length of 85 seconds. When set to long, the backend timeout is increased to 180 seconds. Use long if your server takes more than 85 seconds to respond to requests or if you are unable to access the application and the error status is ''Backend Timeout''. Default value is default.'
+ nullable: true
+ applicationType:
+ type: string
+ description: Indicates if this application is an Application Proxy configured application. This is pre-set by the system. Read-only.
+ nullable: true
+ externalAuthenticationType:
+ $ref: '#/components/schemas/microsoft.graph.externalAuthenticationType'
+ externalUrl:
+ type: string
+ description: 'The published external url for the application. For example, https://intranet-contoso.msappproxy.net/.'
+ nullable: true
+ internalUrl:
+ type: string
+ description: 'The internal url of the application. For example, https://intranet/.'
+ nullable: true
+ isAccessibleViaZTNAClient:
+ type: boolean
+ nullable: true
+ isBackendCertificateValidationEnabled:
+ type: boolean
+ description: 'Indicates whether backend SSL certificate validation is enabled for the application. For all new Application Proxy apps, the property is set to true by default. For all existing apps, the property is set to false.'
+ nullable: true
+ isDnsResolutionEnabled:
+ type: boolean
+ nullable: true
+ isHttpOnlyCookieEnabled:
+ type: boolean
+ description: 'Indicates if the HTTPOnly cookie flag should be set in the HTTP response headers. Set this value to true to have Application Proxy cookies include the HTTPOnly flag in the HTTP response headers. If using Remote Desktop Services, set this value to False. Default value is false.'
+ nullable: true
+ isOnPremPublishingEnabled:
+ type: boolean
+ description: Indicates if the application is currently being published via Application Proxy or not. This is preset by the system. Read-only.
+ nullable: true
+ isPersistentCookieEnabled:
+ type: boolean
+ description: 'Indicates if the Persistent cookie flag should be set in the HTTP response headers. Keep this value set to false. Only use this setting for applications that can''t share cookies between processes. For more information about cookie settings, see Cookie settings for accessing on-premises applications in Microsoft Entra ID. Default value is false.'
+ nullable: true
+ isSecureCookieEnabled:
+ type: boolean
+ description: Indicates if the Secure cookie flag should be set in the HTTP response headers. Set this value to true to transmit cookies over a secure channel such as an encrypted HTTPS request. Default value is true.
+ nullable: true
+ isStateSessionEnabled:
+ type: boolean
+ description: Indicates whether validation of the state parameter when the client uses the OAuth 2.0 authorization code grant flow is enabled. This setting allows admins to specify whether they want to enable CSRF protection for their apps.
+ nullable: true
+ isTranslateHostHeaderEnabled:
+ type: boolean
+ description: Indicates if the application should translate urls in the response headers. Keep this value as true unless your application required the original host header in the authentication request. Default value is true.
+ nullable: true
+ isTranslateLinksInBodyEnabled:
+ type: boolean
+ description: 'Indicates if the application should translate urls in the application body. Keep this value as false unless you have hardcoded HTML links to other on-premises applications and don''t use custom domains. For more information, see Link translation with Application Proxy. Default value is false.'
+ nullable: true
+ onPremisesApplicationSegments:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onPremisesApplicationSegment'
+ segmentsConfiguration:
+ $ref: '#/components/schemas/microsoft.graph.segmentConfiguration'
+ singleSignOnSettings:
+ $ref: '#/components/schemas/microsoft.graph.onPremisesPublishingSingleSignOn'
+ useAlternateUrlForTranslationAndRedirect:
+ type: boolean
+ nullable: true
+ verifiedCustomDomainCertificatesMetadata:
+ $ref: '#/components/schemas/microsoft.graph.verifiedCustomDomainCertificatesMetadata'
+ verifiedCustomDomainKeyCredential:
+ $ref: '#/components/schemas/microsoft.graph.keyCredential'
+ verifiedCustomDomainPasswordCredential:
+ $ref: '#/components/schemas/microsoft.graph.passwordCredential'
+ additionalProperties:
+ type: object
microsoft.graph.optionalClaims:
title: optionalClaims
type: object
@@ -25731,89 +25815,6 @@ components:
description: Specifies the URLs where user tokens are sent for sign-in or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent. Only available for applications that support the PersonalMicrosoftAccount signInAudience.
additionalProperties:
type: object
- microsoft.graph.onPremisesPublishing:
- title: onPremisesPublishing
- type: object
- properties:
- alternateUrl:
- type: string
- description: 'If you''re configuring a traffic manager in front of multiple App Proxy applications, the alternateUrl is the user-friendly URL that points to the traffic manager.'
- nullable: true
- applicationServerTimeout:
- type: string
- description: 'The duration the connector waits for a response from the backend application before closing the connection. Possible values are default, long. When set to default, the backend application timeout has a length of 85 seconds. When set to long, the backend timeout is increased to 180 seconds. Use long if your server takes more than 85 seconds to respond to requests or if you are unable to access the application and the error status is ''Backend Timeout''. Default value is default.'
- nullable: true
- applicationType:
- type: string
- description: Indicates if this application is an Application Proxy configured application. This is pre-set by the system. Read-only.
- nullable: true
- externalAuthenticationType:
- $ref: '#/components/schemas/microsoft.graph.externalAuthenticationType'
- externalUrl:
- type: string
- description: 'The published external url for the application. For example, https://intranet-contoso.msappproxy.net/.'
- nullable: true
- internalUrl:
- type: string
- description: 'The internal url of the application. For example, https://intranet/.'
- nullable: true
- isAccessibleViaZTNAClient:
- type: boolean
- nullable: true
- isBackendCertificateValidationEnabled:
- type: boolean
- description: 'Indicates whether backend SSL certificate validation is enabled for the application. For all new Application Proxy apps, the property is set to true by default. For all existing apps, the property is set to false.'
- nullable: true
- isDnsResolutionEnabled:
- type: boolean
- nullable: true
- isHttpOnlyCookieEnabled:
- type: boolean
- description: 'Indicates if the HTTPOnly cookie flag should be set in the HTTP response headers. Set this value to true to have Application Proxy cookies include the HTTPOnly flag in the HTTP response headers. If using Remote Desktop Services, set this value to False. Default value is false.'
- nullable: true
- isOnPremPublishingEnabled:
- type: boolean
- description: Indicates if the application is currently being published via Application Proxy or not. This is preset by the system. Read-only.
- nullable: true
- isPersistentCookieEnabled:
- type: boolean
- description: 'Indicates if the Persistent cookie flag should be set in the HTTP response headers. Keep this value set to false. Only use this setting for applications that can''t share cookies between processes. For more information about cookie settings, see Cookie settings for accessing on-premises applications in Microsoft Entra ID. Default value is false.'
- nullable: true
- isSecureCookieEnabled:
- type: boolean
- description: Indicates if the Secure cookie flag should be set in the HTTP response headers. Set this value to true to transmit cookies over a secure channel such as an encrypted HTTPS request. Default value is true.
- nullable: true
- isStateSessionEnabled:
- type: boolean
- description: Indicates whether validation of the state parameter when the client uses the OAuth 2.0 authorization code grant flow is enabled. This setting allows admins to specify whether they want to enable CSRF protection for their apps.
- nullable: true
- isTranslateHostHeaderEnabled:
- type: boolean
- description: Indicates if the application should translate urls in the response headers. Keep this value as true unless your application required the original host header in the authentication request. Default value is true.
- nullable: true
- isTranslateLinksInBodyEnabled:
- type: boolean
- description: 'Indicates if the application should translate urls in the application body. Keep this value as false unless you have hardcoded HTML links to other on-premises applications and don''t use custom domains. For more information, see Link translation with Application Proxy. Default value is false.'
- nullable: true
- onPremisesApplicationSegments:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onPremisesApplicationSegment'
- segmentsConfiguration:
- $ref: '#/components/schemas/microsoft.graph.segmentConfiguration'
- singleSignOnSettings:
- $ref: '#/components/schemas/microsoft.graph.onPremisesPublishingSingleSignOn'
- useAlternateUrlForTranslationAndRedirect:
- type: boolean
- nullable: true
- verifiedCustomDomainCertificatesMetadata:
- $ref: '#/components/schemas/microsoft.graph.verifiedCustomDomainCertificatesMetadata'
- verifiedCustomDomainKeyCredential:
- $ref: '#/components/schemas/microsoft.graph.keyCredential'
- verifiedCustomDomainPasswordCredential:
- $ref: '#/components/schemas/microsoft.graph.passwordCredential'
- additionalProperties:
- type: object
microsoft.graph.entity:
title: entity
type: object
@@ -25860,16 +25861,6 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.passwordSingleSignOnSettings:
- title: passwordSingleSignOnSettings
- type: object
- properties:
- fields:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.passwordSingleSignOnField'
- additionalProperties:
- type: object
microsoft.graph.addIn:
title: addIn
type: object
@@ -25892,6 +25883,16 @@ components:
type: object
additionalProperties:
type: object
+ microsoft.graph.passwordSingleSignOnSettings:
+ title: passwordSingleSignOnSettings
+ type: object
+ properties:
+ fields:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.passwordSingleSignOnField'
+ additionalProperties:
+ type: object
microsoft.graph.permissionScope:
title: permissionScope
type: object
@@ -25950,32 +25951,6 @@ components:
type: object
additionalProperties:
type: object
- microsoft.graph.signInActivity:
- title: signInActivity
- type: object
- properties:
- lastNonInteractiveSignInDateTime:
- 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 non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted to sign into the directory the directory on behalf of a user. Because some users may use clients to access tenant resources rather than signing into your tenant directly, you can use the non-interactive sign-in date to along with lastSignInDateTime to identify inactive users. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is: ''2014-01-01T00:00:00Z''. Microsoft Entra ID maintains non-interactive sign-ins going back to May 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
- format: date-time
- nullable: true
- lastNonInteractiveSignInRequestId:
- type: string
- description: Request identifier of the last non-interactive sign-in performed by this user.
- nullable: true
- lastSignInDateTime:
- 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 interactive sign-in date and time for a specific user. You can use this field to calculate the last time a user attempted to sign into the directory the directory with an interactive authentication method. This field can be used to build reports, such as inactive users. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is: ''2014-01-01T00:00:00Z''. Microsoft Entra ID maintains interactive sign-ins going back to April 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
- format: date-time
- nullable: true
- lastSignInRequestId:
- type: string
- description: Request identifier of the last interactive sign-in performed by this user.
- nullable: true
- additionalProperties:
- type: object
microsoft.graph.assignedLicense:
title: assignedLicense
type: object
@@ -26131,6 +26106,40 @@ components:
nullable: true
additionalProperties:
type: object
+ microsoft.graph.mailboxSettings:
+ title: mailboxSettings
+ type: object
+ properties:
+ archiveFolder:
+ type: string
+ description: Folder ID of an archive folder for the user. Read-only.
+ nullable: true
+ automaticRepliesSetting:
+ $ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
+ dateFormat:
+ type: string
+ description: The date format for the user's mailbox.
+ nullable: true
+ delegateMeetingMessageDeliveryOptions:
+ $ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions'
+ language:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ timeFormat:
+ type: string
+ description: The time format for the user's mailbox.
+ nullable: true
+ timeZone:
+ type: string
+ description: The default time zone for the user's mailbox.
+ nullable: true
+ userPurpose:
+ $ref: '#/components/schemas/microsoft.graph.userPurpose'
+ userPurposeV2:
+ $ref: '#/components/schemas/microsoft.graph.mailboxRecipientType'
+ workingHours:
+ $ref: '#/components/schemas/microsoft.graph.workingHours'
+ additionalProperties:
+ type: object
microsoft.graph.onPremisesExtensionAttributes:
title: onPremisesExtensionAttributes
type: object
@@ -26256,6 +26265,17 @@ components:
nullable: true
additionalProperties:
type: object
+ microsoft.graph.userPrint:
+ title: userPrint
+ type: object
+ properties:
+ recentPrinterShares:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.printerShare'
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
microsoft.graph.provisionedPlan:
title: provisionedPlan
type: object
@@ -26294,284 +26314,360 @@ components:
nullable: true
additionalProperties:
type: object
- microsoft.graph.mailboxSettings:
- title: mailboxSettings
+ microsoft.graph.signInActivity:
+ title: signInActivity
type: object
properties:
- archiveFolder:
+ lastNonInteractiveSignInDateTime:
+ 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: Folder ID of an archive folder for the user. Read-only.
+ description: 'The last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted to sign into the directory the directory on behalf of a user. Because some users may use clients to access tenant resources rather than signing into your tenant directly, you can use the non-interactive sign-in date to along with lastSignInDateTime to identify inactive users. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is: ''2014-01-01T00:00:00Z''. Microsoft Entra ID maintains non-interactive sign-ins going back to May 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
+ format: date-time
nullable: true
- automaticRepliesSetting:
- $ref: '#/components/schemas/microsoft.graph.automaticRepliesSetting'
- dateFormat:
+ lastNonInteractiveSignInRequestId:
type: string
- description: The date format for the user's mailbox.
+ description: Request identifier of the last non-interactive sign-in performed by this user.
nullable: true
- delegateMeetingMessageDeliveryOptions:
- $ref: '#/components/schemas/microsoft.graph.delegateMeetingMessageDeliveryOptions'
- language:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- timeFormat:
+ lastSignInDateTime:
+ 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 format for the user's mailbox.
+ description: 'The last interactive sign-in date and time for a specific user. You can use this field to calculate the last time a user attempted to sign into the directory the directory with an interactive authentication method. This field can be used to build reports, such as inactive users. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is: ''2014-01-01T00:00:00Z''. Microsoft Entra ID maintains interactive sign-ins going back to April 2020. For more information about using the value of this property, see Manage inactive user accounts in Microsoft Entra ID.'
+ format: date-time
nullable: true
- timeZone:
+ lastSignInRequestId:
type: string
- description: The default time zone for the user's mailbox.
+ description: Request identifier of the last interactive sign-in performed by this user.
nullable: true
- userPurpose:
- $ref: '#/components/schemas/microsoft.graph.userPurpose'
- userPurposeV2:
- $ref: '#/components/schemas/microsoft.graph.mailboxRecipientType'
- workingHours:
- $ref: '#/components/schemas/microsoft.graph.workingHours'
- additionalProperties:
- type: object
- microsoft.graph.userPrint:
- title: userPrint
- type: object
- properties:
- recentPrinterShares:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.printerShare'
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.userAnalytics:
+ microsoft.graph.userActivity:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userAnalytics
+ - title: userActivity
type: object
properties:
- settings:
- $ref: '#/components/schemas/microsoft.graph.settings'
- activityStatistics:
+ activationUrl:
+ type: string
+ description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
+ activitySourceHost:
+ type: string
+ description: 'Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.'
+ appActivityId:
+ type: string
+ description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
+ appDisplayName:
+ type: string
+ description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
+ nullable: true
+ contentInfo:
+ $ref: '#/components/schemas/microsoft.graph.Json'
+ contentUrl:
+ type: string
+ description: 'Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).'
+ 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: Set by the server. DateTime in UTC when the object was created on the server.
+ 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: Set by the server. DateTime in UTC when the object expired on the server.
+ format: date-time
+ nullable: true
+ fallbackUrl:
+ type: string
+ description: 'Optional. URL used to launch the activity in a web-based app, if available.'
+ 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: Set by the server. DateTime in UTC when the object was modified on the server.
+ format: date-time
+ nullable: true
+ status:
+ $ref: '#/components/schemas/microsoft.graph.status'
+ userTimezone:
+ type: string
+ description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
+ nullable: true
+ visualElements:
+ $ref: '#/components/schemas/microsoft.graph.visualInfo'
+ historyItems:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.activityStatistics'
- description: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
+ description: Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.cloudPC:
+ microsoft.graph.agreementAcceptance:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: cloudPC
+ - title: agreementAcceptance
type: object
properties:
- aadDeviceId:
+ agreementFileId:
type: string
- description: The Microsoft Entra device ID of the Cloud PC.
+ description: ID of the agreement file accepted by the user.
nullable: true
- connectionSettings:
- $ref: '#/components/schemas/microsoft.graph.cloudPcConnectionSettings'
- connectivityResult:
- $ref: '#/components/schemas/microsoft.graph.cloudPcConnectivityResult'
- diskEncryptionState:
- $ref: '#/components/schemas/microsoft.graph.cloudPcDiskEncryptionState'
- displayName:
+ agreementId:
type: string
- description: The display name of the Cloud PC.
+ description: ID of the agreement.
nullable: true
- gracePeriodEndDateTime:
- 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])$'
+ deviceDisplayName:
type: string
- description: 'The date and time when the grace period ends and reprovisioning or deprovisioning happen. Required only if the status is inGracePeriod. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
+ description: The display name of the device used for accepting the agreement.
nullable: true
- imageDisplayName:
+ deviceId:
type: string
- description: Name of the OS image that's on the Cloud PC.
+ description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
nullable: true
- lastLoginResult:
- $ref: '#/components/schemas/microsoft.graph.cloudPcLoginResult'
- 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 modified date and time of the Cloud PC. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- lastRemoteActionResult:
- $ref: '#/components/schemas/microsoft.graph.cloudPcRemoteActionResult'
- managedDeviceId:
+ deviceOSType:
type: string
- description: The Intune device ID of the Cloud PC.
+ description: The operating system used for accepting the agreement.
nullable: true
- managedDeviceName:
+ deviceOSVersion:
type: string
- description: The Intune device name of the Cloud PC.
+ description: The operating system version of the device used for accepting the agreement.
nullable: true
- onPremisesConnectionName:
+ 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 Azure network connection that is applied during the provisioning of Cloud PCs.
+ description: 'The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ge, le) and eq for null values.'
+ format: date-time
nullable: true
- osVersion:
- $ref: '#/components/schemas/microsoft.graph.cloudPcOperatingSystem'
- partnerAgentInstallResults:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.cloudPcPartnerAgentInstallResult'
- description: The results of every partner agent's installation status on Cloud PC.
- powerState:
- $ref: '#/components/schemas/microsoft.graph.cloudPcPowerState'
- provisioningPolicyId:
+ recordedDateTime:
+ 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 provisioning policy ID of the Cloud PC.
+ 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 is 2014-01-01T00:00:00Z. Supports $filter (eq) and eq for null values.'
+ format: date-time
nullable: true
- provisioningPolicyName:
+ state:
+ $ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState'
+ userDisplayName:
type: string
- description: The provisioning policy that is applied during the provisioning of Cloud PCs.
+ description: Display name of the user when the acceptance was recorded.
nullable: true
- provisioningType:
- $ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningType'
- servicePlanId:
+ userEmail:
type: string
- description: The service plan ID of the Cloud PC.
+ description: Email of the user when the acceptance was recorded.
nullable: true
- servicePlanName:
+ userId:
type: string
- description: The service plan name of the Cloud PC.
+ description: ID of the user who accepted the agreement. Supports $filter (eq).
nullable: true
- servicePlanType:
- $ref: '#/components/schemas/microsoft.graph.cloudPcServicePlanType'
- status:
- $ref: '#/components/schemas/microsoft.graph.cloudPcStatus'
- statusDetails:
- $ref: '#/components/schemas/microsoft.graph.cloudPcStatusDetails'
- userAccountType:
- $ref: '#/components/schemas/microsoft.graph.cloudPcUserAccountType'
userPrincipalName:
type: string
- description: The user principal name (UPN) of the user assigned to the Cloud PC.
+ description: UPN of the user when the acceptance was recorded.
nullable: true
additionalProperties:
type: object
- microsoft.graph.usageRight:
+ microsoft.graph.userAnalytics:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: usageRight
+ - title: userAnalytics
type: object
properties:
- catalogId:
- type: string
- description: Product id corresponding to the usage right.
- serviceIdentifier:
- type: string
- description: Identifier of the service corresponding to the usage right.
- state:
- $ref: '#/components/schemas/microsoft.graph.usageRightState'
+ settings:
+ $ref: '#/components/schemas/microsoft.graph.settings'
+ activityStatistics:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.activityStatistics'
+ description: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.informationProtection:
+ microsoft.graph.appConsentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: informationProtection
+ - title: appConsentRequest
type: object
properties:
- bitlocker:
- $ref: '#/components/schemas/microsoft.graph.bitlocker'
- dataLossPreventionPolicies:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.dataLossPreventionPolicy'
- x-ms-navigationProperty: true
- sensitivityLabels:
+ appDisplayName:
+ type: string
+ description: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.
+ nullable: true
+ appId:
+ type: string
+ description: The identifier of the application. Required. Supports $filter (eq only) and $orderby.
+ consentType:
+ type: string
+ description: 'The consent type of the request. Possible values are: Static and Dynamic. These represent static and dynamic permissions, respectively, requested in the consent workflow. Supports $filter (eq only) and $orderby. Required.'
+ nullable: true
+ pendingScopes:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
- x-ms-navigationProperty: true
- sensitivityPolicySettings:
- $ref: '#/components/schemas/microsoft.graph.sensitivityPolicySettings'
- policy:
- $ref: '#/components/schemas/microsoft.graph.informationProtectionPolicy'
- threatAssessmentRequests:
+ $ref: '#/components/schemas/microsoft.graph.appConsentRequestScope'
+ description: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.
+ userConsentRequests:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
+ $ref: '#/components/schemas/microsoft.graph.userConsentRequest'
+ description: A list of pending user consent requests. Supports $filter (eq).
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.scopedRoleMembership:
+ microsoft.graph.approval:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: scopedRoleMembership
+ - title: approval
type: object
properties:
- administrativeUnitId:
- type: string
- description: Unique identifier for the administrative unit that the directory role is scoped to
- roleId:
- type: string
- description: Unique identifier for the directory role that the member is in.
- roleMemberInfo:
- $ref: '#/components/schemas/microsoft.graph.identity'
+ steps:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.approvalStep'
+ description: Used to represent the decision associated with a single step in the approval process configured in approvalStage.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.calendar:
+ microsoft.graph.authentication:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: calendar
+ - title: authentication
type: object
properties:
- allowedOnlineMeetingProviders:
+ signInPreferences:
+ $ref: '#/components/schemas/microsoft.graph.signInPreferences'
+ emailMethods:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
- description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
- calendarGroupId:
- type: string
- description: 'The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.'
- nullable: true
- 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, through an Outlook client or the corresponding calendarPermission resource. Read-only.'
- 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. Read-only.'
- nullable: true
- canViewPrivateItems:
- type: boolean
- description: 'true if the user can read calendar items that have been marked private, false otherwise. This property is set through an Outlook client or the corresponding calendarPermission resource. Read-only.'
- 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:
- $ref: '#/components/schemas/microsoft.graph.calendarColor'
- defaultOnlineMeetingProvider:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
- hexColor:
- type: string
- description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty.'
- nullable: true
- isDefaultCalendar:
- type: boolean
- description: 'true if this is the default calendar where new events are created by default, false otherwise.'
- nullable: true
- isRemovable:
- type: boolean
- description: Indicates whether this user calendar can be deleted from the user mailbox.
- nullable: true
- isShared:
- type: boolean
- description: 'true if the user has shared the calendar with other users, false otherwise. Since only the user who created the calendar can share it, isShared and isSharedWithMe cannot be true for the same user. This property is set when sharing is initiated in an Outlook client, and can be reset when the sharing is cancelled through the client or the corresponding calendarPermission resource. Read-only.'
- nullable: true
- isSharedWithMe:
- type: boolean
- description: 'true if the user has been shared this calendar, false otherwise. This property is always false for a calendar owner. This property is set when sharing is initiated in an Outlook client, and can be reset when the sharing is cancelled through the client or the corresponding calendarPermission resource. Read-only.'
- nullable: true
- isTallyingResponses:
- type: boolean
- description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- nullable: true
- name:
- type: string
- description: The calendar name.
- nullable: true
- owner:
+ $ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
+ description: Represents the email addresses registered to a user for authentication.
+ x-ms-navigationProperty: true
+ fido2Methods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
+ description: Represents the FIDO2 security keys registered to a user for authentication.
+ x-ms-navigationProperty: true
+ methods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ description: Represents all authentication methods registered to a user.
+ x-ms-navigationProperty: true
+ microsoftAuthenticatorMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
+ description: The details of the Microsoft Authenticator app registered to a user for authentication.
+ x-ms-navigationProperty: true
+ operations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
+ x-ms-navigationProperty: true
+ passwordlessMicrosoftAuthenticatorMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.passwordlessMicrosoftAuthenticatorAuthenticationMethod'
+ description: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
+ x-ms-navigationProperty: true
+ passwordMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
+ description: Represents the details of the password authentication method registered to a user for authentication.
+ x-ms-navigationProperty: true
+ phoneMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
+ description: Represents the phone registered to a user for authentication.
+ x-ms-navigationProperty: true
+ platformCredentialMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod'
+ x-ms-navigationProperty: true
+ softwareOathMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
+ x-ms-navigationProperty: true
+ temporaryAccessPassMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
+ description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
+ x-ms-navigationProperty: true
+ windowsHelloForBusinessMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
+ description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.calendar:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: calendar
+ type: object
+ properties:
+ allowedOnlineMeetingProviders:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
+ description: 'Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.'
+ calendarGroupId:
+ type: string
+ description: 'The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.'
+ nullable: true
+ 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, through an Outlook client or the corresponding calendarPermission resource. Read-only.'
+ 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. Read-only.'
+ nullable: true
+ canViewPrivateItems:
+ type: boolean
+ description: 'true if the user can read calendar items that have been marked private, false otherwise. This property is set through an Outlook client or the corresponding calendarPermission resource. Read-only.'
+ 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:
+ $ref: '#/components/schemas/microsoft.graph.calendarColor'
+ defaultOnlineMeetingProvider:
+ $ref: '#/components/schemas/microsoft.graph.onlineMeetingProviderType'
+ hexColor:
+ type: string
+ description: 'The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty.'
+ nullable: true
+ isDefaultCalendar:
+ type: boolean
+ description: 'true if this is the default calendar where new events are created by default, false otherwise.'
+ nullable: true
+ isRemovable:
+ type: boolean
+ description: Indicates whether this user calendar can be deleted from the user mailbox.
+ nullable: true
+ isShared:
+ type: boolean
+ description: 'true if the user has shared the calendar with other users, false otherwise. Since only the user who created the calendar can share it, isShared and isSharedWithMe cannot be true for the same user. This property is set when sharing is initiated in an Outlook client, and can be reset when the sharing is cancelled through the client or the corresponding calendarPermission resource. Read-only.'
+ nullable: true
+ isSharedWithMe:
+ type: boolean
+ description: 'true if the user has been shared this calendar, false otherwise. This property is always false for a calendar owner. This property is set when sharing is initiated in an Outlook client, and can be reset when the sharing is cancelled through the client or the corresponding calendarPermission resource. Read-only.'
+ nullable: true
+ isTallyingResponses:
+ type: boolean
+ description: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
+ nullable: true
+ name:
+ type: string
+ description: The calendar name.
+ nullable: true
+ owner:
$ref: '#/components/schemas/microsoft.graph.emailAddress'
calendarPermissions:
type: array
@@ -26794,6 +26890,185 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
+ microsoft.graph.chat:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: chat
+ type: object
+ properties:
+ chatType:
+ $ref: '#/components/schemas/microsoft.graph.chatType'
+ 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 at which the chat was created. Read-only.
+ format: date-time
+ nullable: true
+ lastUpdatedDateTime:
+ 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 at which the chat was renamed or list of members were last changed. Read-only.
+ format: date-time
+ nullable: true
+ onlineMeetingInfo:
+ $ref: '#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo'
+ tenantId:
+ type: string
+ description: The identifier of the tenant in which the chat was created. Read-only.
+ nullable: true
+ topic:
+ type: string
+ description: (Optional) Subject or topic for the chat. Only available for group chats.
+ nullable: true
+ viewpoint:
+ $ref: '#/components/schemas/microsoft.graph.chatViewpoint'
+ webUrl:
+ type: string
+ description: 'The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.'
+ nullable: true
+ installedApps:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
+ description: A collection of all the apps in the chat. Nullable.
+ x-ms-navigationProperty: true
+ lastMessagePreview:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
+ members:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.conversationMember'
+ description: A collection of all the members in the chat. Nullable.
+ x-ms-navigationProperty: true
+ messages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chatMessage'
+ description: A collection of all the messages in the chat. Nullable.
+ x-ms-navigationProperty: true
+ operations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
+ description: A collection of all the Teams async operations that ran or are running on the chat. Nullable.
+ x-ms-navigationProperty: true
+ permissionGrants:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
+ description: A collection of permissions granted to apps for the chat.
+ x-ms-navigationProperty: true
+ pinnedMessages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
+ description: A collection of all the pinned messages in the chat. Nullable.
+ x-ms-navigationProperty: true
+ tabs:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.teamsTab'
+ description: A collection of all the tabs in the chat. Nullable.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.cloudPC:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: cloudPC
+ type: object
+ properties:
+ aadDeviceId:
+ type: string
+ description: The Microsoft Entra device ID of the Cloud PC.
+ nullable: true
+ connectionSettings:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcConnectionSettings'
+ connectivityResult:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcConnectivityResult'
+ diskEncryptionState:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcDiskEncryptionState'
+ displayName:
+ type: string
+ description: The display name of the Cloud PC.
+ nullable: true
+ gracePeriodEndDateTime:
+ 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 grace period ends and reprovisioning or deprovisioning happen. Required only if the status is inGracePeriod. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
+ nullable: true
+ imageDisplayName:
+ type: string
+ description: Name of the OS image that's on the Cloud PC.
+ nullable: true
+ lastLoginResult:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcLoginResult'
+ 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 modified date and time of the Cloud PC. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
+ lastRemoteActionResult:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcRemoteActionResult'
+ managedDeviceId:
+ type: string
+ description: The Intune device ID of the Cloud PC.
+ nullable: true
+ managedDeviceName:
+ type: string
+ description: The Intune device name of the Cloud PC.
+ nullable: true
+ onPremisesConnectionName:
+ type: string
+ description: The Azure network connection that is applied during the provisioning of Cloud PCs.
+ nullable: true
+ osVersion:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcOperatingSystem'
+ partnerAgentInstallResults:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcPartnerAgentInstallResult'
+ description: The results of every partner agent's installation status on Cloud PC.
+ powerState:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcPowerState'
+ provisioningPolicyId:
+ type: string
+ description: The provisioning policy ID of the Cloud PC.
+ nullable: true
+ provisioningPolicyName:
+ type: string
+ description: The provisioning policy that is applied during the provisioning of Cloud PCs.
+ nullable: true
+ provisioningType:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcProvisioningType'
+ scopeIds:
+ type: array
+ items:
+ type: string
+ nullable: true
+ servicePlanId:
+ type: string
+ description: The service plan ID of the Cloud PC.
+ nullable: true
+ servicePlanName:
+ type: string
+ description: The service plan name of the Cloud PC.
+ nullable: true
+ servicePlanType:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcServicePlanType'
+ status:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcStatus'
+ statusDetails:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcStatusDetails'
+ userAccountType:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcUserAccountType'
+ userPrincipalName:
+ type: string
+ description: The user principal name (UPN) of the user assigned to the Cloud PC.
+ nullable: true
+ additionalProperties:
+ type: object
microsoft.graph.contactFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
@@ -26987,355 +27262,298 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- 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'
- description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.mailFolder:
+ microsoft.graph.deviceEnrollmentConfiguration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: mailFolder
+ - title: deviceEnrollmentConfiguration
type: object
properties:
- childFolderCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The number of immediate child mailFolders in the current mailFolder.
- format: int32
+ 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: Created date time in UTC of the device enrollment configuration
+ format: date-time
+ description:
+ type: string
+ description: The description of the device enrollment configuration
nullable: true
+ deviceEnrollmentConfigurationType:
+ $ref: '#/components/schemas/microsoft.graph.deviceEnrollmentConfigurationType'
displayName:
type: string
- description: The mailFolder's display name.
- nullable: true
- isHidden:
- type: boolean
- description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
+ description: The display name of the device enrollment configuration
nullable: true
- parentFolderId:
+ 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 unique identifier for the mailFolder's parent mailFolder.
- nullable: true
- totalItemCount:
+ description: Last modified date time in UTC of the device enrollment configuration
+ format: date-time
+ priority:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: The number of items in the mailFolder.
+ description: Priority is used when a user exists in multiple groups that are assigned enrollment configuration. Users are subject only to the configuration with the lowest priority value.
format: int32
- nullable: true
- unreadItemCount:
+ roleScopeTagIds:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: Optional role scope tags for the enrollment restrictions.
+ version:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: The number of items in the mailFolder marked as unread.
+ description: The version of the device enrollment configuration
format: int32
- nullable: true
- wellKnownName:
- type: string
- description: 'The well-known folder name for the folder. The possible values are listed above. This property is only set for default folders created by Outlook. For other folders, this property is null.'
- nullable: true
- childFolders:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.mailFolder'
- description: The collection of child folders in the mailFolder.
- x-ms-navigationProperty: true
- messageRules:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.messageRule'
- description: The collection of rules that apply to the user's Inbox folder.
- x-ms-navigationProperty: true
- messages:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.message'
- description: The collection of messages in the mailFolder.
- x-ms-navigationProperty: true
- multiValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
- description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
- x-ms-navigationProperty: true
- singleValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
- description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
- x-ms-navigationProperty: true
- userConfigurations:
+ assignments:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.userConfiguration'
+ $ref: '#/components/schemas/microsoft.graph.enrollmentConfigurationAssignment'
+ description: The list of group assignments for the device configuration profile
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.message:
+ description: The Base Class of Device Enrollment Configuration
+ microsoft.graph.deviceManagementTroubleshootingEvent:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.outlookItem'
- - title: message
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: deviceManagementTroubleshootingEvent
type: object
properties:
- bccRecipients:
+ additionalInformation:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: 'The Bcc: recipients for the message.'
- body:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- bodyPreview:
+ $ref: '#/components/schemas/microsoft.graph.keyValuePair'
+ description: A set of string key and string value pairs which provides additional information on the Troubleshooting event
+ correlationId:
type: string
- description: 'The first 255 characters of the message body. It is in text format. If the message contains instances of mention, this property would contain a concatenation of these mentions as well.'
+ description: Id used for tracing the failure in the service.
nullable: true
- ccRecipients:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: 'The Cc: recipients for the message.'
- conversationId:
+ eventDateTime:
+ 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 ID of the conversation the email belongs to.
- nullable: true
- conversationIndex:
+ description: Time when the event occurred .
+ format: date-time
+ eventName:
type: string
- description: Indicates the position of the message within the conversation.
- format: base64url
+ description: Event Name corresponding to the Troubleshooting Event. It is an Optional field
nullable: true
- flag:
- $ref: '#/components/schemas/microsoft.graph.followupFlag'
- from:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- hasAttachments:
+ troubleshootingErrorDetails:
+ $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingErrorDetails'
+ additionalProperties:
+ type: object
+ description: Event representing an general failure.
+ microsoft.graph.device:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ - title: device
+ type: object
+ properties:
+ accountEnabled:
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
.'
+ description: 'true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.'
nullable: true
- importance:
- $ref: '#/components/schemas/microsoft.graph.importance'
- inferenceClassification:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
- internetMessageHeaders:
+ alternativeSecurityIds:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
- internetMessageId:
- type: string
- nullable: true
- isDeliveryReceiptRequested:
- type: boolean
- nullable: true
- isDraft:
- type: boolean
- nullable: true
- isRead:
- type: boolean
- nullable: true
- isReadReceiptRequested:
- type: boolean
- nullable: true
- mentionsPreview:
- $ref: '#/components/schemas/microsoft.graph.mentionsPreview'
- parentFolderId:
- type: string
- nullable: true
- receivedDateTime:
+ $ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
+ description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le).'
+ 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 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.'
format: date-time
nullable: true
- replyTo:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- sender:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- sentDateTime:
+ complianceExpirationDateTime:
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 when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
- subject:
+ deviceCategory:
type: string
+ description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
nullable: true
- toRecipients:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- uniqueBody:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- unsubscribeData:
+ deviceId:
+ type: string
+ description: 'Unique Identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Also Supports $filter (eq, ne, not, startsWith).'
+ nullable: true
+ deviceMetadata:
+ type: string
+ description: For internal use only. Set to null.
+ nullable: true
+ deviceOwnership:
+ type: string
+ description: 'Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.'
+ nullable: true
+ deviceVersion:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: For internal use only.
+ format: int32
+ nullable: true
+ displayName:
+ type: string
+ description: 'The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
+ nullable: true
+ domainName:
+ type: string
+ description: The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.
+ nullable: true
+ enrollmentProfileName:
+ type: string
+ description: 'Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.'
+ nullable: true
+ enrollmentType:
+ type: string
+ description: 'Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement.'
+ nullable: true
+ extensionAttributes:
+ $ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
+ hostnames:
type: array
items:
type: string
nullable: true
- unsubscribeEnabled:
+ description: List of host names for the device.
+ 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. Supports $filter (eq, ne, not).'
nullable: true
- webLink:
- type: string
+ 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. Supports $filter (eq, ne, not).'
nullable: true
- attachments:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.attachment'
- description: The fileAttachment and itemAttachment attachments for the message.
- x-ms-navigationProperty: true
- extensions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.extension'
- description: The collection of open extensions defined for the message. Nullable.
- x-ms-navigationProperty: true
- mentions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.mention'
- description: 'A collection of mentions in the message, ordered by the createdDateTime from the newest to the oldest. By default, a GET /messages does not return this property unless you apply $expand on the property.'
- x-ms-navigationProperty: true
- multiValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
- description: The collection of multi-value extended properties defined for the message. Nullable.
- x-ms-navigationProperty: true
- singleValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
- description: The collection of single-value extended properties defined for the message. Nullable.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.outlookUser:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: outlookUser
- type: object
- properties:
- masterCategories:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.outlookCategory'
- description: A list of categories defined for the user.
- x-ms-navigationProperty: true
- taskFolders:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.outlookTaskFolder'
- x-ms-navigationProperty: true
- taskGroups:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.outlookTaskGroup'
- x-ms-navigationProperty: true
- tasks:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.outlookTask'
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.person:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: person
- type: object
- properties:
- birthday:
+ isManagementRestricted:
+ type: boolean
+ description: 'Indicates whether the device is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. The default value is false. Read-only. To manage a device that''s a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.'
+ nullable: true
+ isRooted:
+ type: boolean
+ description: true if device is rooted; false if device is jail-broken. This can only be updated by Intune.
+ nullable: true
+ kind:
type: string
- description: The person's birthday.
+ description: Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
nullable: true
- companyName:
+ managementType:
type: string
- description: The name of the person's company.
+ description: 'Management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.'
nullable: true
- department:
+ manufacturer:
type: string
- description: The person's department.
+ description: Manufacturer of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
nullable: true
- displayName:
+ mdmAppId:
type: string
- description: The person's display name.
+ description: 'Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).'
nullable: true
- emailAddresses:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.rankedEmailAddress'
- description: The person's email addresses.
- givenName:
+ model:
type: string
- description: The person's given name.
+ description: Model of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
nullable: true
- isFavorite:
- type: boolean
- description: True if the user has flagged this person as a favorite.
+ name:
+ type: string
+ description: Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.
nullable: true
- mailboxType:
+ 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 type of mailbox that is represented by the person's email address.
+ 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 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).'
+ format: date-time
nullable: true
- officeLocation:
+ onPremisesSecurityIdentifier:
type: string
- description: The location of the person's office.
+ description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).
nullable: true
- personNotes:
+ 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. Supports $filter (eq, ne, not, in, and eq on null values).'
+ nullable: true
+ operatingSystem:
type: string
- description: Free-form notes that the user has taken about this person.
+ description: 'The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
- personType:
+ operatingSystemVersion:
type: string
- description: 'The type of person, for example distribution list.'
+ description: 'Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
nullable: true
- phones:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.phone'
- description: The person's phone numbers.
- postalAddresses:
+ physicalIds:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.location'
- description: The person's addresses.
- profession:
+ type: string
+ description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.'
+ platform:
type: string
- description: The person's profession.
+ description: Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
nullable: true
- sources:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.personDataSource'
- description: 'The sources the user data comes from, for example Directory or Outlook Contacts.'
- surname:
+ profileType:
type: string
- description: The person's surname.
+ description: 'The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.'
nullable: true
- title:
+ registrationDateTime:
+ 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 person's title.
+ description: 'Date and time of when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
+ format: date-time
nullable: true
- userPrincipalName:
+ status:
type: string
- description: 'The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person''s email name. The general format is alias@domain.'
+ description: Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.
nullable: true
- websites:
+ systemLabels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.website'
- description: The person's websites.
- yomiCompany:
+ type: string
+ description: 'List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).'
+ trustType:
type: string
- description: The phonetic Japanese name of the person's company.
+ description: 'Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more details, see Introduction to device management in Microsoft Entra ID.'
nullable: true
+ commands:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.command'
+ description: Set of commands sent to this device.
+ x-ms-navigationProperty: true
+ extensions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.extension'
+ description: The collection of open extensions defined for the device. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ memberOf:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
+ x-ms-navigationProperty: true
+ registeredOwners:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
+ x-ms-navigationProperty: true
+ registeredUsers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: 'Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.'
+ x-ms-navigationProperty: true
+ transitiveMemberOf:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ description: Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand.
+ x-ms-navigationProperty: true
+ usageRights:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.usageRight'
+ description: Represents the usage rights a device has been granted.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.drive:
@@ -27392,6 +27610,26 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
+ microsoft.graph.employeeExperienceUser:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: employeeExperienceUser
+ type: object
+ properties:
+ learningCourseActivities:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.extension:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: extension
+ type: object
+ additionalProperties:
+ type: object
microsoft.graph.site:
allOf:
- $ref: '#/components/schemas/microsoft.graph.baseItem'
@@ -27415,8 +27653,6 @@ components:
$ref: '#/components/schemas/microsoft.graph.sharepointIds'
siteCollection:
$ref: '#/components/schemas/microsoft.graph.siteCollection'
- informationProtection:
- $ref: '#/components/schemas/microsoft.graph.informationProtection'
analytics:
$ref: '#/components/schemas/microsoft.graph.itemAnalytics'
columns:
@@ -27445,6 +27681,8 @@ components:
$ref: '#/components/schemas/microsoft.graph.columnDefinition'
description: The collection of column definitions available in the site that are referenced from the sites in the parent hierarchy of the current site.
x-ms-navigationProperty: true
+ informationProtection:
+ $ref: '#/components/schemas/microsoft.graph.informationProtection'
items:
type: array
items:
@@ -27457,6 +27695,8 @@ components:
$ref: '#/components/schemas/microsoft.graph.list'
description: The collection of lists under this site.
x-ms-navigationProperty: true
+ onenote:
+ $ref: '#/components/schemas/microsoft.graph.onenote'
operations:
type: array
items:
@@ -27485,257 +27725,364 @@ components:
x-ms-navigationProperty: true
termStore:
$ref: '#/components/schemas/microsoft.graph.termStore.store'
- onenote:
- $ref: '#/components/schemas/microsoft.graph.onenote'
additionalProperties:
type: object
- microsoft.graph.extension:
+ microsoft.graph.inferenceClassification:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: extension
+ - title: inferenceClassification
type: object
+ properties:
+ overrides:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.inferenceClassificationOverride'
+ description: 'A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.'
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.appConsentRequest:
+ microsoft.graph.informationProtection:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: appConsentRequest
+ - title: informationProtection
type: object
properties:
- appDisplayName:
- type: string
- description: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.
- nullable: true
- appId:
- type: string
- description: The identifier of the application. Required. Supports $filter (eq only) and $orderby.
- consentType:
- type: string
- description: 'The consent type of the request. Possible values are: Static and Dynamic. These represent static and dynamic permissions, respectively, requested in the consent workflow. Supports $filter (eq only) and $orderby. Required.'
- nullable: true
- pendingScopes:
+ bitlocker:
+ $ref: '#/components/schemas/microsoft.graph.bitlocker'
+ dataLossPreventionPolicies:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.appConsentRequestScope'
- description: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.
- userConsentRequests:
+ $ref: '#/components/schemas/microsoft.graph.dataLossPreventionPolicy'
+ x-ms-navigationProperty: true
+ policy:
+ $ref: '#/components/schemas/microsoft.graph.informationProtectionPolicy'
+ sensitivityLabels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.userConsentRequest'
- description: A list of pending user consent requests. Supports $filter (eq).
+ $ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
+ x-ms-navigationProperty: true
+ sensitivityPolicySettings:
+ $ref: '#/components/schemas/microsoft.graph.sensitivityPolicySettings'
+ threatAssessmentRequests:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.threatAssessmentRequest'
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.approval:
+ microsoft.graph.itemInsights:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: approval
+ - $ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
+ - title: itemInsights
type: object
- properties:
- steps:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.approvalStep'
- description: Used to represent the decision associated with a single step in the approval process configured in approvalStage.
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.accessReviewInstance:
+ microsoft.graph.team:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: accessReviewInstance
+ - title: team
type: object
properties:
- endDateTime:
+ classification:
+ type: string
+ description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
+ 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 when review instance is scheduled to end. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
+ description: Timestamp at which the team was created.
format: date-time
nullable: true
- errors:
+ description:
+ type: string
+ description: 'An optional description for the team. Maximum length: 1024 characters.'
+ nullable: true
+ discoverySettings:
+ $ref: '#/components/schemas/microsoft.graph.teamDiscoverySettings'
+ displayName:
+ type: string
+ description: The name of the team.
+ nullable: true
+ funSettings:
+ $ref: '#/components/schemas/microsoft.graph.teamFunSettings'
+ guestSettings:
+ $ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
+ internalId:
+ type: string
+ description: A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
+ nullable: true
+ isArchived:
+ type: boolean
+ description: Whether this team is in read-only mode.
+ nullable: true
+ isMembershipLimitedToOwners:
+ type: boolean
+ description: 'If set to true, the team is currently in the owner-only team membership state and not accessible by other team members, such as students.'
+ nullable: true
+ memberSettings:
+ $ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
+ messagingSettings:
+ $ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
+ specialization:
+ $ref: '#/components/schemas/microsoft.graph.teamSpecialization'
+ summary:
+ $ref: '#/components/schemas/microsoft.graph.teamSummary'
+ tenantId:
+ type: string
+ description: The ID of the Microsoft Entra tenant.
+ nullable: true
+ visibility:
+ $ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
+ webUrl:
+ type: string
+ description: 'A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.'
+ nullable: true
+ allChannels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewError'
- description: Collection of errors in an access review instance lifecycle. Read-only.
- fallbackReviewers:
+ $ref: '#/components/schemas/microsoft.graph.channel'
+ description: List of channels either hosted in or shared with the team (incoming channels).
+ x-ms-navigationProperty: true
+ channels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn''t exist, or manager is specified as reviewer but a user''s manager doesn''t exist. Supports $select.'
- reviewers:
+ $ref: '#/components/schemas/microsoft.graph.channel'
+ description: The collection of channels and messages associated with the team.
+ x-ms-navigationProperty: true
+ group:
+ $ref: '#/components/schemas/microsoft.graph.group'
+ incomingChannels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- description: 'This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
- scope:
- $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
- startDateTime:
- 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 review instance is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
- format: date-time
- nullable: true
- status:
- type: string
- description: 'Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
- nullable: true
- contactedReviewers:
+ $ref: '#/components/schemas/microsoft.graph.channel'
+ description: List of channels shared with the team.
+ x-ms-navigationProperty: true
+ installedApps:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
- description: 'Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.'
+ $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
+ description: The apps installed in this team.
x-ms-navigationProperty: true
- decisions:
+ members:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
- description: 'Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.'
+ $ref: '#/components/schemas/microsoft.graph.conversationMember'
+ description: Members and owners of the team.
x-ms-navigationProperty: true
- definition:
- $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
- stages:
+ operations:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewStage'
- description: 'If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.'
+ $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
+ description: The async operations that ran or are running on this team.
+ x-ms-navigationProperty: true
+ owners:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.user'
+ description: 'The list of this team''s owners. Currently, when creating a team using application permissions, exactly one owner must be specified. When using user delegated permissions, no owner can be specified (the current user is the owner). Owner must be specified as an object ID (GUID), not a UPN.'
+ x-ms-navigationProperty: true
+ permissionGrants:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
+ description: A collection of permissions granted to apps to access the team.
+ x-ms-navigationProperty: true
+ photo:
+ $ref: '#/components/schemas/microsoft.graph.profilePhoto'
+ primaryChannel:
+ $ref: '#/components/schemas/microsoft.graph.channel'
+ schedule:
+ $ref: '#/components/schemas/microsoft.graph.schedule'
+ tags:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.teamworkTag'
+ description: The tags associated with the team.
x-ms-navigationProperty: true
+ template:
+ $ref: '#/components/schemas/microsoft.graph.teamsTemplate'
+ templateDefinition:
+ $ref: '#/components/schemas/microsoft.graph.teamTemplateDefinition'
additionalProperties:
type: object
- microsoft.graph.agreementAcceptance:
+ microsoft.graph.mailFolder:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: agreementAcceptance
+ - title: mailFolder
type: object
properties:
- agreementFileId:
- type: string
- description: ID of the agreement file accepted by the user.
+ childFolderCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The number of immediate child mailFolders in the current mailFolder.
+ format: int32
nullable: true
- agreementId:
+ displayName:
type: string
- description: ID of the agreement.
+ description: The mailFolder's display name.
nullable: true
- deviceDisplayName:
- type: string
- description: The display name of the device used for accepting the agreement.
+ isHidden:
+ type: boolean
+ description: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.
nullable: true
- deviceId:
+ parentFolderId:
type: string
- description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
+ description: The unique identifier for the mailFolder's parent mailFolder.
nullable: true
- deviceOSType:
+ totalItemCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The number of items in the mailFolder.
+ format: int32
+ nullable: true
+ unreadItemCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The number of items in the mailFolder marked as unread.
+ format: int32
+ nullable: true
+ wellKnownName:
type: string
- description: The operating system used for accepting the agreement.
+ description: 'The well-known folder name for the folder. The possible values are listed above. This property is only set for default folders created by Outlook. For other folders, this property is null.'
nullable: true
- deviceOSVersion:
+ childFolders:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.mailFolder'
+ description: The collection of child folders in the mailFolder.
+ x-ms-navigationProperty: true
+ messageRules:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.messageRule'
+ description: The collection of rules that apply to the user's Inbox folder.
+ x-ms-navigationProperty: true
+ messages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.message'
+ description: The collection of messages in the mailFolder.
+ x-ms-navigationProperty: true
+ multiValueExtendedProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
+ description: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ singleValueExtendedProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
+ description: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ userConfigurations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.userConfiguration'
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.managedAppRegistration:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: managedAppRegistration
+ type: object
+ properties:
+ appIdentifier:
+ $ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
+ applicationVersion:
type: string
- description: The operating system version of the device used for accepting the agreement.
+ description: App version
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])$'
+ azureADDeviceId:
type: string
- description: 'The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ge, le) and eq for null values.'
- format: date-time
+ description: The Azure Active Directory Device identifier of the host device. Value could be empty even when the host device is Azure Active Directory registered.
nullable: true
- recordedDateTime:
+ 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 is 2014-01-01T00:00:00Z. Supports $filter (eq) and eq for null values.'
+ description: Date and time of creation
format: date-time
+ deviceManufacturer:
+ type: string
+ description: The device manufacturer for the current app registration
nullable: true
- state:
- $ref: '#/components/schemas/microsoft.graph.agreementAcceptanceState'
- userDisplayName:
+ deviceModel:
type: string
- description: Display name of the user when the acceptance was recorded.
+ description: The device model for the current app registration
nullable: true
- userEmail:
+ deviceName:
type: string
- description: Email of the user when the acceptance was recorded.
+ description: Host device name
nullable: true
- userId:
+ deviceTag:
type: string
- description: ID of the user who accepted the agreement. Supports $filter (eq).
+ 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
- userPrincipalName:
+ deviceType:
type: string
- description: UPN of the user when the acceptance was recorded.
+ description: Host device type
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.security.security:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: security
- type: object
- properties:
- informationProtection:
- $ref: '#/components/schemas/microsoft.graph.security.informationProtection'
- additionalProperties:
- type: object
- microsoft.graph.deviceEnrollmentConfiguration:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: deviceEnrollmentConfiguration
- type: object
- properties:
- createdDateTime:
+ flaggedReasons:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
+ description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
+ 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: Created date time in UTC of the device enrollment configuration
+ description: Date and time of last the app synced with management service.
format: date-time
- description:
+ managedDeviceId:
type: string
- description: The description of the device enrollment configuration
+ description: The Managed Device identifier of the host device. Value could be empty even when the host device is managed.
nullable: true
- deviceEnrollmentConfigurationType:
- $ref: '#/components/schemas/microsoft.graph.deviceEnrollmentConfigurationType'
- displayName:
+ managementSdkVersion:
type: string
- description: The display name of the device enrollment configuration
+ description: App management SDK version
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])$'
+ platformVersion:
type: string
- description: Last modified date time in UTC of the device enrollment configuration
- format: date-time
- priority:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Priority is used when a user exists in multiple groups that are assigned enrollment configuration. Users are subject only to the configuration with the lowest priority value.
- format: int32
- roleScopeTagIds:
+ description: Operating System version
+ nullable: true
+ userId:
+ type: string
+ description: The user Id to who this app registration belongs.
+ nullable: true
+ version:
+ type: string
+ description: Version of the entity.
+ nullable: true
+ appliedPolicies:
type: array
items:
- type: string
- nullable: true
- description: Optional role scope tags for the enrollment restrictions.
- version:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The version of the device enrollment configuration
- format: int32
- assignments:
+ $ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
+ description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
+ x-ms-navigationProperty: true
+ intendedPolicies:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.enrollmentConfigurationAssignment'
- description: The list of group assignments for the device configuration profile
+ $ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
+ description: Zero or more policies admin intended for the app as of now.
+ x-ms-navigationProperty: true
+ operations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.managedAppOperation'
+ description: Zero or more long running operations triggered on the app registration.
x-ms-navigationProperty: true
additionalProperties:
type: object
- description: The Base Class of Device Enrollment Configuration
+ description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
microsoft.graph.managedDevice:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: managedDevice
type: object
properties:
- cloudPcRemoteActionResults:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.cloudPcRemoteActionResult'
aadRegistered:
type: boolean
description: Whether the device is Azure Active Directory registered. This property is read-only.
@@ -27781,6 +28128,10 @@ components:
items:
$ref: '#/components/schemas/microsoft.graph.chromeOSDeviceProperty'
description: 'List of properties of the ChromeOS Device. Default is an empty list. To retrieve actual values GET call needs to be made, with device id and included in select parameter.'
+ cloudPcRemoteActionResults:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcRemoteActionResult'
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
@@ -27813,6 +28164,8 @@ components:
description: 'Indicates whether the device is DFCI managed. When TRUE the device is DFCI managed. When FALSE, the device is not DFCI managed. The default value is FALSE.'
deviceHealthAttestationState:
$ref: '#/components/schemas/microsoft.graph.deviceHealthAttestationState'
+ deviceIdentityAttestationDetail:
+ $ref: '#/components/schemas/microsoft.graph.deviceIdentityAttestationDetail'
deviceName:
type: string
description: Name of the device. This property is read-only.
@@ -28091,6 +28444,14 @@ components:
$ref: '#/components/schemas/microsoft.graph.assignmentFilterEvaluationStatusDetails'
description: Managed device mobile app configuration states for this device.
x-ms-navigationProperty: true
+ detectedApps:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.detectedApp'
+ description: All applications currently installed on the device
+ x-ms-navigationProperty: true
+ deviceCategory:
+ $ref: '#/components/schemas/microsoft.graph.deviceCategory'
deviceCompliancePolicyStates:
type: array
items:
@@ -28103,26 +28464,6 @@ components:
$ref: '#/components/schemas/microsoft.graph.deviceConfigurationState'
description: Device configuration states for this device.
x-ms-navigationProperty: true
- managedDeviceMobileAppConfigurationStates:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationState'
- description: Managed device mobile app configuration states for this device.
- x-ms-navigationProperty: true
- securityBaselineStates:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.securityBaselineState'
- description: Security baseline states for this device.
- x-ms-navigationProperty: true
- detectedApps:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.detectedApp'
- description: All applications currently installed on the device
- x-ms-navigationProperty: true
- deviceCategory:
- $ref: '#/components/schemas/microsoft.graph.deviceCategory'
deviceHealthScriptStates:
type: array
items:
@@ -28135,6 +28476,18 @@ components:
$ref: '#/components/schemas/microsoft.graph.deviceLogCollectionResponse'
description: List of log collection requests
x-ms-navigationProperty: true
+ managedDeviceMobileAppConfigurationStates:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationState'
+ description: Managed device mobile app configuration states for this device.
+ x-ms-navigationProperty: true
+ securityBaselineStates:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.securityBaselineState'
+ description: Security baseline states for this device.
+ x-ms-navigationProperty: true
users:
type: array
items:
@@ -28146,161 +28499,141 @@ components:
additionalProperties:
type: object
description: Devices that are managed or pre-enrolled through Intune
- microsoft.graph.managedAppRegistration:
+ microsoft.graph.message:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: managedAppRegistration
+ - $ref: '#/components/schemas/microsoft.graph.outlookItem'
+ - title: message
type: object
properties:
- appIdentifier:
- $ref: '#/components/schemas/microsoft.graph.mobileAppIdentifier'
- applicationVersion:
+ bccRecipients:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ description: 'The Bcc: recipients for the message.'
+ body:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ bodyPreview:
type: string
- description: App version
+ description: 'The first 255 characters of the message body. It is in text format. If the message contains instances of mention, this property would contain a concatenation of these mentions as well.'
nullable: true
- azureADDeviceId:
+ ccRecipients:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ description: 'The Cc: recipients for the message.'
+ conversationId:
type: string
- description: The Azure Active Directory Device identifier of the host device. Value could be empty even when the host device is Azure Active Directory registered.
+ description: The ID of the conversation the email belongs to.
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 creation
- format: date-time
- deviceManufacturer:
+ conversationIndex:
type: string
- description: The device manufacturer for the current app registration
+ description: Indicates the position of the message within the conversation.
+ format: base64url
nullable: true
- deviceModel:
- type: string
- description: The device model for the current app registration
+ flag:
+ $ref: '#/components/schemas/microsoft.graph.followupFlag'
+ from:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ 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
.'
nullable: true
- deviceName:
+ importance:
+ $ref: '#/components/schemas/microsoft.graph.importance'
+ inferenceClassification:
+ $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
+ internetMessageHeaders:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.internetMessageHeader'
+ internetMessageId:
type: string
- description: Host device name
nullable: true
- deviceTag:
+ isDeliveryReceiptRequested:
+ type: boolean
+ nullable: true
+ isDraft:
+ type: boolean
+ nullable: true
+ isRead:
+ type: boolean
+ nullable: true
+ isReadReceiptRequested:
+ type: boolean
+ nullable: true
+ mentionsPreview:
+ $ref: '#/components/schemas/microsoft.graph.mentionsPreview'
+ parentFolderId:
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
- deviceType:
+ 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: Host device type
+ format: date-time
nullable: true
- flaggedReasons:
+ replyTo:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.managedAppFlaggedReason'
- description: Zero or more reasons an app registration is flagged. E.g. app running on rooted device
- lastSyncDateTime:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ sender:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ 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: Date and time of last the app synced with management service.
format: date-time
- managedDeviceId:
- type: string
- description: The Managed Device identifier of the host device. Value could be empty even when the host device is managed.
nullable: true
- managementSdkVersion:
- type: string
- description: App management SDK version
- nullable: true
- platformVersion:
+ subject:
type: string
- description: Operating System version
nullable: true
- userId:
- type: string
- description: The user Id to who this app registration belongs.
+ toRecipients:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ uniqueBody:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ unsubscribeData:
+ type: array
+ items:
+ type: string
+ nullable: true
+ unsubscribeEnabled:
+ type: boolean
nullable: true
- version:
+ webLink:
type: string
- description: Version of the entity.
nullable: true
- appliedPolicies:
+ attachments:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
- description: Zero or more policys already applied on the registered app when it last synchronized with managment service.
+ $ref: '#/components/schemas/microsoft.graph.attachment'
+ description: The fileAttachment and itemAttachment attachments for the message.
x-ms-navigationProperty: true
- intendedPolicies:
+ extensions:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.managedAppPolicy'
- description: Zero or more policies admin intended for the app as of now.
+ $ref: '#/components/schemas/microsoft.graph.extension'
+ description: The collection of open extensions defined for the message. Nullable.
x-ms-navigationProperty: true
- operations:
+ mentions:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.managedAppOperation'
- description: Zero or more long running operations triggered on the app registration.
+ $ref: '#/components/schemas/microsoft.graph.mention'
+ description: 'A collection of mentions in the message, ordered by the createdDateTime from the newest to the oldest. By default, a GET /messages does not return this property unless you apply $expand on the property.'
x-ms-navigationProperty: true
- additionalProperties:
- type: object
- description: The ManagedAppEntity is the base entity type for all other entity types under app management workflow.
- microsoft.graph.windowsInformationProtectionDeviceRegistration:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: windowsInformationProtectionDeviceRegistration
- type: object
- properties:
- deviceMacAddress:
- type: string
- description: Device Mac address.
- nullable: true
- deviceName:
- type: string
- description: Device name.
- nullable: true
- deviceRegistrationId:
- type: string
- description: Device identifier for this device registration record.
- nullable: true
- deviceType:
- type: string
- description: 'Device type, for example, Windows laptop VS Windows phone.'
- nullable: true
- lastCheckInDateTime:
- 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 checkin time of the device.
- format: date-time
- userId:
- type: string
- description: UserId associated with this device registration record.
- nullable: true
- additionalProperties:
- type: object
- description: Represents device registration records for Bring-Your-Own-Device(BYOD) Windows devices.
- microsoft.graph.deviceManagementTroubleshootingEvent:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: deviceManagementTroubleshootingEvent
- type: object
- properties:
- additionalInformation:
+ multiValueExtendedProperties:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.keyValuePair'
- description: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- correlationId:
- type: string
- description: Id used for tracing the failure in the service.
- nullable: true
- eventDateTime:
- 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: Time when the event occurred .
- format: date-time
- eventName:
- type: string
- description: Event Name corresponding to the Troubleshooting Event. It is an Optional field
- nullable: true
- troubleshootingErrorDetails:
- $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingErrorDetails'
+ $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
+ description: The collection of multi-value extended properties defined for the message. Nullable.
+ x-ms-navigationProperty: true
+ singleValueExtendedProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
+ description: The collection of single-value extended properties defined for the message. Nullable.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- description: Event representing an general failure.
microsoft.graph.mobileAppIntentAndState:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
@@ -28393,125 +28726,337 @@ components:
$ref: '#/components/schemas/microsoft.graph.targetPolicyEndpoints'
additionalProperties:
type: object
- microsoft.graph.plannerUser:
+ microsoft.graph.onenote:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.plannerDelta'
- - title: plannerUser
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: onenote
type: object
properties:
- favoritePlanReferences:
- $ref: '#/components/schemas/microsoft.graph.plannerFavoritePlanReferenceCollection'
- recentPlanReferences:
- $ref: '#/components/schemas/microsoft.graph.plannerRecentPlanReferenceCollection'
- all:
+ notebooks:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.plannerDelta'
+ $ref: '#/components/schemas/microsoft.graph.notebook'
+ description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
- favoritePlans:
+ operations:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.plannerPlan'
- description: Read-only. Nullable. Returns the plannerPlans that the user marked as favorites.
+ $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
+ description: 'The status of OneNote operations. Getting an operations collection isn''t supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.'
x-ms-navigationProperty: true
- plans:
+ pages:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.plannerPlan'
+ $ref: '#/components/schemas/microsoft.graph.onenotePage'
+ description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
- recentPlans:
+ resources:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.plannerPlan'
- description: Read-only. Nullable. Returns the plannerPlans that have been recently viewed by the user in apps that support recent plans.
+ $ref: '#/components/schemas/microsoft.graph.onenoteResource'
+ description: 'The image and other file resources in OneNote pages. Getting a resources collection isn''t supported, but you can get the binary content of a specific resource. Read-only. Nullable.'
x-ms-navigationProperty: true
- rosterPlans:
+ sectionGroups:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.plannerPlan'
- description: Read-only. Nullable. Returns the plannerPlans contained by the plannerRosters the user is a member.
+ $ref: '#/components/schemas/microsoft.graph.sectionGroup'
+ description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
- tasks:
+ sections:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.plannerTask'
- description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
+ $ref: '#/components/schemas/microsoft.graph.onenoteSection'
+ description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.itemInsights:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.officeGraphInsights'
- - title: itemInsights
- type: object
- additionalProperties:
- type: object
- microsoft.graph.userSettings:
+ microsoft.graph.onlineMeeting:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userSettings
+ - $ref: '#/components/schemas/microsoft.graph.onlineMeetingBase'
+ - title: onlineMeeting
type: object
properties:
- contributionToContentDiscoveryAsOrganizationDisabled:
- type: boolean
- description: 'Reflects the Office Delve organization level setting. When set to true, the organization doesn''t have access to Office Delve. This setting is read-only and can only be changed by administrators in the SharePoint admin center.'
- contributionToContentDiscoveryDisabled:
+ alternativeRecording:
+ type: string
+ format: base64url
+ nullable: true
+ attendeeReport:
+ type: string
+ format: base64url
+ nullable: true
+ broadcastRecording:
+ type: string
+ format: base64url
+ nullable: true
+ broadcastSettings:
+ $ref: '#/components/schemas/microsoft.graph.broadcastMeetingSettings'
+ capabilities:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.meetingCapabilities'
+ creationDateTime:
+ 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 meeting creation time in UTC. Read-only.
+ format: date-time
+ nullable: true
+ endDateTime:
+ 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 meeting end time in UTC.
+ format: date-time
+ nullable: true
+ externalId:
+ type: string
+ description: The external ID. A custom ID. Optional.
+ nullable: true
+ isBroadcast:
type: boolean
- description: 'When set to true, documents in the user''s Office Delve are disabled. Users can control this setting in Office Delve.'
- itemInsights:
- $ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
- contactMergeSuggestions:
- $ref: '#/components/schemas/microsoft.graph.contactMergeSuggestions'
- regionalAndLanguageSettings:
- $ref: '#/components/schemas/microsoft.graph.regionalAndLanguageSettings'
- shiftPreferences:
- $ref: '#/components/schemas/microsoft.graph.shiftPreferences'
+ nullable: true
+ joinUrl:
+ type: string
+ nullable: true
+ participants:
+ $ref: '#/components/schemas/microsoft.graph.meetingParticipants'
+ recording:
+ type: string
+ format: base64url
+ nullable: true
+ startDateTime:
+ 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 meeting start time in UTC.
+ format: date-time
+ nullable: true
+ meetingAttendanceReport:
+ $ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
+ recordings:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.callRecording'
+ description: The recordings of an online meeting. Read-only.
+ x-ms-navigationProperty: true
+ registration:
+ $ref: '#/components/schemas/microsoft.graph.meetingRegistration'
+ transcripts:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.callTranscript'
+ description: The transcripts of an online meeting. Read-only.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.onenote:
+ microsoft.graph.outlookUser:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: onenote
+ - title: outlookUser
type: object
properties:
- notebooks:
+ masterCategories:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- description: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.outlookCategory'
+ description: A list of categories defined for the user.
x-ms-navigationProperty: true
- operations:
+ taskFolders:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperation'
- description: 'The status of OneNote operations. Getting an operations collection isn''t supported, but you can get the status of long-running operations if the Operation-Location header is returned in the response. Read-only. Nullable.'
+ $ref: '#/components/schemas/microsoft.graph.outlookTaskFolder'
x-ms-navigationProperty: true
- pages:
+ taskGroups:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onenotePage'
- description: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.outlookTaskGroup'
x-ms-navigationProperty: true
- resources:
+ tasks:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onenoteResource'
- description: 'The image and other file resources in OneNote pages. Getting a resources collection isn''t supported, but you can get the binary content of a specific resource. Read-only. Nullable.'
+ $ref: '#/components/schemas/microsoft.graph.outlookTask'
x-ms-navigationProperty: true
- sectionGroups:
+ additionalProperties:
+ type: object
+ microsoft.graph.accessReviewInstance:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: accessReviewInstance
+ type: object
+ properties:
+ endDateTime:
+ 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 review instance is scheduled to end. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
+ format: date-time
+ nullable: true
+ errors:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- description: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.accessReviewError'
+ description: Collection of errors in an access review instance lifecycle. Read-only.
+ fallbackReviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn''t exist, or manager is specified as reviewer but a user''s manager doesn''t exist. Supports $select.'
+ reviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ description: 'This collection of access review scopes is used to define who the reviewers are. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
+ scope:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
+ startDateTime:
+ 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 review instance is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
+ format: date-time
+ nullable: true
+ status:
+ type: string
+ description: 'Specifies the status of an accessReview. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
+ nullable: true
+ contactedReviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewer'
+ description: 'Returns the collection of reviewers who were contacted to complete this review. While the reviewers and fallbackReviewers properties of the accessReviewScheduleDefinition might specify group owners or managers as reviewers, contactedReviewers returns their individual identities. Supports $select. Read-only.'
x-ms-navigationProperty: true
- sections:
+ decisions:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onenoteSection'
- description: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
+ description: 'Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.'
+ x-ms-navigationProperty: true
+ definition:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleDefinition'
+ stages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewStage'
+ description: 'If the instance has multiple stages, this returns the collection of stages. A new stage will only be created when the previous stage ends. The existence, number, and settings of stages on a review instance are created based on the accessReviewStageSettings on the parent accessReviewScheduleDefinition.'
x-ms-navigationProperty: true
additionalProperties:
type: object
+ microsoft.graph.person:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: person
+ type: object
+ properties:
+ birthday:
+ type: string
+ description: The person's birthday.
+ nullable: true
+ companyName:
+ type: string
+ description: The name of the person's company.
+ nullable: true
+ department:
+ type: string
+ description: The person's department.
+ nullable: true
+ displayName:
+ type: string
+ description: The person's display name.
+ nullable: true
+ emailAddresses:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.rankedEmailAddress'
+ description: The person's email addresses.
+ givenName:
+ type: string
+ description: The person's given name.
+ nullable: true
+ isFavorite:
+ type: boolean
+ description: True if the user has flagged this person as a favorite.
+ nullable: true
+ mailboxType:
+ type: string
+ description: The type of mailbox that is represented by the person's email address.
+ nullable: true
+ officeLocation:
+ type: string
+ description: The location of the person's office.
+ nullable: true
+ personNotes:
+ type: string
+ description: Free-form notes that the user has taken about this person.
+ nullable: true
+ personType:
+ type: string
+ description: 'The type of person, for example distribution list.'
+ nullable: true
+ phones:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.phone'
+ description: The person's phone numbers.
+ postalAddresses:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.location'
+ description: The person's addresses.
+ profession:
+ type: string
+ description: The person's profession.
+ nullable: true
+ sources:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.personDataSource'
+ description: 'The sources the user data comes from, for example Directory or Outlook Contacts.'
+ surname:
+ type: string
+ description: The person's surname.
+ nullable: true
+ title:
+ type: string
+ description: The person's title.
+ nullable: true
+ userPrincipalName:
+ type: string
+ description: 'The user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person''s email name. The general format is alias@domain.'
+ nullable: true
+ websites:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.website'
+ description: The person's websites.
+ yomiCompany:
+ type: string
+ description: The phonetic Japanese name of the person's company.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.resourceSpecificPermissionGrant:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ - title: resourceSpecificPermissionGrant
+ type: object
+ properties:
+ clientAppId:
+ type: string
+ description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
+ nullable: true
+ clientId:
+ type: string
+ description: ID of the Microsoft Entra app that has been granted access. Read-only.
+ nullable: true
+ permission:
+ type: string
+ description: The name of the resource-specific permission. Read-only.
+ nullable: true
+ permissionType:
+ type: string
+ description: 'The type of permission. Possible values are: Application, Delegated. Read-only.'
+ nullable: true
+ resourceAppId:
+ type: string
+ description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
+ nullable: true
+ additionalProperties:
+ type: object
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
@@ -28534,6 +29079,72 @@ components:
nullable: true
additionalProperties:
type: object
+ microsoft.graph.plannerUser:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.plannerDelta'
+ - title: plannerUser
+ type: object
+ properties:
+ favoritePlanReferences:
+ $ref: '#/components/schemas/microsoft.graph.plannerFavoritePlanReferenceCollection'
+ recentPlanReferences:
+ $ref: '#/components/schemas/microsoft.graph.plannerRecentPlanReferenceCollection'
+ all:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerDelta'
+ x-ms-navigationProperty: true
+ favoritePlans:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlan'
+ description: Read-only. Nullable. Returns the plannerPlans that the user marked as favorites.
+ x-ms-navigationProperty: true
+ plans:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlan'
+ x-ms-navigationProperty: true
+ recentPlans:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlan'
+ description: Read-only. Nullable. Returns the plannerPlans that have been recently viewed by the user in apps that support recent plans.
+ x-ms-navigationProperty: true
+ rosterPlans:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlan'
+ description: Read-only. Nullable. Returns the plannerPlans contained by the plannerRosters the user is a member.
+ x-ms-navigationProperty: true
+ tasks:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerTask'
+ description: Read-only. Nullable. Returns the plannerTasks assigned to the user.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.presence:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: presence
+ type: object
+ properties:
+ activity:
+ type: string
+ description: 'The supplemental information to a user''s availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.'
+ nullable: true
+ availability:
+ type: string
+ description: 'The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.'
+ nullable: true
+ outOfOfficeSettings:
+ $ref: '#/components/schemas/microsoft.graph.outOfOfficeSettings'
+ statusMessage:
+ $ref: '#/components/schemas/microsoft.graph.presenceStatusMessage'
+ additionalProperties:
+ type: object
microsoft.graph.profile:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
@@ -28655,2256 +29266,1575 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.userActivity:
+ microsoft.graph.scopedRoleMembership:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userActivity
+ - title: scopedRoleMembership
type: object
properties:
- activationUrl:
+ administrativeUnitId:
type: string
- description: Required. URL used to launch the activity in the best native experience represented by the appId. Might launch a web-based app if no native app exists.
- activitySourceHost:
+ description: Unique identifier for the administrative unit that the directory role is scoped to
+ roleId:
type: string
- description: 'Required. URL for the domain representing the cross-platform identity mapping for the app. Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. You must have a unique file and domain (or sub domain) per cross-platform app identity. For example, a separate file and domain is needed for Word vs. PowerPoint.'
- appActivityId:
+ description: Unique identifier for the directory role that the member is in.
+ roleMemberInfo:
+ $ref: '#/components/schemas/microsoft.graph.identity'
+ additionalProperties:
+ type: object
+ microsoft.graph.security.security:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: security
+ type: object
+ properties:
+ informationProtection:
+ $ref: '#/components/schemas/microsoft.graph.security.informationProtection'
+ additionalProperties:
+ type: object
+ microsoft.graph.userSettings:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: userSettings
+ type: object
+ properties:
+ contributionToContentDiscoveryAsOrganizationDisabled:
+ type: boolean
+ description: 'Reflects the Office Delve organization level setting. When set to true, the organization doesn''t have access to Office Delve. This setting is read-only and can only be changed by administrators in the SharePoint admin center.'
+ contributionToContentDiscoveryDisabled:
+ type: boolean
+ description: 'When set to true, documents in the user''s Office Delve are disabled. Users can control this setting in Office Delve.'
+ contactMergeSuggestions:
+ $ref: '#/components/schemas/microsoft.graph.contactMergeSuggestions'
+ itemInsights:
+ $ref: '#/components/schemas/microsoft.graph.userInsightsSettings'
+ regionalAndLanguageSettings:
+ $ref: '#/components/schemas/microsoft.graph.regionalAndLanguageSettings'
+ shiftPreferences:
+ $ref: '#/components/schemas/microsoft.graph.shiftPreferences'
+ additionalProperties:
+ type: object
+ microsoft.graph.userTeamwork:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: userTeamwork
+ type: object
+ properties:
+ associatedTeams:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
+ description: The list of associatedTeamInfo objects that a user is associated with.
+ x-ms-navigationProperty: true
+ installedApps:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
+ description: The apps installed in the personal scope of this user.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.todo:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: todo
+ type: object
+ properties:
+ lists:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.todoTaskList'
+ description: The task lists in the users mailbox.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.usageRight:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: usageRight
+ type: object
+ properties:
+ catalogId:
type: string
- description: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
- appDisplayName:
+ description: Product id corresponding to the usage right.
+ serviceIdentifier:
type: string
- description: Optional. Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
- nullable: true
- contentInfo:
- $ref: '#/components/schemas/microsoft.graph.Json'
- contentUrl:
+ description: Identifier of the service corresponding to the usage right.
+ state:
+ $ref: '#/components/schemas/microsoft.graph.usageRightState'
+ additionalProperties:
+ type: object
+ microsoft.graph.userVirtualEventsRoot:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: userVirtualEventsRoot
+ type: object
+ properties:
+ webinars:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.virtualEventWebinar'
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.windowsInformationProtectionDeviceRegistration:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: windowsInformationProtectionDeviceRegistration
+ type: object
+ properties:
+ deviceMacAddress:
type: string
- description: 'Optional. Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).'
+ description: Device Mac address.
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])$'
+ deviceName:
type: string
- description: Set by the server. DateTime in UTC when the object was created on the server.
- format: date-time
+ description: Device name.
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])$'
+ deviceRegistrationId:
type: string
- description: Set by the server. DateTime in UTC when the object expired on the server.
- format: date-time
+ description: Device identifier for this device registration record.
nullable: true
- fallbackUrl:
+ deviceType:
type: string
- description: 'Optional. URL used to launch the activity in a web-based app, if available.'
+ description: 'Device type, for example, Windows laptop VS Windows phone.'
nullable: true
- lastModifiedDateTime:
+ lastCheckInDateTime:
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: Set by the server. DateTime in UTC when the object was modified on the server.
+ description: Last checkin time of the device.
format: date-time
- nullable: true
- status:
- $ref: '#/components/schemas/microsoft.graph.status'
- userTimezone:
+ userId:
type: string
- description: Optional. The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
+ description: UserId associated with this device registration record.
nullable: true
- visualElements:
- $ref: '#/components/schemas/microsoft.graph.visualInfo'
- historyItems:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.activityHistoryItem'
- description: Optional. NavigationProperty/Containment; navigation property to the activity's historyItems.
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.device:
- allOf:
+ description: Represents device registration records for Bring-Your-Own-Device(BYOD) Windows devices.
+ microsoft.graph.synchronizationSchedule:
+ title: synchronizationSchedule
+ type: object
+ properties:
+ expiration:
+ 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 when this job will expire. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
+ nullable: true
+ interval:
+ pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
+ type: string
+ description: 'The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, PT1M represents a period of 1 month.'
+ format: duration
+ state:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationScheduleState'
+ additionalProperties:
+ type: object
+ microsoft.graph.synchronizationStatus:
+ title: synchronizationStatus
+ type: object
+ properties:
+ code:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationStatusCode'
+ countSuccessiveCompleteFailures:
+ type: integer
+ description: Number of consecutive times this job failed.
+ format: int64
+ escrowsPruned:
+ type: boolean
+ description: 'true if the job''s escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job''s errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.'
+ lastExecution:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
+ lastSuccessfulExecution:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
+ lastSuccessfulExecutionWithExports:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
+ progress:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationProgress'
+ description: Details of the progress of a job toward completion.
+ quarantine:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationQuarantine'
+ steadyStateFirstAchievedTime:
+ 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 when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
+ steadyStateLastAchievedTime:
+ 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 when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
+ synchronizedEntryCountByType:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.stringKeyLongValuePair'
+ description: 'Count of synchronized objects, listed by object type.'
+ troubleshootingUrl:
+ type: string
+ description: 'In the event of an error, the URL with the troubleshooting steps for the issue.'
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.keyValuePair:
+ title: keyValuePair
+ type: object
+ properties:
+ name:
+ type: string
+ description: Name for this key-value pair
+ value:
+ type: string
+ description: Value for this key-value pair
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.synchronizationJobSubject:
+ title: synchronizationJobSubject
+ type: object
+ properties:
+ links:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationLinkedObjects'
+ objectId:
+ type: string
+ description: 'The identifier of an object to which a synchronizationJob is to be applied. Can be one of the following: An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD.The user ID for synchronization from Microsoft Entra ID to a third-party.The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.'
+ nullable: true
+ objectTypeName:
+ type: string
+ description: 'The type of the object to which a synchronizationJob is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD.User for synchronizing a user between Microsoft Entra ID and a third-party application. Worker for synchronization a user between Workday and either Active Directory or Azure AD.Group for synchronizing a group between Microsoft Entra ID and a third-party application.'
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.synchronizationJobRestartScope:
+ title: synchronizationJobRestartScope
+ enum:
+ - None
+ - ConnectorDataStore
+ - Escrows
+ - Watermark
+ - QuarantineState
+ - Full
+ - ForceDeletes
+ type: string
+ x-ms-enum-flags:
+ isFlags: true
+ microsoft.graph.synchronizationSecret:
+ title: synchronizationSecret
+ enum:
+ - None
+ - UserName
+ - Password
+ - SecretToken
+ - AppKey
+ - BaseAddress
+ - ClientIdentifier
+ - ClientSecret
+ - SingleSignOnType
+ - Sandbox
+ - Url
+ - Domain
+ - ConsumerKey
+ - ConsumerSecret
+ - TokenKey
+ - TokenExpiration
+ - Oauth2AccessToken
+ - Oauth2AccessTokenCreationTime
+ - Oauth2RefreshToken
+ - SyncAll
+ - InstanceName
+ - Oauth2ClientId
+ - Oauth2ClientSecret
+ - CompanyId
+ - UpdateKeyOnSoftDelete
+ - SynchronizationSchedule
+ - SystemOfRecord
+ - SandboxName
+ - EnforceDomain
+ - SyncNotificationSettings
+ - SkipOutOfScopeDeletions
+ - Oauth2AuthorizationCode
+ - Oauth2RedirectUri
+ - ApplicationTemplateIdentifier
+ - Oauth2TokenExchangeUri
+ - Oauth2AuthorizationUri
+ - AuthenticationType
+ - Server
+ - PerformInboundEntitlementGrants
+ - HardDeletesEnabled
+ - SyncAgentCompatibilityKey
+ - SyncAgentADContainer
+ - ValidateDomain
+ - TestReferences
+ - ConnectionString
+ type: string
+ microsoft.graph.synchronizationRule:
+ title: synchronizationRule
+ type: object
+ properties:
+ containerFilter:
+ $ref: '#/components/schemas/microsoft.graph.containerFilter'
+ editable:
+ type: boolean
+ description: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
+ groupFilter:
+ $ref: '#/components/schemas/microsoft.graph.groupFilter'
+ id:
+ type: string
+ description: Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API.
+ nullable: true
+ metadata:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair'
+ description: 'Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn''t be changed.'
+ name:
+ type: string
+ description: Human-readable name of the synchronization rule. Not nullable.
+ nullable: true
+ objectMappings:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.objectMapping'
+ description: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.
+ priority:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first.
+ format: int32
+ sourceDirectoryName:
+ type: string
+ description: Name of the source directory. Must match one of the directory definitions in synchronizationSchema.
+ nullable: true
+ targetDirectoryName:
+ type: string
+ description: Name of the target directory. Must match one of the directory definitions in synchronizationSchema.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.directoryDefinitionDiscoverabilities:
+ title: directoryDefinitionDiscoverabilities
+ enum:
+ - None
+ - AttributeNames
+ - AttributeDataTypes
+ - AttributeReadOnly
+ - ReferenceAttributes
+ - UnknownFutureValue
+ type: string
+ x-ms-enum-flags:
+ isFlags: true
+ microsoft.graph.objectDefinition:
+ title: objectDefinition
+ type: object
+ properties:
+ attributes:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.attributeDefinition'
+ description: Defines attributes of the object.
+ metadata:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.objectDefinitionMetadataEntry'
+ description: Metadata for the given object.
+ name:
+ type: string
+ description: Name of the object. Must be unique within a directory definition. Not nullable.
+ nullable: true
+ supportedApis:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: The API that the provisioning service queries to retrieve data for synchronization.
+ additionalProperties:
+ type: object
+ microsoft.graph.scopeOperatorType:
+ title: scopeOperatorType
+ enum:
+ - Binary
+ - Unary
+ type: string
+ microsoft.graph.scopeOperatorMultiValuedComparisonType:
+ title: scopeOperatorMultiValuedComparisonType
+ enum:
+ - All
+ - Any
+ type: string
+ microsoft.graph.attributeType:
+ title: attributeType
+ enum:
+ - String
+ - Integer
+ - Reference
+ - Binary
+ - Boolean
+ - DateTime
+ type: string
+ microsoft.graph.attributeMappingParameterSchema:
+ title: attributeMappingParameterSchema
+ type: object
+ properties:
+ allowMultipleOccurrences:
+ type: boolean
+ description: 'The given parameter can be provided multiple times (for example, multiple input strings in the Concatenate(string,string,...) function).'
+ name:
+ type: string
+ description: Parameter name.
+ nullable: true
+ required:
+ type: boolean
+ description: true if the parameter is required; otherwise false.
+ type:
+ $ref: '#/components/schemas/microsoft.graph.attributeType'
+ additionalProperties:
+ type: object
+ microsoft.graph.stringKeyObjectValuePair:
+ title: stringKeyObjectValuePair
+ type: object
+ properties:
+ key:
+ type: string
+ description: Key.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.attributeDefinitionMetadataEntry:
+ title: attributeDefinitionMetadataEntry
+ type: object
+ properties:
+ key:
+ $ref: '#/components/schemas/microsoft.graph.attributeDefinitionMetadata'
+ value:
+ type: string
+ description: Value of the metadata property.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.mutability:
+ title: mutability
+ enum:
+ - ReadWrite
+ - ReadOnly
+ - Immutable
+ - WriteOnly
+ type: string
+ microsoft.graph.referencedObject:
+ title: referencedObject
+ type: object
+ properties:
+ referencedObjectName:
+ type: string
+ description: Name of the referenced object. Must match one of the objects in the directory definition.
+ nullable: true
+ referencedProperty:
+ type: string
+ description: 'Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.'
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.publicError:
+ title: publicError
+ type: object
+ properties:
+ code:
+ type: string
+ description: Represents the error code.
+ nullable: true
+ details:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
+ description: Details of the error.
+ innerError:
+ $ref: '#/components/schemas/microsoft.graph.publicInnerError'
+ message:
+ type: string
+ description: A non-localized message for the developer.
+ nullable: true
+ target:
+ type: string
+ description: The target of the error.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.attributeMappingSource:
+ title: attributeMappingSource
+ type: object
+ properties:
+ expression:
+ type: string
+ description: Equivalent expression representation of this attributeMappingSource object.
+ nullable: true
+ name:
+ type: string
+ description: 'Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used.'
+ nullable: true
+ parameters:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.stringKeyAttributeMappingSourceValuePair'
+ description: 'If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn''t Function, this property is null/empty array.'
+ type:
+ $ref: '#/components/schemas/microsoft.graph.attributeMappingSourceType'
+ additionalProperties:
+ type: object
+ microsoft.graph.synchronizationMetadataEntry:
+ title: synchronizationMetadataEntry
+ type: object
+ properties:
+ key:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationMetadata'
+ value:
+ type: string
+ description: Value of the metadata property.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.informationalUrls:
+ title: informationalUrls
+ type: object
+ properties:
+ appSignUpUrl:
+ type: string
+ nullable: true
+ singleSignOnDocumentationUrl:
+ type: string
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.supportedClaimConfiguration:
+ title: supportedClaimConfiguration
+ type: object
+ properties:
+ nameIdPolicyFormat:
+ type: string
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.hybridAgentUpdaterConfiguration:
+ title: hybridAgentUpdaterConfiguration
+ type: object
+ properties:
+ allowUpdateConfigurationOverride:
+ type: boolean
+ description: Indicates if updater configuration will be skipped and the agent will receive an update when the next version of the agent is available.
+ deferUpdateDateTime:
+ 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 is 2014-01-01T00:00:00Z'
+ format: date-time
+ nullable: true
+ updateWindow:
+ $ref: '#/components/schemas/microsoft.graph.updateWindow'
+ additionalProperties:
+ type: object
+ microsoft.graph.onPremisesPublishingType:
+ title: onPremisesPublishingType
+ enum:
+ - applicationProxy
+ - exchangeOnline
+ - authentication
+ - provisioning
+ - intunePfx
+ - oflineDomainJoin
+ - unknownFutureValue
+ type: string
+ microsoft.graph.agentStatus:
+ title: agentStatus
+ enum:
+ - active
+ - inactive
+ type: string
+ microsoft.graph.connectorStatus:
+ title: connectorStatus
+ enum:
+ - active
+ - inactive
+ type: string
+ microsoft.graph.policyBase:
+ allOf:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- - title: device
+ - title: policyBase
type: object
properties:
- accountEnabled:
- type: boolean
- description: 'true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.'
- nullable: true
- alternativeSecurityIds:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.alternativeSecurityId'
- description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le).'
- 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 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.'
- format: date-time
- nullable: true
- complianceExpirationDateTime:
- 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 when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
- format: date-time
- nullable: true
- deviceCategory:
- type: string
- description: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- nullable: true
- deviceId:
- type: string
- description: 'Unique Identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Also Supports $filter (eq, ne, not, startsWith).'
- nullable: true
- deviceMetadata:
- type: string
- description: For internal use only. Set to null.
- nullable: true
- deviceOwnership:
+ description:
type: string
- description: 'Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.'
- nullable: true
- deviceVersion:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: For internal use only.
- format: int32
- nullable: true
+ description: Description for this policy. Required.
displayName:
type: string
- description: 'The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.'
- nullable: true
- domainName:
- type: string
- description: The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.
- nullable: true
- enrollmentProfileName:
- type: string
- description: 'Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune.'
- nullable: true
- enrollmentType:
- type: string
- description: 'Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement.'
- nullable: true
- extensionAttributes:
- $ref: '#/components/schemas/microsoft.graph.onPremisesExtensionAttributes'
- hostnames:
- type: array
- items:
- type: string
- nullable: true
- description: List of host names for the device.
- 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. Supports $filter (eq, ne, not).'
- 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. Supports $filter (eq, ne, not).'
- nullable: true
- isManagementRestricted:
- type: boolean
- description: 'Indicates whether the device is a member of a restricted management administrative unit, in which case it requires a role scoped to the restricted administrative unit to manage. The default value is false. Read-only. To manage a device that''s a member of a restricted administrative unit, the calling app must be assigned the Directory.Write.Restricted permission. For delegated scenarios, the administrators must also be explicitly assigned supported roles at the restricted administrative unit scope.'
- nullable: true
- isRooted:
- type: boolean
- description: true if device is rooted; false if device is jail-broken. This can only be updated by Intune.
- nullable: true
- managementType:
- type: string
- description: 'Management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController.'
- nullable: true
- mdmAppId:
- type: string
- description: 'Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).'
- 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 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).'
- format: date-time
- nullable: true
- onPremisesSecurityIdentifier:
- type: string
- description: The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq).
- 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. Supports $filter (eq, ne, not, in, and eq on null values).'
- nullable: true
- operatingSystem:
- type: string
- description: 'The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
- nullable: true
- operatingSystemVersion:
- type: string
- description: 'Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).'
- nullable: true
- physicalIds:
- type: array
- items:
- type: string
- description: 'For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.'
- profileType:
- type: string
- description: 'The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.'
- nullable: true
- registrationDateTime:
- 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 when the device was registered. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
- format: date-time
- nullable: true
- systemLabels:
- type: array
- items:
- type: string
- description: 'List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).'
- trustType:
- type: string
- description: 'Type of trust for the joined device. Read-only. Possible values: Workplace (indicates bring your own personal devices), AzureAd (Cloud only joined devices), ServerAd (on-premises domain joined devices joined to Microsoft Entra ID). For more details, see Introduction to device management in Microsoft Entra ID.'
- nullable: true
- kind:
- type: string
- description: Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
- nullable: true
- manufacturer:
- type: string
- description: Manufacturer of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
- nullable: true
- model:
- type: string
- description: Model of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
- nullable: true
- name:
- type: string
- description: Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.
- nullable: true
- platform:
- type: string
- description: Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.
- nullable: true
- status:
+ description: Display name for this policy. Required.
+ additionalProperties:
+ type: object
+ microsoft.graph.appManagementConfiguration:
+ title: appManagementConfiguration
+ type: object
+ properties:
+ keyCredentials:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.keyCredentialConfiguration'
+ description: Collection of keyCredential restrictions settings to be applied to an application or service principal.
+ passwordCredentials:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.passwordCredentialConfiguration'
+ description: Collection of password restrictions settings to be applied to an application or service principal.
+ additionalProperties:
+ type: object
+ microsoft.graph.permissionClassificationType:
+ title: permissionClassificationType
+ enum:
+ - low
+ - medium
+ - high
+ - unknownFutureValue
+ type: string
+ microsoft.graph.servicePlanInfo:
+ title: servicePlanInfo
+ type: object
+ properties:
+ appliesTo:
+ type: string
+ description: 'The object the service plan can be assigned to. The possible values are: User - service plan can be assigned to individual users.Company - service plan can be assigned to the entire tenant.'
+ nullable: true
+ provisioningStatus:
+ type: string
+ description: 'The provisioning status of the service plan. The possible values are:Success - Service is fully provisioned.Disabled - Service is disabled.Error - The service plan isn''t provisioned and is in an error state.PendingInput - The service isn''t provisioned and is awaiting service confirmation.PendingActivation - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it isn''t activated in the tenant.'
+ nullable: true
+ servicePlanId:
+ 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 of the service plan.
+ format: uuid
+ nullable: true
+ servicePlanName:
+ type: string
+ description: The name of the service plan.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.groupAccessType:
+ title: groupAccessType
+ enum:
+ - none
+ - private
+ - secret
+ - public
+ type: string
+ microsoft.graph.assignedLabel:
+ title: assignedLabel
+ type: object
+ properties:
+ displayName:
+ type: string
+ description: The display name of the label. Read-only.
+ nullable: true
+ labelId:
+ type: string
+ description: The unique identifier of the label.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.licenseProcessingState:
+ title: licenseProcessingState
+ type: object
+ properties:
+ state:
+ type: string
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.membershipRuleProcessingStatus:
+ title: membershipRuleProcessingStatus
+ type: object
+ properties:
+ errorMessage:
+ type: string
+ description: Detailed error message if dynamic group processing ran into an error. Optional. Read-only.
+ nullable: true
+ lastMembershipUpdated:
+ 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: Most recent date and time when membership of a dynamic group was updated. Optional. Read-only.
+ format: date-time
+ nullable: true
+ status:
+ $ref: '#/components/schemas/microsoft.graph.MembershipRuleProcessingStatusDetails'
+ additionalProperties:
+ type: object
+ microsoft.graph.groupWritebackConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.writebackConfiguration'
+ - title: groupWritebackConfiguration
+ type: object
+ properties:
+ onPremisesGroupType:
type: string
- description: Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.
+ description: 'Indicates the target on-premises group type the cloud object is written back as. Nullable. The possible values are: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Microsoft Entra security groups can be written back as universalSecurityGroup. If isEnabled or the NewUnifiedGroupWritebackDefault group setting is true but this property isn''t explicitly configured: Microsoft 365 groups are written back as universalDistributionGroup by defaultSecurity groups are written back as universalSecurityGroup by default'
nullable: true
- usageRights:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.usageRight'
- description: Represents the usage rights a device has been granted.
- x-ms-navigationProperty: true
- memberOf:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.
- x-ms-navigationProperty: true
- registeredOwners:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: The user that cloud joined the device or registered their personal device. The registered owner is set at the time of registration. Read-only. Nullable. Supports $expand.
- x-ms-navigationProperty: true
- registeredUsers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: 'Collection of registered users of the device. For cloud joined devices and registered personal devices, registered users are set to the same value as registered owners at the time of registration. Read-only. Nullable. Supports $expand.'
- x-ms-navigationProperty: true
- transitiveMemberOf:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- description: Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand.
- x-ms-navigationProperty: true
- extensions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.extension'
- description: The collection of open extensions defined for the device. Read-only. Nullable.
- x-ms-navigationProperty: true
- commands:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.command'
- description: Set of commands sent to this device.
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.onlineMeeting:
+ microsoft.graph.conversation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: onlineMeeting
+ - title: conversation
type: object
properties:
- allowAttendeeToEnableCamera:
- type: boolean
- description: Indicates whether attendees can turn on their camera.
- nullable: true
- allowAttendeeToEnableMic:
- type: boolean
- description: Indicates whether attendees can turn on their microphone.
- nullable: true
- allowedPresenters:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingPresenters'
- allowMeetingChat:
- $ref: '#/components/schemas/microsoft.graph.meetingChatMode'
- allowParticipantsToChangeName:
- type: boolean
- description: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- nullable: true
- allowRecording:
- type: boolean
- description: Indicates whether recording is enabled for the meeting.
- nullable: true
- allowTeamworkReactions:
- type: boolean
- description: Indicates if Teams reactions are enabled for the meeting.
- nullable: true
- allowTranscription:
- type: boolean
- description: Indicates whether transcription is enabled for the meeting.
- nullable: true
- alternativeRecording:
- type: string
- format: base64url
- nullable: true
- anonymizeIdentityForRoles:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onlineMeetingRole'
- description: 'Specifies whose identity will be anonymized in the meeting. Possible values are: attendee. The attendee value cannot be removed through a PATCH operation once added.'
- attendeeReport:
- type: string
- format: base64url
- nullable: true
- audioConferencing:
- $ref: '#/components/schemas/microsoft.graph.audioConferencing'
- broadcastRecording:
- type: string
- format: base64url
- nullable: true
- broadcastSettings:
- $ref: '#/components/schemas/microsoft.graph.broadcastMeetingSettings'
- capabilities:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.meetingCapabilities'
- chatInfo:
- $ref: '#/components/schemas/microsoft.graph.chatInfo'
- chatRestrictions:
- $ref: '#/components/schemas/microsoft.graph.chatRestrictions'
- creationDateTime:
- 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 meeting creation time in UTC. Read-only.
- format: date-time
- nullable: true
- endDateTime:
- 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 meeting end time in UTC.
- format: date-time
- nullable: true
- externalId:
- type: string
- description: The external ID. A custom ID. Optional.
- nullable: true
- isBroadcast:
- type: boolean
- nullable: true
- isEndToEndEncryptionEnabled:
- type: boolean
- nullable: true
- isEntryExitAnnounced:
- type: boolean
- description: Indicates whether to announce when callers join or leave.
- nullable: true
- joinInformation:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- joinMeetingIdSettings:
- $ref: '#/components/schemas/microsoft.graph.joinMeetingIdSettings'
- joinUrl:
- type: string
- nullable: true
- joinWebUrl:
- type: string
- description: The join URL of the online meeting. Read-only.
- nullable: true
- lobbyBypassSettings:
- $ref: '#/components/schemas/microsoft.graph.lobbyBypassSettings'
- participants:
- $ref: '#/components/schemas/microsoft.graph.meetingParticipants'
- recordAutomatically:
+ hasAttachments:
type: boolean
- description: Indicates whether to record the meeting automatically.
- nullable: true
- recording:
- type: string
- format: base64url
- nullable: true
- shareMeetingChatHistoryDefault:
- $ref: '#/components/schemas/microsoft.graph.meetingChatHistoryDefaultMode'
- startDateTime:
+ description: 'Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.'
+ 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 meeting start time in UTC.
+ 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 is 2014-01-01T00:00:00Z. Supports $filter (eq, ne, le, ge).'
format: date-time
- nullable: true
- subject:
+ preview:
type: string
- description: The subject of the online meeting.
- nullable: true
- videoTeleconferenceId:
+ description: A short summary from the body of the latest post in this conversation.
+ topic:
type: string
- description: The video teleconferencing ID. Read-only.
- nullable: true
- watermarkProtection:
- $ref: '#/components/schemas/microsoft.graph.watermarkProtectionValues'
- attendanceReports:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
- description: The attendance reports of an online meeting. Read-only.
- x-ms-navigationProperty: true
- meetingAttendanceReport:
- $ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
- registration:
- $ref: '#/components/schemas/microsoft.graph.meetingRegistration'
- recordings:
+ description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.'
+ uniqueSenders:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.callRecording'
- description: The recordings of an online meeting. Read-only.
- x-ms-navigationProperty: true
- transcripts:
+ type: string
+ description: All the users that sent a message to this Conversation.
+ threads:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.callTranscript'
- description: The transcripts of an online meeting. Read-only.
+ $ref: '#/components/schemas/microsoft.graph.conversationThread'
+ description: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.presence:
+ microsoft.graph.groupLifecyclePolicy:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: presence
+ - title: groupLifecyclePolicy
type: object
properties:
- activity:
+ alternateNotificationEmails:
type: string
- description: 'The supplemental information to a user''s availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, InACall, InAConferenceCall, Inactive, InAMeeting, Offline, OffWork, OutOfOffice, PresenceUnknown, Presenting, UrgentInterruptionsOnly.'
+ 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
- availability:
+ 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 base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.'
+ description: 'The group type for which the expiration policy applies. Possible values are All, Selected or None.'
nullable: true
- outOfOfficeSettings:
- $ref: '#/components/schemas/microsoft.graph.outOfOfficeSettings'
- statusMessage:
- $ref: '#/components/schemas/microsoft.graph.presenceStatusMessage'
additionalProperties:
type: object
- microsoft.graph.userVirtualEventsRoot:
+ microsoft.graph.plannerGroup:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userVirtualEventsRoot
+ - title: plannerGroup
type: object
properties:
- webinars:
+ plans:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.virtualEventWebinar'
+ $ref: '#/components/schemas/microsoft.graph.plannerPlan'
+ description: Read-only. Nullable. Returns the plannerPlans owned by the group.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.authentication:
+ microsoft.graph.directorySetting:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: authentication
+ - title: directorySetting
type: object
properties:
- signInPreferences:
- $ref: '#/components/schemas/microsoft.graph.signInPreferences'
- emailMethods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.emailAuthenticationMethod'
- description: Represents the email addresses registered to a user for authentication.
- x-ms-navigationProperty: true
- fido2Methods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.fido2AuthenticationMethod'
- description: Represents the FIDO2 security keys registered to a user for authentication.
- x-ms-navigationProperty: true
- methods:
+ displayName:
+ type: string
+ description: 'Display name of this group of settings, which comes from the associated template. Read-only.'
+ 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:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- description: Represents all authentication methods registered to a user.
- x-ms-navigationProperty: true
- microsoftAuthenticatorMethods:
+ $ref: '#/components/schemas/microsoft.graph.settingValue'
+ description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.
+ additionalProperties:
+ type: object
+ microsoft.graph.conversationThread:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: conversationThread
+ type: object
+ properties:
+ ccRecipients:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod'
- description: The details of the Microsoft Authenticator app registered to a user for authentication.
- x-ms-navigationProperty: true
- operations:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ description: 'The Cc: recipients for the thread. Returned only on $select.'
+ hasAttachments:
+ type: boolean
+ description: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.
+ isLocked:
+ type: boolean
+ description: Indicates if the thread is locked. Returned by default.
+ 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 is 2014-01-01T00:00:00Z. Returned by default.'
+ format: date-time
+ preview:
+ type: string
+ description: A short summary from the body of the latest post in this conversation. Returned by default.
+ topic:
+ type: string
+ description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.'
+ toRecipients:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- x-ms-navigationProperty: true
- passwordlessMicrosoftAuthenticatorMethods:
+ $ref: '#/components/schemas/microsoft.graph.recipient'
+ description: 'The To: recipients for the thread. Returned only on $select.'
+ uniqueSenders:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.passwordlessMicrosoftAuthenticatorAuthenticationMethod'
- description: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- x-ms-navigationProperty: true
- passwordMethods:
+ type: string
+ description: All the users that sent a message to this thread. Returned by default.
+ posts:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.passwordAuthenticationMethod'
- description: Represents the details of the password authentication method registered to a user for authentication.
- x-ms-navigationProperty: true
- phoneMethods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.phoneAuthenticationMethod'
- description: Represents the phone registered to a user for authentication.
- x-ms-navigationProperty: true
- platformCredentialMethods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod'
- x-ms-navigationProperty: true
- softwareOathMethods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod'
- x-ms-navigationProperty: true
- temporaryAccessPassMethods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod'
- description: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- x-ms-navigationProperty: true
- windowsHelloForBusinessMethods:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod'
- description: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.chat:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: chat
- type: object
- properties:
- chatType:
- $ref: '#/components/schemas/microsoft.graph.chatType'
- 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 at which the chat was created. Read-only.
- format: date-time
- nullable: true
- lastUpdatedDateTime:
- 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 at which the chat was renamed or list of members were last changed. Read-only.
- format: date-time
- nullable: true
- onlineMeetingInfo:
- $ref: '#/components/schemas/microsoft.graph.teamworkOnlineMeetingInfo'
- tenantId:
- type: string
- description: The identifier of the tenant in which the chat was created. Read-only.
- nullable: true
- topic:
- type: string
- description: (Optional) Subject or topic for the chat. Only available for group chats.
- nullable: true
- viewpoint:
- $ref: '#/components/schemas/microsoft.graph.chatViewpoint'
- webUrl:
- type: string
- description: 'The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.'
- nullable: true
- installedApps:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
- description: A collection of all the apps in the chat. Nullable.
- x-ms-navigationProperty: true
- lastMessagePreview:
- $ref: '#/components/schemas/microsoft.graph.chatMessageInfo'
- members:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.conversationMember'
- description: A collection of all the members in the chat. Nullable.
- x-ms-navigationProperty: true
- messages:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
- description: A collection of all the messages in the chat. Nullable.
- x-ms-navigationProperty: true
- operations:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
- description: A collection of all the Teams async operations that ran or are running on the chat. Nullable.
- x-ms-navigationProperty: true
- permissionGrants:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
- description: A collection of permissions granted to apps for the chat.
- x-ms-navigationProperty: true
- pinnedMessages:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.pinnedChatMessageInfo'
- description: A collection of all the pinned messages in the chat. Nullable.
- x-ms-navigationProperty: true
- tabs:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamsTab'
- description: A collection of all the tabs in the chat. Nullable.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.team:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: team
- type: object
- properties:
- classification:
- type: string
- description: An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
- 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 at which the team was created.
- format: date-time
- nullable: true
- description:
- type: string
- description: 'An optional description for the team. Maximum length: 1024 characters.'
- nullable: true
- discoverySettings:
- $ref: '#/components/schemas/microsoft.graph.teamDiscoverySettings'
- displayName:
- type: string
- description: The name of the team.
- nullable: true
- funSettings:
- $ref: '#/components/schemas/microsoft.graph.teamFunSettings'
- guestSettings:
- $ref: '#/components/schemas/microsoft.graph.teamGuestSettings'
- internalId:
- type: string
- description: A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
- nullable: true
- isArchived:
- type: boolean
- description: Whether this team is in read-only mode.
- nullable: true
- isMembershipLimitedToOwners:
- type: boolean
- description: 'If set to true, the team is currently in the owner-only team membership state and not accessible by other team members, such as students.'
- nullable: true
- memberSettings:
- $ref: '#/components/schemas/microsoft.graph.teamMemberSettings'
- messagingSettings:
- $ref: '#/components/schemas/microsoft.graph.teamMessagingSettings'
- specialization:
- $ref: '#/components/schemas/microsoft.graph.teamSpecialization'
- summary:
- $ref: '#/components/schemas/microsoft.graph.teamSummary'
- tenantId:
- type: string
- description: The ID of the Microsoft Entra tenant.
- nullable: true
- visibility:
- $ref: '#/components/schemas/microsoft.graph.teamVisibilityType'
- webUrl:
- type: string
- description: 'A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.'
- nullable: true
- allChannels:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.channel'
- description: List of channels either hosted in or shared with the team (incoming channels).
- x-ms-navigationProperty: true
- channels:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.channel'
- description: The collection of channels and messages associated with the team.
- x-ms-navigationProperty: true
- group:
- $ref: '#/components/schemas/microsoft.graph.group'
- incomingChannels:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.channel'
- description: List of channels shared with the team.
- x-ms-navigationProperty: true
- installedApps:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamsAppInstallation'
- description: The apps installed in this team.
- x-ms-navigationProperty: true
- members:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.conversationMember'
- description: Members and owners of the team.
- x-ms-navigationProperty: true
- operations:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperation'
- description: The async operations that ran or are running on this team.
- x-ms-navigationProperty: true
- owners:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.user'
- description: 'The list of this team''s owners. Currently, when creating a team using application permissions, exactly one owner must be specified. When using user delegated permissions, no owner can be specified (the current user is the owner). Owner must be specified as an object ID (GUID), not a UPN.'
- x-ms-navigationProperty: true
- permissionGrants:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant'
- description: A collection of permissions granted to apps to access the team.
- x-ms-navigationProperty: true
- photo:
- $ref: '#/components/schemas/microsoft.graph.profilePhoto'
- primaryChannel:
- $ref: '#/components/schemas/microsoft.graph.channel'
- tags:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamworkTag'
- description: The tags associated with the team.
- x-ms-navigationProperty: true
- template:
- $ref: '#/components/schemas/microsoft.graph.teamsTemplate'
- templateDefinition:
- $ref: '#/components/schemas/microsoft.graph.teamTemplateDefinition'
- schedule:
- $ref: '#/components/schemas/microsoft.graph.schedule'
- additionalProperties:
- type: object
- microsoft.graph.resourceSpecificPermissionGrant:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.directoryObject'
- - title: resourceSpecificPermissionGrant
- type: object
- properties:
- clientAppId:
- type: string
- description: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.
- nullable: true
- clientId:
- type: string
- description: ID of the Microsoft Entra app that has been granted access. Read-only.
- nullable: true
- permission:
- type: string
- description: The name of the resource-specific permission. Read-only.
- nullable: true
- permissionType:
- type: string
- description: 'The type of permission. Possible values are: Application, Delegated. Read-only.'
- nullable: true
- resourceAppId:
- type: string
- description: ID of the Microsoft Entra app that is hosting the resource. Read-only.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.userTeamwork:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userTeamwork
- type: object
- properties:
- associatedTeams:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.associatedTeamInfo'
- description: The list of associatedTeamInfo objects that a user is associated with.
- x-ms-navigationProperty: true
- installedApps:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation'
- description: The apps installed in the personal scope of this user.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.todo:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: todo
- type: object
- properties:
- lists:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.todoTaskList'
- description: The task lists in the users mailbox.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.employeeExperienceUser:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: employeeExperienceUser
- type: object
- properties:
- learningCourseActivities:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.learningCourseActivity'
+ $ref: '#/components/schemas/microsoft.graph.post'
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.synchronizationSchedule:
- title: synchronizationSchedule
+ ReferenceCreate:
type: object
properties:
- expiration:
- 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 when this job will expire. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- nullable: true
- interval:
- pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$'
+ '@odata.id':
type: string
- description: 'The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, PT1M represents a period of 1 month.'
- format: duration
- state:
- $ref: '#/components/schemas/microsoft.graph.synchronizationScheduleState'
additionalProperties:
type: object
- microsoft.graph.synchronizationStatus:
- title: synchronizationStatus
+ ReferenceUpdate:
type: object
properties:
- code:
- $ref: '#/components/schemas/microsoft.graph.synchronizationStatusCode'
- countSuccessiveCompleteFailures:
- type: integer
- description: Number of consecutive times this job failed.
- format: int64
- escrowsPruned:
- type: boolean
- description: 'true if the job''s escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job''s errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.'
- lastExecution:
- $ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
- lastSuccessfulExecution:
- $ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
- lastSuccessfulExecutionWithExports:
- $ref: '#/components/schemas/microsoft.graph.synchronizationTaskExecution'
- progress:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.synchronizationProgress'
- description: Details of the progress of a job toward completion.
- quarantine:
- $ref: '#/components/schemas/microsoft.graph.synchronizationQuarantine'
- steadyStateFirstAchievedTime:
- 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])$'
+ '@odata.id':
type: string
- description: 'The time when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- steadyStateLastAchievedTime:
- 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])$'
+ '@odata.type':
type: string
- description: 'The time when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- synchronizedEntryCountByType:
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.applicationCollectionResponse:
+ title: Collection of application
+ type: object
+ properties:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.stringKeyLongValuePair'
- description: 'Count of synchronized objects, listed by object type.'
- troubleshootingUrl:
+ $ref: '#/components/schemas/microsoft.graph.application'
+ '@odata.nextLink':
type: string
- description: 'In the event of an error, the URL with the troubleshooting steps for the issue.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.keyValuePair:
- title: keyValuePair
+ microsoft.graph.ODataErrors.ODataError:
+ required:
+ - error
+ type: object
+ properties:
+ error:
+ $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
+ additionalProperties:
+ type: object
+ microsoft.graph.appManagementPolicyCollectionResponse:
+ title: Collection of appManagementPolicy
type: object
properties:
- name:
- type: string
- description: Name for this key-value pair
value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
+ '@odata.nextLink':
type: string
- description: Value for this key-value pair
nullable: true
additionalProperties:
type: object
- microsoft.graph.synchronizationJobSubject:
- title: synchronizationJobSubject
+ ODataCountResponse:
+ type: integer
+ format: int32
+ StringCollectionResponse:
+ title: Collection of string
type: object
properties:
- links:
- $ref: '#/components/schemas/microsoft.graph.synchronizationLinkedObjects'
- objectId:
- type: string
- description: 'The identifier of an object to which a synchronizationJob is to be applied. Can be one of the following: An onPremisesDistinguishedName for synchronization from Active Directory to Azure AD.The user ID for synchronization from Microsoft Entra ID to a third-party.The Worker ID of the Workday worker for synchronization from Workday to either Active Directory or Azure AD.'
- nullable: true
- objectTypeName:
+ value:
+ type: array
+ items:
+ type: string
+ '@odata.nextLink':
type: string
- description: 'The type of the object to which a synchronizationJob is to be applied. Can be one of the following: user for synchronizing between Active Directory and Azure AD.User for synchronizing a user between Microsoft Entra ID and a third-party application. Worker for synchronization a user between Workday and either Active Directory or Azure AD.Group for synchronizing a group between Microsoft Entra ID and a third-party application.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.synchronizationJobRestartScope:
- title: synchronizationJobRestartScope
- enum:
- - None
- - ConnectorDataStore
- - Escrows
- - Watermark
- - QuarantineState
- - Full
- - ForceDeletes
- type: string
- x-ms-enum-flags:
- isFlags: true
- microsoft.graph.synchronizationSecret:
- title: synchronizationSecret
- enum:
- - None
- - UserName
- - Password
- - SecretToken
- - AppKey
- - BaseAddress
- - ClientIdentifier
- - ClientSecret
- - SingleSignOnType
- - Sandbox
- - Url
- - Domain
- - ConsumerKey
- - ConsumerSecret
- - TokenKey
- - TokenExpiration
- - Oauth2AccessToken
- - Oauth2AccessTokenCreationTime
- - Oauth2RefreshToken
- - SyncAll
- - InstanceName
- - Oauth2ClientId
- - Oauth2ClientSecret
- - CompanyId
- - UpdateKeyOnSoftDelete
- - SynchronizationSchedule
- - SystemOfRecord
- - SandboxName
- - EnforceDomain
- - SyncNotificationSettings
- - SkipOutOfScopeDeletions
- - Oauth2AuthorizationCode
- - Oauth2RedirectUri
- - ApplicationTemplateIdentifier
- - Oauth2TokenExchangeUri
- - Oauth2AuthorizationUri
- - AuthenticationType
- - Server
- - PerformInboundEntitlementGrants
- - HardDeletesEnabled
- - SyncAgentCompatibilityKey
- - SyncAgentADContainer
- - ValidateDomain
- - TestReferences
- - ConnectionString
- type: string
- microsoft.graph.synchronizationRule:
- title: synchronizationRule
+ microsoft.graph.extensionPropertyCollectionResponse:
+ title: Collection of extensionProperty
type: object
properties:
- containerFilter:
- $ref: '#/components/schemas/microsoft.graph.containerFilter'
- editable:
- type: boolean
- description: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- groupFilter:
- $ref: '#/components/schemas/microsoft.graph.groupFilter'
- id:
- type: string
- description: Synchronization rule identifier. Must be one of the identifiers recognized by the synchronization engine. Supported rule identifiers can be found in the synchronization template returned by the API.
- nullable: true
- metadata:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.stringKeyStringValuePair'
- description: 'Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn''t be changed.'
- name:
+ $ref: '#/components/schemas/microsoft.graph.extensionProperty'
+ '@odata.nextLink':
type: string
- description: Human-readable name of the synchronization rule. Not nullable.
nullable: true
- objectMappings:
+ additionalProperties:
+ type: object
+ microsoft.graph.federatedIdentityCredentialCollectionResponse:
+ title: Collection of federatedIdentityCredential
+ type: object
+ properties:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.objectMapping'
- description: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.
- priority:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first.
- format: int32
- sourceDirectoryName:
- type: string
- description: Name of the source directory. Must match one of the directory definitions in synchronizationSchema.
- nullable: true
- targetDirectoryName:
+ $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
+ '@odata.nextLink':
type: string
- description: Name of the target directory. Must match one of the directory definitions in synchronizationSchema.
nullable: true
additionalProperties:
type: object
- microsoft.graph.directoryDefinitionDiscoverabilities:
- title: directoryDefinitionDiscoverabilities
- enum:
- - None
- - AttributeNames
- - AttributeDataTypes
- - AttributeReadOnly
- - ReferenceAttributes
- - UnknownFutureValue
- type: string
- x-ms-enum-flags:
- isFlags: true
- microsoft.graph.objectDefinition:
- title: objectDefinition
+ microsoft.graph.homeRealmDiscoveryPolicyCollectionResponse:
+ title: Collection of homeRealmDiscoveryPolicy
type: object
properties:
- attributes:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.attributeDefinition'
- description: Defines attributes of the object.
- metadata:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.objectDefinitionMetadataEntry'
- description: Metadata for the given object.
- name:
+ $ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
+ '@odata.nextLink':
type: string
- description: Name of the object. Must be unique within a directory definition. Not nullable.
nullable: true
- supportedApis:
+ additionalProperties:
+ type: object
+ microsoft.graph.directoryObjectCollectionResponse:
+ title: Collection of directoryObject
+ type: object
+ properties:
+ value:
type: array
items:
- type: string
- nullable: true
- description: The API that the provisioning service queries to retrieve data for synchronization.
+ $ref: '#/components/schemas/microsoft.graph.directoryObject'
+ '@odata.nextLink':
+ type: string
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.scopeOperatorType:
- title: scopeOperatorType
- enum:
- - Binary
- - Unary
- type: string
- microsoft.graph.scopeOperatorMultiValuedComparisonType:
- title: scopeOperatorMultiValuedComparisonType
- enum:
- - All
- - Any
- type: string
- microsoft.graph.attributeType:
- title: attributeType
- enum:
- - String
- - Integer
- - Reference
- - Binary
- - Boolean
- - DateTime
- type: string
- microsoft.graph.attributeMappingParameterSchema:
- title: attributeMappingParameterSchema
+ microsoft.graph.endpointCollectionResponse:
+ title: Collection of endpoint
type: object
properties:
- allowMultipleOccurrences:
- type: boolean
- description: 'The given parameter can be provided multiple times (for example, multiple input strings in the Concatenate(string,string,...) function).'
- name:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.endpoint'
+ '@odata.nextLink':
type: string
- description: Parameter name.
nullable: true
- required:
- type: boolean
- description: true if the parameter is required; otherwise false.
- type:
- $ref: '#/components/schemas/microsoft.graph.attributeType'
additionalProperties:
type: object
- microsoft.graph.stringKeyObjectValuePair:
- title: stringKeyObjectValuePair
+ microsoft.graph.servicePrincipalCollectionResponse:
+ title: Collection of servicePrincipal
type: object
properties:
- key:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
+ '@odata.nextLink':
type: string
- description: Key.
nullable: true
additionalProperties:
type: object
- microsoft.graph.attributeDefinitionMetadataEntry:
- title: attributeDefinitionMetadataEntry
+ microsoft.graph.userCollectionResponse:
+ title: Collection of user
type: object
properties:
- key:
- $ref: '#/components/schemas/microsoft.graph.attributeDefinitionMetadata'
value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.user'
+ '@odata.nextLink':
type: string
- description: Value of the metadata property.
nullable: true
additionalProperties:
type: object
- microsoft.graph.mutability:
- title: mutability
- enum:
- - ReadWrite
- - ReadOnly
- - Immutable
- - WriteOnly
- type: string
- microsoft.graph.referencedObject:
- title: referencedObject
+ microsoft.graph.synchronizationJobCollectionResponse:
+ title: Collection of synchronizationJob
type: object
properties:
- referencedObjectName:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationJob'
+ '@odata.nextLink':
type: string
- description: Name of the referenced object. Must match one of the objects in the directory definition.
nullable: true
- referencedProperty:
+ additionalProperties:
+ type: object
+ microsoft.graph.directoryDefinitionCollectionResponse:
+ title: Collection of directoryDefinition
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryDefinition'
+ '@odata.nextLink':
type: string
- description: 'Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.publicError:
- title: publicError
+ microsoft.graph.synchronizationTemplateCollectionResponse:
+ title: Collection of synchronizationTemplate
type: object
properties:
- code:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
+ '@odata.nextLink':
type: string
- description: Represents the error code.
nullable: true
- details:
+ additionalProperties:
+ type: object
+ microsoft.graph.tokenIssuancePolicyCollectionResponse:
+ title: Collection of tokenIssuancePolicy
+ type: object
+ properties:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.publicErrorDetail'
- description: Details of the error.
- innerError:
- $ref: '#/components/schemas/microsoft.graph.publicInnerError'
- message:
+ $ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
+ '@odata.nextLink':
type: string
- description: A non-localized message for the developer.
nullable: true
- target:
+ additionalProperties:
+ type: object
+ microsoft.graph.tokenLifetimePolicyCollectionResponse:
+ title: Collection of tokenLifetimePolicy
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
+ '@odata.nextLink':
type: string
- description: The target of the error.
nullable: true
additionalProperties:
type: object
- microsoft.graph.attributeMappingSource:
- title: attributeMappingSource
+ microsoft.graph.applicationTemplateCollectionResponse:
+ title: Collection of applicationTemplate
type: object
properties:
- expression:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.applicationTemplate'
+ '@odata.nextLink':
type: string
- description: Equivalent expression representation of this attributeMappingSource object.
nullable: true
- name:
+ additionalProperties:
+ type: object
+ microsoft.graph.appRoleAssignmentCollectionResponse:
+ title: Collection of appRoleAssignment
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
+ '@odata.nextLink':
type: string
- description: 'Name parameter of the mapping source. Depending on the type property value, this can be the name of the function, the name of the source attribute, or a constant value to be used.'
nullable: true
- parameters:
+ additionalProperties:
+ type: object
+ microsoft.graph.onPremisesPublishingProfileCollectionResponse:
+ title: Collection of onPremisesPublishingProfile
+ type: object
+ properties:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.stringKeyAttributeMappingSourceValuePair'
- description: 'If this object represents a function, lists function parameters. Parameters consist of attributeMappingSource objects themselves, allowing for complex expressions. If type isn''t Function, this property is null/empty array.'
- type:
- $ref: '#/components/schemas/microsoft.graph.attributeMappingSourceType'
+ $ref: '#/components/schemas/microsoft.graph.onPremisesPublishingProfile'
+ '@odata.nextLink':
+ type: string
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.synchronizationMetadataEntry:
- title: synchronizationMetadataEntry
+ microsoft.graph.onPremisesAgentGroupCollectionResponse:
+ title: Collection of onPremisesAgentGroup
type: object
properties:
- key:
- $ref: '#/components/schemas/microsoft.graph.synchronizationMetadata'
value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onPremisesAgentGroup'
+ '@odata.nextLink':
type: string
- description: Value of the metadata property.
nullable: true
additionalProperties:
type: object
- microsoft.graph.informationalUrls:
- title: informationalUrls
+ microsoft.graph.onPremisesAgentCollectionResponse:
+ title: Collection of onPremisesAgent
type: object
properties:
- appSignUpUrl:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onPremisesAgent'
+ '@odata.nextLink':
type: string
nullable: true
- singleSignOnDocumentationUrl:
+ additionalProperties:
+ type: object
+ microsoft.graph.publishedResourceCollectionResponse:
+ title: Collection of publishedResource
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.publishedResource'
+ '@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
- microsoft.graph.supportedClaimConfiguration:
- title: supportedClaimConfiguration
+ microsoft.graph.connectorGroupCollectionResponse:
+ title: Collection of connectorGroup
type: object
properties:
- nameIdPolicyFormat:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.connectorGroup'
+ '@odata.nextLink':
type: string
nullable: true
additionalProperties:
type: object
- microsoft.graph.hybridAgentUpdaterConfiguration:
- title: hybridAgentUpdaterConfiguration
+ microsoft.graph.connectorCollectionResponse:
+ title: Collection of connector
type: object
properties:
- allowUpdateConfigurationOverride:
- type: boolean
- description: Indicates if updater configuration will be skipped and the agent will receive an update when the next version of the agent is available.
- deferUpdateDateTime:
- 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])$'
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.connector'
+ '@odata.nextLink':
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 is 2014-01-01T00:00:00Z'
- format: date-time
nullable: true
- updateWindow:
- $ref: '#/components/schemas/microsoft.graph.updateWindow'
additionalProperties:
type: object
- microsoft.graph.onPremisesPublishingType:
- title: onPremisesPublishingType
- enum:
- - applicationProxy
- - exchangeOnline
- - authentication
- - provisioning
- - intunePfx
- - oflineDomainJoin
- - unknownFutureValue
- type: string
- microsoft.graph.agentStatus:
- title: agentStatus
- enum:
- - active
- - inactive
- type: string
- microsoft.graph.connectorStatus:
- title: connectorStatus
- enum:
- - active
- - inactive
- type: string
- microsoft.graph.policyBase:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.directoryObject'
- - title: policyBase
- type: object
- properties:
- description:
- type: string
- description: Description for this policy. Required.
- displayName:
- type: string
- description: Display name for this policy. Required.
- additionalProperties:
- type: object
- microsoft.graph.appManagementConfiguration:
- title: appManagementConfiguration
+ microsoft.graph.claimsMappingPolicyCollectionResponse:
+ title: Collection of claimsMappingPolicy
type: object
properties:
- keyCredentials:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.keyCredentialConfiguration'
- description: Collection of keyCredential restrictions settings to be applied to an application or service principal.
- passwordCredentials:
+ $ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
+ '@odata.nextLink':
+ type: string
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.delegatedPermissionClassificationCollectionResponse:
+ title: Collection of delegatedPermissionClassification
+ type: object
+ properties:
+ value:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.passwordCredentialConfiguration'
- description: Collection of password restrictions settings to be applied to an application or service principal.
+ $ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
+ '@odata.nextLink':
+ type: string
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.permissionClassificationType:
- title: permissionClassificationType
- enum:
- - low
- - medium
- - high
- - unknownFutureValue
- type: string
- microsoft.graph.servicePlanInfo:
- title: servicePlanInfo
+ microsoft.graph.licenseDetailsCollectionResponse:
+ title: Collection of licenseDetails
type: object
properties:
- appliesTo:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.licenseDetails'
+ '@odata.nextLink':
type: string
- description: The object the service plan can be assigned to. The possible values are:User - service plan can be assigned to individual users.Company - service plan can be assigned to the entire tenant.
nullable: true
- provisioningStatus:
+ additionalProperties:
+ type: object
+ microsoft.graph.administrativeUnitCollectionResponse:
+ title: Collection of administrativeUnit
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.administrativeUnit'
+ '@odata.nextLink':
type: string
- description: 'The provisioning status of the service plan. The possible values are:Success - Service is fully provisioned.Disabled - Service has been disabled.ErrorStatus - The service plan has not been provisioned and is in an error state.PendingInput - Service is not yet provisioned; awaiting service confirmation.PendingActivation - Service is provisioned but requires explicit activation by administrator (for example, Intune_O365 service plan)PendingProvisioning - Microsoft has added a new service to the product SKU and it has not been activated in the tenant, yet.'
nullable: true
- servicePlanId:
- 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}$'
+ additionalProperties:
+ type: object
+ microsoft.graph.directoryRoleCollectionResponse:
+ title: Collection of directoryRole
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.directoryRole'
+ '@odata.nextLink':
type: string
- description: The unique identifier of the service plan.
- format: uuid
nullable: true
- servicePlanName:
+ additionalProperties:
+ type: object
+ microsoft.graph.groupCollectionResponse:
+ title: Collection of group
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.group'
+ '@odata.nextLink':
type: string
- description: The name of the service plan.
nullable: true
additionalProperties:
type: object
- microsoft.graph.assignedLabel:
- title: assignedLabel
+ microsoft.graph.oAuth2PermissionGrantCollectionResponse:
+ title: Collection of oAuth2PermissionGrant
type: object
properties:
- displayName:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
+ '@odata.nextLink':
type: string
- description: The display name of the label. Read-only.
nullable: true
- labelId:
+ additionalProperties:
+ type: object
+ microsoft.graph.targetDeviceGroupCollectionResponse:
+ title: Collection of targetDeviceGroup
+ type: object
+ properties:
+ value:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
+ '@odata.nextLink':
type: string
- description: The unique identifier of the label.
nullable: true
additionalProperties:
type: object
- microsoft.graph.licenseProcessingState:
- title: licenseProcessingState
+ microsoft.graph.preAuthorizedApplication:
+ title: preAuthorizedApplication
type: object
properties:
- state:
+ appId:
type: string
- nullable: true
+ description: The unique identifier for the client application.
+ permissionIds:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: The unique identifier for the scopes the client application is granted.
additionalProperties:
type: object
- microsoft.graph.groupWritebackConfiguration:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.writebackConfiguration'
- - title: groupWritebackConfiguration
- type: object
- properties:
- onPremisesGroupType:
- type: string
- description: 'Indicates the target on-premises group type the cloud object is written back as. Nullable. The possible values are: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Microsoft Entra security groups can be written back as universalSecurityGroup. If isEnabled or the NewUnifiedGroupWritebackDefault group setting is true but this property isn''t explicitly configured: Microsoft 365 groups are written back as universalDistributionGroup by defaultSecurity groups are written back as universalSecurityGroup by default'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.groupAccessType:
- title: groupAccessType
+ microsoft.graph.externalAuthenticationType:
+ title: externalAuthenticationType
enum:
- - none
- - private
- - secret
- - public
+ - passthru
+ - aadPreAuthentication
type: string
- microsoft.graph.membershipRuleProcessingStatus:
- title: membershipRuleProcessingStatus
+ microsoft.graph.onPremisesApplicationSegment:
+ title: onPremisesApplicationSegment
type: object
properties:
- errorMessage:
+ alternateUrl:
type: string
- description: Detailed error message if dynamic group processing ran into an error. Optional. Read-only.
+ description: 'If you''re configuring a traffic manager in front of multiple App Proxy application segments, contains the user-friendly URL that will point to the traffic manager.'
nullable: true
- lastMembershipUpdated:
- 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])$'
+ corsConfigurations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.corsConfiguration'
+ description: CORS Rule definition for a particular application segment.
+ externalUrl:
type: string
- description: Most recent date and time when membership of a dynamic group was updated. Optional. Read-only.
- format: date-time
+ description: 'The published external URL for the application segment; for example, https://intranet.contoso.com./'
+ nullable: true
+ internalUrl:
+ type: string
+ description: 'The internal URL of the application segment; for example, https://intranet/.'
nullable: true
- status:
- $ref: '#/components/schemas/microsoft.graph.MembershipRuleProcessingStatusDetails'
additionalProperties:
type: object
- microsoft.graph.directorySetting:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: directorySetting
- type: object
- properties:
- displayName:
- type: string
- description: 'Display name of this group of settings, which comes from the associated template. Read-only.'
- 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:
- $ref: '#/components/schemas/microsoft.graph.settingValue'
- description: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.
- additionalProperties:
- type: object
- 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. Supports $filter (eq, ne) and $search.'
- 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 is 2014-01-01T00:00:00Z. Supports $filter (eq, ne, le, ge).'
- format: date-time
- preview:
- type: string
- description: A short summary from the body of the latest post in this conversation.
- topic:
- type: string
- description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.'
- uniqueSenders:
- type: array
- items:
- type: string
- description: All the users that sent a message to this Conversation.
- threads:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.conversationThread'
- description: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.conversationThread:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: conversationThread
- type: object
- properties:
- ccRecipients:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: 'The Cc: recipients for the thread. Returned only on $select.'
- hasAttachments:
- type: boolean
- description: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.
- isLocked:
- type: boolean
- description: Indicates if the thread is locked. Returned by default.
- 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 is 2014-01-01T00:00:00Z. Returned by default.'
- format: date-time
- preview:
- type: string
- description: A short summary from the body of the latest post in this conversation. Returned by default.
- topic:
- type: string
- description: 'The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.'
- toRecipients:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: 'The To: recipients for the thread. Returned only on $select.'
- uniqueSenders:
- type: array
- items:
- type: string
- description: All the users that sent a message to this thread. Returned by default.
- posts:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.post'
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- 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
- additionalProperties:
- type: object
- microsoft.graph.plannerGroup:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: plannerGroup
- type: object
- properties:
- plans:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.plannerPlan'
- description: Read-only. Nullable. Returns the plannerPlans owned by the group.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- ReferenceCreate:
+ microsoft.graph.segmentConfiguration:
+ title: segmentConfiguration
type: object
- properties:
- '@odata.id':
- type: string
additionalProperties:
type: object
- ReferenceUpdate:
+ microsoft.graph.onPremisesPublishingSingleSignOn:
+ title: onPremisesPublishingSingleSignOn
type: object
properties:
- '@odata.id':
- type: string
- '@odata.type':
- type: string
- nullable: true
+ kerberosSignOnSettings:
+ $ref: '#/components/schemas/microsoft.graph.kerberosSignOnSettings'
+ singleSignOnMode:
+ $ref: '#/components/schemas/microsoft.graph.singleSignOnMode'
additionalProperties:
type: object
- microsoft.graph.applicationCollectionResponse:
- title: Collection of application
+ microsoft.graph.verifiedCustomDomainCertificatesMetadata:
+ title: verifiedCustomDomainCertificatesMetadata
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.application'
- '@odata.nextLink':
+ expiryDate:
+ 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 expiry date of the custom domain certificate. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.ODataErrors.ODataError:
- required:
- - error
- type: object
- properties:
- error:
- $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
- additionalProperties:
- type: object
- microsoft.graph.appManagementPolicyCollectionResponse:
- title: Collection of appManagementPolicy
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.appManagementPolicy'
- '@odata.nextLink':
+ issueDate:
+ 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 issue date of the custom domain. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
nullable: true
- additionalProperties:
- type: object
- ODataCountResponse:
- type: integer
- format: int32
- StringCollectionResponse:
- title: Collection of string
- type: object
- properties:
- value:
- type: array
- items:
- type: string
- '@odata.nextLink':
+ issuerName:
type: string
+ description: The issuer name of the custom domain certificate.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.extensionPropertyCollectionResponse:
- title: Collection of extensionProperty
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.extensionProperty'
- '@odata.nextLink':
+ subjectName:
type: string
+ description: The subject name of the custom domain certificate.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.federatedIdentityCredentialCollectionResponse:
- title: Collection of federatedIdentityCredential
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.federatedIdentityCredential'
- '@odata.nextLink':
+ thumbprint:
type: string
+ description: The thumbprint associated with the custom domain certificate.
nullable: true
additionalProperties:
type: object
- microsoft.graph.homeRealmDiscoveryPolicyCollectionResponse:
- title: Collection of homeRealmDiscoveryPolicy
+ microsoft.graph.optionalClaim:
+ title: optionalClaim
type: object
properties:
- value:
+ additionalProperties:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.homeRealmDiscoveryPolicy'
- '@odata.nextLink':
+ type: string
+ nullable: true
+ description: 'Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property.'
+ essential:
+ type: boolean
+ description: 'If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false.'
+ name:
type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.directoryObjectCollectionResponse:
- title: Collection of directoryObject
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryObject'
- '@odata.nextLink':
+ description: The name of the optional claim.
+ source:
type: string
+ description: 'The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.endpointCollectionResponse:
- title: Collection of endpoint
+ microsoft.graph.weakAlgorithms:
+ title: weakAlgorithms
+ enum:
+ - rsaSha1
+ - unknownFutureValue
+ type: string
+ x-ms-enum-flags:
+ isFlags: true
+ microsoft.graph.resourceAccess:
+ title: resourceAccess
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.endpoint'
- '@odata.nextLink':
+ id:
+ 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
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.servicePrincipalCollectionResponse:
- title: Collection of servicePrincipal
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.servicePrincipal'
- '@odata.nextLink':
+ description: 'The unique identifier of an app role or delegated permission exposed by the resource application. For delegated permissions, this should match the id property of one of the delegated permissions in the oauth2PermissionScopes collection of the resource application''s service principal. For app roles (application permissions), this should match the id property of an app role in the appRoles collection of the resource application''s service principal.'
+ format: uuid
+ type:
type: string
+ description: 'Specifies whether the id property references a delegated permission or an app role (application permission). The possible values are: Scope (for delegated permissions) or Role (for app roles).'
nullable: true
additionalProperties:
type: object
- microsoft.graph.userCollectionResponse:
- title: Collection of user
+ microsoft.graph.implicitGrantSettings:
+ title: implicitGrantSettings
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.user'
- '@odata.nextLink':
- type: string
+ enableAccessTokenIssuance:
+ type: boolean
+ description: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow.
+ nullable: true
+ enableIdTokenIssuance:
+ type: boolean
+ description: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow.
nullable: true
additionalProperties:
type: object
- microsoft.graph.synchronizationJobCollectionResponse:
- title: Collection of synchronizationJob
+ microsoft.graph.redirectUriSettings:
+ title: redirectUriSettings
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.synchronizationJob'
- '@odata.nextLink':
+ index:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Identifies the specific URI within the redirectURIs collection in SAML SSO flows. Defaults to null. The index is unique across all the redirectUris for the application.
+ format: int32
+ nullable: true
+ uri:
type: string
+ description: Specifies the URI that tokens are sent to.
nullable: true
additionalProperties:
type: object
- microsoft.graph.directoryDefinitionCollectionResponse:
- title: Collection of directoryDefinition
+ microsoft.graph.keyValue:
+ title: keyValue
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryDefinition'
- '@odata.nextLink':
+ key:
type: string
+ description: Key.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.synchronizationTemplateCollectionResponse:
- title: Collection of synchronizationTemplate
- type: object
- properties:
value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.synchronizationTemplate'
- '@odata.nextLink':
type: string
+ description: Value.
nullable: true
additionalProperties:
type: object
- microsoft.graph.tokenIssuancePolicyCollectionResponse:
- title: Collection of tokenIssuancePolicy
+ microsoft.graph.passwordSingleSignOnField:
+ title: passwordSingleSignOnField
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.tokenIssuancePolicy'
- '@odata.nextLink':
+ customizedLabel:
type: string
+ description: Title/label override for customization.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.tokenLifetimePolicyCollectionResponse:
- title: Collection of tokenLifetimePolicy
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.tokenLifetimePolicy'
- '@odata.nextLink':
+ defaultLabel:
type: string
+ description: Label that would be used if no customizedLabel is provided. Read only.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.applicationTemplateCollectionResponse:
- title: Collection of applicationTemplate
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.applicationTemplate'
- '@odata.nextLink':
+ fieldId:
type: string
+ description: 'Id used to identity the field type. This is an internal ID and possible values are param1, param2, paramuserName, parampassword.'
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.appRoleAssignmentCollectionResponse:
- title: Collection of appRoleAssignment
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.appRoleAssignment'
- '@odata.nextLink':
+ type:
type: string
+ description: 'Type of the credential. The values can be text, password.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.onPremisesPublishingProfileCollectionResponse:
- title: Collection of onPremisesPublishingProfile
+ microsoft.graph.automaticRepliesSetting:
+ title: automaticRepliesSetting
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onPremisesPublishingProfile'
- '@odata.nextLink':
+ externalAudience:
+ $ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
+ externalReplyMessage:
type: string
+ description: 'The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.'
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.onPremisesAgentGroupCollectionResponse:
- title: Collection of onPremisesAgentGroup
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onPremisesAgentGroup'
- '@odata.nextLink':
+ internalReplyMessage:
type: string
+ description: 'The automatic reply to send to the audience internal to the signed-in user''s organization, if Status is AlwaysEnabled or Scheduled.'
nullable: true
+ scheduledEndDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ scheduledStartDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ status:
+ $ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
additionalProperties:
type: object
- microsoft.graph.onPremisesAgentCollectionResponse:
- title: Collection of onPremisesAgent
+ microsoft.graph.delegateMeetingMessageDeliveryOptions:
+ title: delegateMeetingMessageDeliveryOptions
+ enum:
+ - sendToDelegateAndInformationToPrincipal
+ - sendToDelegateAndPrincipal
+ - sendToDelegateOnly
+ type: string
+ microsoft.graph.localeInfo:
+ title: localeInfo
type: object
properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onPremisesAgent'
- '@odata.nextLink':
+ displayName:
type: string
+ description: 'A name representing the user''s locale in natural language, for example, ''English (United States)''.'
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.publishedResourceCollectionResponse:
- title: Collection of publishedResource
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.publishedResource'
- '@odata.nextLink':
+ locale:
type: string
+ description: 'A locale representation for the user, which includes the user''s preferred language and country/region. For example, ''en-us''. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.connectorGroupCollectionResponse:
- title: Collection of connectorGroup
+ microsoft.graph.userPurpose:
+ title: userPurpose
+ enum:
+ - unknown
+ - user
+ - linked
+ - shared
+ - room
+ - equipment
+ - others
+ - unknownFutureValue
+ type: string
+ microsoft.graph.mailboxRecipientType:
+ title: mailboxRecipientType
+ enum:
+ - unknown
+ - user
+ - linked
+ - shared
+ - room
+ - equipment
+ - others
+ type: string
+ microsoft.graph.workingHours:
+ title: workingHours
type: object
properties:
- value:
+ daysOfWeek:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.connectorGroup'
- '@odata.nextLink':
+ $ref: '#/components/schemas/microsoft.graph.dayOfWeek'
+ description: The days of the week on which the user works.
+ endTime:
+ pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
+ description: The time of the day that the user stops working.
+ format: time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.connectorCollectionResponse:
- title: Collection of connector
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.connector'
- '@odata.nextLink':
+ startTime:
+ pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
type: string
+ description: The time of the day that the user starts working.
+ format: time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.claimsMappingPolicyCollectionResponse:
- title: Collection of claimsMappingPolicy
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.claimsMappingPolicy'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.delegatedPermissionClassificationCollectionResponse:
- title: Collection of delegatedPermissionClassification
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.delegatedPermissionClassification'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.licenseDetailsCollectionResponse:
- title: Collection of licenseDetails
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.licenseDetails'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.administrativeUnitCollectionResponse:
- title: Collection of administrativeUnit
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.administrativeUnit'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.directoryRoleCollectionResponse:
- title: Collection of directoryRole
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.directoryRole'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.groupCollectionResponse:
- title: Collection of group
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.group'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.oAuth2PermissionGrantCollectionResponse:
- title: Collection of oAuth2PermissionGrant
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.oAuth2PermissionGrant'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.targetDeviceGroupCollectionResponse:
- title: Collection of targetDeviceGroup
- type: object
- properties:
- value:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup'
- '@odata.nextLink':
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.preAuthorizedApplication:
- title: preAuthorizedApplication
- type: object
- properties:
- appId:
- type: string
- description: The unique identifier for the client application.
- permissionIds:
- type: array
- items:
- type: string
- nullable: true
- description: The unique identifier for the scopes the client application is granted.
- additionalProperties:
- type: object
- microsoft.graph.optionalClaim:
- title: optionalClaim
- type: object
- properties:
- additionalProperties:
- type: array
- items:
- type: string
- nullable: true
- description: 'Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property.'
- essential:
- type: boolean
- description: 'If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false.'
- name:
- type: string
- description: The name of the optional claim.
- source:
- type: string
- description: 'The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.weakAlgorithms:
- title: weakAlgorithms
- enum:
- - rsaSha1
- - unknownFutureValue
- type: string
- x-ms-enum-flags:
- isFlags: true
- microsoft.graph.resourceAccess:
- title: resourceAccess
- type: object
- properties:
- id:
- 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 of an app role or delegated permission exposed by the resource application. For delegated permissions, this should match the id property of one of the delegated permissions in the oauth2PermissionScopes collection of the resource application''s service principal. For app roles (application permissions), this should match the id property of an app role in the appRoles collection of the resource application''s service principal.'
- format: uuid
- type:
- type: string
- description: 'Specifies whether the id property references a delegated permission or an app role (application permission). The possible values are: Scope (for delegated permissions) or Role (for app roles).'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.implicitGrantSettings:
- title: implicitGrantSettings
- type: object
- properties:
- enableAccessTokenIssuance:
- type: boolean
- description: Specifies whether this web application can request an access token using the OAuth 2.0 implicit flow.
- nullable: true
- enableIdTokenIssuance:
- type: boolean
- description: Specifies whether this web application can request an ID token using the OAuth 2.0 implicit flow.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.redirectUriSettings:
- title: redirectUriSettings
- type: object
- properties:
- index:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Identifies the specific URI within the redirectURIs collection in SAML SSO flows. Defaults to null. The index is unique across all the redirectUris for the application.
- format: int32
- nullable: true
- uri:
- type: string
- description: Specifies the URI that tokens are sent to.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.externalAuthenticationType:
- title: externalAuthenticationType
- enum:
- - passthru
- - aadPreAuthentication
- type: string
- microsoft.graph.onPremisesApplicationSegment:
- title: onPremisesApplicationSegment
- type: object
- properties:
- alternateUrl:
- type: string
- description: 'If you''re configuring a traffic manager in front of multiple App Proxy application segments, contains the user-friendly URL that will point to the traffic manager.'
- nullable: true
- corsConfigurations:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.corsConfiguration'
- description: CORS Rule definition for a particular application segment.
- externalUrl:
- type: string
- description: 'The published external URL for the application segment; for example, https://intranet.contoso.com./'
- nullable: true
- internalUrl:
- type: string
- description: 'The internal URL of the application segment; for example, https://intranet/.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.segmentConfiguration:
- title: segmentConfiguration
- type: object
- additionalProperties:
- type: object
- microsoft.graph.onPremisesPublishingSingleSignOn:
- title: onPremisesPublishingSingleSignOn
- type: object
- properties:
- kerberosSignOnSettings:
- $ref: '#/components/schemas/microsoft.graph.kerberosSignOnSettings'
- singleSignOnMode:
- $ref: '#/components/schemas/microsoft.graph.singleSignOnMode'
- additionalProperties:
- type: object
- microsoft.graph.verifiedCustomDomainCertificatesMetadata:
- title: verifiedCustomDomainCertificatesMetadata
- type: object
- properties:
- expiryDate:
- 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 expiry date of the custom domain certificate. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- nullable: true
- issueDate:
- 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 issue date of the custom domain. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- nullable: true
- issuerName:
- type: string
- description: The issuer name of the custom domain certificate.
- nullable: true
- subjectName:
- type: string
- description: The subject name of the custom domain certificate.
- nullable: true
- thumbprint:
- type: string
- description: The thumbprint associated with the custom domain certificate.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.passwordSingleSignOnField:
- title: passwordSingleSignOnField
- type: object
- properties:
- customizedLabel:
- type: string
- description: Title/label override for customization.
- nullable: true
- defaultLabel:
- type: string
- description: Label that would be used if no customizedLabel is provided. Read only.
- nullable: true
- fieldId:
- type: string
- description: 'Id used to identity the field type. This is an internal ID and possible values are param1, param2, paramuserName, parampassword.'
- nullable: true
- type:
- type: string
- description: 'Type of the credential. The values can be text, password.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.keyValue:
- title: keyValue
- type: object
- properties:
- key:
- type: string
- description: Contains the name of the field that a value is associated with.
- nullable: true
- value:
- type: string
- description: Contains the corresponding value for the specified key.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.automaticRepliesSetting:
- title: automaticRepliesSetting
- type: object
- properties:
- externalAudience:
- $ref: '#/components/schemas/microsoft.graph.externalAudienceScope'
- externalReplyMessage:
- type: string
- description: 'The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.'
- nullable: true
- internalReplyMessage:
- type: string
- description: 'The automatic reply to send to the audience internal to the signed-in user''s organization, if Status is AlwaysEnabled or Scheduled.'
- nullable: true
- scheduledEndDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- scheduledStartDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- status:
- $ref: '#/components/schemas/microsoft.graph.automaticRepliesStatus'
- additionalProperties:
- type: object
- microsoft.graph.delegateMeetingMessageDeliveryOptions:
- title: delegateMeetingMessageDeliveryOptions
- enum:
- - sendToDelegateAndInformationToPrincipal
- - sendToDelegateAndPrincipal
- - sendToDelegateOnly
- type: string
- microsoft.graph.localeInfo:
- title: localeInfo
- type: object
- properties:
- displayName:
- type: string
- description: 'A name representing the user''s locale in natural language, for example, ''English (United States)''.'
- nullable: true
- locale:
- type: string
- description: 'A locale representation for the user, which includes the user''s preferred language and country/region. For example, ''en-us''. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.userPurpose:
- title: userPurpose
- enum:
- - unknown
- - user
- - linked
- - shared
- - room
- - equipment
- - others
- - unknownFutureValue
- type: string
- microsoft.graph.mailboxRecipientType:
- title: mailboxRecipientType
- enum:
- - unknown
- - user
- - linked
- - shared
- - room
- - equipment
- - others
- type: string
- microsoft.graph.workingHours:
- title: workingHours
- type: object
- properties:
- daysOfWeek:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.dayOfWeek'
- description: The days of the week on which the user works.
- endTime:
- pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
- type: string
- description: The time of the day that the user stops working.
- format: time
- nullable: true
- startTime:
- pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$'
- type: string
- description: The time of the day that the user starts working.
- format: time
- nullable: true
- timeZone:
- $ref: '#/components/schemas/microsoft.graph.timeZoneBase'
+ timeZone:
+ $ref: '#/components/schemas/microsoft.graph.timeZoneBase'
additionalProperties:
type: object
microsoft.graph.printerShare:
@@ -30939,6 +30869,93 @@ components:
$ref: '#/components/schemas/microsoft.graph.printer'
additionalProperties:
type: object
+ microsoft.graph.Json:
+ title: Json
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.status:
+ title: status
+ enum:
+ - active
+ - updated
+ - deleted
+ - ignored
+ - unknownFutureValue
+ type: string
+ microsoft.graph.visualInfo:
+ title: visualInfo
+ type: object
+ properties:
+ attribution:
+ $ref: '#/components/schemas/microsoft.graph.imageInfo'
+ backgroundColor:
+ type: string
+ description: Optional. Background color used to render the activity in the UI - brand color for the application source of the activity. Must be a valid hex color
+ nullable: true
+ content:
+ $ref: '#/components/schemas/microsoft.graph.Json'
+ description:
+ type: string
+ description: 'Optional. Longer text description of the user''s unique activity (example: document name, first sentence, and/or metadata)'
+ nullable: true
+ displayText:
+ type: string
+ description: 'Required. Short text description of the user''s unique activity (for example, document name in cases where an activity refers to document creation)'
+ additionalProperties:
+ type: object
+ microsoft.graph.activityHistoryItem:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: activityHistoryItem
+ type: object
+ properties:
+ activeDurationSeconds:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ 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
+ 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
+ format: date-time
+ nullable: true
+ lastActiveDateTime:
+ 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
+ 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
+ format: date-time
+ nullable: true
+ startedDateTime:
+ 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
+ status:
+ $ref: '#/components/schemas/microsoft.graph.status'
+ userTimezone:
+ type: string
+ nullable: true
+ activity:
+ $ref: '#/components/schemas/microsoft.graph.userActivity'
+ additionalProperties:
+ type: object
+ microsoft.graph.agreementAcceptanceState:
+ title: agreementAcceptanceState
+ enum:
+ - accepted
+ - declined
+ - unknownFutureValue
+ type: string
microsoft.graph.settings:
title: settings
type: object
@@ -30983,343 +31000,343 @@ components:
nullable: true
additionalProperties:
type: object
- microsoft.graph.cloudPcConnectionSettings:
- title: cloudPcConnectionSettings
- type: object
- properties:
- enableSingleSignOn:
- type: boolean
- additionalProperties:
- type: object
- microsoft.graph.cloudPcConnectivityResult:
- title: cloudPcConnectivityResult
+ microsoft.graph.appConsentRequestScope:
+ title: appConsentRequestScope
type: object
properties:
- failedHealthCheckItems:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.cloudPcHealthCheckItem'
- description: 'A list of failed health check items. If the status property is available, this property will be empty.'
- status:
- $ref: '#/components/schemas/microsoft.graph.cloudPcConnectivityStatus'
- updatedDateTime:
- 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])$'
+ displayName:
type: string
- description: 'Datetime when the status was updated. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as 2014-01-01T00:00:00Z.'
- format: date-time
+ description: The name of the scope.
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.cloudPcDiskEncryptionState:
- title: cloudPcDiskEncryptionState
- enum:
- - notAvailable
- - notEncrypted
- - encryptedUsingPlatformManagedKey
- - encryptedUsingCustomerManagedKey
- - unknownFutureValue
- type: string
- microsoft.graph.cloudPcLoginResult:
- title: cloudPcLoginResult
- type: object
- properties:
- time:
- 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 of the Cloud PC sign in action. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as ''2014-01-01T00:00:00Z''. Read-only.'
- format: date-time
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.cloudPcRemoteActionResult:
- title: cloudPcRemoteActionResult
- type: object
- properties:
- actionName:
- type: string
- description: 'The specified action. Supported values in the Microsoft Endpoint Manager portal are: Reprovision, Resize, Restore. Supported values in enterprise Cloud PC devices are: Reboot, Rename, Reprovision, Troubleshoot.'
- nullable: true
- actionState:
- $ref: '#/components/schemas/microsoft.graph.actionState'
- cloudPcId:
- type: string
- description: The ID of the Cloud PC device on which the remote action is performed. Read-only.
- nullable: true
- lastUpdatedDateTime:
- 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 for action. The Timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as ''2014-01-01T00:00:00Z''.'
- format: date-time
- nullable: true
- managedDeviceId:
- type: string
- description: The ID of the Intune managed device on which the remote action is performed. Read-only.
- nullable: true
- startDateTime:
- 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: 'Time the action was initiated. The Timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as ''2014-01-01T00:00:00Z''.'
- format: date-time
- nullable: true
- statusDetails:
- $ref: '#/components/schemas/microsoft.graph.cloudPcStatusDetails'
- additionalProperties:
- type: object
- microsoft.graph.cloudPcOperatingSystem:
- title: cloudPcOperatingSystem
- enum:
- - windows10
- - windows11
- - unknownFutureValue
- type: string
- microsoft.graph.cloudPcPartnerAgentInstallResult:
- title: cloudPcPartnerAgentInstallResult
+ microsoft.graph.userConsentRequest:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.request'
+ - title: userConsentRequest
+ type: object
+ properties:
+ reason:
+ type: string
+ description: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
+ nullable: true
+ approval:
+ $ref: '#/components/schemas/microsoft.graph.approval'
+ additionalProperties:
+ type: object
+ microsoft.graph.approvalStep:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: approvalStep
+ type: object
+ properties:
+ assignedToMe:
+ type: boolean
+ description: Indicates whether the step is assigned to the calling user to review. Read-only.
+ nullable: true
+ displayName:
+ type: string
+ description: The label provided by the policy creator to identify an approval step. Read-only.
+ nullable: true
+ justification:
+ type: string
+ description: The justification associated with the approval step decision.
+ nullable: true
+ reviewedBy:
+ $ref: '#/components/schemas/microsoft.graph.identity'
+ reviewedDateTime:
+ 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 a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
+ format: date-time
+ nullable: true
+ reviewResult:
+ type: string
+ description: 'The result of this approval record. Possible values include: NotReviewed, Approved, Denied.'
+ nullable: true
+ status:
+ type: string
+ description: 'The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.'
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.signInPreferences:
+ title: signInPreferences
type: object
properties:
- errorMessage:
- type: string
- nullable: true
- installStatus:
- $ref: '#/components/schemas/microsoft.graph.cloudPcPartnerAgentInstallStatus'
- isThirdPartyPartner:
- type: boolean
- description: Indicates if the partner agent is a third party. When 'TRUE' the agent is a third-party (non-Microsoft) agent and when 'FALSE' the agent is a Microsoft agent or isn't known. The default value is 'FALSE'
- nullable: true
- partnerAgentName:
- $ref: '#/components/schemas/microsoft.graph.cloudPcPartnerAgentName'
- retriable:
+ isSystemPreferredAuthenticationMethodEnabled:
type: boolean
- description: Indicates if the partner agent is a third party. When 'TRUE' the agent is a third-party (non-Microsoft) agent and when 'FALSE' the agent is a Microsoft agent or isn't known. The default value is 'FALSE'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.cloudPcPowerState:
- title: cloudPcPowerState
- enum:
- - running
- - poweredOff
- - unknownFutureValue
- type: string
- microsoft.graph.cloudPcProvisioningType:
- title: cloudPcProvisioningType
- enum:
- - dedicated
- - shared
- - unknownFutureValue
- type: string
- microsoft.graph.cloudPcServicePlanType:
- title: cloudPcServicePlanType
- enum:
- - enterprise
- - business
- - unknownFutureValue
- type: string
- microsoft.graph.cloudPcStatus:
- title: cloudPcStatus
- enum:
- - notProvisioned
- - provisioning
- - provisioned
- - inGracePeriod
- - deprovisioning
- - failed
- - provisionedWithWarnings
- - resizing
- - restoring
- - pendingProvision
- - unknownFutureValue
- - movingRegion
- - resizePendingLicense
- - updatingSingleSignOn
- type: string
- microsoft.graph.cloudPcStatusDetails:
- title: cloudPcStatusDetails
- type: object
- properties:
- additionalInformation:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.keyValuePair'
- description: Any additional information about the Cloud PC status.
- code:
- type: string
- description: The code associated with the Cloud PC status.
- nullable: true
- message:
- type: string
- description: The status message.
+ description: Indicates whether the credential preferences of the system are enabled.
nullable: true
+ userPreferredMethodForSecondaryAuthentication:
+ $ref: '#/components/schemas/microsoft.graph.userDefaultAuthenticationMethodType'
additionalProperties:
type: object
- microsoft.graph.cloudPcUserAccountType:
- title: cloudPcUserAccountType
- enum:
- - standardUser
- - administrator
- - unknownFutureValue
- type: string
- microsoft.graph.usageRightState:
- title: usageRightState
- enum:
- - active
- - inactive
- - warning
- - suspended
- - unknownFutureValue
- type: string
- microsoft.graph.bitlocker:
+ microsoft.graph.emailAuthenticationMethod:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: bitlocker
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: emailAuthenticationMethod
type: object
properties:
- recoveryKeys:
+ emailAddress:
+ type: string
+ description: The email address registered to this user.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.fido2AuthenticationMethod:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: fido2AuthenticationMethod
+ type: object
+ properties:
+ aaGuid:
+ type: string
+ description: 'Authenticator Attestation GUID, an identifier that indicates the type (e.g. make and model) of the authenticator.'
+ nullable: true
+ attestationCertificates:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
- description: The recovery keys associated with the bitlocker entity.
- x-ms-navigationProperty: true
+ type: string
+ nullable: true
+ description: The attestation certificate(s) attached to this security key.
+ attestationLevel:
+ $ref: '#/components/schemas/microsoft.graph.attestationLevel'
+ 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 when this key was registered to the user.
+ format: date-time
+ nullable: true
+ displayName:
+ type: string
+ description: The display name of the key as given by the user.
+ nullable: true
+ model:
+ type: string
+ description: The manufacturer-assigned model of the FIDO2 security key.
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.dataLossPreventionPolicy:
+ microsoft.graph.authenticationMethod:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: dataLossPreventionPolicy
+ - title: authenticationMethod
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.microsoftAuthenticatorAuthenticationMethod:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: microsoftAuthenticatorAuthenticationMethod
type: object
properties:
- name:
+ clientAppName:
+ $ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethodClientAppName'
+ 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 that this app was registered. This property is null if the device is not registered for passwordless Phone Sign-In.
+ format: date-time
+ nullable: true
+ deviceTag:
+ type: string
+ description: Tags containing app metadata.
+ nullable: true
+ displayName:
type: string
+ description: The name of the device on which this app is registered.
+ nullable: true
+ phoneAppVersion:
+ type: string
+ description: Numerical version of this instance of the Authenticator app.
nullable: true
+ device:
+ $ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
- microsoft.graph.sensitivityLabel:
+ microsoft.graph.longRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: sensitivityLabel
+ - title: longRunningOperation
type: object
properties:
- applicableTo:
- $ref: '#/components/schemas/microsoft.graph.sensitivityLabelTarget'
- applicationMode:
- $ref: '#/components/schemas/microsoft.graph.applicationMode'
- assignedPolicies:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.labelPolicy'
- autoLabeling:
- $ref: '#/components/schemas/microsoft.graph.autoLabeling'
- description:
+ 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 start time of the operation. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
nullable: true
- displayName:
+ lastActionDateTime:
+ 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 of the last action in the operation. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
nullable: true
- isDefault:
- type: boolean
+ resourceLocation:
+ type: string
+ description: URI of the resource that the operation is performed on.
nullable: true
- isEndpointProtectionEnabled:
- type: boolean
+ status:
+ $ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus'
+ statusDetail:
+ type: string
+ description: Details about the status of the operation.
nullable: true
- labelActions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.labelActionBase'
- name:
+ additionalProperties:
+ type: object
+ microsoft.graph.passwordlessMicrosoftAuthenticatorAuthenticationMethod:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: passwordlessMicrosoftAuthenticatorAuthenticationMethod
+ 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
+ format: date-time
nullable: true
- priority:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- format: int32
+ creationDateTime:
+ 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 when this method was registered to the user.
+ format: date-time
nullable: true
- toolTip:
+ displayName:
type: string
+ description: The display name of the mobile device as given by the user.
nullable: true
- sublabels:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
- x-ms-navigationProperty: true
+ device:
+ $ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
- microsoft.graph.sensitivityPolicySettings:
+ microsoft.graph.passwordAuthenticationMethod:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: sensitivityPolicySettings
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: passwordAuthenticationMethod
type: object
properties:
- applicableTo:
- $ref: '#/components/schemas/microsoft.graph.sensitivityLabelTarget'
- downgradeSensitivityRequiresJustification:
- type: boolean
+ 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 this password was last updated. This property is currently not populated. Read-only. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ format: date-time
nullable: true
- helpWebUrl:
+ password:
type: string
+ description: 'For security, the password is always returned as null from a LIST or GET operation.'
nullable: true
- isMandatory:
- type: boolean
+ additionalProperties:
+ type: object
+ microsoft.graph.phoneAuthenticationMethod:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: phoneAuthenticationMethod
+ type: object
+ properties:
+ phoneNumber:
+ type: string
+ description: 'The phone number to text or call for authentication. Phone numbers use the format ''+ x'', with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating/updating if they don''t match the required format.'
+ nullable: true
+ phoneType:
+ $ref: '#/components/schemas/microsoft.graph.authenticationPhoneType'
+ smsSignInState:
+ $ref: '#/components/schemas/microsoft.graph.authenticationMethodSignInState'
+ additionalProperties:
+ type: object
+ microsoft.graph.platformCredentialAuthenticationMethod:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: platformCredentialAuthenticationMethod
+ 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: The date and time that this Platform Credential Key was registered.
+ format: date-time
+ nullable: true
+ displayName:
+ type: string
+ description: The name of the device on which Platform Credential is registered.
nullable: true
+ keyStrength:
+ $ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
+ platform:
+ $ref: '#/components/schemas/microsoft.graph.authenticationMethodPlatform'
+ device:
+ $ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
- microsoft.graph.informationProtectionPolicy:
+ microsoft.graph.softwareOathAuthenticationMethod:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: informationProtectionPolicy
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: softwareOathAuthenticationMethod
type: object
properties:
- labels:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.informationProtectionLabel'
- x-ms-navigationProperty: true
+ secretKey:
+ type: string
+ description: The secret key of the method. Always returns null.
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.threatAssessmentRequest:
+ microsoft.graph.temporaryAccessPassAuthenticationMethod:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: threatAssessmentRequest
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: temporaryAccessPassAuthenticationMethod
type: object
properties:
- category:
- $ref: '#/components/schemas/microsoft.graph.threatCategory'
- contentType:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentContentType'
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
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 is 2014-01-01T00:00:00Z.'
+ description: The date and time when the Temporary Access Pass was created.
format: date-time
nullable: true
- expectedAssessment:
- $ref: '#/components/schemas/microsoft.graph.threatExpectedAssessment'
- requestSource:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentRequestSource'
- status:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentStatus'
- results:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
- description: 'A collection of threat assessment results. Read-only. By default, a GET /threatAssessmentRequests/{id} does not return this property unless you apply $expand on it.'
- x-ms-navigationProperty: true
+ isUsableOnce:
+ type: boolean
+ description: 'Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime.'
+ nullable: true
+ lifetimeInMinutes:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
+ format: int32
+ nullable: true
+ startDateTime:
+ 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 Temporary Access Pass becomes available to use and when isUsable is true is enforced.
+ format: date-time
+ nullable: true
+ temporaryAccessPass:
+ type: string
+ description: The Temporary Access Pass used to authenticate. Returned only on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden in subsequent read operations and returned as null with GET.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.windowsHelloForBusinessAuthenticationMethod:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
+ - title: windowsHelloForBusinessAuthenticationMethod
+ 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: The date and time that this Windows Hello for Business key was registered.
+ format: date-time
+ nullable: true
+ displayName:
+ type: string
+ description: The name of the device on which Windows Hello for Business is registered
+ nullable: true
+ keyStrength:
+ $ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
+ device:
+ $ref: '#/components/schemas/microsoft.graph.device'
additionalProperties:
type: object
- microsoft.graph.identity:
- title: identity
- type: object
- properties:
- displayName:
- type: string
- description: 'The display name of the identity. This might not always be available or up to date. For example, if a user changes their display name, the API might show the new value in a future response, but the items associated with the user won''t show up as having changed when using delta.'
- nullable: true
- id:
- type: string
- description: Unique identifier for the identity.
- nullable: true
- additionalProperties:
- type: object
microsoft.graph.onlineMeetingProviderType:
title: onlineMeetingProviderType
enum:
@@ -31632,412 +31649,726 @@ components:
format: int32
additionalProperties:
type: object
- microsoft.graph.typedEmailAddress:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.emailAddress'
- - title: typedEmailAddress
- type: object
- properties:
- otherLabel:
- type: string
- description: 'To specify a custom type of email address, set type to other, and assign otherLabel to a custom string. For example, you may use a specific email address for your volunteer activities. Set type to other, and set otherLabel to a custom string such as Volunteer work.'
- nullable: true
- type:
- $ref: '#/components/schemas/microsoft.graph.emailType'
- additionalProperties:
- type: object
- microsoft.graph.followupFlag:
- title: followupFlag
- type: object
- properties:
- completedDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- dueDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- flagStatus:
- $ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
- startDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- additionalProperties:
- type: object
- microsoft.graph.phone:
- title: phone
- type: object
- properties:
- number:
- type: string
- description: The phone number.
- nullable: true
- type:
- $ref: '#/components/schemas/microsoft.graph.phoneType'
- additionalProperties:
- type: object
- microsoft.graph.physicalAddress:
- title: physicalAddress
+ microsoft.graph.chatType:
+ title: chatType
+ enum:
+ - oneOnOne
+ - group
+ - meeting
+ - unknownFutureValue
+ type: string
+ microsoft.graph.teamworkOnlineMeetingInfo:
+ title: teamworkOnlineMeetingInfo
type: object
properties:
- city:
- type: string
- description: The city.
- nullable: true
- countryOrRegion:
- type: string
- description: 'The country or region. It''s a free-format string value, for example, ''United States''.'
- nullable: true
- postalCode:
- type: string
- description: The postal code.
- nullable: true
- postOfficeBox:
- type: string
- description: The post office box number.
- nullable: true
- state:
+ calendarEventId:
type: string
- description: The state.
+ description: The identifier of the calendar event associated with the meeting.
nullable: true
- street:
+ joinWebUrl:
type: string
- description: The street.
+ description: The URL which can be clicked on to join or uniquely identify the meeting.
nullable: true
- type:
- $ref: '#/components/schemas/microsoft.graph.physicalAddressType'
+ organizer:
+ $ref: '#/components/schemas/microsoft.graph.teamworkUserIdentity'
additionalProperties:
type: object
- microsoft.graph.website:
- title: website
+ microsoft.graph.chatViewpoint:
+ title: chatViewpoint
type: object
properties:
- address:
- type: string
- description: The URL of the website.
+ isHidden:
+ type: boolean
+ description: Indicates whether the chat is hidden for the current user.
nullable: true
- displayName:
+ lastMessageReadDateTime:
+ 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 display name of the web site.
+ description: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
+ format: date-time
nullable: true
- type:
- $ref: '#/components/schemas/microsoft.graph.websiteType'
additionalProperties:
type: object
- microsoft.graph.inferenceClassificationOverride:
+ microsoft.graph.teamsAppInstallation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: inferenceClassificationOverride
+ - title: teamsAppInstallation
type: object
properties:
- classifyAs:
- $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
- senderEmailAddress:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
+ consentedPermissionSet:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'
+ teamsApp:
+ $ref: '#/components/schemas/microsoft.graph.teamsApp'
+ teamsAppDefinition:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
additionalProperties:
type: object
- microsoft.graph.messageRule:
+ microsoft.graph.chatMessageInfo:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: messageRule
+ - title: chatMessageInfo
type: object
properties:
- actions:
- $ref: '#/components/schemas/microsoft.graph.messageRuleActions'
- conditions:
- $ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
- displayName:
+ body:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ 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 display name of the rule.
- nullable: true
- exceptions:
- $ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
- hasError:
- type: boolean
- description: Indicates whether the rule is in an error condition. Read-only.
- nullable: true
- isEnabled:
- type: boolean
- description: Indicates whether the rule is enabled to be applied to messages.
+ description: Date time object representing the time at which message was created.
+ format: date-time
nullable: true
- isReadOnly:
+ eventDetail:
+ $ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
+ from:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
+ isDeleted:
type: boolean
- description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
- nullable: true
- sequence:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'Indicates the order in which the rule is executed, among other rules.'
- format: int32
+ description: 'If set to true, the original message has been deleted.'
nullable: true
+ messageType:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageType'
additionalProperties:
type: object
- microsoft.graph.userConfiguration:
+ microsoft.graph.conversationMember:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userConfiguration
+ - title: conversationMember
type: object
properties:
- binaryData:
+ displayName:
type: string
- format: base64url
+ description: The display name of the user.
+ nullable: true
+ roles:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.'
+ visibleHistoryStartDateTime:
+ 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 denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.inferenceClassificationType:
- title: inferenceClassificationType
- enum:
- - focused
- - other
- type: string
- microsoft.graph.internetMessageHeader:
- title: internetMessageHeader
- type: object
- properties:
- name:
- type: string
- description: Represents the key in a key-value pair.
- nullable: true
- value:
- type: string
- description: The value in a key-value pair.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.mentionsPreview:
- title: mentionsPreview
- type: object
- properties:
- isMentioned:
- type: boolean
- description: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.mention:
+ microsoft.graph.chatMessage:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: mention
+ - title: chatMessage
type: object
properties:
- application:
- type: string
- description: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.
- nullable: true
- clientReference:
+ attachments:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageAttachment'
+ description: 'References to attached objects like files, tabs, meetings etc.'
+ body:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ channelIdentity:
+ $ref: '#/components/schemas/microsoft.graph.channelIdentity'
+ chatId:
type: string
- description: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.
+ description: 'If the message was sent in a chat, represents the identity of the chat.'
nullable: true
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
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 that the mention is created on the client.
+ description: Timestamp of when the chat message was created.
format: date-time
nullable: true
- deepLink:
+ deletedDateTime:
+ 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: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.
+ description: 'Read only. Timestamp at which the chat message was deleted, or null if not deleted.'
+ format: date-time
nullable: true
- mentioned:
- $ref: '#/components/schemas/microsoft.graph.emailAddress'
- mentionText:
+ etag:
type: string
- description: 'Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.'
+ description: Read-only. Version number of the chat message.
nullable: true
- serverCreatedDateTime:
+ eventDetail:
+ $ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
+ from:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
+ importance:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageImportance'
+ lastEditedDateTime:
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 mention is created on the server. Optional. Not used and defaulted as null for message.
+ description: Read only. Timestamp when edits to the chat message were made. Triggers an 'Edited' flag in the Teams UI. If no edits are made the value is null.
format: date-time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.outlookCategory:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: outlookCategory
- type: object
- properties:
- color:
- $ref: '#/components/schemas/microsoft.graph.categoryColor'
- displayName:
+ 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: 'A unique name that identifies a category in the user''s mailbox. After a category is created, the name cannot be changed. Read-only.'
+ description: 'Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.'
+ format: date-time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.outlookTaskFolder:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: outlookTaskFolder
- type: object
- properties:
- changeKey:
+ locale:
type: string
- description: The version of the task folder.
+ description: Locale of the chat message set by the client. Always set to en-us.
+ mentions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageMention'
+ description: 'List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, and tag.'
+ messageHistory:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageHistoryItem'
+ description: 'List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.'
+ messageType:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageType'
+ onBehalfOf:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
+ policyViolation:
+ $ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolation'
+ reactions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
+ description: 'Reactions for this chat message (for example, Like).'
+ replyToId:
+ type: string
+ description: 'Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)'
nullable: true
- isDefaultFolder:
- type: boolean
- description: True if the folder is the default task folder.
+ subject:
+ type: string
+ description: 'The subject of the chat message, in plaintext.'
nullable: true
- name:
+ summary:
type: string
- description: The name of the task folder.
+ description: 'Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.'
nullable: true
- parentGroupKey:
- 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}$'
+ webUrl:
type: string
- description: The unique GUID identifier for the task folder's parent group.
- format: uuid
+ description: Read-only. Link to the message in Microsoft Teams.
nullable: true
- multiValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
- description: The collection of multi-value extended properties defined for the task folder. Read-only. Nullable.
- x-ms-navigationProperty: true
- singleValueExtendedProperties:
+ hostedContents:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
- description: The collection of single-value extended properties defined for the task folder. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
+ description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.'
x-ms-navigationProperty: true
- tasks:
+ replies:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.outlookTask'
- description: The tasks in this task folder. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.chatMessage'
+ description: Replies for a specified message. Supports $expand for channel messages.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.outlookTaskGroup:
+ microsoft.graph.teamsAsyncOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: outlookTaskGroup
+ - title: teamsAsyncOperation
type: object
properties:
- changeKey:
+ attemptsCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of times the operation was attempted before being marked successful or failed.
+ format: int32
+ 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 version of the task group.
- nullable: true
- groupKey:
- 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}$'
+ description: Time when the operation was created.
+ format: date-time
+ error:
+ $ref: '#/components/schemas/microsoft.graph.operationError'
+ lastActionDateTime:
+ 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 unique GUID identifier for the task group.
- format: uuid
- nullable: true
- isDefaultGroup:
- type: boolean
- description: True if the task group is the default task group.
+ description: Time when the async operation was last updated.
+ format: date-time
+ operationType:
+ $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType'
+ status:
+ $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus'
+ targetResourceId:
+ type: string
+ description: 'The ID of the object that''s created or modified as result of this async operation, typically a team.'
nullable: true
- name:
+ targetResourceLocation:
type: string
- description: The name of the task group.
+ description: The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
nullable: true
- taskFolders:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.outlookTaskFolder'
- description: The collection of task folders in the task group. Read-only. Nullable.
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.outlookTask:
+ microsoft.graph.pinnedChatMessageInfo:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.outlookItem'
- - title: outlookTask
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: pinnedChatMessageInfo
type: object
properties:
- assignedTo:
+ message:
+ $ref: '#/components/schemas/microsoft.graph.chatMessage'
+ additionalProperties:
+ type: object
+ microsoft.graph.teamsTab:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: teamsTab
+ type: object
+ properties:
+ configuration:
+ $ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
+ displayName:
type: string
- description: The name of the person who has been assigned the task in Outlook. Read-only.
- nullable: true
- body:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- completedDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- dueDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- hasAttachments:
- type: boolean
- description: Set to true if the task has attachments.
+ description: Name of the tab.
nullable: true
- importance:
- $ref: '#/components/schemas/microsoft.graph.importance'
- isReminderOn:
- type: boolean
+ messageId:
+ type: string
nullable: true
- owner:
+ sortOrderIndex:
type: string
+ description: Index of the order used for sorting tabs.
nullable: true
- parentFolderId:
+ teamsAppId:
type: string
nullable: true
- recurrence:
- $ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
- reminderDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- sensitivity:
- $ref: '#/components/schemas/microsoft.graph.sensitivity'
- startDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- status:
- $ref: '#/components/schemas/microsoft.graph.taskStatus'
- subject:
+ webUrl:
type: string
+ description: Deep link URL of the tab instance. Read only.
nullable: true
- attachments:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.attachment'
- description: 'The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the task. Read-only. Nullable.'
- x-ms-navigationProperty: true
- multiValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
- description: The collection of multi-value extended properties defined for the task. Read-only. Nullable.
- x-ms-navigationProperty: true
- singleValueExtendedProperties:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
- description: The collection of single-value extended properties defined for the task. Read-only. Nullable.
- x-ms-navigationProperty: true
+ teamsApp:
+ $ref: '#/components/schemas/microsoft.graph.teamsApp'
additionalProperties:
type: object
- microsoft.graph.rankedEmailAddress:
- title: rankedEmailAddress
+ microsoft.graph.cloudPcConnectionSettings:
+ title: cloudPcConnectionSettings
type: object
properties:
- address:
+ enableSingleSignOn:
+ type: boolean
+ additionalProperties:
+ type: object
+ microsoft.graph.cloudPcConnectivityResult:
+ title: cloudPcConnectivityResult
+ type: object
+ properties:
+ failedHealthCheckItems:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcHealthCheckItem'
+ description: 'A list of failed health check items. If the status property is available, this property will be empty.'
+ status:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcConnectivityStatus'
+ updatedDateTime:
+ 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 email address.
- nullable: true
- rank:
- type: number
- description: 'The rank of the email address. A rank is used as a sort key, in relation to the other returned results. A higher rank value corresponds to a more relevant result. Relevance is determined by communication, collaboration, and business relationship signals.'
- format: double
- nullable: true
+ description: 'Datetime when the status was updated. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as 2014-01-01T00:00:00Z.'
+ format: date-time
additionalProperties:
type: object
- microsoft.graph.personDataSource:
- title: personDataSource
+ microsoft.graph.cloudPcDiskEncryptionState:
+ title: cloudPcDiskEncryptionState
+ enum:
+ - notAvailable
+ - notEncrypted
+ - encryptedUsingPlatformManagedKey
+ - encryptedUsingCustomerManagedKey
+ - unknownFutureValue
+ type: string
+ microsoft.graph.cloudPcLoginResult:
+ title: cloudPcLoginResult
type: object
properties:
- type:
+ time:
+ 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 type of data source.
+ description: 'The time of the Cloud PC sign in action. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as ''2014-01-01T00:00:00Z''. Read-only.'
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.baseItem:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: baseItem
- type: object
- properties:
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
+ microsoft.graph.cloudPcRemoteActionResult:
+ title: cloudPcRemoteActionResult
+ type: object
+ properties:
+ actionName:
+ type: string
+ description: 'The specified action. Supported values in the Microsoft Endpoint Manager portal are: Reprovision, Resize, Restore. Supported values in enterprise Cloud PC devices are: Reboot, Rename, Reprovision, Troubleshoot.'
+ nullable: true
+ actionState:
+ $ref: '#/components/schemas/microsoft.graph.actionState'
+ cloudPcId:
+ type: string
+ description: The ID of the Cloud PC device on which the remote action is performed. Read-only.
+ nullable: true
+ lastUpdatedDateTime:
+ 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 for action. The Timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as ''2014-01-01T00:00:00Z''.'
+ format: date-time
+ nullable: true
+ managedDeviceId:
+ type: string
+ description: The ID of the Intune managed device on which the remote action is performed. Read-only.
+ nullable: true
+ startDateTime:
+ 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: 'Time the action was initiated. The Timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as ''2014-01-01T00:00:00Z''.'
+ format: date-time
+ nullable: true
+ statusDetails:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcStatusDetails'
+ additionalProperties:
+ type: object
+ microsoft.graph.cloudPcOperatingSystem:
+ title: cloudPcOperatingSystem
+ enum:
+ - windows10
+ - windows11
+ - unknownFutureValue
+ type: string
+ microsoft.graph.cloudPcPartnerAgentInstallResult:
+ title: cloudPcPartnerAgentInstallResult
+ type: object
+ properties:
+ errorMessage:
+ type: string
+ nullable: true
+ installStatus:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcPartnerAgentInstallStatus'
+ isThirdPartyPartner:
+ type: boolean
+ description: Indicates if the partner agent is a third party. When 'TRUE' the agent is a third-party (non-Microsoft) agent and when 'FALSE' the agent is a Microsoft agent or isn't known. The default value is 'FALSE'
+ nullable: true
+ partnerAgentName:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcPartnerAgentName'
+ retriable:
+ type: boolean
+ description: Indicates if the partner agent is a third party. When 'TRUE' the agent is a third-party (non-Microsoft) agent and when 'FALSE' the agent is a Microsoft agent or isn't known. The default value is 'FALSE'
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.cloudPcPowerState:
+ title: cloudPcPowerState
+ enum:
+ - running
+ - poweredOff
+ - unknownFutureValue
+ type: string
+ microsoft.graph.cloudPcProvisioningType:
+ title: cloudPcProvisioningType
+ enum:
+ - dedicated
+ - shared
+ - unknownFutureValue
+ type: string
+ microsoft.graph.cloudPcServicePlanType:
+ title: cloudPcServicePlanType
+ enum:
+ - enterprise
+ - business
+ - unknownFutureValue
+ type: string
+ microsoft.graph.cloudPcStatus:
+ title: cloudPcStatus
+ enum:
+ - notProvisioned
+ - provisioning
+ - provisioned
+ - inGracePeriod
+ - deprovisioning
+ - failed
+ - provisionedWithWarnings
+ - resizing
+ - restoring
+ - pendingProvision
+ - unknownFutureValue
+ - movingRegion
+ - resizePendingLicense
+ - updatingSingleSignOn
+ type: string
+ microsoft.graph.cloudPcStatusDetails:
+ title: cloudPcStatusDetails
+ type: object
+ properties:
+ additionalInformation:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.keyValuePair'
+ description: Any additional information about the Cloud PC status.
+ code:
+ type: string
+ description: The code associated with the Cloud PC status.
+ nullable: true
+ message:
+ type: string
+ description: The status message.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.cloudPcUserAccountType:
+ title: cloudPcUserAccountType
+ enum:
+ - standardUser
+ - administrator
+ - unknownFutureValue
+ type: string
+ microsoft.graph.typedEmailAddress:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.emailAddress'
+ - title: typedEmailAddress
+ type: object
+ properties:
+ otherLabel:
+ type: string
+ description: 'To specify a custom type of email address, set type to other, and assign otherLabel to a custom string. For example, you may use a specific email address for your volunteer activities. Set type to other, and set otherLabel to a custom string such as Volunteer work.'
+ nullable: true
+ type:
+ $ref: '#/components/schemas/microsoft.graph.emailType'
+ additionalProperties:
+ type: object
+ microsoft.graph.followupFlag:
+ title: followupFlag
+ type: object
+ properties:
+ completedDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ dueDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ flagStatus:
+ $ref: '#/components/schemas/microsoft.graph.followupFlagStatus'
+ startDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ additionalProperties:
+ type: object
+ microsoft.graph.phone:
+ title: phone
+ type: object
+ properties:
+ number:
+ type: string
+ description: The phone number.
+ nullable: true
+ type:
+ $ref: '#/components/schemas/microsoft.graph.phoneType'
+ additionalProperties:
+ type: object
+ microsoft.graph.physicalAddress:
+ title: physicalAddress
+ type: object
+ properties:
+ city:
+ type: string
+ description: The city.
+ nullable: true
+ countryOrRegion:
+ type: string
+ description: 'The country or region. It''s a free-format string value, for example, ''United States''.'
+ nullable: true
+ postalCode:
+ type: string
+ description: The postal code.
+ nullable: true
+ postOfficeBox:
+ type: string
+ description: The post office box number.
+ nullable: true
+ state:
+ type: string
+ description: The state.
+ nullable: true
+ street:
+ type: string
+ description: The street.
+ nullable: true
+ type:
+ $ref: '#/components/schemas/microsoft.graph.physicalAddressType'
+ additionalProperties:
+ type: object
+ microsoft.graph.website:
+ title: website
+ type: object
+ properties:
+ address:
+ type: string
+ description: The URL of the website.
+ nullable: true
+ displayName:
+ type: string
+ description: The display name of the web site.
+ nullable: true
+ type:
+ $ref: '#/components/schemas/microsoft.graph.websiteType'
+ additionalProperties:
+ type: object
+ microsoft.graph.deviceEnrollmentConfigurationType:
+ title: deviceEnrollmentConfigurationType
+ enum:
+ - unknown
+ - limit
+ - platformRestrictions
+ - windowsHelloForBusiness
+ - defaultLimit
+ - defaultPlatformRestrictions
+ - defaultWindowsHelloForBusiness
+ - defaultWindows10EnrollmentCompletionPageConfiguration
+ - windows10EnrollmentCompletionPageConfiguration
+ - deviceComanagementAuthorityConfiguration
+ - singlePlatformRestriction
+ - unknownFutureValue
+ - enrollmentNotificationsConfiguration
+ type: string
+ description: Describes the TemplateFamily for the Template entity
+ x-ms-enum:
+ name: deviceEnrollmentConfigurationType
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Default. Set to unknown if the configuration type cannot be determined.
+ name: unknown
+ - value: limit
+ description: Indicates that configuration is of type limit which refers to number of devices a user is allowed to enroll.
+ name: limit
+ - value: platformRestrictions
+ description: Indicates that configuration is of type platform restriction which refers to types of devices a user is allowed to enroll.
+ name: platformRestrictions
+ - value: windowsHelloForBusiness
+ description: Indicates that configuration is of type Windows Hello which refers to authentication method devices would use.
+ name: windowsHelloForBusiness
+ - value: defaultLimit
+ description: Indicates that configuration is of type default limit which refers to types of devices a user is allowed to enroll by default.
+ name: defaultLimit
+ - value: defaultPlatformRestrictions
+ description: Indicates that configuration is of type default platform restriction which refers to types of devices a user is allowed to enroll by default.
+ name: defaultPlatformRestrictions
+ - value: defaultWindowsHelloForBusiness
+ description: Indicates that configuration is of type default Windows Hello which refers to authentication method devices would use by default.
+ name: defaultWindowsHelloForBusiness
+ - value: defaultWindows10EnrollmentCompletionPageConfiguration
+ description: Indicates that configuration is of type default Enrollment status page which refers to startup page displayed during OOBE in Autopilot devices by default.
+ name: defaultWindows10EnrollmentCompletionPageConfiguration
+ - value: windows10EnrollmentCompletionPageConfiguration
+ description: Indicates that configuration is of type Enrollment status page which refers to startup page displayed during OOBE in Autopilot devices.
+ name: windows10EnrollmentCompletionPageConfiguration
+ - value: deviceComanagementAuthorityConfiguration
+ description: Indicates that configuration is of type Comanagement Authority which refers to policies applied to Co-Managed devices.
+ name: deviceComanagementAuthorityConfiguration
+ - value: singlePlatformRestriction
+ description: Indicates that configuration is of type single platform restriction which refers to types of devices a user is allowed to enroll.
+ name: singlePlatformRestriction
+ - value: unknownFutureValue
+ description: Unknown future value
+ name: unknownFutureValue
+ - value: enrollmentNotificationsConfiguration
+ description: Indicates that configuration is of type Enrollment Notification which refers to types of notification a user receives during enrollment.
+ name: enrollmentNotificationsConfiguration
+ microsoft.graph.enrollmentConfigurationAssignment:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: enrollmentConfigurationAssignment
+ type: object
+ properties:
+ source:
+ $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentSource'
+ sourceId:
+ type: string
+ description: Identifier for resource used for deployment to a group
+ nullable: true
+ target:
+ $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget'
+ additionalProperties:
+ type: object
+ description: Enrollment Configuration Assignment
+ microsoft.graph.deviceManagementTroubleshootingErrorDetails:
+ title: deviceManagementTroubleshootingErrorDetails
+ type: object
+ properties:
+ context:
+ type: string
+ description: Not yet documented
+ nullable: true
+ failure:
+ type: string
+ description: Not yet documented
+ nullable: true
+ failureDetails:
+ type: string
+ description: The detailed description of what went wrong.
+ nullable: true
+ remediation:
+ type: string
+ description: The detailed description of how to remediate this issue.
+ nullable: true
+ resources:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingErrorResource'
+ description: Links to helpful documentation about this failure.
+ additionalProperties:
+ type: object
+ description: Object containing detailed information about the error and its remediation.
+ microsoft.graph.alternativeSecurityId:
+ title: alternativeSecurityId
+ type: object
+ properties:
+ identityProvider:
+ type: string
+ description: For internal use only.
+ nullable: true
+ key:
+ type: string
+ description: For internal use only.
+ format: base64url
+ nullable: true
+ type:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: For internal use only.
+ format: int32
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.command:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: command
+ type: object
+ properties:
+ appServiceName:
+ type: string
+ nullable: true
+ error:
+ type: string
+ nullable: true
+ packageFamilyName:
+ type: string
+ nullable: true
+ payload:
+ $ref: '#/components/schemas/microsoft.graph.payloadRequest'
+ permissionTicket:
+ type: string
+ nullable: true
+ postBackUri:
+ type: string
+ nullable: true
+ status:
+ type: string
+ nullable: true
+ type:
+ type: string
+ nullable: true
+ responsepayload:
+ $ref: '#/components/schemas/microsoft.graph.payloadResponse'
+ additionalProperties:
+ type: object
+ microsoft.graph.baseItem:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: baseItem
+ type: object
+ properties:
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
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
@@ -32242,8 +32573,6 @@ components:
type: string
description: WebDAV compatible URL for the item.
nullable: true
- workbook:
- $ref: '#/components/schemas/microsoft.graph.workbook'
activities:
type: array
items:
@@ -32278,7 +32607,7 @@ components:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.thumbnailSet'
- description: 'Collection containing [ThumbnailSet][] objects associated with the item. For more info, see [getting thumbnails][]. Read-only. Nullable.'
+ description: 'Collection of [thumbnailSet][] objects associated with the item. For more information, see [getting thumbnails][]. Read-only. Nullable.'
x-ms-navigationProperty: true
versions:
type: array
@@ -32286,6 +32615,8 @@ components:
$ref: '#/components/schemas/microsoft.graph.driveItemVersion'
description: 'The list of previous versions of the item. For more info, see [getting previous versions][]. Read-only. Nullable.'
x-ms-navigationProperty: true
+ workbook:
+ $ref: '#/components/schemas/microsoft.graph.workbook'
additionalProperties:
type: object
microsoft.graph.list:
@@ -32344,6 +32675,43 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
+ microsoft.graph.learningCourseActivity:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: learningCourseActivity
+ type: object
+ properties:
+ completedDateTime:
+ 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 when the assignment was completed. Optional.
+ format: date-time
+ nullable: true
+ completionPercentage:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The percentage completion value of the course activity. Optional.
+ format: int32
+ nullable: true
+ externalcourseActivityId:
+ type: string
+ description: A course activity ID generated by the provider. Optional.
+ nullable: true
+ learnerUserId:
+ type: string
+ description: The user ID of the learner to whom the activity is assigned. Required.
+ learningContentId:
+ type: string
+ description: The ID of the learning content created in Viva Learning. Required.
+ learningProviderId:
+ type: string
+ description: The registration ID of the provider. Required.
+ nullable: true
+ status:
+ $ref: '#/components/schemas/microsoft.graph.courseStatus'
+ additionalProperties:
+ type: object
microsoft.graph.deleted:
title: deleted
type: object
@@ -32718,3453 +33086,2831 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.appConsentRequestScope:
- title: appConsentRequestScope
- type: object
- properties:
- displayName:
- type: string
- description: The name of the scope.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.userConsentRequest:
+ microsoft.graph.inferenceClassificationOverride:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.request'
- - title: userConsentRequest
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: inferenceClassificationOverride
type: object
properties:
- reason:
- type: string
- description: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
- nullable: true
- approval:
- $ref: '#/components/schemas/microsoft.graph.approval'
+ classifyAs:
+ $ref: '#/components/schemas/microsoft.graph.inferenceClassificationType'
+ senderEmailAddress:
+ $ref: '#/components/schemas/microsoft.graph.emailAddress'
additionalProperties:
type: object
- microsoft.graph.approvalStep:
+ microsoft.graph.bitlocker:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: approvalStep
+ - title: bitlocker
type: object
properties:
- assignedToMe:
- type: boolean
- description: Indicates whether the step is assigned to the calling user to review. Read-only.
- nullable: true
- displayName:
- type: string
- description: The label provided by the policy creator to identify an approval step. Read-only.
- nullable: true
- justification:
- type: string
- description: The justification associated with the approval step decision.
- nullable: true
- reviewedBy:
- $ref: '#/components/schemas/microsoft.graph.identity'
- reviewedDateTime:
- 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 a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
- format: date-time
- nullable: true
- reviewResult:
- type: string
- description: 'The result of this approval record. Possible values include: NotReviewed, Approved, Denied.'
- nullable: true
- status:
- type: string
- description: 'The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.'
- nullable: true
+ recoveryKeys:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.bitlockerRecoveryKey'
+ description: The recovery keys associated with the bitlocker entity.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.accessReviewError:
+ microsoft.graph.dataLossPreventionPolicy:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.genericError'
- - title: accessReviewError
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: dataLossPreventionPolicy
type: object
+ properties:
+ name:
+ type: string
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.accessReviewReviewerScope:
+ microsoft.graph.informationProtectionPolicy:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
- - title: accessReviewReviewerScope
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: informationProtectionPolicy
type: object
properties:
- query:
- type: string
- description: The query specifying who will be the reviewer.
- nullable: true
- queryRoot:
- type: string
- description: 'In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.'
- nullable: true
- queryType:
- type: string
- description: The type of query. Examples include MicrosoftGraph and ARM.
- nullable: true
+ labels:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.informationProtectionLabel'
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.accessReviewScope:
- title: accessReviewScope
- type: object
- additionalProperties:
- type: object
- microsoft.graph.accessReviewReviewer:
+ microsoft.graph.sensitivityLabel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: accessReviewReviewer
+ - title: sensitivityLabel
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])$'
+ applicableTo:
+ $ref: '#/components/schemas/microsoft.graph.sensitivityLabelTarget'
+ applicationMode:
+ $ref: '#/components/schemas/microsoft.graph.applicationMode'
+ assignedPolicies:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.labelPolicy'
+ autoLabeling:
+ $ref: '#/components/schemas/microsoft.graph.autoLabeling'
+ description:
type: string
- description: The date when the reviewer was added for the access review.
- format: date-time
nullable: true
displayName:
type: string
- description: Name of reviewer.
- nullable: true
- userPrincipalName:
- type: string
- description: User principal name of the user.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.accessReviewInstanceDecisionItem:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: accessReviewInstanceDecisionItem
- type: object
- properties:
- accessReviewId:
- type: string
- description: The identifier of the accessReviewInstance parent. Supports $select. Read-only.
- appliedBy:
- $ref: '#/components/schemas/microsoft.graph.userIdentity'
- appliedDateTime:
- 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 when the approval decision was applied. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
- format: date-time
- nullable: true
- applyResult:
- type: string
- description: 'The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
- decision:
- type: string
- description: 'Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).'
- nullable: true
- justification:
- type: string
- description: Justification left by the reviewer when they made the decision.
+ isDefault:
+ type: boolean
nullable: true
- principal:
- $ref: '#/components/schemas/microsoft.graph.identity'
- principalLink:
- type: string
- description: 'Link to the principal object. For example: https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.'
+ isEndpointProtectionEnabled:
+ type: boolean
nullable: true
- principalResourceMembership:
- $ref: '#/components/schemas/microsoft.graph.decisionItemPrincipalResourceMembership'
- recommendation:
+ labelActions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.labelActionBase'
+ name:
type: string
- description: 'A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within thirty days of start of review. Recommend deny if sign-in is greater than thirty days of start of review. Recommendation not available otherwise. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
- resource:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemResource'
- resourceLink:
- type: string
- description: 'A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.'
+ priority:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ format: int32
nullable: true
- reviewedBy:
- $ref: '#/components/schemas/microsoft.graph.userIdentity'
- reviewedDateTime:
- 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])$'
+ toolTip:
type: string
- description: The timestamp when the review decision occurred. Supports $select. Read-only.
- format: date-time
nullable: true
- target:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemTarget'
- insights:
+ sublabels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.governanceInsight'
- description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
+ $ref: '#/components/schemas/microsoft.graph.sensitivityLabel'
x-ms-navigationProperty: true
- instance:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
additionalProperties:
type: object
- microsoft.graph.accessReviewScheduleDefinition:
+ microsoft.graph.sensitivityPolicySettings:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: accessReviewScheduleDefinition
+ - title: sensitivityPolicySettings
type: object
properties:
- additionalNotificationRecipients:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientItem'
- description: Defines the list of additional users or group members to be notified of the access review progress.
- backupReviewers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.userIdentity'
- 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 when the access review series was created. Supports $select. Read-only.
- format: date-time
- nullable: true
- descriptionForAdmins:
- type: string
- description: Description provided by review creators to provide more context of the review to admins. Supports $select.
- nullable: true
- descriptionForReviewers:
- type: string
- description: Description provided by review creators to provide more context of the review to reviewers. Reviewers see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.
+ applicableTo:
+ $ref: '#/components/schemas/microsoft.graph.sensitivityLabelTarget'
+ downgradeSensitivityRequiresJustification:
+ type: boolean
nullable: true
- displayName:
+ helpWebUrl:
type: string
- description: Name of the access review series. Supports $select and $orderby. Required on create.
nullable: true
- fallbackReviewers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn''t exist, or manager is specified as reviewer but a user''s manager doesn''t exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.'
- instanceEnumerationScope:
- $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
- 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: Timestamp when the access review series was last modified. Supports $select. Read-only.
- format: date-time
- nullable: true
- reviewers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- description: 'This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.'
- scope:
- $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
- settings:
- $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleSettings'
- stageSettings:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewStageSettings'
- description: 'Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages are created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.'
- status:
- type: string
- description: 'This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
+ isMandatory:
+ type: boolean
nullable: true
- instances:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
- description: 'Set of access reviews instances for this access review series. Access reviews that don''t recur will only have one instance; otherwise, there''s an instance for each recurrence.'
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.accessReviewStage:
+ microsoft.graph.threatAssessmentRequest:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: accessReviewStage
+ - title: threatAssessmentRequest
type: object
properties:
- endDateTime:
- 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 review stage is scheduled to end. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. This property is the cumulative total of the durationInDays for all stages. Read-only.'
- format: date-time
- nullable: true
- fallbackReviewers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This can occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist.'
- reviewers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
- description: 'This collection of access review scopes is used to define who the reviewers are. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
- startDateTime:
+ category:
+ $ref: '#/components/schemas/microsoft.graph.threatCategory'
+ contentType:
+ $ref: '#/components/schemas/microsoft.graph.threatAssessmentContentType'
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ 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 when review stage is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
+ 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 is 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
+ expectedAssessment:
+ $ref: '#/components/schemas/microsoft.graph.threatExpectedAssessment'
+ requestSource:
+ $ref: '#/components/schemas/microsoft.graph.threatAssessmentRequestSource'
status:
- type: string
- description: 'Specifies the status of an accessReviewStage. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $orderby, and $filter (eq only). Read-only.'
- nullable: true
- decisions:
+ $ref: '#/components/schemas/microsoft.graph.threatAssessmentStatus'
+ results:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
- description: 'Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.'
+ $ref: '#/components/schemas/microsoft.graph.threatAssessmentResult'
+ description: 'A collection of threat assessment results. Read-only. By default, a GET /threatAssessmentRequests/{id} does not return this property unless you apply $expand on it.'
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.agreementAcceptanceState:
- title: agreementAcceptanceState
- enum:
- - accepted
- - declined
- - unknownFutureValue
- type: string
- microsoft.graph.security.informationProtection:
+ microsoft.graph.officeGraphInsights:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: informationProtection
+ - title: officeGraphInsights
type: object
properties:
- labelPolicySettings:
- $ref: '#/components/schemas/microsoft.graph.security.informationProtectionPolicySetting'
- sensitivityLabels:
+ shared:
type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.security.sensitivityLabel'
- description: Read the Microsoft Purview Information Protection labels for the user or organization.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.deviceEnrollmentConfigurationType:
- title: deviceEnrollmentConfigurationType
- enum:
- - unknown
- - limit
- - platformRestrictions
- - windowsHelloForBusiness
- - defaultLimit
- - defaultPlatformRestrictions
- - defaultWindowsHelloForBusiness
- - defaultWindows10EnrollmentCompletionPageConfiguration
- - windows10EnrollmentCompletionPageConfiguration
- - deviceComanagementAuthorityConfiguration
- - singlePlatformRestriction
- - unknownFutureValue
- - enrollmentNotificationsConfiguration
- type: string
- description: Describes the TemplateFamily for the Template entity
- x-ms-enum:
- name: deviceEnrollmentConfigurationType
- modelAsString: false
- values:
- - value: unknown
- description: Default. Set to unknown if the configuration type cannot be determined.
- name: unknown
- - value: limit
- description: Indicates that configuration is of type limit which refers to number of devices a user is allowed to enroll.
- name: limit
- - value: platformRestrictions
- description: Indicates that configuration is of type platform restriction which refers to types of devices a user is allowed to enroll.
- name: platformRestrictions
- - value: windowsHelloForBusiness
- description: Indicates that configuration is of type Windows Hello which refers to authentication method devices would use.
- name: windowsHelloForBusiness
- - value: defaultLimit
- description: Indicates that configuration is of type default limit which refers to types of devices a user is allowed to enroll by default.
- name: defaultLimit
- - value: defaultPlatformRestrictions
- description: Indicates that configuration is of type default platform restriction which refers to types of devices a user is allowed to enroll by default.
- name: defaultPlatformRestrictions
- - value: defaultWindowsHelloForBusiness
- description: Indicates that configuration is of type default Windows Hello which refers to authentication method devices would use by default.
- name: defaultWindowsHelloForBusiness
- - value: defaultWindows10EnrollmentCompletionPageConfiguration
- description: Indicates that configuration is of type default Enrollment status page which refers to startup page displayed during OOBE in Autopilot devices by default.
- name: defaultWindows10EnrollmentCompletionPageConfiguration
- - value: windows10EnrollmentCompletionPageConfiguration
- description: Indicates that configuration is of type Enrollment status page which refers to startup page displayed during OOBE in Autopilot devices.
- name: windows10EnrollmentCompletionPageConfiguration
- - value: deviceComanagementAuthorityConfiguration
- description: Indicates that configuration is of type Comanagement Authority which refers to policies applied to Co-Managed devices.
- name: deviceComanagementAuthorityConfiguration
- - value: singlePlatformRestriction
- description: Indicates that configuration is of type single platform restriction which refers to types of devices a user is allowed to enroll.
- name: singlePlatformRestriction
- - value: unknownFutureValue
- description: Unknown future value
- name: unknownFutureValue
- - value: enrollmentNotificationsConfiguration
- description: Indicates that configuration is of type Enrollment Notification which refers to types of notification a user receives during enrollment.
- name: enrollmentNotificationsConfiguration
- microsoft.graph.enrollmentConfigurationAssignment:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: enrollmentConfigurationAssignment
- type: object
- properties:
- source:
- $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentSource'
- sourceId:
- type: string
- description: Identifier for resource used for deployment to a group
- nullable: true
- target:
- $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentTarget'
- additionalProperties:
- type: object
- description: Enrollment Configuration Assignment
- microsoft.graph.chassisType:
- title: chassisType
- enum:
- - unknown
- - desktop
- - laptop
- - worksWorkstation
- - enterpriseServer
- - phone
- - tablet
- - mobileOther
- - mobileUnknown
- type: string
- description: Chassis type.
- x-ms-enum:
- name: chassisType
- modelAsString: false
- values:
- - value: unknown
- description: Unknown.
- name: unknown
- - value: desktop
- description: Desktop.
- name: desktop
- - value: laptop
- description: Laptop.
- name: laptop
- - value: worksWorkstation
- description: Workstation.
- name: worksWorkstation
- - value: enterpriseServer
- description: Enterprise server.
- name: enterpriseServer
- - value: phone
- description: Phone.
- name: phone
- - value: tablet
- description: Mobile tablet.
- name: tablet
- - value: mobileOther
- description: Other mobile.
- name: mobileOther
- - value: mobileUnknown
- description: Unknown mobile.
- name: mobileUnknown
- microsoft.graph.chromeOSDeviceProperty:
- title: chromeOSDeviceProperty
- type: object
- properties:
- name:
- type: string
- description: Name of the property
- nullable: true
- updatable:
- type: boolean
- description: Whether this property is updatable
- value:
- type: string
- description: Value of the property
- nullable: true
- valueType:
- type: string
- description: Type of the value
- nullable: true
- additionalProperties:
- type: object
- description: Represents a property of the ChromeOS device.
- microsoft.graph.complianceState:
- title: complianceState
- enum:
- - unknown
- - compliant
- - noncompliant
- - conflict
- - error
- - inGracePeriod
- - configManager
- type: string
- description: Compliance state.
- x-ms-enum:
- name: complianceState
- modelAsString: false
- values:
- - value: unknown
- description: Unknown.
- name: unknown
- - value: compliant
- description: Compliant.
- name: compliant
- - value: noncompliant
- description: Device is non-compliant and is blocked from corporate resources.
- name: noncompliant
- - value: conflict
- description: Conflict with other rules.
- name: conflict
- - value: error
- description: Error.
- name: error
- - value: inGracePeriod
- description: Device is non-compliant but still has access to corporate resources
- name: inGracePeriod
- - value: configManager
- description: Managed by Config Manager
- name: configManager
- microsoft.graph.configurationManagerClientEnabledFeatures:
- title: configurationManagerClientEnabledFeatures
- type: object
- properties:
- compliancePolicy:
- type: boolean
- description: Whether compliance policy is managed by Intune
- deviceConfiguration:
- type: boolean
- description: Whether device configuration is managed by Intune
- endpointProtection:
- type: boolean
- description: Whether Endpoint Protection is managed by Intune
- inventory:
- type: boolean
- description: Whether inventory is managed by Intune
- modernApps:
- type: boolean
- description: Whether modern application is managed by Intune
- officeApps:
- type: boolean
- description: Whether Office application is managed by Intune
- resourceAccess:
- type: boolean
- description: Whether resource access is managed by Intune
- windowsUpdateForBusiness:
- type: boolean
- description: Whether Windows Update for Business is managed by Intune
- additionalProperties:
- type: object
- description: configuration Manager client enabled features
- microsoft.graph.configurationManagerClientHealthState:
- title: configurationManagerClientHealthState
- type: object
- properties:
- errorCode:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Error code for failed state.
- format: int32
- 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: Datetime for last sync with configuration manager management point.
- format: date-time
- state:
- $ref: '#/components/schemas/microsoft.graph.configurationManagerClientState'
- additionalProperties:
- type: object
- description: Configuration manager client health state
- microsoft.graph.configurationManagerClientInformation:
- title: configurationManagerClientInformation
- type: object
- properties:
- clientIdentifier:
- type: string
- description: Configuration Manager Client Id from SCCM
- nullable: true
- clientVersion:
- type: string
- description: Configuration Manager Client version from SCCM
- nullable: true
- isBlocked:
- type: boolean
- description: Configuration Manager Client blocked status from SCCM
- additionalProperties:
- type: object
- description: Configuration Manager client information synced from SCCM
- microsoft.graph.deviceActionResult:
- title: deviceActionResult
- type: object
- properties:
- actionName:
- type: string
- description: Action name
- nullable: true
- actionState:
- $ref: '#/components/schemas/microsoft.graph.actionState'
- lastUpdatedDateTime:
- 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: Time the action state was last updated
- format: date-time
- startDateTime:
- 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: Time the action was initiated
- format: date-time
- additionalProperties:
- type: object
- description: Device action result
- microsoft.graph.deviceEnrollmentType:
- title: deviceEnrollmentType
- enum:
- - unknown
- - userEnrollment
- - deviceEnrollmentManager
- - appleBulkWithUser
- - appleBulkWithoutUser
- - windowsAzureADJoin
- - windowsBulkUserless
- - windowsAutoEnrollment
- - windowsBulkAzureDomainJoin
- - windowsCoManagement
- - windowsAzureADJoinUsingDeviceAuth
- - appleUserEnrollment
- - appleUserEnrollmentWithServiceAccount
- - azureAdJoinUsingAzureVmExtension
- - androidEnterpriseDedicatedDevice
- - androidEnterpriseFullyManaged
- - androidEnterpriseCorporateWorkProfile
- type: string
- description: Possible ways of adding a mobile device to management.
- x-ms-enum:
- name: deviceEnrollmentType
- modelAsString: false
- values:
- - value: unknown
- description: 'Default value, enrollment type was not collected.'
- name: unknown
- - value: userEnrollment
- description: User driven enrollment through BYOD channel.
- name: userEnrollment
- - value: deviceEnrollmentManager
- description: User enrollment with a device enrollment manager account.
- name: deviceEnrollmentManager
- - value: appleBulkWithUser
- description: 'Apple bulk enrollment with user challenge. (DEP, Apple Configurator)'
- name: appleBulkWithUser
- - value: appleBulkWithoutUser
- description: 'Apple bulk enrollment without user challenge. (DEP, Apple Configurator, Mobile Config)'
- name: appleBulkWithoutUser
- - value: windowsAzureADJoin
- description: Windows 10 Azure AD Join.
- name: windowsAzureADJoin
- - value: windowsBulkUserless
- description: Windows 10 Bulk enrollment through ICD with certificate.
- name: windowsBulkUserless
- - value: windowsAutoEnrollment
- description: Windows 10 automatic enrollment. (Add work account)
- name: windowsAutoEnrollment
- - value: windowsBulkAzureDomainJoin
- description: Windows 10 bulk Azure AD Join.
- name: windowsBulkAzureDomainJoin
- - value: windowsCoManagement
- description: Windows 10 Co-Management triggered by AutoPilot or Group Policy.
- name: windowsCoManagement
- - value: windowsAzureADJoinUsingDeviceAuth
- description: Windows 10 Azure AD Join using Device Auth.
- name: windowsAzureADJoinUsingDeviceAuth
- - value: appleUserEnrollment
- description: Device managed by Apple user enrollment
- name: appleUserEnrollment
- - value: appleUserEnrollmentWithServiceAccount
- description: Device managed by Apple user enrollment with service account
- name: appleUserEnrollmentWithServiceAccount
- - value: azureAdJoinUsingAzureVmExtension
- description: Azure AD Join enrollment when an Azure VM is provisioned
- name: azureAdJoinUsingAzureVmExtension
- - value: androidEnterpriseDedicatedDevice
- description: Android Enterprise Dedicated Device
- name: androidEnterpriseDedicatedDevice
- - value: androidEnterpriseFullyManaged
- description: Android Enterprise Fully Managed
- name: androidEnterpriseFullyManaged
- - value: androidEnterpriseCorporateWorkProfile
- description: Android Enterprise Corporate Work Profile
- name: androidEnterpriseCorporateWorkProfile
- microsoft.graph.deviceHealthAttestationState:
- title: deviceHealthAttestationState
- type: object
- properties:
- attestationIdentityKey:
- type: string
- description: 'TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.'
- nullable: true
- bitLockerStatus:
- type: string
- description: On or Off of BitLocker Drive Encryption
- nullable: true
- bootAppSecurityVersion:
- type: string
- description: The security version number of the Boot Application
- nullable: true
- bootDebugging:
- type: string
- description: 'When bootDebugging is enabled, the device is used in development and testing'
- nullable: true
- bootManagerSecurityVersion:
- type: string
- description: The security version number of the Boot Application
- nullable: true
- bootManagerVersion:
- type: string
- description: The version of the Boot Manager
- nullable: true
- bootRevisionListInfo:
- type: string
- description: The Boot Revision List that was loaded during initial boot on the attested device
- nullable: true
- codeIntegrity:
- type: string
- description: 'When code integrity is enabled, code execution is restricted to integrity verified code'
- nullable: true
- codeIntegrityCheckVersion:
- type: string
- description: The version of the Boot Manager
- nullable: true
- codeIntegrityPolicy:
- type: string
- description: The Code Integrity policy that is controlling the security of the boot environment
- nullable: true
- contentNamespaceUrl:
- type: string
- description: The DHA report version. (Namespace version)
- nullable: true
- contentVersion:
- type: string
- description: The HealthAttestation state schema version
- nullable: true
- dataExcutionPolicy:
- type: string
- description: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory
- nullable: true
- deviceHealthAttestationStatus:
- type: string
- description: The DHA report version. (Namespace version)
- nullable: true
- earlyLaunchAntiMalwareDriverProtection:
- type: string
- description: ELAM provides protection for the computers in your network when they start up
- nullable: true
- firmwareProtection:
- $ref: '#/components/schemas/microsoft.graph.firmwareProtectionType'
- healthAttestationSupportedStatus:
- type: string
- description: This attribute indicates if DHA is supported for the device
- nullable: true
- healthStatusMismatchInfo:
- type: string
- description: This attribute appears if DHA-Service detects an integrity issue
- nullable: true
- issuedDateTime:
- 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 was evaluated or issued to MDM
- format: date-time
- lastUpdateDateTime:
- type: string
- description: The Timestamp of the last update.
- nullable: true
- memoryAccessProtection:
- $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
- memoryIntegrityProtection:
- $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
- operatingSystemKernelDebugging:
- type: string
- description: 'When operatingSystemKernelDebugging is enabled, the device is used in development and testing'
- nullable: true
- operatingSystemRevListInfo:
- type: string
- description: The Operating System Revision List that was loaded during initial boot on the attested device
- nullable: true
- pcr0:
- type: string
- description: 'The measurement that is captured in PCR[0]'
- nullable: true
- pcrHashAlgorithm:
- type: string
- description: Informational attribute that identifies the HASH algorithm that was used by TPM
- nullable: true
- resetCount:
- type: integer
- description: The number of times a PC device has hibernated or resumed
- format: int64
- restartCount:
- type: integer
- description: The number of times a PC device has rebooted
- format: int64
- safeMode:
- type: string
- description: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state
- nullable: true
- secureBoot:
- type: string
- description: 'When Secure Boot is enabled, the core components must have the correct cryptographic signatures'
- nullable: true
- secureBootConfigurationPolicyFingerPrint:
- type: string
- description: Fingerprint of the Custom Secure Boot Configuration Policy
- nullable: true
- securedCorePC:
- $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
- systemManagementMode:
- $ref: '#/components/schemas/microsoft.graph.systemManagementModeLevel'
- testSigning:
- type: string
- description: 'When test signing is allowed, the device does not enforce signature validation during boot'
- nullable: true
- tpmVersion:
- type: string
- description: The security version number of the Boot Application
- nullable: true
- virtualizationBasedSecurity:
- $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
- virtualSecureMode:
- type: string
- description: VSM is a container that protects high value assets from a compromised kernel
- nullable: true
- windowsPE:
- type: string
- description: Operating system running with limited services that is used to prepare a computer for Windows
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.deviceRegistrationState:
- title: deviceRegistrationState
- enum:
- - notRegistered
- - registered
- - revoked
- - keyConflict
- - approvalPending
- - certificateReset
- - notRegisteredPendingEnrollment
- - unknown
- type: string
- description: Device registration status.
- x-ms-enum:
- name: deviceRegistrationState
- modelAsString: false
- values:
- - value: notRegistered
- description: The device is not registered.
- name: notRegistered
- - value: registered
- description: The device is registered.
- name: registered
- - value: revoked
- description: 'The device has been blocked, wiped or retired.'
- name: revoked
- - value: keyConflict
- description: The device has a key conflict.
- name: keyConflict
- - value: approvalPending
- description: The device is pending approval.
- name: approvalPending
- - value: certificateReset
- description: The device certificate has been reset.
- name: certificateReset
- - value: notRegisteredPendingEnrollment
- description: The device is not registered and pending enrollment.
- name: notRegisteredPendingEnrollment
- - value: unknown
- description: The device registration status is unknown.
- name: unknown
- microsoft.graph.deviceType:
- title: deviceType
- enum:
- - desktop
- - windowsRT
- - winMO6
- - nokia
- - windowsPhone
- - mac
- - winCE
- - winEmbedded
- - iPhone
- - iPad
- - iPod
- - android
- - iSocConsumer
- - unix
- - macMDM
- - holoLens
- - surfaceHub
- - androidForWork
- - androidEnterprise
- - windows10x
- - androidnGMS
- - chromeOS
- - linux
- - blackberry
- - palm
- - unknown
- - cloudPC
- type: string
- description: Device type.
- x-ms-enum:
- name: deviceType
- modelAsString: false
- values:
- - value: desktop
- description: Desktop.
- name: desktop
- - value: windowsRT
- description: WindowsRT.
- name: windowsRT
- - value: winMO6
- description: WinMO6.
- name: winMO6
- - value: nokia
- description: Nokia.
- name: nokia
- - value: windowsPhone
- description: Windows phone.
- name: windowsPhone
- - value: mac
- description: Mac.
- name: mac
- - value: winCE
- description: WinCE.
- name: winCE
- - value: winEmbedded
- description: WinEmbedded.
- name: winEmbedded
- - value: iPhone
- description: iPhone.
- name: iPhone
- - value: iPad
- description: iPad.
- name: iPad
- - value: iPod
- description: iPodTouch.
- name: iPod
- - value: android
- description: Android.
- name: android
- - value: iSocConsumer
- description: iSocConsumer.
- name: iSocConsumer
- - value: unix
- description: Unix.
- name: unix
- - value: macMDM
- description: Mac OS X client using built in MDM agent.
- name: macMDM
- - value: holoLens
- description: Representing the fancy Windows 10 goggles.
- name: holoLens
- - value: surfaceHub
- description: Surface HUB device.
- name: surfaceHub
- - value: androidForWork
- description: Android for work device.
- name: androidForWork
- - value: androidEnterprise
- description: Android enterprise device.
- name: androidEnterprise
- - value: windows10x
- description: Windows 10x device.
- name: windows10x
- - value: androidnGMS
- description: Android non Google managed device.
- name: androidnGMS
- - value: chromeOS
- description: ChromeOS device.
- name: chromeOS
- - value: linux
- description: Linux device.
- name: linux
- - value: blackberry
- description: Blackberry.
- name: blackberry
- - value: palm
- description: Palm.
- name: palm
- - value: unknown
- description: Represents that the device type is unknown.
- name: unknown
- - value: cloudPC
- description: Cloud PC device.
- name: cloudPC
- microsoft.graph.deviceManagementExchangeAccessState:
- title: deviceManagementExchangeAccessState
- enum:
- - none
- - unknown
- - allowed
- - blocked
- - quarantined
- type: string
- description: Device Exchange Access State.
- x-ms-enum:
- name: deviceManagementExchangeAccessState
- modelAsString: false
- values:
- - value: none
- description: No access state discovered from Exchange
- name: none
- - value: unknown
- description: Device access state to Exchange is unknown
- name: unknown
- - value: allowed
- description: Device has access to Exchange
- name: allowed
- - value: blocked
- description: Device is Blocked in Exchange
- name: blocked
- - value: quarantined
- description: Device is Quarantined in Exchange
- name: quarantined
- microsoft.graph.deviceManagementExchangeAccessStateReason:
- title: deviceManagementExchangeAccessStateReason
- enum:
- - none
- - unknown
- - exchangeGlobalRule
- - exchangeIndividualRule
- - exchangeDeviceRule
- - exchangeUpgrade
- - exchangeMailboxPolicy
- - other
- - compliant
- - notCompliant
- - notEnrolled
- - unknownLocation
- - mfaRequired
- - azureADBlockDueToAccessPolicy
- - compromisedPassword
- - deviceNotKnownWithManagedApp
- type: string
- description: Device Exchange Access State Reason.
- x-ms-enum:
- name: deviceManagementExchangeAccessStateReason
- modelAsString: false
- values:
- - value: none
- description: No access state reason discovered from Exchange
- name: none
- - value: unknown
- description: Unknown access state reason
- name: unknown
- - value: exchangeGlobalRule
- description: Access state determined by Exchange Global rule
- name: exchangeGlobalRule
- - value: exchangeIndividualRule
- description: Access state determined by Exchange Individual rule
- name: exchangeIndividualRule
- - value: exchangeDeviceRule
- description: Access state determined by Exchange Device rule
- name: exchangeDeviceRule
- - value: exchangeUpgrade
- description: Access state due to Exchange upgrade
- name: exchangeUpgrade
- - value: exchangeMailboxPolicy
- description: Access state determined by Exchange Mailbox Policy
- name: exchangeMailboxPolicy
- - value: other
- description: Access state determined by Exchange
- name: other
- - value: compliant
- description: Access state granted by compliance challenge
- name: compliant
- - value: notCompliant
- description: Access state revoked by compliance challenge
- name: notCompliant
- - value: notEnrolled
- description: Access state revoked by management challenge
- name: notEnrolled
- - value: unknownLocation
- description: Access state due to unknown location
- name: unknownLocation
- - value: mfaRequired
- description: Access state due to MFA challenge
- name: mfaRequired
- - value: azureADBlockDueToAccessPolicy
- description: Access State revoked by AAD Access Policy
- name: azureADBlockDueToAccessPolicy
- - value: compromisedPassword
- description: Access State revoked by compromised password
- name: compromisedPassword
- - value: deviceNotKnownWithManagedApp
- description: Access state revoked by managed application challenge
- name: deviceNotKnownWithManagedApp
- microsoft.graph.hardwareInformation:
- title: hardwareInformation
+ items:
+ $ref: '#/components/schemas/microsoft.graph.sharedInsight'
+ description: Access this property from the derived type itemInsights.
+ x-ms-navigationProperty: true
+ trending:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.trending'
+ description: Access this property from the derived type itemInsights.
+ x-ms-navigationProperty: true
+ used:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.usedInsight'
+ description: Access this property from the derived type itemInsights.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.teamDiscoverySettings:
+ title: teamDiscoverySettings
type: object
properties:
- batteryChargeCycles:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The number of charge cycles the device’s current battery has gone through. Valid values 0 to 2147483647
- format: int32
- batteryHealthPercentage:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The device’s current battery’s health percentage. Valid values 0 to 100
- format: int32
- batteryLevelPercentage:
- type: number
- description: 'The battery level, between 0.0 and 100, or null if the battery level cannot be determined. The update frequency of this property is per-checkin. Note this property is currently supported only on devices running iOS 5.0 and later, and is available only when Device Information access right is obtained. Valid values 0 to 100'
- format: double
- nullable: true
- batterySerialNumber:
- type: string
- description: The serial number of the device’s current battery
- nullable: true
- cellularTechnology:
- type: string
- description: Cellular technology of the device
- nullable: true
- deviceFullQualifiedDomainName:
- type: string
- description: 'Returns the fully qualified domain name of the device (if any). If the device is not domain-joined, it returns an empty string.'
- nullable: true
- deviceGuardLocalSystemAuthorityCredentialGuardState:
- $ref: '#/components/schemas/microsoft.graph.deviceGuardLocalSystemAuthorityCredentialGuardState'
- deviceGuardVirtualizationBasedSecurityHardwareRequirementState:
- $ref: '#/components/schemas/microsoft.graph.deviceGuardVirtualizationBasedSecurityHardwareRequirementState'
- deviceGuardVirtualizationBasedSecurityState:
- $ref: '#/components/schemas/microsoft.graph.deviceGuardVirtualizationBasedSecurityState'
- deviceLicensingLastErrorCode:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'A standard error code indicating the last error, or 0 indicating no error (default). The update frequency of this property is daily. Note this property is currently supported only for Windows based Device based subscription licensing. Valid values 0 to 2147483647'
- format: int32
- deviceLicensingLastErrorDescription:
- type: string
- description: Error text message as a descripition for deviceLicensingLastErrorCode. The update frequency of this property is daily. Note this property is currently supported only for Windows based Device based subscription licensing.
- nullable: true
- deviceLicensingStatus:
- $ref: '#/components/schemas/microsoft.graph.deviceLicensingStatus'
- esimIdentifier:
- type: string
- description: eSIM identifier
- nullable: true
- freeStorageSpace:
- type: integer
- description: Free storage space of the device.
- format: int64
- imei:
- type: string
- description: IMEI
- nullable: true
- ipAddressV4:
- type: string
- description: IPAddressV4
- nullable: true
- isEncrypted:
- type: boolean
- description: Encryption status of the device
- isSharedDevice:
- type: boolean
- description: Shared iPad
- isSupervised:
+ showInTeamsSearchAndSuggestions:
type: boolean
- description: Supervised mode of the device
- manufacturer:
- type: string
- description: Manufacturer of the device
- nullable: true
- meid:
- type: string
- description: MEID
- nullable: true
- model:
- type: string
- description: Model of the device
+ description: 'If set to true, the team is visible via search and suggestions from the Teams client.'
nullable: true
- operatingSystemEdition:
- type: string
- description: String that specifies the OS edition.
+ additionalProperties:
+ type: object
+ microsoft.graph.teamFunSettings:
+ title: teamFunSettings
+ type: object
+ properties:
+ allowCustomMemes:
+ type: boolean
+ description: 'If set to true, enables users to include custom memes.'
nullable: true
- operatingSystemLanguage:
- type: string
- description: Operating system language of the device
+ allowGiphy:
+ type: boolean
+ description: 'If set to true, enables Giphy use.'
nullable: true
- operatingSystemProductType:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Int that specifies the Windows Operating System ProductType. More details here https://go.microsoft.com/fwlink/?linkid=2126950. Valid values 0 to 2147483647
- format: int32
- osBuildNumber:
- type: string
- description: Operating System Build Number on Android device
+ allowStickersAndMemes:
+ type: boolean
+ description: 'If set to true, enables users to include stickers and memes.'
nullable: true
- phoneNumber:
- type: string
- description: Phone number of the device
+ giphyContentRating:
+ $ref: '#/components/schemas/microsoft.graph.giphyRatingType'
+ additionalProperties:
+ type: object
+ microsoft.graph.teamGuestSettings:
+ title: teamGuestSettings
+ type: object
+ properties:
+ allowCreateUpdateChannels:
+ type: boolean
+ description: 'If set to true, guests can add and update channels.'
nullable: true
- productName:
- type: string
- description: 'The product name, e.g. iPad8,12 etc. The update frequency of this property is weekly. Note this property is currently supported only on iOS/MacOS devices, and is available only when Device Information access right is obtained.'
+ allowDeleteChannels:
+ type: boolean
+ description: 'If set to true, guests can delete channels.'
nullable: true
- residentUsersCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'The number of users currently on this device, or null (default) if the value of this property cannot be determined. The update frequency of this property is per-checkin. Note this property is currently supported only on devices running iOS 13.4 and later, and is available only when Device Information access right is obtained. Valid values 0 to 2147483647'
- format: int32
+ additionalProperties:
+ type: object
+ microsoft.graph.teamMemberSettings:
+ title: teamMemberSettings
+ type: object
+ properties:
+ allowAddRemoveApps:
+ type: boolean
+ description: 'If set to true, members can add and remove apps.'
nullable: true
- serialNumber:
- type: string
- description: Serial number.
+ allowCreatePrivateChannels:
+ type: boolean
+ description: 'If set to true, members can add and update private channels.'
nullable: true
- sharedDeviceCachedUsers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.sharedAppleDeviceUser'
- description: All users on the shared Apple device
- subnetAddress:
- type: string
- description: SubnetAddress
+ allowCreateUpdateChannels:
+ type: boolean
+ description: 'If set to true, members can add and update any channels.'
nullable: true
- subscriberCarrier:
- type: string
- description: Subscriber carrier of the device
+ allowCreateUpdateRemoveConnectors:
+ type: boolean
+ description: 'If set to true, members can add, update, and remove connectors.'
nullable: true
- systemManagementBIOSVersion:
- type: string
- description: BIOS version as reported by SMBIOS
+ allowCreateUpdateRemoveTabs:
+ type: boolean
+ description: 'If set to true, members can add, update, and remove tabs.'
nullable: true
- totalStorageSpace:
- type: integer
- description: Total storage space of the device.
- format: int64
- tpmManufacturer:
- type: string
- description: The identifying information that uniquely names the TPM manufacturer
+ allowDeleteChannels:
+ type: boolean
+ description: 'If set to true, members can delete channels.'
nullable: true
- tpmSpecificationVersion:
- type: string
- description: String that specifies the specification version.
+ additionalProperties:
+ type: object
+ microsoft.graph.teamMessagingSettings:
+ title: teamMessagingSettings
+ type: object
+ properties:
+ allowChannelMentions:
+ type: boolean
+ description: 'If set to true, @channel mentions are allowed.'
nullable: true
- tpmVersion:
- type: string
- description: 'The version of the TPM, as specified by the manufacturer'
+ allowOwnerDeleteMessages:
+ type: boolean
+ description: 'If set to true, owners can delete any message.'
nullable: true
- wifiMac:
- type: string
- description: WiFi MAC address of the device
+ allowTeamMentions:
+ type: boolean
+ description: 'If set to true, @team mentions are allowed.'
nullable: true
- wiredIPv4Addresses:
- type: array
- items:
- type: string
- nullable: true
- description: A list of wired IPv4 addresses. The update frequency (the maximum delay for the change of property value to be synchronized from the device to the cloud storage) of this property is daily. Note this property is currently supported only on devices running on Windows.
- additionalProperties:
- type: object
- description: Hardware information of a given device.
- microsoft.graph.joinType:
- title: joinType
- enum:
- - unknown
- - azureADJoined
- - azureADRegistered
- - hybridAzureADJoined
- type: string
- description: Device enrollment join type.
- x-ms-enum:
- name: joinType
- modelAsString: false
- values:
- - value: unknown
- description: Unknown enrollment join type.
- name: unknown
- - value: azureADJoined
- description: The device is joined by Azure AD.
- name: azureADJoined
- - value: azureADRegistered
- description: The device is registered by Azure AD.
- name: azureADRegistered
- - value: hybridAzureADJoined
- description: The device is joined by hybrid Azure AD.
- name: hybridAzureADJoined
- microsoft.graph.lostModeState:
- title: lostModeState
- enum:
- - disabled
- - enabled
- type: string
- description: 'State of lost mode, indicating if lost mode is enabled or disabled'
- x-ms-enum:
- name: lostModeState
- modelAsString: false
- values:
- - value: disabled
- description: Lost mode is disabled.
- name: disabled
- - value: enabled
- description: Lost mode is enabled.
- name: enabled
- microsoft.graph.managedDeviceOwnerType:
- title: managedDeviceOwnerType
- enum:
- - unknown
- - company
- - personal
- type: string
- description: Owner type of device.
- x-ms-enum:
- name: managedDeviceOwnerType
- modelAsString: false
- values:
- - value: unknown
- description: Unknown.
- name: unknown
- - value: company
- description: Owned by company.
- name: company
- - value: personal
- description: Owned by person.
- name: personal
- microsoft.graph.managementAgentType:
- title: managementAgentType
- enum:
- - eas
- - mdm
- - easMdm
- - intuneClient
- - easIntuneClient
- - configurationManagerClient
- - configurationManagerClientMdm
- - configurationManagerClientMdmEas
- - unknown
- - jamf
- - googleCloudDevicePolicyController
- - microsoft365ManagedMdm
- - msSense
- - intuneAosp
- type: string
- description: Management agent type.
- x-ms-enum:
- name: managementAgentType
- modelAsString: false
- values:
- - value: eas
- description: The device is managed by Exchange server.
- name: eas
- - value: mdm
- description: The device is managed by Intune MDM.
- name: mdm
- - value: easMdm
- description: The device is managed by both Exchange server and Intune MDM.
- name: easMdm
- - value: intuneClient
- description: Intune client managed.
- name: intuneClient
- - value: easIntuneClient
- description: The device is EAS and Intune client dual managed.
- name: easIntuneClient
- - value: configurationManagerClient
- description: The device is managed by Configuration Manager.
- name: configurationManagerClient
- - value: configurationManagerClientMdm
- description: The device is managed by Configuration Manager and MDM.
- name: configurationManagerClientMdm
- - value: configurationManagerClientMdmEas
- description: 'The device is managed by Configuration Manager, MDM and Eas.'
- name: configurationManagerClientMdmEas
- - value: unknown
- description: Unknown management agent type.
- name: unknown
- - value: jamf
- description: The device attributes are fetched from Jamf.
- name: jamf
- - value: googleCloudDevicePolicyController
- description: The device is managed by Google's CloudDPC.
- name: googleCloudDevicePolicyController
- - value: microsoft365ManagedMdm
- description: This device is managed by Microsoft 365 through Intune.
- name: microsoft365ManagedMdm
- - value: intuneAosp
- description: This device is managed by Intune's MDM for AOSP (Android Open Source Project) devices
- name: intuneAosp
- microsoft.graph.managedDeviceManagementFeatures:
- title: managedDeviceManagementFeatures
- enum:
- - none
- - microsoftManagedDesktop
- type: string
- description: Device management features.
- x-ms-enum:
- name: managedDeviceManagementFeatures
- modelAsString: false
- values:
- - value: none
- description: Unknown device management features.
- name: none
- - value: microsoftManagedDesktop
- description: Microsoft Managed Desktop
- name: microsoftManagedDesktop
- microsoft.graph.managementState:
- title: managementState
- enum:
- - managed
- - retirePending
- - retireFailed
- - wipePending
- - wipeFailed
- - unhealthy
- - deletePending
- - retireIssued
- - wipeIssued
- - wipeCanceled
- - retireCanceled
- - discovered
- type: string
- description: Management state of device in Microsoft Intune.
- x-ms-enum:
- name: managementState
- modelAsString: false
- values:
- - value: managed
- description: The device is under management
- name: managed
- - value: retirePending
- description: A retire command is occuring on the device and in the process of unenrolling from management
- name: retirePending
- - value: retireFailed
- description: Retire command failed on the device
- name: retireFailed
- - value: wipePending
- description: A wipe command is occuring on the device and in the process of unenrolling from management
- name: wipePending
- - value: wipeFailed
- description: Wipe command failed on the device
- name: wipeFailed
- - value: unhealthy
- description: The device is unhealthy.
- name: unhealthy
- - value: deletePending
- description: 'A delete command is occuring on the device '
- name: deletePending
- - value: retireIssued
- description: A retire command was issued for the device
- name: retireIssued
- - value: wipeIssued
- description: A wipe command was issued for the device
- name: wipeIssued
- - value: wipeCanceled
- description: A wipe command for this device has been canceled
- name: wipeCanceled
- - value: retireCanceled
- description: A retire command for this device has been canceled
- name: retireCanceled
- - value: discovered
- description: The device is discovered but not fully enrolled.
- name: discovered
- microsoft.graph.ownerType:
- title: ownerType
- enum:
- - unknown
- - company
- - personal
- type: string
- description: Owner type of device.
- x-ms-enum:
- name: ownerType
- modelAsString: false
- values:
- - value: unknown
- description: Unknown.
- name: unknown
- - value: company
- description: Owned by company.
- name: company
- - value: personal
- description: Owned by person.
- name: personal
- microsoft.graph.managedDevicePartnerReportedHealthState:
- title: managedDevicePartnerReportedHealthState
- enum:
- - unknown
- - activated
- - deactivated
- - secured
- - lowSeverity
- - mediumSeverity
- - highSeverity
- - unresponsive
- - compromised
- - misconfigured
- type: string
- description: Available health states for the Device Health API
- x-ms-enum:
- name: managedDevicePartnerReportedHealthState
- modelAsString: false
- values:
- - value: unknown
- description: Device health state is not yet reported
- name: unknown
- - value: activated
- description: 'Device has been activated by a mobile threat defense partner, but has not yet reported health.'
- name: activated
- - value: deactivated
- description: Device has been deactivated by a mobile threat defense partner. The device health is not known.
- name: deactivated
- - value: secured
- description: Device is considered secured by the mobile threat defense partner.
- name: secured
- - value: lowSeverity
- description: Device is considered low threat by the mobile threat defense partner.
- name: lowSeverity
- - value: mediumSeverity
- description: Device is considered medium threat by the mobile threat defense partner.
- name: mediumSeverity
- - value: highSeverity
- description: Device is considered high threat by the mobile threat defense partner.
- name: highSeverity
- - value: unresponsive
- description: Device is considered unresponsive by the mobile threat defense partner. The device health is not known.
- name: unresponsive
- - value: compromised
- description: Device is considered compromised by the Threat Defense partner. This means the device has an active Threat or Risk which cannot be easily remediated by the end user and the user should contact their IT Admin.
- name: compromised
- - value: misconfigured
- description: Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.
- name: misconfigured
- microsoft.graph.managedDeviceArchitecture:
- title: managedDeviceArchitecture
+ allowUserDeleteMessages:
+ type: boolean
+ description: 'If set to true, users can delete their messages.'
+ nullable: true
+ allowUserEditMessages:
+ type: boolean
+ description: 'If set to true, users can edit their messages.'
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.teamSpecialization:
+ title: teamSpecialization
enum:
- - unknown
- - x86
- - x64
- - arm
- - arM64
+ - none
+ - educationStandard
+ - educationClass
+ - educationProfessionalLearningCommunity
+ - educationStaff
+ - healthcareStandard
+ - healthcareCareCoordination
+ - unknownFutureValue
type: string
- description: Processor architecture
- x-ms-enum:
- name: managedDeviceArchitecture
- modelAsString: false
- values:
- - value: unknown
- description: Unknown architecture
- name: unknown
- - value: x86
- description: X86
- name: x86
- - value: x64
- description: X64
- name: x64
- - value: arm
- description: ARM
- name: arm
- - value: arM64
- description: ARM64
- name: arM64
- microsoft.graph.loggedOnUser:
- title: loggedOnUser
+ microsoft.graph.teamSummary:
+ title: teamSummary
type: object
properties:
- lastLogOnDateTime:
- 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 time when user logs on
- format: date-time
- userId:
- type: string
- description: User id
+ guestsCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Count of guests in a team.
+ format: int32
+ nullable: true
+ membersCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Count of members in a team.
+ format: int32
+ nullable: true
+ ownersCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Count of owners in a team.
+ format: int32
nullable: true
additionalProperties:
type: object
- description: Logged On User
- microsoft.graph.assignmentFilterEvaluationStatusDetails:
+ microsoft.graph.teamVisibilityType:
+ title: teamVisibilityType
+ enum:
+ - private
+ - public
+ - hiddenMembership
+ - unknownFutureValue
+ type: string
+ microsoft.graph.channel:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: assignmentFilterEvaluationStatusDetails
+ - title: channel
type: object
properties:
- payloadId:
+ 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: PayloadId on which filter has been applied.
+ description: Read only. Timestamp at which the channel was created.
+ format: date-time
nullable: true
- additionalProperties:
- type: object
- description: A class containing information about the payloads on which filter has been applied.
- microsoft.graph.deviceCompliancePolicyState:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: deviceCompliancePolicyState
- type: object
- properties:
- displayName:
+ description:
type: string
- description: The name of the policy for this policyBase
+ description: Optional textual description for the channel.
nullable: true
- platformType:
- $ref: '#/components/schemas/microsoft.graph.policyPlatformType'
- settingCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Count of how many setting a policy holds
- format: int32
- settingStates:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicySettingState'
- state:
- $ref: '#/components/schemas/microsoft.graph.complianceStatus'
- userId:
+ displayName:
type: string
- description: 'User unique identifier, must be Guid'
- nullable: true
- userPrincipalName:
+ description: Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
+ email:
type: string
- description: User Principal Name
+ description: The email address for sending messages to the channel. Read-only.
nullable: true
- version:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The version of the policy
- format: int32
- additionalProperties:
- type: object
- description: Device Compliance Policy State for a given device.
- microsoft.graph.deviceConfigurationState:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: deviceConfigurationState
- type: object
- properties:
- displayName:
- type: string
- description: The name of the policy for this policyBase
+ isFavoriteByDefault:
+ type: boolean
+ description: 'Indicates whether the channel should automatically be marked ''favorite'' for all members of the team. Can only be set programmatically with Create team. Default: false.'
nullable: true
- platformType:
- $ref: '#/components/schemas/microsoft.graph.policyPlatformType'
- settingCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Count of how many setting a policy holds
- format: int32
- settingStates:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.deviceConfigurationSettingState'
- state:
- $ref: '#/components/schemas/microsoft.graph.complianceStatus'
- userId:
+ membershipType:
+ $ref: '#/components/schemas/microsoft.graph.channelMembershipType'
+ moderationSettings:
+ $ref: '#/components/schemas/microsoft.graph.channelModerationSettings'
+ summary:
+ $ref: '#/components/schemas/microsoft.graph.channelSummary'
+ tenantId:
type: string
- description: 'User unique identifier, must be Guid'
+ description: The ID of the Microsoft Entra tenant.
nullable: true
- userPrincipalName:
+ webUrl:
type: string
- description: User Principal Name
+ description: 'A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.'
nullable: true
- version:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The version of the policy
- format: int32
+ filesFolder:
+ $ref: '#/components/schemas/microsoft.graph.driveItem'
+ members:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.conversationMember'
+ description: A collection of membership records associated with the channel.
+ x-ms-navigationProperty: true
+ messages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.chatMessage'
+ description: A collection of all the messages in the channel. A navigation property. Nullable.
+ x-ms-navigationProperty: true
+ sharedWithTeams:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
+ description: A collection of teams with which a channel is shared.
+ x-ms-navigationProperty: true
+ tabs:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.teamsTab'
+ description: A collection of all the tabs in the channel. A navigation property.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- description: Device Configuration State for a given device.
- microsoft.graph.managedDeviceMobileAppConfigurationState:
+ microsoft.graph.schedule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: managedDeviceMobileAppConfigurationState
+ - title: schedule
type: object
properties:
- displayName:
- type: string
- description: The name of the policy for this policyBase
+ enabled:
+ type: boolean
+ description: Indicates whether the schedule is enabled for the team. Required.
nullable: true
- platformType:
- $ref: '#/components/schemas/microsoft.graph.policyPlatformType'
- settingCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Count of how many setting a policy holds
- format: int32
- settingStates:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationSettingState'
- state:
- $ref: '#/components/schemas/microsoft.graph.complianceStatus'
- userId:
- type: string
- description: 'User unique identifier, must be Guid'
+ offerShiftRequestsEnabled:
+ type: boolean
+ description: Indicates whether offer shift requests are enabled for the schedule.
nullable: true
- userPrincipalName:
- type: string
- description: User Principal Name
+ openShiftsEnabled:
+ type: boolean
+ description: Indicates whether open shifts are enabled for the schedule.
nullable: true
- version:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The version of the policy
- format: int32
- additionalProperties:
- type: object
- description: Managed Device Mobile App Configuration State for a given device.
- microsoft.graph.securityBaselineState:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: securityBaselineState
- type: object
- properties:
- displayName:
- type: string
- description: The display name of the security baseline
- securityBaselineTemplateId:
+ provisionStatus:
+ $ref: '#/components/schemas/microsoft.graph.operationStatus'
+ provisionStatusCode:
type: string
- description: The security baseline template id
+ description: Additional information about why schedule provisioning failed.
nullable: true
- state:
- $ref: '#/components/schemas/microsoft.graph.securityBaselineComplianceState'
- userPrincipalName:
+ readOnly: true
+ swapShiftsRequestsEnabled:
+ type: boolean
+ description: Indicates whether swap shifts requests are enabled for the schedule.
+ nullable: true
+ timeClockEnabled:
+ type: boolean
+ description: Indicates whether time clock is enabled for the schedule.
+ nullable: true
+ timeClockSettings:
+ $ref: '#/components/schemas/microsoft.graph.timeClockSettings'
+ timeOffRequestsEnabled:
+ type: boolean
+ description: Indicates whether time off requests are enabled for the schedule.
+ nullable: true
+ timeZone:
type: string
- description: User Principal Name
+ description: Indicates the time zone of the schedule team using tz database format. Required.
nullable: true
- settingStates:
+ workforceIntegrationIds:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.securityBaselineSettingState'
- description: The security baseline state for different settings for a device
+ type: string
+ nullable: true
+ description: The Ids for the workforce integrations associated with this schedule.
+ dayNotes:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.dayNote'
+ x-ms-navigationProperty: true
+ offerShiftRequests:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
+ description: The offer requests for shifts in the schedule.
+ x-ms-navigationProperty: true
+ openShiftChangeRequests:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
+ description: The open shift requests in the schedule.
+ x-ms-navigationProperty: true
+ openShifts:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.openShift'
+ description: The set of open shifts in a scheduling group in the schedule.
+ x-ms-navigationProperty: true
+ schedulingGroups:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.schedulingGroup'
+ description: The logical grouping of users in the schedule (usually by role).
+ x-ms-navigationProperty: true
+ shifts:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.shift'
+ description: The shifts in the schedule.
+ x-ms-navigationProperty: true
+ swapShiftsChangeRequests:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
+ description: The swap requests for shifts in the schedule.
+ x-ms-navigationProperty: true
+ timeCards:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.timeCard'
+ x-ms-navigationProperty: true
+ timeOffReasons:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.timeOffReason'
+ description: The set of reasons for a time off in the schedule.
+ x-ms-navigationProperty: true
+ timeOffRequests:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.timeOffRequest'
+ description: The time off requests in the schedule.
+ x-ms-navigationProperty: true
+ timesOff:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.timeOff'
+ description: The instances of times off in the schedule.
x-ms-navigationProperty: true
additionalProperties:
type: object
- description: Security baseline state for a device.
- microsoft.graph.detectedApp:
+ microsoft.graph.teamworkTag:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: detectedApp
+ - title: teamworkTag
type: object
properties:
- deviceCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The number of devices that have installed this application
- format: int32
- displayName:
+ description:
type: string
- description: Name of the discovered application. Read-only
+ description: Tag description as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
nullable: true
- platform:
- $ref: '#/components/schemas/microsoft.graph.detectedAppPlatformType'
- publisher:
+ displayName:
type: string
- description: 'Indicates the publisher of the discovered application. For example: ''Microsoft''. The default value is an empty string.'
+ description: Tag name as it appears to the user in Microsoft Teams.
nullable: true
- sizeInByte:
+ memberCount:
+ maximum: 2147483647
+ minimum: -2147483648
type: integer
- description: Discovered application size in bytes. Read-only
- format: int64
- version:
+ description: The number of users assigned to the tag.
+ format: int32
+ nullable: true
+ tagType:
+ $ref: '#/components/schemas/microsoft.graph.teamworkTagType'
+ teamId:
type: string
- description: Version of the discovered application. Read-only
+ description: ID of the team in which the tag is defined.
nullable: true
- managedDevices:
+ members:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.managedDevice'
- description: The devices that have the discovered application installed
+ $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
+ description: Users assigned to the tag.
x-ms-navigationProperty: true
additionalProperties:
type: object
- description: A managed or unmanaged app that is installed on a managed device. Unmanaged apps will only appear for devices marked as corporate owned.
- microsoft.graph.deviceCategory:
+ microsoft.graph.teamsTemplate:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: deviceCategory
+ - title: teamsTemplate
type: object
- properties:
- description:
- type: string
- description: Optional description for the device category.
- nullable: true
- displayName:
- type: string
- description: Display name for the device category.
- nullable: true
- roleScopeTagIds:
- type: array
- items:
- type: string
- nullable: true
- description: Optional role scope tags for the device category.
additionalProperties:
type: object
- description: 'Device categories provides a way to organize your devices. Using device categories, company administrators can define their own categories that make sense to their company. These categories can then be applied to a device in the Intune Azure console or selected by a user during device enrollment. You can filter reports and create dynamic Azure Active Directory device groups based on device categories.'
- microsoft.graph.deviceHealthScriptPolicyState:
- title: deviceHealthScriptPolicyState
- type: object
- properties:
- assignmentFilterIds:
- type: array
- items:
- type: string
- nullable: true
- description: A list of the assignment filter ids used for health script applicability evaluation
- detectionState:
- $ref: '#/components/schemas/microsoft.graph.runState'
- deviceId:
- type: string
- description: The Intune device Id
- deviceName:
- type: string
- description: Display name of the device
- nullable: true
- expectedStateUpdateDateTime:
- 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 next timestamp of when the device health script is expected to execute
- format: date-time
- nullable: true
- id:
- type: string
- description: Key of the device health script policy state is a concatenation of the MT sideCar policy Id and Intune device Id
- lastStateUpdateDateTime:
- 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 timestamp of when the device health script executed
- format: date-time
- 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 that Intune Managment Extension synced with Intune
- format: date-time
- osVersion:
- type: string
- description: Value of the OS Version in string
- nullable: true
- policyId:
- type: string
- description: The MT sideCar policy Id
- policyName:
- type: string
- description: Display name of the device health script
- nullable: true
- postRemediationDetectionScriptError:
- type: string
- description: Error from the detection script after remediation
- nullable: true
- postRemediationDetectionScriptOutput:
- type: string
- description: Detection script output after remediation
- nullable: true
- preRemediationDetectionScriptError:
- type: string
- description: Error from the detection script before remediation
- nullable: true
- preRemediationDetectionScriptOutput:
- type: string
- description: Output of the detection script before remediation
- nullable: true
- remediationScriptError:
- type: string
- description: Error output of the remediation script
- nullable: true
- remediationState:
- $ref: '#/components/schemas/microsoft.graph.remediationState'
- userName:
- type: string
- description: Name of the user whom ran the device health script
- nullable: true
- additionalProperties:
- type: object
- description: Contains properties for policy run state of the device health script.
- microsoft.graph.deviceLogCollectionResponse:
+ microsoft.graph.teamTemplateDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: deviceLogCollectionResponse
+ - title: teamTemplateDefinition
type: object
properties:
- enrolledByUser:
+ audience:
+ $ref: '#/components/schemas/microsoft.graph.teamTemplateAudience'
+ categories:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: The assigned categories for the team template.
+ description:
type: string
- description: The User Principal Name (UPN) of the user that enrolled the device.
+ description: A brief description of the team template as it will appear to the users in Microsoft Teams.
nullable: true
- errorCode:
- type: integer
- description: 'The error code, if any. Valid values -9.22337203685478E+18 to 9.22337203685478E+18'
- format: int64
- expirationDateTimeUTC:
- 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])$'
+ displayName:
type: string
- description: The DateTime of the expiration of the logs.
- format: date-time
+ description: The user defined name of the team template.
nullable: true
- initiatedByUserPrincipalName:
+ iconUrl:
type: string
- description: The UPN for who initiated the request.
+ description: The icon url for the team template.
nullable: true
- managedDeviceId:
- 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}$'
+ languageTag:
type: string
- description: Indicates Intune device unique identifier.
- format: uuid
- receivedDateTimeUTC:
+ description: Language the template is available in.
+ nullable: true
+ lastModifiedBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ 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 DateTime the request was received.
+ description: The date time of when the team template was last modified.
format: date-time
nullable: true
- requestedDateTimeUTC:
- 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])$'
+ parentTemplateId:
type: string
- description: The DateTime of the request.
- format: date-time
+ description: The templateId for the team template
nullable: true
- size:
- type: number
- description: The size of the logs. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
- format: double
- sizeInKB:
- type: number
- description: The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
- format: double
- status:
- $ref: '#/components/schemas/microsoft.graph.appLogUploadState'
+ publisherName:
+ type: string
+ description: The organization which published the team template.
+ nullable: true
+ shortDescription:
+ type: string
+ description: A short-description of the team template as it will appear to the users in Microsoft Teams.
+ nullable: true
+ teamDefinition:
+ $ref: '#/components/schemas/microsoft.graph.team'
additionalProperties:
type: object
- description: Windows Log Collection request entity.
- microsoft.graph.windowsProtectionState:
+ microsoft.graph.messageRule:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: windowsProtectionState
+ - title: messageRule
type: object
properties:
- antiMalwareVersion:
- type: string
- description: Current anti malware version
- nullable: true
- deviceState:
- $ref: '#/components/schemas/microsoft.graph.windowsDeviceHealthState'
- engineVersion:
+ actions:
+ $ref: '#/components/schemas/microsoft.graph.messageRuleActions'
+ conditions:
+ $ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
+ displayName:
type: string
- description: Current endpoint protection engine's version
+ description: The display name of the rule.
nullable: true
- fullScanOverdue:
+ exceptions:
+ $ref: '#/components/schemas/microsoft.graph.messageRulePredicates'
+ hasError:
type: boolean
- description: 'When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.'
+ description: Indicates whether the rule is in an error condition. Read-only.
nullable: true
- fullScanRequired:
+ isEnabled:
type: boolean
- description: 'When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.'
+ description: Indicates whether the rule is enabled to be applied to messages.
nullable: true
- isVirtualMachine:
+ isReadOnly:
type: boolean
- description: 'When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.'
+ description: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.
nullable: true
- lastFullScanDateTime:
+ sequence:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'Indicates the order in which the rule is executed, among other rules.'
+ format: int32
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.userConfiguration:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: userConfiguration
+ type: object
+ properties:
+ binaryData:
+ type: string
+ format: base64url
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.mobileAppIdentifier:
+ title: mobileAppIdentifier
+ type: object
+ additionalProperties:
+ type: object
+ description: The identifier for a mobile app.
+ microsoft.graph.managedAppFlaggedReason:
+ title: managedAppFlaggedReason
+ enum:
+ - none
+ - rootedDevice
+ - androidBootloaderUnlocked
+ - androidFactoryRomModified
+ type: string
+ description: The reason for which a user has been flagged
+ x-ms-enum:
+ name: managedAppFlaggedReason
+ modelAsString: false
+ values:
+ - value: none
+ description: No issue.
+ name: none
+ - value: rootedDevice
+ description: The app registration is running on a rooted/unlocked device.
+ name: rootedDevice
+ - value: androidBootloaderUnlocked
+ description: The app registration is running on an Android device on which the bootloader is unlocked.
+ name: androidBootloaderUnlocked
+ - value: androidFactoryRomModified
+ description: The app registration is running on an Android device on which the factory ROM has been modified.
+ name: androidFactoryRomModified
+ microsoft.graph.managedAppPolicy:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: managedAppPolicy
+ 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: Last quick scan datetime
+ description: The date and time the policy was created.
format: date-time
- nullable: true
- lastFullScanSignatureVersion:
+ description:
type: string
- description: Last full scan signature version
+ description: The policy's description.
nullable: true
- lastQuickScanDateTime:
+ displayName:
+ type: string
+ description: Policy display name.
+ 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 quick scan datetime
+ description: Last time the policy was modified.
format: date-time
+ roleScopeTagIds:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: List of Scope Tags for this Entity instance.
+ version:
+ type: string
+ description: Version of the entity.
nullable: true
- lastQuickScanSignatureVersion:
+ additionalProperties:
+ type: object
+ description: The ManagedAppPolicy resource represents a base type for platform specific policies.
+ microsoft.graph.managedAppOperation:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: managedAppOperation
+ type: object
+ properties:
+ displayName:
type: string
- description: Last quick scan signature version
+ description: The operation name.
nullable: true
- lastReportedDateTime:
+ 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 device health status reported time
+ description: The last time the app operation was modified.
format: date-time
- nullable: true
- malwareProtectionEnabled:
- type: boolean
- description: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.
- nullable: true
- networkInspectionSystemEnabled:
- type: boolean
- description: 'When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.'
- nullable: true
- productStatus:
- $ref: '#/components/schemas/microsoft.graph.windowsDefenderProductStatus'
- quickScanOverdue:
- type: boolean
- description: 'When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.'
- nullable: true
- realTimeProtectionEnabled:
- type: boolean
- description: 'When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.'
- nullable: true
- rebootRequired:
- type: boolean
- description: 'When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.'
- nullable: true
- signatureUpdateOverdue:
- type: boolean
- description: 'When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.'
- nullable: true
- signatureVersion:
+ state:
type: string
- description: Current malware definitions version
+ description: The current state of the operation
nullable: true
- tamperProtectionEnabled:
- type: boolean
- description: 'When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.'
+ version:
+ type: string
+ description: Version of the entity.
nullable: true
- detectedMalwareState:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
- description: Device malware list
- x-ms-navigationProperty: true
additionalProperties:
type: object
- description: Device protection status entity.
- microsoft.graph.mobileAppIdentifier:
- title: mobileAppIdentifier
+ description: Represents an operation applied against an app registration.
+ microsoft.graph.chassisType:
+ title: chassisType
+ enum:
+ - unknown
+ - desktop
+ - laptop
+ - worksWorkstation
+ - enterpriseServer
+ - phone
+ - tablet
+ - mobileOther
+ - mobileUnknown
+ type: string
+ description: Chassis type.
+ x-ms-enum:
+ name: chassisType
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Unknown.
+ name: unknown
+ - value: desktop
+ description: Desktop.
+ name: desktop
+ - value: laptop
+ description: Laptop.
+ name: laptop
+ - value: worksWorkstation
+ description: Workstation.
+ name: worksWorkstation
+ - value: enterpriseServer
+ description: Enterprise server.
+ name: enterpriseServer
+ - value: phone
+ description: Phone.
+ name: phone
+ - value: tablet
+ description: Mobile tablet.
+ name: tablet
+ - value: mobileOther
+ description: Other mobile.
+ name: mobileOther
+ - value: mobileUnknown
+ description: Unknown mobile.
+ name: mobileUnknown
+ microsoft.graph.chromeOSDeviceProperty:
+ title: chromeOSDeviceProperty
+ type: object
+ properties:
+ name:
+ type: string
+ description: Name of the property
+ nullable: true
+ updatable:
+ type: boolean
+ description: Whether this property is updatable
+ value:
+ type: string
+ description: Value of the property
+ nullable: true
+ valueType:
+ type: string
+ description: Type of the value
+ nullable: true
+ additionalProperties:
+ type: object
+ description: Represents a property of the ChromeOS device.
+ microsoft.graph.complianceState:
+ title: complianceState
+ enum:
+ - unknown
+ - compliant
+ - noncompliant
+ - conflict
+ - error
+ - inGracePeriod
+ - configManager
+ type: string
+ description: Compliance state.
+ x-ms-enum:
+ name: complianceState
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Unknown.
+ name: unknown
+ - value: compliant
+ description: Compliant.
+ name: compliant
+ - value: noncompliant
+ description: Device is non-compliant and is blocked from corporate resources.
+ name: noncompliant
+ - value: conflict
+ description: Conflict with other rules.
+ name: conflict
+ - value: error
+ description: Error.
+ name: error
+ - value: inGracePeriod
+ description: Device is non-compliant but still has access to corporate resources
+ name: inGracePeriod
+ - value: configManager
+ description: Managed by Config Manager
+ name: configManager
+ microsoft.graph.configurationManagerClientEnabledFeatures:
+ title: configurationManagerClientEnabledFeatures
+ type: object
+ properties:
+ compliancePolicy:
+ type: boolean
+ description: Whether compliance policy is managed by Intune
+ deviceConfiguration:
+ type: boolean
+ description: Whether device configuration is managed by Intune
+ endpointProtection:
+ type: boolean
+ description: Whether Endpoint Protection is managed by Intune
+ inventory:
+ type: boolean
+ description: Whether inventory is managed by Intune
+ modernApps:
+ type: boolean
+ description: Whether modern application is managed by Intune
+ officeApps:
+ type: boolean
+ description: Whether Office application is managed by Intune
+ resourceAccess:
+ type: boolean
+ description: Whether resource access is managed by Intune
+ windowsUpdateForBusiness:
+ type: boolean
+ description: Whether Windows Update for Business is managed by Intune
+ additionalProperties:
+ type: object
+ description: configuration Manager client enabled features
+ microsoft.graph.configurationManagerClientHealthState:
+ title: configurationManagerClientHealthState
+ type: object
+ properties:
+ errorCode:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Error code for failed state.
+ format: int32
+ 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: Datetime for last sync with configuration manager management point.
+ format: date-time
+ state:
+ $ref: '#/components/schemas/microsoft.graph.configurationManagerClientState'
+ additionalProperties:
+ type: object
+ description: Configuration manager client health state
+ microsoft.graph.configurationManagerClientInformation:
+ title: configurationManagerClientInformation
+ type: object
+ properties:
+ clientIdentifier:
+ type: string
+ description: Configuration Manager Client Id from SCCM
+ nullable: true
+ clientVersion:
+ type: string
+ description: Configuration Manager Client version from SCCM
+ nullable: true
+ isBlocked:
+ type: boolean
+ description: Configuration Manager Client blocked status from SCCM
+ additionalProperties:
+ type: object
+ description: Configuration Manager client information synced from SCCM
+ microsoft.graph.deviceActionResult:
+ title: deviceActionResult
+ type: object
+ properties:
+ actionName:
+ type: string
+ description: Action name
+ nullable: true
+ actionState:
+ $ref: '#/components/schemas/microsoft.graph.actionState'
+ lastUpdatedDateTime:
+ 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: Time the action state was last updated
+ format: date-time
+ startDateTime:
+ 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: Time the action was initiated
+ format: date-time
+ additionalProperties:
+ type: object
+ description: Device action result
+ microsoft.graph.deviceEnrollmentType:
+ title: deviceEnrollmentType
+ enum:
+ - unknown
+ - userEnrollment
+ - deviceEnrollmentManager
+ - appleBulkWithUser
+ - appleBulkWithoutUser
+ - windowsAzureADJoin
+ - windowsBulkUserless
+ - windowsAutoEnrollment
+ - windowsBulkAzureDomainJoin
+ - windowsCoManagement
+ - windowsAzureADJoinUsingDeviceAuth
+ - appleUserEnrollment
+ - appleUserEnrollmentWithServiceAccount
+ - azureAdJoinUsingAzureVmExtension
+ - androidEnterpriseDedicatedDevice
+ - androidEnterpriseFullyManaged
+ - androidEnterpriseCorporateWorkProfile
+ type: string
+ description: Possible ways of adding a mobile device to management.
+ x-ms-enum:
+ name: deviceEnrollmentType
+ modelAsString: false
+ values:
+ - value: unknown
+ description: 'Default value, enrollment type was not collected.'
+ name: unknown
+ - value: userEnrollment
+ description: User driven enrollment through BYOD channel.
+ name: userEnrollment
+ - value: deviceEnrollmentManager
+ description: User enrollment with a device enrollment manager account.
+ name: deviceEnrollmentManager
+ - value: appleBulkWithUser
+ description: 'Apple bulk enrollment with user challenge. (DEP, Apple Configurator)'
+ name: appleBulkWithUser
+ - value: appleBulkWithoutUser
+ description: 'Apple bulk enrollment without user challenge. (DEP, Apple Configurator, Mobile Config)'
+ name: appleBulkWithoutUser
+ - value: windowsAzureADJoin
+ description: Windows 10 Azure AD Join.
+ name: windowsAzureADJoin
+ - value: windowsBulkUserless
+ description: Windows 10 Bulk enrollment through ICD with certificate.
+ name: windowsBulkUserless
+ - value: windowsAutoEnrollment
+ description: Windows 10 automatic enrollment. (Add work account)
+ name: windowsAutoEnrollment
+ - value: windowsBulkAzureDomainJoin
+ description: Windows 10 bulk Azure AD Join.
+ name: windowsBulkAzureDomainJoin
+ - value: windowsCoManagement
+ description: Windows 10 Co-Management triggered by AutoPilot or Group Policy.
+ name: windowsCoManagement
+ - value: windowsAzureADJoinUsingDeviceAuth
+ description: Windows 10 Azure AD Join using Device Auth.
+ name: windowsAzureADJoinUsingDeviceAuth
+ - value: appleUserEnrollment
+ description: Device managed by Apple user enrollment
+ name: appleUserEnrollment
+ - value: appleUserEnrollmentWithServiceAccount
+ description: Device managed by Apple user enrollment with service account
+ name: appleUserEnrollmentWithServiceAccount
+ - value: azureAdJoinUsingAzureVmExtension
+ description: Azure AD Join enrollment when an Azure VM is provisioned
+ name: azureAdJoinUsingAzureVmExtension
+ - value: androidEnterpriseDedicatedDevice
+ description: Android Enterprise Dedicated Device
+ name: androidEnterpriseDedicatedDevice
+ - value: androidEnterpriseFullyManaged
+ description: Android Enterprise Fully Managed
+ name: androidEnterpriseFullyManaged
+ - value: androidEnterpriseCorporateWorkProfile
+ description: Android Enterprise Corporate Work Profile
+ name: androidEnterpriseCorporateWorkProfile
+ microsoft.graph.deviceHealthAttestationState:
+ title: deviceHealthAttestationState
+ type: object
+ properties:
+ attestationIdentityKey:
+ type: string
+ description: 'TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.'
+ nullable: true
+ bitLockerStatus:
+ type: string
+ description: On or Off of BitLocker Drive Encryption
+ nullable: true
+ bootAppSecurityVersion:
+ type: string
+ description: The security version number of the Boot Application
+ nullable: true
+ bootDebugging:
+ type: string
+ description: 'When bootDebugging is enabled, the device is used in development and testing'
+ nullable: true
+ bootManagerSecurityVersion:
+ type: string
+ description: The security version number of the Boot Application
+ nullable: true
+ bootManagerVersion:
+ type: string
+ description: The version of the Boot Manager
+ nullable: true
+ bootRevisionListInfo:
+ type: string
+ description: The Boot Revision List that was loaded during initial boot on the attested device
+ nullable: true
+ codeIntegrity:
+ type: string
+ description: 'When code integrity is enabled, code execution is restricted to integrity verified code'
+ nullable: true
+ codeIntegrityCheckVersion:
+ type: string
+ description: The version of the Boot Manager
+ nullable: true
+ codeIntegrityPolicy:
+ type: string
+ description: The Code Integrity policy that is controlling the security of the boot environment
+ nullable: true
+ contentNamespaceUrl:
+ type: string
+ description: The DHA report version. (Namespace version)
+ nullable: true
+ contentVersion:
+ type: string
+ description: The HealthAttestation state schema version
+ nullable: true
+ dataExcutionPolicy:
+ type: string
+ description: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory
+ nullable: true
+ deviceHealthAttestationStatus:
+ type: string
+ description: The DHA report version. (Namespace version)
+ nullable: true
+ earlyLaunchAntiMalwareDriverProtection:
+ type: string
+ description: ELAM provides protection for the computers in your network when they start up
+ nullable: true
+ firmwareProtection:
+ $ref: '#/components/schemas/microsoft.graph.firmwareProtectionType'
+ healthAttestationSupportedStatus:
+ type: string
+ description: This attribute indicates if DHA is supported for the device
+ nullable: true
+ healthStatusMismatchInfo:
+ type: string
+ description: This attribute appears if DHA-Service detects an integrity issue
+ nullable: true
+ issuedDateTime:
+ 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 was evaluated or issued to MDM
+ format: date-time
+ lastUpdateDateTime:
+ type: string
+ description: The Timestamp of the last update.
+ nullable: true
+ memoryAccessProtection:
+ $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
+ memoryIntegrityProtection:
+ $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
+ operatingSystemKernelDebugging:
+ type: string
+ description: 'When operatingSystemKernelDebugging is enabled, the device is used in development and testing'
+ nullable: true
+ operatingSystemRevListInfo:
+ type: string
+ description: The Operating System Revision List that was loaded during initial boot on the attested device
+ nullable: true
+ pcr0:
+ type: string
+ description: 'The measurement that is captured in PCR[0]'
+ nullable: true
+ pcrHashAlgorithm:
+ type: string
+ description: Informational attribute that identifies the HASH algorithm that was used by TPM
+ nullable: true
+ resetCount:
+ type: integer
+ description: The number of times a PC device has hibernated or resumed
+ format: int64
+ restartCount:
+ type: integer
+ description: The number of times a PC device has rebooted
+ format: int64
+ safeMode:
+ type: string
+ description: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state
+ nullable: true
+ secureBoot:
+ type: string
+ description: 'When Secure Boot is enabled, the core components must have the correct cryptographic signatures'
+ nullable: true
+ secureBootConfigurationPolicyFingerPrint:
+ type: string
+ description: Fingerprint of the Custom Secure Boot Configuration Policy
+ nullable: true
+ securedCorePC:
+ $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
+ systemManagementMode:
+ $ref: '#/components/schemas/microsoft.graph.systemManagementModeLevel'
+ testSigning:
+ type: string
+ description: 'When test signing is allowed, the device does not enforce signature validation during boot'
+ nullable: true
+ tpmVersion:
+ type: string
+ description: The security version number of the Boot Application
+ nullable: true
+ virtualizationBasedSecurity:
+ $ref: '#/components/schemas/microsoft.graph.azureAttestationSettingStatus'
+ virtualSecureMode:
+ type: string
+ description: VSM is a container that protects high value assets from a compromised kernel
+ nullable: true
+ windowsPE:
+ type: string
+ description: Operating system running with limited services that is used to prepare a computer for Windows
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.deviceIdentityAttestationDetail:
+ title: deviceIdentityAttestationDetail
type: object
+ properties:
+ deviceIdentityAttestationStatus:
+ $ref: '#/components/schemas/microsoft.graph.deviceIdentityAttestationStatus'
additionalProperties:
type: object
- description: The identifier for a mobile app.
- microsoft.graph.managedAppFlaggedReason:
- title: managedAppFlaggedReason
+ description: Indicates the attestation status of the managed device
+ microsoft.graph.deviceRegistrationState:
+ title: deviceRegistrationState
+ enum:
+ - notRegistered
+ - registered
+ - revoked
+ - keyConflict
+ - approvalPending
+ - certificateReset
+ - notRegisteredPendingEnrollment
+ - unknown
+ type: string
+ description: Device registration status.
+ x-ms-enum:
+ name: deviceRegistrationState
+ modelAsString: false
+ values:
+ - value: notRegistered
+ description: The device is not registered.
+ name: notRegistered
+ - value: registered
+ description: The device is registered.
+ name: registered
+ - value: revoked
+ description: 'The device has been blocked, wiped or retired.'
+ name: revoked
+ - value: keyConflict
+ description: The device has a key conflict.
+ name: keyConflict
+ - value: approvalPending
+ description: The device is pending approval.
+ name: approvalPending
+ - value: certificateReset
+ description: The device certificate has been reset.
+ name: certificateReset
+ - value: notRegisteredPendingEnrollment
+ description: The device is not registered and pending enrollment.
+ name: notRegisteredPendingEnrollment
+ - value: unknown
+ description: The device registration status is unknown.
+ name: unknown
+ microsoft.graph.deviceType:
+ title: deviceType
+ enum:
+ - desktop
+ - windowsRT
+ - winMO6
+ - nokia
+ - windowsPhone
+ - mac
+ - winCE
+ - winEmbedded
+ - iPhone
+ - iPad
+ - iPod
+ - android
+ - iSocConsumer
+ - unix
+ - macMDM
+ - holoLens
+ - surfaceHub
+ - androidForWork
+ - androidEnterprise
+ - windows10x
+ - androidnGMS
+ - chromeOS
+ - linux
+ - blackberry
+ - palm
+ - unknown
+ - cloudPC
+ type: string
+ description: Device type.
+ x-ms-enum:
+ name: deviceType
+ modelAsString: false
+ values:
+ - value: desktop
+ description: Desktop.
+ name: desktop
+ - value: windowsRT
+ description: WindowsRT.
+ name: windowsRT
+ - value: winMO6
+ description: WinMO6.
+ name: winMO6
+ - value: nokia
+ description: Nokia.
+ name: nokia
+ - value: windowsPhone
+ description: Windows phone.
+ name: windowsPhone
+ - value: mac
+ description: Mac.
+ name: mac
+ - value: winCE
+ description: WinCE.
+ name: winCE
+ - value: winEmbedded
+ description: WinEmbedded.
+ name: winEmbedded
+ - value: iPhone
+ description: iPhone.
+ name: iPhone
+ - value: iPad
+ description: iPad.
+ name: iPad
+ - value: iPod
+ description: iPodTouch.
+ name: iPod
+ - value: android
+ description: Android.
+ name: android
+ - value: iSocConsumer
+ description: iSocConsumer.
+ name: iSocConsumer
+ - value: unix
+ description: Unix.
+ name: unix
+ - value: macMDM
+ description: Mac OS X client using built in MDM agent.
+ name: macMDM
+ - value: holoLens
+ description: Representing the fancy Windows 10 goggles.
+ name: holoLens
+ - value: surfaceHub
+ description: Surface HUB device.
+ name: surfaceHub
+ - value: androidForWork
+ description: Android for work device.
+ name: androidForWork
+ - value: androidEnterprise
+ description: Android enterprise device.
+ name: androidEnterprise
+ - value: windows10x
+ description: Windows 10x device.
+ name: windows10x
+ - value: androidnGMS
+ description: Android non Google managed device.
+ name: androidnGMS
+ - value: chromeOS
+ description: ChromeOS device.
+ name: chromeOS
+ - value: linux
+ description: Linux device.
+ name: linux
+ - value: blackberry
+ description: Blackberry.
+ name: blackberry
+ - value: palm
+ description: Palm.
+ name: palm
+ - value: unknown
+ description: Represents that the device type is unknown.
+ name: unknown
+ - value: cloudPC
+ description: Cloud PC device.
+ name: cloudPC
+ microsoft.graph.deviceManagementExchangeAccessState:
+ title: deviceManagementExchangeAccessState
enum:
- none
- - rootedDevice
- - androidBootloaderUnlocked
- - androidFactoryRomModified
+ - unknown
+ - allowed
+ - blocked
+ - quarantined
type: string
- description: The reason for which a user has been flagged
+ description: Device Exchange Access State.
x-ms-enum:
- name: managedAppFlaggedReason
+ name: deviceManagementExchangeAccessState
modelAsString: false
values:
- value: none
- description: No issue.
+ description: No access state discovered from Exchange
name: none
- - value: rootedDevice
- description: The app registration is running on a rooted/unlocked device.
- name: rootedDevice
- - value: androidBootloaderUnlocked
- description: The app registration is running on an Android device on which the bootloader is unlocked.
- name: androidBootloaderUnlocked
- - value: androidFactoryRomModified
- description: The app registration is running on an Android device on which the factory ROM has been modified.
- name: androidFactoryRomModified
- microsoft.graph.managedAppPolicy:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: managedAppPolicy
- 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: The date and time the policy was created.
- format: date-time
- description:
- type: string
- description: The policy's description.
- nullable: true
- displayName:
- type: string
- description: Policy display name.
- 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
- roleScopeTagIds:
- type: array
- items:
- type: string
- nullable: true
- description: List of Scope Tags for this Entity instance.
- version:
- type: string
- description: Version of the entity.
- nullable: true
- additionalProperties:
- type: object
- description: The ManagedAppPolicy resource represents a base type for platform specific policies.
- 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
- state:
- type: string
- description: The current state of the operation
- nullable: true
- version:
- type: string
- description: Version of the entity.
- nullable: true
- additionalProperties:
- type: object
- description: Represents an operation applied against an app registration.
- microsoft.graph.deviceManagementTroubleshootingErrorDetails:
- title: deviceManagementTroubleshootingErrorDetails
+ - value: unknown
+ description: Device access state to Exchange is unknown
+ name: unknown
+ - value: allowed
+ description: Device has access to Exchange
+ name: allowed
+ - value: blocked
+ description: Device is Blocked in Exchange
+ name: blocked
+ - value: quarantined
+ description: Device is Quarantined in Exchange
+ name: quarantined
+ microsoft.graph.deviceManagementExchangeAccessStateReason:
+ title: deviceManagementExchangeAccessStateReason
+ enum:
+ - none
+ - unknown
+ - exchangeGlobalRule
+ - exchangeIndividualRule
+ - exchangeDeviceRule
+ - exchangeUpgrade
+ - exchangeMailboxPolicy
+ - other
+ - compliant
+ - notCompliant
+ - notEnrolled
+ - unknownLocation
+ - mfaRequired
+ - azureADBlockDueToAccessPolicy
+ - compromisedPassword
+ - deviceNotKnownWithManagedApp
+ type: string
+ description: Device Exchange Access State Reason.
+ x-ms-enum:
+ name: deviceManagementExchangeAccessStateReason
+ modelAsString: false
+ values:
+ - value: none
+ description: No access state reason discovered from Exchange
+ name: none
+ - value: unknown
+ description: Unknown access state reason
+ name: unknown
+ - value: exchangeGlobalRule
+ description: Access state determined by Exchange Global rule
+ name: exchangeGlobalRule
+ - value: exchangeIndividualRule
+ description: Access state determined by Exchange Individual rule
+ name: exchangeIndividualRule
+ - value: exchangeDeviceRule
+ description: Access state determined by Exchange Device rule
+ name: exchangeDeviceRule
+ - value: exchangeUpgrade
+ description: Access state due to Exchange upgrade
+ name: exchangeUpgrade
+ - value: exchangeMailboxPolicy
+ description: Access state determined by Exchange Mailbox Policy
+ name: exchangeMailboxPolicy
+ - value: other
+ description: Access state determined by Exchange
+ name: other
+ - value: compliant
+ description: Access state granted by compliance challenge
+ name: compliant
+ - value: notCompliant
+ description: Access state revoked by compliance challenge
+ name: notCompliant
+ - value: notEnrolled
+ description: Access state revoked by management challenge
+ name: notEnrolled
+ - value: unknownLocation
+ description: Access state due to unknown location
+ name: unknownLocation
+ - value: mfaRequired
+ description: Access state due to MFA challenge
+ name: mfaRequired
+ - value: azureADBlockDueToAccessPolicy
+ description: Access State revoked by AAD Access Policy
+ name: azureADBlockDueToAccessPolicy
+ - value: compromisedPassword
+ description: Access State revoked by compromised password
+ name: compromisedPassword
+ - value: deviceNotKnownWithManagedApp
+ description: Access state revoked by managed application challenge
+ name: deviceNotKnownWithManagedApp
+ microsoft.graph.hardwareInformation:
+ title: hardwareInformation
type: object
properties:
- context:
+ batteryChargeCycles:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The number of charge cycles the device’s current battery has gone through. Valid values 0 to 2147483647
+ format: int32
+ batteryHealthPercentage:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The device’s current battery’s health percentage. Valid values 0 to 100
+ format: int32
+ batteryLevelPercentage:
+ type: number
+ description: 'The battery level, between 0.0 and 100, or null if the battery level cannot be determined. The update frequency of this property is per-checkin. Note this property is currently supported only on devices running iOS 5.0 and later, and is available only when Device Information access right is obtained. Valid values 0 to 100'
+ format: double
+ nullable: true
+ batterySerialNumber:
+ type: string
+ description: The serial number of the device’s current battery
+ nullable: true
+ cellularTechnology:
+ type: string
+ description: Cellular technology of the device
+ nullable: true
+ deviceFullQualifiedDomainName:
type: string
- description: Not yet documented
+ description: 'Returns the fully qualified domain name of the device (if any). If the device is not domain-joined, it returns an empty string.'
nullable: true
- failure:
+ deviceGuardLocalSystemAuthorityCredentialGuardState:
+ $ref: '#/components/schemas/microsoft.graph.deviceGuardLocalSystemAuthorityCredentialGuardState'
+ deviceGuardVirtualizationBasedSecurityHardwareRequirementState:
+ $ref: '#/components/schemas/microsoft.graph.deviceGuardVirtualizationBasedSecurityHardwareRequirementState'
+ deviceGuardVirtualizationBasedSecurityState:
+ $ref: '#/components/schemas/microsoft.graph.deviceGuardVirtualizationBasedSecurityState'
+ deviceLicensingLastErrorCode:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'A standard error code indicating the last error, or 0 indicating no error (default). The update frequency of this property is daily. Note this property is currently supported only for Windows based Device based subscription licensing. Valid values 0 to 2147483647'
+ format: int32
+ deviceLicensingLastErrorDescription:
type: string
- description: Not yet documented
+ description: Error text message as a descripition for deviceLicensingLastErrorCode. The update frequency of this property is daily. Note this property is currently supported only for Windows based Device based subscription licensing.
nullable: true
- failureDetails:
+ deviceLicensingStatus:
+ $ref: '#/components/schemas/microsoft.graph.deviceLicensingStatus'
+ esimIdentifier:
type: string
- description: The detailed description of what went wrong.
+ description: eSIM identifier
nullable: true
- remediation:
+ freeStorageSpace:
+ type: integer
+ description: Free storage space of the device.
+ format: int64
+ imei:
type: string
- description: The detailed description of how to remediate this issue.
+ description: IMEI
nullable: true
- resources:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingErrorResource'
- description: Links to helpful documentation about this failure.
- additionalProperties:
- type: object
- description: Object containing detailed information about the error and its remediation.
- microsoft.graph.mobileAppIntentAndStateDetail:
- title: mobileAppIntentAndStateDetail
- type: object
- properties:
- applicationId:
+ ipAddressV4:
type: string
- description: MobieApp identifier.
+ description: IPAddressV4
nullable: true
- displayName:
+ isEncrypted:
+ type: boolean
+ description: Encryption status of the device
+ isSharedDevice:
+ type: boolean
+ description: Shared iPad
+ isSupervised:
+ type: boolean
+ description: Supervised mode of the device
+ manufacturer:
type: string
- description: The admin provided or imported title of the app.
+ description: Manufacturer of the device
nullable: true
- displayVersion:
+ meid:
type: string
- description: Human readable version of the application
+ description: MEID
nullable: true
- installState:
- $ref: '#/components/schemas/microsoft.graph.resultantAppState'
- mobileAppIntent:
- $ref: '#/components/schemas/microsoft.graph.mobileAppIntent'
- supportedDeviceTypes:
+ model:
+ type: string
+ description: Model of the device
+ nullable: true
+ operatingSystemEdition:
+ type: string
+ description: String that specifies the OS edition.
+ nullable: true
+ operatingSystemLanguage:
+ type: string
+ description: Operating system language of the device
+ nullable: true
+ operatingSystemProductType:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Int that specifies the Windows Operating System ProductType. More details here https://go.microsoft.com/fwlink/?linkid=2126950. Valid values 0 to 2147483647
+ format: int32
+ osBuildNumber:
+ type: string
+ description: Operating System Build Number on Android device
+ nullable: true
+ phoneNumber:
+ type: string
+ description: Phone number of the device
+ nullable: true
+ productName:
+ type: string
+ description: 'The product name, e.g. iPad8,12 etc. The update frequency of this property is weekly. Note this property is currently supported only on iOS/MacOS devices, and is available only when Device Information access right is obtained.'
+ nullable: true
+ residentUsersCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'The number of users currently on this device, or null (default) if the value of this property cannot be determined. The update frequency of this property is per-checkin. Note this property is currently supported only on devices running iOS 13.4 and later, and is available only when Device Information access right is obtained. Valid values 0 to 2147483647'
+ format: int32
+ nullable: true
+ serialNumber:
+ type: string
+ description: Serial number.
+ nullable: true
+ sharedDeviceCachedUsers:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.mobileAppSupportedDeviceType'
- description: The supported platforms for the app.
- additionalProperties:
- type: object
- description: Mobile App Intent and Install State for a given device.
- microsoft.graph.mobileAppTroubleshootingHistoryItem:
- title: mobileAppTroubleshootingHistoryItem
- type: object
- properties:
- occurrenceDateTime:
- 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])$'
+ $ref: '#/components/schemas/microsoft.graph.sharedAppleDeviceUser'
+ description: All users on the shared Apple device
+ subnetAddress:
type: string
- description: Time when the history item occurred.
- format: date-time
- troubleshootingErrorDetails:
- $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingErrorDetails'
- additionalProperties:
- type: object
- description: History Item contained in the Mobile App Troubleshooting Event.
- microsoft.graph.appLogCollectionRequest:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: appLogCollectionRequest
- type: object
- properties:
- completedDateTime:
- 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: Time at which the upload log request reached a completed state if not completed yet NULL will be returned.
- format: date-time
- nullable: true
- customLogFolders:
- type: array
- items:
- type: string
- nullable: true
- description: List of log folders.
- errorMessage:
- type: string
- description: Indicates error message if any during the upload process.
- nullable: true
- status:
- $ref: '#/components/schemas/microsoft.graph.appLogUploadState'
- additionalProperties:
- type: object
- description: Entity for AppLogCollectionRequest contains all logs values.
- microsoft.graph.payloadTypes:
- title: payloadTypes
- type: object
- properties:
- rawContent:
+ description: SubnetAddress
+ nullable: true
+ subscriberCarrier:
type: string
- description: 'The notification content of a raw user notification that will be delivered to and consumed by the app client on all supported platforms (Windows, iOS, Android or WebPush) receiving this notification. At least one of Payload.RawContent or Payload.VisualContent needs to be valid for a POST Notification request.'
+ description: Subscriber carrier of the device
nullable: true
- visualContent:
- $ref: '#/components/schemas/microsoft.graph.visualProperties'
- additionalProperties:
- type: object
- microsoft.graph.priority:
- title: priority
- enum:
- - None
- - High
- - Low
- type: string
- microsoft.graph.targetPolicyEndpoints:
- title: targetPolicyEndpoints
- type: object
- properties:
- platformTypes:
+ systemManagementBIOSVersion:
+ type: string
+ description: BIOS version as reported by SMBIOS
+ nullable: true
+ totalStorageSpace:
+ type: integer
+ description: Total storage space of the device.
+ format: int64
+ tpmManufacturer:
+ type: string
+ description: The identifying information that uniquely names the TPM manufacturer
+ nullable: true
+ tpmSpecificationVersion:
+ type: string
+ description: String that specifies the specification version.
+ nullable: true
+ tpmVersion:
+ type: string
+ description: 'The version of the TPM, as specified by the manufacturer'
+ nullable: true
+ wifiMac:
+ type: string
+ description: WiFi MAC address of the device
+ nullable: true
+ wiredIPv4Addresses:
type: array
items:
type: string
nullable: true
- description: 'Use to filter the notification distribution to a specific platform or platforms. Valid values are Windows, iOS, Android and WebPush. By default, all push endpoint types (Windows, iOS, Android and WebPush) are enabled.'
- additionalProperties:
- type: object
- microsoft.graph.plannerDelta:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: plannerDelta
- type: object
- additionalProperties:
- type: object
- microsoft.graph.plannerFavoritePlanReferenceCollection:
- title: plannerFavoritePlanReferenceCollection
- type: object
+ description: A list of wired IPv4 addresses. The update frequency (the maximum delay for the change of property value to be synchronized from the device to the cloud storage) of this property is daily. Note this property is currently supported only on devices running on Windows.
additionalProperties:
type: object
- microsoft.graph.plannerRecentPlanReferenceCollection:
- title: plannerRecentPlanReferenceCollection
+ description: Hardware information of a given device.
+ microsoft.graph.joinType:
+ title: joinType
+ enum:
+ - unknown
+ - azureADJoined
+ - azureADRegistered
+ - hybridAzureADJoined
+ type: string
+ description: Device enrollment join type.
+ x-ms-enum:
+ name: joinType
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Unknown enrollment join type.
+ name: unknown
+ - value: azureADJoined
+ description: The device is joined by Azure AD.
+ name: azureADJoined
+ - value: azureADRegistered
+ description: The device is registered by Azure AD.
+ name: azureADRegistered
+ - value: hybridAzureADJoined
+ description: The device is joined by hybrid Azure AD.
+ name: hybridAzureADJoined
+ microsoft.graph.lostModeState:
+ title: lostModeState
+ enum:
+ - disabled
+ - enabled
+ type: string
+ description: 'State of lost mode, indicating if lost mode is enabled or disabled'
+ x-ms-enum:
+ name: lostModeState
+ modelAsString: false
+ values:
+ - value: disabled
+ description: Lost mode is disabled.
+ name: disabled
+ - value: enabled
+ description: Lost mode is enabled.
+ name: enabled
+ microsoft.graph.managedDeviceOwnerType:
+ title: managedDeviceOwnerType
+ enum:
+ - unknown
+ - company
+ - personal
+ type: string
+ description: Owner type of device.
+ x-ms-enum:
+ name: managedDeviceOwnerType
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Unknown.
+ name: unknown
+ - value: company
+ description: Owned by company.
+ name: company
+ - value: personal
+ description: Owned by person.
+ name: personal
+ microsoft.graph.managementAgentType:
+ title: managementAgentType
+ enum:
+ - eas
+ - mdm
+ - easMdm
+ - intuneClient
+ - easIntuneClient
+ - configurationManagerClient
+ - configurationManagerClientMdm
+ - configurationManagerClientMdmEas
+ - unknown
+ - jamf
+ - googleCloudDevicePolicyController
+ - microsoft365ManagedMdm
+ - msSense
+ - intuneAosp
+ type: string
+ description: Management agent type.
+ x-ms-enum:
+ name: managementAgentType
+ modelAsString: false
+ values:
+ - value: eas
+ description: The device is managed by Exchange server.
+ name: eas
+ - value: mdm
+ description: The device is managed by Intune MDM.
+ name: mdm
+ - value: easMdm
+ description: The device is managed by both Exchange server and Intune MDM.
+ name: easMdm
+ - value: intuneClient
+ description: Intune client managed.
+ name: intuneClient
+ - value: easIntuneClient
+ description: The device is EAS and Intune client dual managed.
+ name: easIntuneClient
+ - value: configurationManagerClient
+ description: The device is managed by Configuration Manager.
+ name: configurationManagerClient
+ - value: configurationManagerClientMdm
+ description: The device is managed by Configuration Manager and MDM.
+ name: configurationManagerClientMdm
+ - value: configurationManagerClientMdmEas
+ description: 'The device is managed by Configuration Manager, MDM and Eas.'
+ name: configurationManagerClientMdmEas
+ - value: unknown
+ description: Unknown management agent type.
+ name: unknown
+ - value: jamf
+ description: The device attributes are fetched from Jamf.
+ name: jamf
+ - value: googleCloudDevicePolicyController
+ description: The device is managed by Google's CloudDPC.
+ name: googleCloudDevicePolicyController
+ - value: microsoft365ManagedMdm
+ description: This device is managed by Microsoft 365 through Intune.
+ name: microsoft365ManagedMdm
+ - value: intuneAosp
+ description: This device is managed by Intune's MDM for AOSP (Android Open Source Project) devices
+ name: intuneAosp
+ microsoft.graph.managedDeviceManagementFeatures:
+ title: managedDeviceManagementFeatures
+ enum:
+ - none
+ - microsoftManagedDesktop
+ type: string
+ description: Device management features.
+ x-ms-enum:
+ name: managedDeviceManagementFeatures
+ modelAsString: false
+ values:
+ - value: none
+ description: Unknown device management features.
+ name: none
+ - value: microsoftManagedDesktop
+ description: Microsoft Managed Desktop
+ name: microsoftManagedDesktop
+ microsoft.graph.managementState:
+ title: managementState
+ enum:
+ - managed
+ - retirePending
+ - retireFailed
+ - wipePending
+ - wipeFailed
+ - unhealthy
+ - deletePending
+ - retireIssued
+ - wipeIssued
+ - wipeCanceled
+ - retireCanceled
+ - discovered
+ type: string
+ description: Management state of device in Microsoft Intune.
+ x-ms-enum:
+ name: managementState
+ modelAsString: false
+ values:
+ - value: managed
+ description: The device is under management
+ name: managed
+ - value: retirePending
+ description: A retire command is occuring on the device and in the process of unenrolling from management
+ name: retirePending
+ - value: retireFailed
+ description: Retire command failed on the device
+ name: retireFailed
+ - value: wipePending
+ description: A wipe command is occuring on the device and in the process of unenrolling from management
+ name: wipePending
+ - value: wipeFailed
+ description: Wipe command failed on the device
+ name: wipeFailed
+ - value: unhealthy
+ description: The device is unhealthy.
+ name: unhealthy
+ - value: deletePending
+ description: 'A delete command is occuring on the device '
+ name: deletePending
+ - value: retireIssued
+ description: A retire command was issued for the device
+ name: retireIssued
+ - value: wipeIssued
+ description: A wipe command was issued for the device
+ name: wipeIssued
+ - value: wipeCanceled
+ description: A wipe command for this device has been canceled
+ name: wipeCanceled
+ - value: retireCanceled
+ description: A retire command for this device has been canceled
+ name: retireCanceled
+ - value: discovered
+ description: The device is discovered but not fully enrolled.
+ name: discovered
+ microsoft.graph.ownerType:
+ title: ownerType
+ enum:
+ - unknown
+ - company
+ - personal
+ type: string
+ description: Owner type of device.
+ x-ms-enum:
+ name: ownerType
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Unknown.
+ name: unknown
+ - value: company
+ description: Owned by company.
+ name: company
+ - value: personal
+ description: Owned by person.
+ name: personal
+ microsoft.graph.managedDevicePartnerReportedHealthState:
+ title: managedDevicePartnerReportedHealthState
+ enum:
+ - unknown
+ - activated
+ - deactivated
+ - secured
+ - lowSeverity
+ - mediumSeverity
+ - highSeverity
+ - unresponsive
+ - compromised
+ - misconfigured
+ type: string
+ description: Available health states for the Device Health API
+ x-ms-enum:
+ name: managedDevicePartnerReportedHealthState
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Device health state is not yet reported
+ name: unknown
+ - value: activated
+ description: 'Device has been activated by a mobile threat defense partner, but has not yet reported health.'
+ name: activated
+ - value: deactivated
+ description: Device has been deactivated by a mobile threat defense partner. The device health is not known.
+ name: deactivated
+ - value: secured
+ description: Device is considered secured by the mobile threat defense partner.
+ name: secured
+ - value: lowSeverity
+ description: Device is considered low threat by the mobile threat defense partner.
+ name: lowSeverity
+ - value: mediumSeverity
+ description: Device is considered medium threat by the mobile threat defense partner.
+ name: mediumSeverity
+ - value: highSeverity
+ description: Device is considered high threat by the mobile threat defense partner.
+ name: highSeverity
+ - value: unresponsive
+ description: Device is considered unresponsive by the mobile threat defense partner. The device health is not known.
+ name: unresponsive
+ - value: compromised
+ description: Device is considered compromised by the Threat Defense partner. This means the device has an active Threat or Risk which cannot be easily remediated by the end user and the user should contact their IT Admin.
+ name: compromised
+ - value: misconfigured
+ description: Device is considered misconfigured with the Threat Defense partner. This means the device is missing a required profile or configuration for the Threat Defense Partner to function properly and is thus threat or risk analysis is not able to complete.
+ name: misconfigured
+ microsoft.graph.managedDeviceArchitecture:
+ title: managedDeviceArchitecture
+ enum:
+ - unknown
+ - x86
+ - x64
+ - arm
+ - arM64
+ type: string
+ description: Processor architecture
+ x-ms-enum:
+ name: managedDeviceArchitecture
+ modelAsString: false
+ values:
+ - value: unknown
+ description: Unknown architecture
+ name: unknown
+ - value: x86
+ description: X86
+ name: x86
+ - value: x64
+ description: X64
+ name: x64
+ - value: arm
+ description: ARM
+ name: arm
+ - value: arM64
+ description: ARM64
+ name: arM64
+ microsoft.graph.loggedOnUser:
+ title: loggedOnUser
type: object
+ properties:
+ lastLogOnDateTime:
+ 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 time when user logs on
+ format: date-time
+ userId:
+ type: string
+ description: User id
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.plannerPlan:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.plannerDelta'
- - title: plannerPlan
- type: object
- properties:
- container:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanContainer'
- contexts:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanContextCollection'
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- 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: 'Read-only. Date and time at which the plan 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 is 2014-01-01T00:00:00Z'
- format: date-time
- nullable: true
- creationSource:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanCreation'
- owner:
- type: string
- nullable: true
- sharedWithContainers:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.plannerSharedWithContainer'
- description: List of containers the plan is shared with.
- title:
- type: string
- description: Required. Title of the plan.
- buckets:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.plannerBucket'
- description: Collection of buckets in the plan. Read-only. Nullable.
- x-ms-navigationProperty: true
- details:
- $ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
- tasks:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.plannerTask'
- description: Collection of tasks in the plan. Read-only. Nullable.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.plannerTask:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.plannerDelta'
- - title: plannerTask
- type: object
- properties:
- activeChecklistItemCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'Number of checklist items with value set to false, representing incomplete items.'
- format: int32
- nullable: true
- appliedCategories:
- $ref: '#/components/schemas/microsoft.graph.plannerAppliedCategories'
- assigneePriority:
- type: string
- description: Hint used to order items of this type in a list view. The format is defined as outlined here.
- nullable: true
- assignments:
- $ref: '#/components/schemas/microsoft.graph.plannerAssignments'
- bucketId:
- type: string
- description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. Format validation is done on the service.
- nullable: true
- checklistItemCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Number of checklist items that are present on the task.
- format: int32
- nullable: true
- completedBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- completedDateTime:
- 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: 'Read-only. Date and time at which the ''percentComplete'' of the task is set to ''100''. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
- format: date-time
- nullable: true
- conversationThreadId:
- type: string
- description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
- nullable: true
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- 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: 'Read-only. Date and time at which the task 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 is 2014-01-01T00:00:00Z'
- format: date-time
- nullable: true
- creationSource:
- $ref: '#/components/schemas/microsoft.graph.plannerTaskCreation'
- dueDateTime:
- 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 at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
- format: date-time
- nullable: true
- hasDescription:
- type: boolean
- description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
- nullable: true
- orderHint:
- type: string
- description: Hint used to order items of this type in a list view. The format is defined as outlined here.
- nullable: true
- percentComplete:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'Percentage of task completion. When set to 100, the task is considered completed.'
- format: int32
- nullable: true
- planId:
- type: string
- description: Plan ID to which the task belongs.
- nullable: true
- previewType:
- $ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
- priority:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ''urgent'', 2 and 3 and 4 as ''important'', 5, 6, and 7 as ''medium'', and 8, 9, and 10 as ''low''. Currently, Planner sets the value 1 for ''urgent'', 3 for ''important'', 5 for ''medium'', and 9 for ''low''.'
- format: int32
- nullable: true
- recurrence:
- $ref: '#/components/schemas/microsoft.graph.plannerTaskRecurrence'
- referenceCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Number of external references that exist on the task.
- format: int32
- nullable: true
- specifiedCompletionRequirements:
- $ref: '#/components/schemas/microsoft.graph.plannerTaskCompletionRequirements'
- startDateTime:
- 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 at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
- format: date-time
- nullable: true
- title:
- type: string
- description: Title of the task.
- assignedToTaskBoardFormat:
- $ref: '#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat'
- bucketTaskBoardFormat:
- $ref: '#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat'
- details:
- $ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
- progressTaskBoardFormat:
- $ref: '#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat'
- additionalProperties:
- type: object
- microsoft.graph.officeGraphInsights:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: officeGraphInsights
- type: object
- properties:
- shared:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.sharedInsight'
- description: Access this property from the derived type itemInsights.
- x-ms-navigationProperty: true
- trending:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.trending'
- description: Access this property from the derived type itemInsights.
- x-ms-navigationProperty: true
- used:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.usedInsight'
- description: Access this property from the derived type itemInsights.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.userInsightsSettings:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: userInsightsSettings
- type: object
- properties:
- isEnabled:
- type: boolean
- description: true if user's itemInsights and meeting hours insights are enabled; false if user's itemInsights and meeting hours insights are disabled. Default is true. Optional.
- additionalProperties:
- type: object
- microsoft.graph.contactMergeSuggestions:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: contactMergeSuggestions
- type: object
- properties:
- isEnabled:
- type: boolean
- description: true if the duplicate contact merge suggestions feature is enabled for the user; false if the feature is disabled. Default value is true.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.regionalAndLanguageSettings:
+ description: Logged On User
+ microsoft.graph.assignmentFilterEvaluationStatusDetails:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: regionalAndLanguageSettings
- type: object
- properties:
- authoringLanguages:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- description: Prioritized list of languages the user reads and authors in.Returned by default. Not nullable.
- defaultDisplayLanguage:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- defaultRegionalFormat:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- defaultSpeechInputLanguage:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- defaultTranslationLanguage:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- regionalFormatOverrides:
- $ref: '#/components/schemas/microsoft.graph.regionalFormatOverrides'
- translationPreferences:
- $ref: '#/components/schemas/microsoft.graph.translationPreferences'
- additionalProperties:
- type: object
- microsoft.graph.shiftPreferences:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
- - title: shiftPreferences
- type: object
- properties:
- availability:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.shiftAvailability'
- description: Availability of the user to be scheduled for work and its recurrence pattern.
- additionalProperties:
- type: object
- microsoft.graph.notebook:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- - title: notebook
- type: object
- properties:
- isDefault:
- type: boolean
- description: Indicates whether this is the user's default notebook. Read-only.
- nullable: true
- isShared:
- type: boolean
- description: 'Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.'
- nullable: true
- links:
- $ref: '#/components/schemas/microsoft.graph.notebookLinks'
- sectionGroupsUrl:
- type: string
- description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.'
- nullable: true
- sectionsUrl:
- type: string
- description: 'The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.'
- nullable: true
- userRole:
- $ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
- sectionGroups:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- description: The section groups in the notebook. Read-only. Nullable.
- x-ms-navigationProperty: true
- sections:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onenoteSection'
- description: The sections in the notebook. Read-only. Nullable.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.onenoteOperation:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.operation'
- - title: onenoteOperation
+ - title: assignmentFilterEvaluationStatusDetails
type: object
properties:
- error:
- $ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
- percentComplete:
- type: string
- description: The operation percent complete if the operation is still in running status.
- nullable: true
- resourceId:
- type: string
- description: The resource id.
- nullable: true
- resourceLocation:
+ payloadId:
type: string
- description: 'The resource URI for the object. For example, the resource URI for a copied page or section.'
+ description: PayloadId on which filter has been applied.
nullable: true
additionalProperties:
type: object
- microsoft.graph.onenotePage:
+ description: A class containing information about the payloads on which filter has been applied.
+ microsoft.graph.detectedApp:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
- - title: onenotePage
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: detectedApp
type: object
properties:
- content:
- type: string
- description: The page's HTML content.
- format: base64url
- nullable: true
- contentUrl:
- type: string
- description: The URL for the page's HTML content. Read-only.
- nullable: true
- createdByAppId:
- type: string
- description: The unique identifier of the application that created the page. 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: 'The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
- format: date-time
- nullable: true
- level:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The indentation level of the page. Read-only.
- format: int32
- nullable: true
- links:
- $ref: '#/components/schemas/microsoft.graph.pageLinks'
- order:
+ deviceCount:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: The order of the page within its parent section. Read-only.
+ description: The number of devices that have installed this application
format: int32
- nullable: true
- title:
- type: string
- description: The title of the page.
- nullable: true
- userTags:
- type: array
- items:
- type: string
- nullable: true
- parentNotebook:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- parentSection:
- $ref: '#/components/schemas/microsoft.graph.onenoteSection'
- additionalProperties:
- type: object
- microsoft.graph.onenoteResource:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
- - title: onenoteResource
- type: object
- properties:
- content:
- type: string
- format: base64url
- nullable: true
- contentUrl:
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.sectionGroup:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- - title: sectionGroup
- type: object
- properties:
- sectionGroupsUrl:
+ displayName:
type: string
- description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.'
+ description: Name of the discovered application. Read-only
nullable: true
- sectionsUrl:
+ platform:
+ $ref: '#/components/schemas/microsoft.graph.detectedAppPlatformType'
+ publisher:
type: string
- description: 'The URL for the sections navigation property, which returns all the sections in the section group. Read-only.'
- nullable: true
- parentNotebook:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- parentSectionGroup:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- sectionGroups:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- description: The section groups in the section. Read-only. Nullable.
- x-ms-navigationProperty: true
- sections:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.onenoteSection'
- description: The sections in the section group. Read-only. Nullable.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.onenoteSection:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
- - title: onenoteSection
- type: object
- properties:
- isDefault:
- type: boolean
- description: Indicates whether this is the user's default section. Read-only.
+ description: 'Indicates the publisher of the discovered application. For example: ''Microsoft''. The default value is an empty string.'
nullable: true
- links:
- $ref: '#/components/schemas/microsoft.graph.sectionLinks'
- pagesUrl:
+ sizeInByte:
+ type: integer
+ description: Discovered application size in bytes. Read-only
+ format: int64
+ version:
type: string
- description: The pages endpoint where you can get details for all the pages in the section. Read-only.
+ description: Version of the discovered application. Read-only
nullable: true
- pages:
+ managedDevices:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.onenotePage'
- description: The collection of pages in the section. Read-only. Nullable.
+ $ref: '#/components/schemas/microsoft.graph.managedDevice'
+ description: The devices that have the discovered application installed
x-ms-navigationProperty: true
- parentNotebook:
- $ref: '#/components/schemas/microsoft.graph.notebook'
- parentSectionGroup:
- $ref: '#/components/schemas/microsoft.graph.sectionGroup'
- additionalProperties:
- type: object
- microsoft.graph.userAccountInformation:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: userAccountInformation
- type: object
- properties:
- ageGroup:
- type: string
- description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and can''t be changed.'
- nullable: true
- countryCode:
- type: string
- description: Contains the two-character country code associated with the users' account.
- preferredLanguageTag:
- $ref: '#/components/schemas/microsoft.graph.localeInfo'
- userPrincipalName:
- type: string
- description: The user principal name (UPN) of the user associated with the account.
- additionalProperties:
- type: object
- microsoft.graph.itemAddress:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: itemAddress
- type: object
- properties:
- detail:
- $ref: '#/components/schemas/microsoft.graph.physicalAddress'
- displayName:
- type: string
- description: Friendly name the user has assigned to this address.
- nullable: true
- geoCoordinates:
- $ref: '#/components/schemas/microsoft.graph.geoCoordinates'
additionalProperties:
type: object
- microsoft.graph.personAnnualEvent:
+ description: A managed or unmanaged app that is installed on a managed device. Unmanaged apps will only appear for devices marked as corporate owned.
+ microsoft.graph.deviceCategory:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personAnnualEvent
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: deviceCategory
type: object
properties:
- date:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ description:
type: string
- format: date
+ description: Optional description for the device category.
nullable: true
displayName:
type: string
+ description: Display name for the device category.
nullable: true
- type:
- $ref: '#/components/schemas/microsoft.graph.personAnnualEventType'
+ roleScopeTagIds:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: Optional role scope tags for the device category.
additionalProperties:
type: object
- microsoft.graph.personAward:
+ description: 'Device categories provides a way to organize your devices. Using device categories, company administrators can define their own categories that make sense to their company. These categories can then be applied to a device in the Intune Azure console or selected by a user during device enrollment. You can filter reports and create dynamic Azure Active Directory device groups based on device categories.'
+ microsoft.graph.deviceCompliancePolicyState:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personAward
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: deviceCompliancePolicyState
type: object
properties:
- description:
- type: string
- description: Descpription of the award or honor.
- nullable: true
displayName:
type: string
- description: Name of the award or honor.
- issuedDate:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
- type: string
- description: The date that the award or honor was granted.
- format: date
- nullable: true
- issuingAuthority:
- type: string
- description: Authority which granted the award or honor.
+ description: The name of the policy for this policyBase
nullable: true
- thumbnailUrl:
+ platformType:
+ $ref: '#/components/schemas/microsoft.graph.policyPlatformType'
+ settingCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Count of how many setting a policy holds
+ format: int32
+ settingStates:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.deviceCompliancePolicySettingState'
+ state:
+ $ref: '#/components/schemas/microsoft.graph.complianceStatus'
+ userId:
type: string
- description: URL referencing a thumbnail of the award or honor.
+ description: 'User unique identifier, must be Guid'
nullable: true
- webUrl:
+ userPrincipalName:
type: string
- description: URL referencing the award or honor.
+ description: User Principal Name
nullable: true
+ version:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The version of the policy
+ format: int32
additionalProperties:
type: object
- microsoft.graph.personCertification:
+ description: Device Compliance Policy State for a given device.
+ microsoft.graph.deviceConfigurationState:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personCertification
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: deviceConfigurationState
type: object
properties:
- certificationId:
+ displayName:
type: string
- description: The referenceable identifier for the certification.
+ description: The name of the policy for this policyBase
nullable: true
- description:
+ platformType:
+ $ref: '#/components/schemas/microsoft.graph.policyPlatformType'
+ settingCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Count of how many setting a policy holds
+ format: int32
+ settingStates:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.deviceConfigurationSettingState'
+ state:
+ $ref: '#/components/schemas/microsoft.graph.complianceStatus'
+ userId:
type: string
- description: Description of the certification.
+ description: 'User unique identifier, must be Guid'
nullable: true
- displayName:
- type: string
- description: Title of the certification.
- endDate:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ userPrincipalName:
type: string
- description: The date that the certification expires.
- format: date
+ description: User Principal Name
nullable: true
- issuedDate:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ version:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The version of the policy
+ format: int32
+ additionalProperties:
+ type: object
+ description: Device Configuration State for a given device.
+ microsoft.graph.deviceHealthScriptPolicyState:
+ title: deviceHealthScriptPolicyState
+ type: object
+ properties:
+ assignmentFilterIds:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: A list of the assignment filter ids used for health script applicability evaluation
+ detectionState:
+ $ref: '#/components/schemas/microsoft.graph.runState'
+ deviceId:
+ type: string
+ description: The Intune device Id
+ deviceName:
+ type: string
+ description: Display name of the device
+ nullable: true
+ expectedStateUpdateDateTime:
+ 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 next timestamp of when the device health script is expected to execute
+ format: date-time
+ nullable: true
+ id:
+ type: string
+ description: Key of the device health script policy state is a concatenation of the MT sideCar policy Id and Intune device Id
+ lastStateUpdateDateTime:
+ 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 timestamp of when the device health script executed
+ format: date-time
+ 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 that Intune Managment Extension synced with Intune
+ format: date-time
+ osVersion:
+ type: string
+ description: Value of the OS Version in string
+ nullable: true
+ policyId:
+ type: string
+ description: The MT sideCar policy Id
+ policyName:
+ type: string
+ description: Display name of the device health script
+ nullable: true
+ postRemediationDetectionScriptError:
+ type: string
+ description: Error from the detection script after remediation
+ nullable: true
+ postRemediationDetectionScriptOutput:
+ type: string
+ description: Detection script output after remediation
+ nullable: true
+ preRemediationDetectionScriptError:
+ type: string
+ description: Error from the detection script before remediation
+ nullable: true
+ preRemediationDetectionScriptOutput:
+ type: string
+ description: Output of the detection script before remediation
+ nullable: true
+ remediationScriptError:
+ type: string
+ description: Error output of the remediation script
+ nullable: true
+ remediationState:
+ $ref: '#/components/schemas/microsoft.graph.remediationState'
+ userName:
+ type: string
+ description: Name of the user whom ran the device health script
+ nullable: true
+ additionalProperties:
+ type: object
+ description: Contains properties for policy run state of the device health script.
+ microsoft.graph.deviceLogCollectionResponse:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: deviceLogCollectionResponse
+ type: object
+ properties:
+ enrolledByUser:
type: string
- description: The date that the certification was issued.
- format: date
+ description: The User Principal Name (UPN) of the user that enrolled the device.
nullable: true
- issuingAuthority:
+ errorCode:
+ type: integer
+ description: 'The error code, if any. Valid values -9.22337203685478E+18 to 9.22337203685478E+18'
+ format: int64
+ expirationDateTimeUTC:
+ 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: Authority which granted the certification.
+ description: The DateTime of the expiration of the logs.
+ format: date-time
nullable: true
- issuingCompany:
+ initiatedByUserPrincipalName:
type: string
- description: Company which granted the certification.
+ description: The UPN for who initiated the request.
nullable: true
- startDate:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ managedDeviceId:
+ 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 date that the certification became valid.
- format: date
- nullable: true
- thumbnailUrl:
+ description: Indicates Intune device unique identifier.
+ format: uuid
+ receivedDateTimeUTC:
+ 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: URL referencing a thumbnail of the certification.
+ description: The DateTime the request was received.
+ format: date-time
nullable: true
- webUrl:
+ requestedDateTimeUTC:
+ 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: URL referencing the certification.
+ description: The DateTime of the request.
+ format: date-time
nullable: true
+ size:
+ type: number
+ description: The size of the logs. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
+ format: double
+ sizeInKB:
+ type: number
+ description: The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308
+ format: double
+ status:
+ $ref: '#/components/schemas/microsoft.graph.appLogUploadState'
additionalProperties:
type: object
- microsoft.graph.educationalActivity:
+ description: Windows Log Collection request entity.
+ microsoft.graph.managedDeviceMobileAppConfigurationState:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: educationalActivity
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: managedDeviceMobileAppConfigurationState
type: object
properties:
- completionMonthYear:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ displayName:
type: string
- description: The month and year the user graduated or completed the activity.
- format: date
+ description: The name of the policy for this policyBase
nullable: true
- endMonthYear:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ platformType:
+ $ref: '#/components/schemas/microsoft.graph.policyPlatformType'
+ settingCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Count of how many setting a policy holds
+ format: int32
+ settingStates:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.managedDeviceMobileAppConfigurationSettingState'
+ state:
+ $ref: '#/components/schemas/microsoft.graph.complianceStatus'
+ userId:
type: string
- description: The month and year the user completed the educational activity referenced.
- format: date
+ description: 'User unique identifier, must be Guid'
nullable: true
- institution:
- $ref: '#/components/schemas/microsoft.graph.institutionData'
- program:
- $ref: '#/components/schemas/microsoft.graph.educationalActivityDetail'
- startMonthYear:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ userPrincipalName:
type: string
- description: The month and year the user commenced the activity referenced.
- format: date
+ description: User Principal Name
nullable: true
+ version:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The version of the policy
+ format: int32
additionalProperties:
type: object
- microsoft.graph.itemEmail:
+ description: Managed Device Mobile App Configuration State for a given device.
+ microsoft.graph.securityBaselineState:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: itemEmail
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: securityBaselineState
type: object
properties:
- address:
- type: string
- description: The email address itself.
displayName:
type: string
- description: The name or label a user has associated with a particular email address.
+ description: The display name of the security baseline
+ securityBaselineTemplateId:
+ type: string
+ description: The security baseline template id
nullable: true
- type:
- $ref: '#/components/schemas/microsoft.graph.emailType'
+ state:
+ $ref: '#/components/schemas/microsoft.graph.securityBaselineComplianceState'
+ userPrincipalName:
+ type: string
+ description: User Principal Name
+ nullable: true
+ settingStates:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.securityBaselineSettingState'
+ description: The security baseline state for different settings for a device
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.personInterest:
+ description: Security baseline state for a device.
+ microsoft.graph.windowsProtectionState:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personInterest
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: windowsProtectionState
type: object
properties:
- categories:
- type: array
- items:
- type: string
- nullable: true
- description: 'Contains categories a user has associated with the interest (for example, personal, recipies).'
- collaborationTags:
- type: array
- items:
- type: string
- nullable: true
- description: 'Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.'
- description:
+ antiMalwareVersion:
type: string
- description: Contains a description of the interest.
+ description: Current anti malware version
nullable: true
- displayName:
- type: string
- description: Contains a friendly name for the interest.
- thumbnailUrl:
+ deviceState:
+ $ref: '#/components/schemas/microsoft.graph.windowsDeviceHealthState'
+ engineVersion:
type: string
+ description: Current endpoint protection engine's version
nullable: true
- webUrl:
- type: string
- description: Contains a link to a web page or resource about the interest.
+ fullScanOverdue:
+ type: boolean
+ description: 'When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.'
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.languageProficiency:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: languageProficiency
- type: object
- properties:
- displayName:
- type: string
- description: Contains the long-form name for the language.
- proficiency:
- $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
- reading:
- $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
- spoken:
- $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
- tag:
+ fullScanRequired:
+ type: boolean
+ description: 'When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.'
+ nullable: true
+ isVirtualMachine:
+ type: boolean
+ description: 'When TRUE indicates the device is a virtual machine, when FALSE indicates the device is not a virtual machine. Defaults to setting on client device.'
+ nullable: true
+ lastFullScanDateTime:
+ 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: 'Contains the four-character BCP47 name for the language (en-US, no-NB, en-AU).'
+ description: Last quick scan datetime
+ format: date-time
nullable: true
- thumbnailUrl:
+ lastFullScanSignatureVersion:
type: string
+ description: Last full scan signature version
nullable: true
- written:
- $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
- additionalProperties:
- type: object
- microsoft.graph.personName:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personName
- type: object
- properties:
- displayName:
+ lastQuickScanDateTime:
+ 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: Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.
+ description: Last quick scan datetime
+ format: date-time
nullable: true
- first:
+ lastQuickScanSignatureVersion:
type: string
- description: First name of the user.
+ description: Last quick scan signature version
nullable: true
- initials:
+ 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: Initials of the user.
+ description: Last device health status reported time
+ format: date-time
nullable: true
- languageTag:
+ malwareProtectionEnabled:
+ type: boolean
+ description: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.
+ nullable: true
+ networkInspectionSystemEnabled:
+ type: boolean
+ description: 'When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.'
+ nullable: true
+ productStatus:
+ $ref: '#/components/schemas/microsoft.graph.windowsDefenderProductStatus'
+ quickScanOverdue:
+ type: boolean
+ description: 'When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.'
+ nullable: true
+ realTimeProtectionEnabled:
+ type: boolean
+ description: 'When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.'
+ nullable: true
+ rebootRequired:
+ type: boolean
+ description: 'When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.'
+ nullable: true
+ signatureUpdateOverdue:
+ type: boolean
+ description: 'When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.'
+ nullable: true
+ signatureVersion:
type: string
- description: 'Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.'
+ description: Current malware definitions version
nullable: true
- last:
+ tamperProtectionEnabled:
+ type: boolean
+ description: 'When TRUE indicates the Windows Defender tamper protection feature is enabled, when FALSE indicates the Windows Defender tamper protection feature is not enabled. Defaults to setting on client device.'
+ nullable: true
+ detectedMalwareState:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.windowsDeviceMalwareState'
+ description: Device malware list
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ description: Device protection status entity.
+ microsoft.graph.inferenceClassificationType:
+ title: inferenceClassificationType
+ enum:
+ - focused
+ - other
+ type: string
+ microsoft.graph.internetMessageHeader:
+ title: internetMessageHeader
+ type: object
+ properties:
+ name:
+ type: string
+ description: Represents the key in a key-value pair.
+ nullable: true
+ value:
+ type: string
+ description: The value in a key-value pair.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.mentionsPreview:
+ title: mentionsPreview
+ type: object
+ properties:
+ isMentioned:
+ type: boolean
+ description: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.mention:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: mention
+ type: object
+ properties:
+ application:
type: string
- description: Last name of the user.
+ description: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.
nullable: true
- maiden:
+ clientReference:
type: string
- description: Maiden name of the user.
+ description: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.
nullable: true
- middle:
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.emailAddress'
+ 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: Middle name of the user.
+ description: The date and time that the mention is created on the client.
+ format: date-time
nullable: true
- nickname:
+ deepLink:
type: string
- description: Nickname of the user.
+ description: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.
nullable: true
- pronunciation:
- $ref: '#/components/schemas/microsoft.graph.personNamePronounciation'
- suffix:
+ mentioned:
+ $ref: '#/components/schemas/microsoft.graph.emailAddress'
+ mentionText:
type: string
- description: 'Designators used after the users name (eg: PhD.)'
+ description: 'Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.'
nullable: true
- title:
+ serverCreatedDateTime:
+ 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: 'Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)'
+ description: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.personAnnotation:
+ microsoft.graph.mobileAppIntentAndStateDetail:
+ title: mobileAppIntentAndStateDetail
+ type: object
+ properties:
+ applicationId:
+ type: string
+ description: MobieApp identifier.
+ nullable: true
+ displayName:
+ type: string
+ description: The admin provided or imported title of the app.
+ nullable: true
+ displayVersion:
+ type: string
+ description: Human readable version of the application
+ nullable: true
+ installState:
+ $ref: '#/components/schemas/microsoft.graph.resultantAppState'
+ mobileAppIntent:
+ $ref: '#/components/schemas/microsoft.graph.mobileAppIntent'
+ supportedDeviceTypes:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.mobileAppSupportedDeviceType'
+ description: The supported platforms for the app.
+ additionalProperties:
+ type: object
+ description: Mobile App Intent and Install State for a given device.
+ microsoft.graph.mobileAppTroubleshootingHistoryItem:
+ title: mobileAppTroubleshootingHistoryItem
+ type: object
+ properties:
+ occurrenceDateTime:
+ 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: Time when the history item occurred.
+ format: date-time
+ troubleshootingErrorDetails:
+ $ref: '#/components/schemas/microsoft.graph.deviceManagementTroubleshootingErrorDetails'
+ additionalProperties:
+ type: object
+ description: History Item contained in the Mobile App Troubleshooting Event.
+ microsoft.graph.appLogCollectionRequest:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personAnnotation
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: appLogCollectionRequest
type: object
properties:
- detail:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- displayName:
+ completedDateTime:
+ 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: Contains a friendly name for the note.
+ description: Time at which the upload log request reached a completed state if not completed yet NULL will be returned.
+ format: date-time
nullable: true
- thumbnailUrl:
+ customLogFolders:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: List of log folders.
+ errorMessage:
type: string
+ description: Indicates error message if any during the upload process.
nullable: true
+ status:
+ $ref: '#/components/schemas/microsoft.graph.appLogUploadState'
additionalProperties:
type: object
- microsoft.graph.itemPatent:
+ description: Entity for AppLogCollectionRequest contains all logs values.
+ microsoft.graph.payloadTypes:
+ title: payloadTypes
+ type: object
+ properties:
+ rawContent:
+ type: string
+ description: 'The notification content of a raw user notification that will be delivered to and consumed by the app client on all supported platforms (Windows, iOS, Android or WebPush) receiving this notification. At least one of Payload.RawContent or Payload.VisualContent needs to be valid for a POST Notification request.'
+ nullable: true
+ visualContent:
+ $ref: '#/components/schemas/microsoft.graph.visualProperties'
+ additionalProperties:
+ type: object
+ microsoft.graph.priority:
+ title: priority
+ enum:
+ - None
+ - High
+ - Low
+ type: string
+ microsoft.graph.targetPolicyEndpoints:
+ title: targetPolicyEndpoints
+ type: object
+ properties:
+ platformTypes:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'Use to filter the notification distribution to a specific platform or platforms. Valid values are Windows, iOS, Android and WebPush. By default, all push endpoint types (Windows, iOS, Android and WebPush) are enabled.'
+ additionalProperties:
+ type: object
+ microsoft.graph.notebook:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: itemPatent
+ - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
+ - title: notebook
type: object
properties:
- description:
- type: string
- description: Descpription of the patent or filing.
- nullable: true
- displayName:
- type: string
- description: Title of the patent or filing.
- isPending:
+ isDefault:
type: boolean
- description: Indicates the patent is pending.
- nullable: true
- issuedDate:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
- type: string
- description: The date that the patent was granted.
- format: date
- nullable: true
- issuingAuthority:
- type: string
- description: Authority which granted the patent.
+ description: Indicates whether this is the user's default notebook. Read-only.
nullable: true
- number:
- type: string
- description: The patent number.
+ isShared:
+ type: boolean
+ description: 'Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.'
nullable: true
- webUrl:
+ links:
+ $ref: '#/components/schemas/microsoft.graph.notebookLinks'
+ sectionGroupsUrl:
type: string
- description: URL referencing the patent or filing.
+ description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.'
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.itemPhone:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: itemPhone
- type: object
- properties:
- displayName:
+ sectionsUrl:
type: string
- description: Friendly name the user has assigned this phone number.
+ description: 'The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.'
nullable: true
- number:
- type: string
- description: Phone number provided by the user.
- type:
- $ref: '#/components/schemas/microsoft.graph.phoneType'
- additionalProperties:
- type: object
- microsoft.graph.workPosition:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: workPosition
- type: object
- properties:
- categories:
+ userRole:
+ $ref: '#/components/schemas/microsoft.graph.onenoteUserRole'
+ sectionGroups:
type: array
items:
- type: string
- nullable: true
- description: Categories that the user has associated with this position.
- colleagues:
+ $ref: '#/components/schemas/microsoft.graph.sectionGroup'
+ description: The section groups in the notebook. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ sections:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.relatedPerson'
- description: Colleagues that are associated with this position.
- detail:
- $ref: '#/components/schemas/microsoft.graph.positionDetail'
- isCurrent:
- type: boolean
- description: Denotes whether or not the position is current.
- nullable: true
- manager:
- $ref: '#/components/schemas/microsoft.graph.relatedPerson'
+ $ref: '#/components/schemas/microsoft.graph.onenoteSection'
+ description: The sections in the notebook. Read-only. Nullable.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.projectParticipation:
+ microsoft.graph.onenoteOperation:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: projectParticipation
+ - $ref: '#/components/schemas/microsoft.graph.operation'
+ - title: onenoteOperation
type: object
properties:
- categories:
- type: array
- items:
- type: string
- nullable: true
- description: 'Contains categories a user has associated with the project (for example, digital transformation, oil rig).'
- client:
- $ref: '#/components/schemas/microsoft.graph.companyDetail'
- collaborationTags:
- type: array
- items:
- type: string
- nullable: true
- description: 'Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.'
- colleagues:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.relatedPerson'
- description: Lists people that also worked on the project.
- detail:
- $ref: '#/components/schemas/microsoft.graph.positionDetail'
- displayName:
+ error:
+ $ref: '#/components/schemas/microsoft.graph.onenoteOperationError'
+ percentComplete:
type: string
- description: Contains a friendly name for the project.
- sponsors:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.relatedPerson'
- description: The Person or people who sponsored the project.
- thumbnailUrl:
+ description: The operation percent complete if the operation is still in running status.
+ nullable: true
+ resourceId:
+ type: string
+ description: The resource id.
+ nullable: true
+ resourceLocation:
type: string
+ description: 'The resource URI for the object. For example, the resource URI for a copied page or section.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.itemPublication:
+ microsoft.graph.onenotePage:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: itemPublication
+ - $ref: '#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel'
+ - title: onenotePage
type: object
properties:
- description:
+ content:
type: string
- description: Description of the publication.
+ description: The page's HTML content.
+ format: base64url
nullable: true
- displayName:
- type: string
- description: Title of the publication.
- publishedDate:
- pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ contentUrl:
type: string
- description: The date that the publication was published.
- format: date
+ description: The URL for the page's HTML content. Read-only.
nullable: true
- publisher:
+ createdByAppId:
type: string
- description: Publication or publisher for the publication.
+ description: The unique identifier of the application that created the page. Read-only.
nullable: true
- thumbnailUrl:
+ 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: URL referencing a thumbnail of the publication.
+ description: 'The date and time when the page was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
+ format: date-time
nullable: true
- webUrl:
+ level:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The indentation level of the page. Read-only.
+ format: int32
+ nullable: true
+ links:
+ $ref: '#/components/schemas/microsoft.graph.pageLinks'
+ order:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The order of the page within its parent section. Read-only.
+ format: int32
+ nullable: true
+ title:
type: string
- description: URL referencing the publication.
+ description: The title of the page.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.skillProficiency:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: skillProficiency
- type: object
- properties:
- categories:
- type: array
- items:
- type: string
- nullable: true
- description: 'Contains categories a user has associated with the skill (for example, personal, professional, hobby).'
- collaborationTags:
+ userTags:
type: array
items:
type: string
nullable: true
- description: 'Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.'
- displayName:
- type: string
- description: Contains a friendly name for the skill.
- proficiency:
- $ref: '#/components/schemas/microsoft.graph.skillProficiencyLevel'
- thumbnailUrl:
- type: string
- nullable: true
- webUrl:
- type: string
- description: Contains a link to an information source about the skill.
- nullable: true
+ parentNotebook:
+ $ref: '#/components/schemas/microsoft.graph.notebook'
+ parentSection:
+ $ref: '#/components/schemas/microsoft.graph.onenoteSection'
additionalProperties:
type: object
- microsoft.graph.webAccount:
+ microsoft.graph.onenoteResource:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: webAccount
+ - $ref: '#/components/schemas/microsoft.graph.onenoteEntityBaseModel'
+ - title: onenoteResource
type: object
properties:
- description:
- type: string
- description: Contains the description the user has provided for the account on the service being referenced.
- nullable: true
- service:
- $ref: '#/components/schemas/microsoft.graph.serviceInformation'
- statusMessage:
- type: string
- description: Contains a status message from the cloud service if provided or synchronized.
- nullable: true
- thumbnailUrl:
+ content:
type: string
+ format: base64url
nullable: true
- userId:
- type: string
- description: The user name displayed for the webaccount.
- webUrl:
+ contentUrl:
type: string
- description: Contains a link to the user's profile on the cloud service if one exists.
nullable: true
additionalProperties:
type: object
- microsoft.graph.personWebsite:
+ microsoft.graph.sectionGroup:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.itemFacet'
- - title: personWebsite
+ - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
+ - title: sectionGroup
type: object
properties:
- categories:
- type: array
- items:
- type: string
- nullable: true
- description: 'Contains categories a user has associated with the website (for example, personal, recipes).'
- description:
+ sectionGroupsUrl:
type: string
- description: Contains a description of the website.
+ description: 'The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.'
nullable: true
- displayName:
- type: string
- description: Contains a friendly name for the website.
- thumbnailUrl:
+ sectionsUrl:
type: string
+ description: 'The URL for the sections navigation property, which returns all the sections in the section group. Read-only.'
nullable: true
- webUrl:
- type: string
- description: Contains a link to the website itself.
+ parentNotebook:
+ $ref: '#/components/schemas/microsoft.graph.notebook'
+ parentSectionGroup:
+ $ref: '#/components/schemas/microsoft.graph.sectionGroup'
+ sectionGroups:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.sectionGroup'
+ description: The section groups in the section. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ sections:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onenoteSection'
+ description: The sections in the section group. Read-only. Nullable.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.Json:
- title: Json
- type: object
- additionalProperties:
- type: object
- microsoft.graph.status:
- title: status
- enum:
- - active
- - updated
- - deleted
- - ignored
- - unknownFutureValue
- type: string
- microsoft.graph.visualInfo:
- title: visualInfo
- type: object
- properties:
- attribution:
- $ref: '#/components/schemas/microsoft.graph.imageInfo'
- backgroundColor:
- type: string
- description: Optional. Background color used to render the activity in the UI - brand color for the application source of the activity. Must be a valid hex color
- nullable: true
- content:
- $ref: '#/components/schemas/microsoft.graph.Json'
- description:
- type: string
- description: 'Optional. Longer text description of the user''s unique activity (example: document name, first sentence, and/or metadata)'
- nullable: true
- displayText:
- type: string
- description: 'Required. Short text description of the user''s unique activity (for example, document name in cases where an activity refers to document creation)'
- additionalProperties:
- type: object
- microsoft.graph.activityHistoryItem:
+ microsoft.graph.onenoteSection:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: activityHistoryItem
+ - $ref: '#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel'
+ - title: onenoteSection
type: object
properties:
- activeDurationSeconds:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- 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
- 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
- format: date-time
- nullable: true
- lastActiveDateTime:
- 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
- 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
- format: date-time
- nullable: true
- startedDateTime:
- 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
- status:
- $ref: '#/components/schemas/microsoft.graph.status'
- userTimezone:
- type: string
+ isDefault:
+ type: boolean
+ description: Indicates whether this is the user's default section. Read-only.
nullable: true
- activity:
- $ref: '#/components/schemas/microsoft.graph.userActivity'
- additionalProperties:
- type: object
- microsoft.graph.alternativeSecurityId:
- title: alternativeSecurityId
- type: object
- properties:
- identityProvider:
- type: string
- description: For internal use only.
- nullable: true
- key:
- type: string
- description: For internal use only.
- format: base64url
- nullable: true
- type:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: For internal use only.
- format: int32
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.command:
+ links:
+ $ref: '#/components/schemas/microsoft.graph.sectionLinks'
+ pagesUrl:
+ type: string
+ description: The pages endpoint where you can get details for all the pages in the section. Read-only.
+ nullable: true
+ pages:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onenotePage'
+ description: The collection of pages in the section. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ parentNotebook:
+ $ref: '#/components/schemas/microsoft.graph.notebook'
+ parentSectionGroup:
+ $ref: '#/components/schemas/microsoft.graph.sectionGroup'
+ additionalProperties:
+ type: object
+ microsoft.graph.onlineMeetingBase:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: command
+ - title: onlineMeetingBase
type: object
properties:
- appServiceName:
- type: string
+ allowAttendeeToEnableCamera:
+ type: boolean
+ description: Indicates whether attendees can turn on their camera.
nullable: true
- error:
- type: string
+ allowAttendeeToEnableMic:
+ type: boolean
+ description: Indicates whether attendees can turn on their microphone.
nullable: true
- packageFamilyName:
- type: string
+ allowedPresenters:
+ $ref: '#/components/schemas/microsoft.graph.onlineMeetingPresenters'
+ allowMeetingChat:
+ $ref: '#/components/schemas/microsoft.graph.meetingChatMode'
+ allowParticipantsToChangeName:
+ type: boolean
+ description: Specifies if participants are allowed to rename themselves in an instance of the meeting.
nullable: true
- payload:
- $ref: '#/components/schemas/microsoft.graph.payloadRequest'
- permissionTicket:
- type: string
+ allowRecording:
+ type: boolean
+ description: Indicates whether recording is enabled for the meeting.
nullable: true
- postBackUri:
+ allowTeamworkReactions:
+ type: boolean
+ description: Indicates if Teams reactions are enabled for the meeting.
+ nullable: true
+ allowTranscription:
+ type: boolean
+ description: Indicates whether transcription is enabled for the meeting.
+ nullable: true
+ anonymizeIdentityForRoles:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.onlineMeetingRole'
+ description: 'Specifies whose identity is anonymized in the meeting. Possible values are: attendee. The attendee value can''t be removed through a PATCH operation once added.'
+ audioConferencing:
+ $ref: '#/components/schemas/microsoft.graph.audioConferencing'
+ chatInfo:
+ $ref: '#/components/schemas/microsoft.graph.chatInfo'
+ chatRestrictions:
+ $ref: '#/components/schemas/microsoft.graph.chatRestrictions'
+ isEndToEndEncryptionEnabled:
+ type: boolean
+ nullable: true
+ isEntryExitAnnounced:
+ type: boolean
+ description: Indicates whether to announce when callers join or leave.
+ nullable: true
+ joinInformation:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ joinMeetingIdSettings:
+ $ref: '#/components/schemas/microsoft.graph.joinMeetingIdSettings'
+ joinWebUrl:
type: string
+ description: The join URL of the online meeting. Read-only.
nullable: true
- status:
+ lobbyBypassSettings:
+ $ref: '#/components/schemas/microsoft.graph.lobbyBypassSettings'
+ recordAutomatically:
+ type: boolean
+ description: Indicates whether to record the meeting automatically.
+ nullable: true
+ shareMeetingChatHistoryDefault:
+ $ref: '#/components/schemas/microsoft.graph.meetingChatHistoryDefaultMode'
+ subject:
type: string
+ description: The subject of the online meeting.
nullable: true
- type:
+ videoTeleconferenceId:
type: string
+ description: The video teleconferencing ID. Read-only.
nullable: true
- responsepayload:
- $ref: '#/components/schemas/microsoft.graph.payloadResponse'
+ watermarkProtection:
+ $ref: '#/components/schemas/microsoft.graph.watermarkProtectionValues'
+ attendanceReports:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.meetingAttendanceReport'
+ description: The attendance reports of an online meeting. Read-only.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.onlineMeetingPresenters:
- title: onlineMeetingPresenters
- enum:
- - everyone
- - organization
- - roleIsPresenter
- - organizer
- - unknownFutureValue
- type: string
- microsoft.graph.meetingChatMode:
- title: meetingChatMode
- enum:
- - enabled
- - disabled
- - limited
- - unknownFutureValue
- type: string
- microsoft.graph.onlineMeetingRole:
- title: onlineMeetingRole
- enum:
- - attendee
- - presenter
- - unknownFutureValue
- - producer
- - coorganizer
- type: string
- microsoft.graph.audioConferencing:
- title: audioConferencing
- type: object
- properties:
- conferenceId:
- type: string
- description: The conference id of the online meeting.
- nullable: true
- dialinUrl:
- type: string
- description: A URL to the externally-accessible web page that contains dial-in information.
- nullable: true
- tollFreeNumber:
- type: string
- nullable: true
- tollFreeNumbers:
- type: array
- items:
- type: string
- nullable: true
- description: List of toll-free numbers that are displayed in the meeting invite.
- tollNumber:
- type: string
- nullable: true
- tollNumbers:
- type: array
- items:
- type: string
- nullable: true
- description: List of toll numbers that are displayed in the meeting invite.
- additionalProperties:
- type: object
microsoft.graph.broadcastMeetingSettings:
title: broadcastMeetingSettings
type: object
@@ -36197,63 +35943,6 @@ components:
- questionAndAnswer
- unknownFutureValue
type: string
- microsoft.graph.chatInfo:
- title: chatInfo
- type: object
- properties:
- messageId:
- type: string
- description: The unique identifier for a message in a Microsoft Teams channel.
- nullable: true
- replyChainMessageId:
- type: string
- description: The ID of the reply message.
- nullable: true
- threadId:
- type: string
- description: The unique identifier for a thread in Microsoft Teams.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.chatRestrictions:
- title: chatRestrictions
- type: object
- properties:
- allowTextOnly:
- type: boolean
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.joinMeetingIdSettings:
- title: joinMeetingIdSettings
- type: object
- properties:
- isPasscodeRequired:
- type: boolean
- description: Indicates whether a passcode is required to join a meeting when using joinMeetingId. Optional.
- nullable: true
- joinMeetingId:
- type: string
- description: The meeting ID to be used to join a meeting. Optional. Read-only.
- nullable: true
- passcode:
- type: string
- description: The passcode to join a meeting. Optional. Read-only.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.lobbyBypassSettings:
- title: lobbyBypassSettings
- type: object
- properties:
- isDialInBypassEnabled:
- type: boolean
- description: Specifies whether or not to always let dial-in callers bypass the lobby. Optional.
- nullable: true
- scope:
- $ref: '#/components/schemas/microsoft.graph.lobbyBypassScope'
- additionalProperties:
- type: object
microsoft.graph.meetingParticipants:
title: meetingParticipants
type: object
@@ -36275,27 +35964,6 @@ components:
$ref: '#/components/schemas/microsoft.graph.meetingParticipantInfo'
additionalProperties:
type: object
- microsoft.graph.meetingChatHistoryDefaultMode:
- title: meetingChatHistoryDefaultMode
- enum:
- - none
- - all
- - unknownFutureValue
- type: string
- microsoft.graph.watermarkProtectionValues:
- title: watermarkProtectionValues
- type: object
- properties:
- isEnabledForContentSharing:
- type: boolean
- description: Indicates whether to apply a watermark to any shared content.
- nullable: true
- isEnabledForVideo:
- type: boolean
- description: Indicates whether to apply a watermark to everyone's video feed.
- nullable: true
- additionalProperties:
- type: object
microsoft.graph.meetingAttendanceReport:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
@@ -36329,6 +35997,39 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
+ microsoft.graph.callRecording:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: callRecording
+ type: object
+ properties:
+ content:
+ type: string
+ description: The content of the recording. Read-only.
+ format: base64url
+ 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 at which the recording was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
+ format: date-time
+ nullable: true
+ meetingId:
+ type: string
+ description: The unique identifier of the onlineMeeting related to this recording. Read-only.
+ nullable: true
+ meetingOrganizer:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ meetingOrganizerId:
+ type: string
+ description: The unique identifier of the organizer of the onlineMeeting related to this recording. Read-only.
+ nullable: true
+ recordingContentUrl:
+ type: string
+ description: The URL which can be used to access the content of the recording. Read-only.
+ nullable: true
+ additionalProperties:
+ type: object
microsoft.graph.meetingRegistration:
allOf:
- $ref: '#/components/schemas/microsoft.graph.meetingRegistrationBase'
@@ -36379,1113 +36080,1314 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.callRecording:
+ microsoft.graph.callTranscript:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: callRecording
+ - title: callTranscript
type: object
properties:
content:
type: string
- description: The content of the recording. Read-only.
+ description: The content of the transcript. Read-only.
format: base64url
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 at which the recording was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
+ description: 'Date and time at which the transcript was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
meetingId:
type: string
- description: The unique identifier of the onlineMeeting related to this recording. Read-only.
+ description: The unique identifier of the online meeting related to this transcript. Read-only.
nullable: true
meetingOrganizer:
$ref: '#/components/schemas/microsoft.graph.identitySet'
meetingOrganizerId:
type: string
- description: The unique identifier of the organizer of the onlineMeeting related to this recording. Read-only.
+ description: The unique identifier of the organizer of the onlineMeeting related to this transcript. Read-only.
nullable: true
- recordingContentUrl:
+ metadataContent:
type: string
- description: The URL which can be used to access the content of the recording. Read-only.
+ description: The time-aligned metadata of the utterances in the transcript. Read-only.
+ format: base64url
+ nullable: true
+ transcriptContentUrl:
+ type: string
+ description: The URL which can be used to access the content of the transcript. Read-only.
nullable: true
additionalProperties:
type: object
- microsoft.graph.callTranscript:
+ microsoft.graph.outlookCategory:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: callTranscript
+ - title: outlookCategory
type: object
properties:
- content:
+ color:
+ $ref: '#/components/schemas/microsoft.graph.categoryColor'
+ displayName:
type: string
- description: The content of the transcript. Read-only.
- format: base64url
+ description: 'A unique name that identifies a category in the user''s mailbox. After a category is created, the name cannot be changed. 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])$'
+ additionalProperties:
+ type: object
+ microsoft.graph.outlookTaskFolder:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: outlookTaskFolder
+ type: object
+ properties:
+ changeKey:
type: string
- description: 'Date and time at which the transcript was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
- format: date-time
+ description: The version of the task folder.
nullable: true
- meetingId:
+ isDefaultFolder:
+ type: boolean
+ description: True if the folder is the default task folder.
+ nullable: true
+ name:
type: string
- description: The unique identifier of the online meeting related to this transcript. Read-only.
+ description: The name of the task folder.
nullable: true
- meetingOrganizer:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- meetingOrganizerId:
+ parentGroupKey:
+ 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 of the organizer of the onlineMeeting related to this transcript. Read-only.
+ description: The unique GUID identifier for the task folder's parent group.
+ format: uuid
nullable: true
- metadataContent:
+ multiValueExtendedProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
+ description: The collection of multi-value extended properties defined for the task folder. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ singleValueExtendedProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
+ description: The collection of single-value extended properties defined for the task folder. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ tasks:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.outlookTask'
+ description: The tasks in this task folder. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.outlookTaskGroup:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: outlookTaskGroup
+ type: object
+ properties:
+ changeKey:
type: string
- description: The time-aligned metadata of the utterances in the transcript. Read-only.
- format: base64url
+ description: The version of the task group.
nullable: true
- transcriptContentUrl:
+ groupKey:
+ 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 URL which can be used to access the content of the transcript. Read-only.
+ description: The unique GUID identifier for the task group.
+ format: uuid
+ nullable: true
+ isDefaultGroup:
+ type: boolean
+ description: True if the task group is the default task group.
+ nullable: true
+ name:
+ type: string
+ description: The name of the task group.
nullable: true
+ taskFolders:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.outlookTaskFolder'
+ description: The collection of task folders in the task group. Read-only. Nullable.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.outOfOfficeSettings:
- title: outOfOfficeSettings
- type: object
- properties:
- isOutOfOffice:
- type: boolean
- description: 'True if either:It is currently in the out of office time window configured on the Outlook or Teams client.There is currently an event on the user''s calendar that''s marked as Show as Out of OfficeOtherwise, false.'
- nullable: true
- message:
- type: string
- description: The out of office message that the user configured on Outlook client (Automatic Replies (Out of Office)) or the Teams client (Schedule out of office).
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.presenceStatusMessage:
- title: presenceStatusMessage
- type: object
- properties:
- expiryDateTime:
- $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
- message:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- 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: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
- format: date-time
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.virtualEventWebinar:
+ microsoft.graph.outlookTask:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.virtualEvent'
- - title: virtualEventWebinar
+ - $ref: '#/components/schemas/microsoft.graph.outlookItem'
+ - title: outlookTask
type: object
properties:
- audience:
- $ref: '#/components/schemas/microsoft.graph.meetingAudience'
- coOrganizers:
+ assignedTo:
+ type: string
+ description: The name of the person who has been assigned the task in Outlook. Read-only.
+ nullable: true
+ body:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ completedDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ dueDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ hasAttachments:
+ type: boolean
+ description: Set to true if the task has attachments.
+ nullable: true
+ importance:
+ $ref: '#/components/schemas/microsoft.graph.importance'
+ isReminderOn:
+ type: boolean
+ nullable: true
+ owner:
+ type: string
+ nullable: true
+ parentFolderId:
+ type: string
+ nullable: true
+ recurrence:
+ $ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
+ reminderDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ sensitivity:
+ $ref: '#/components/schemas/microsoft.graph.sensitivity'
+ startDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ status:
+ $ref: '#/components/schemas/microsoft.graph.taskStatus'
+ subject:
+ type: string
+ nullable: true
+ attachments:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.communicationsUserIdentity'
- description: Identity information of coorganizers of the webinar.
- registrationConfiguration:
- $ref: '#/components/schemas/microsoft.graph.virtualEventRegistrationConfiguration'
- registrations:
+ $ref: '#/components/schemas/microsoft.graph.attachment'
+ description: 'The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the task. Read-only. Nullable.'
+ x-ms-navigationProperty: true
+ multiValueExtendedProperties:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.virtualEventRegistration'
- description: Registration records of the webinar.
+ $ref: '#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty'
+ description: The collection of multi-value extended properties defined for the task. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ singleValueExtendedProperties:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty'
+ description: The collection of single-value extended properties defined for the task. Read-only. Nullable.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.signInPreferences:
- title: signInPreferences
- type: object
- properties:
- isSystemPreferredAuthenticationMethodEnabled:
- type: boolean
- description: Indicates whether the credential preferences of the system are enabled.
- nullable: true
- userPreferredMethodForSecondaryAuthentication:
- $ref: '#/components/schemas/microsoft.graph.userDefaultAuthenticationMethodType'
- additionalProperties:
- type: object
- microsoft.graph.emailAuthenticationMethod:
+ microsoft.graph.accessReviewError:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: emailAuthenticationMethod
+ - $ref: '#/components/schemas/microsoft.graph.genericError'
+ - title: accessReviewError
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.accessReviewReviewerScope:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
+ - title: accessReviewReviewerScope
type: object
properties:
- emailAddress:
+ query:
+ type: string
+ description: The query specifying who will be the reviewer.
+ nullable: true
+ queryRoot:
+ type: string
+ description: 'In the scenario where reviewers need to be specified dynamically, this property is used to indicate the relative source of the query. This property is only required if a relative query, for example, ./manager, is specified. Possible value: decisions.'
+ nullable: true
+ queryType:
type: string
- description: The email address registered to this user.
+ description: The type of query. Examples include MicrosoftGraph and ARM.
nullable: true
additionalProperties:
type: object
- microsoft.graph.fido2AuthenticationMethod:
+ microsoft.graph.accessReviewScope:
+ title: accessReviewScope
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.accessReviewReviewer:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: fido2AuthenticationMethod
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: accessReviewReviewer
type: object
properties:
- aaGuid:
- type: string
- description: 'Authenticator Attestation GUID, an identifier that indicates the type (e.g. make and model) of the authenticator.'
- nullable: true
- attestationCertificates:
- type: array
- items:
- type: string
- nullable: true
- description: The attestation certificate(s) attached to this security key.
- attestationLevel:
- $ref: '#/components/schemas/microsoft.graph.attestationLevel'
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 when this key was registered to the user.
+ description: The date when the reviewer was added for the access review.
format: date-time
nullable: true
displayName:
type: string
- description: The display name of the key as given by the user.
+ description: Name of reviewer.
nullable: true
- model:
+ userPrincipalName:
type: string
- description: The manufacturer-assigned model of the FIDO2 security key.
+ description: User principal name of the user.
nullable: true
additionalProperties:
type: object
- microsoft.graph.authenticationMethod:
+ microsoft.graph.accessReviewInstanceDecisionItem:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: authenticationMethod
- type: object
- additionalProperties:
- type: object
- microsoft.graph.microsoftAuthenticatorAuthenticationMethod:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: microsoftAuthenticatorAuthenticationMethod
+ - title: accessReviewInstanceDecisionItem
type: object
properties:
- clientAppName:
- $ref: '#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethodClientAppName'
- createdDateTime:
+ accessReviewId:
+ type: string
+ description: The identifier of the accessReviewInstance parent. Supports $select. Read-only.
+ appliedBy:
+ $ref: '#/components/schemas/microsoft.graph.userIdentity'
+ appliedDateTime:
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 this app was registered. This property is null if the device is not registered for passwordless Phone Sign-In.
+ description: 'The timestamp when the approval decision was applied. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $select. Read-only.'
format: date-time
nullable: true
- deviceTag:
+ applyResult:
type: string
- description: Tags containing app metadata.
+ description: 'The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
- displayName:
+ decision:
type: string
- description: The name of the device on which this app is registered.
+ description: 'Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).'
nullable: true
- phoneAppVersion:
+ justification:
type: string
- description: Numerical version of this instance of the Authenticator app.
+ description: Justification left by the reviewer when they made the decision.
nullable: true
- device:
- $ref: '#/components/schemas/microsoft.graph.device'
+ principal:
+ $ref: '#/components/schemas/microsoft.graph.identity'
+ principalLink:
+ type: string
+ description: 'Link to the principal object. For example: https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.'
+ nullable: true
+ principalResourceMembership:
+ $ref: '#/components/schemas/microsoft.graph.decisionItemPrincipalResourceMembership'
+ recommendation:
+ type: string
+ description: 'A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within thirty days of start of review. Recommend deny if sign-in is greater than thirty days of start of review. Recommendation not available otherwise. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.'
+ nullable: true
+ resource:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemResource'
+ resourceLink:
+ type: string
+ description: 'A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.'
+ nullable: true
+ reviewedBy:
+ $ref: '#/components/schemas/microsoft.graph.userIdentity'
+ reviewedDateTime:
+ 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 when the review decision occurred. Supports $select. Read-only.
+ format: date-time
+ nullable: true
+ target:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItemTarget'
+ insights:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.governanceInsight'
+ description: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.
+ x-ms-navigationProperty: true
+ instance:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
additionalProperties:
type: object
- microsoft.graph.longRunningOperation:
+ microsoft.graph.accessReviewScheduleDefinition:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: longRunningOperation
+ - title: accessReviewScheduleDefinition
type: object
properties:
+ additionalNotificationRecipients:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewNotificationRecipientItem'
+ description: Defines the list of additional users or group members to be notified of the access review progress.
+ backupReviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.userIdentity'
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 start time of the operation. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ description: Timestamp when the access review series was created. Supports $select. Read-only.
format: date-time
nullable: true
- lastActionDateTime:
- 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])$'
+ descriptionForAdmins:
type: string
- description: 'The time of the last action in the operation. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
+ description: Description provided by review creators to provide more context of the review to admins. Supports $select.
nullable: true
- resourceLocation:
+ descriptionForReviewers:
type: string
- description: URI of the resource that the operation is performed on.
+ description: Description provided by review creators to provide more context of the review to reviewers. Reviewers see this description in the email sent to them requesting their review. Email notifications support up to 256 characters. Supports $select.
+ nullable: true
+ displayName:
+ type: string
+ description: Name of the access review series. Supports $select and $orderby. Required on create.
+ nullable: true
+ fallbackReviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner doesn''t exist, or manager is specified as reviewer but a user''s manager doesn''t exist. See accessReviewReviewerScope. Replaces backupReviewers. Supports $select. NOTE: The value of this property will be ignored if fallback reviewers are assigned through the stageSettings property.'
+ instanceEnumerationScope:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
+ 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: Timestamp when the access review series was last modified. Supports $select. Read-only.
+ format: date-time
nullable: true
+ reviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ description: 'This collection of access review scopes is used to define who are the reviewers. The reviewers property is only updatable if individual users are assigned as reviewers. Required on create. Supports $select. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API. NOTE: The value of this property will be ignored if reviewers are assigned through the stageSettings property.'
+ scope:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewScope'
+ settings:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewScheduleSettings'
+ stageSettings:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewStageSettings'
+ description: 'Required only for a multi-stage access review to define the stages and their settings. You can break down each review instance into up to three sequential stages, where each stage can have a different set of reviewers, fallback reviewers, and settings. Stages are created sequentially based on the dependsOn property. Optional. When this property is defined, its settings are used instead of the corresponding settings in the accessReviewScheduleDefinition object and its settings, reviewers, and fallbackReviewers properties.'
status:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperationStatus'
- statusDetail:
type: string
- description: Details about the status of the operation.
+ description: 'This read-only field specifies the status of an access review. The typical states include Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $select, $orderby, and $filter (eq only). Read-only.'
nullable: true
+ instances:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstance'
+ description: 'Set of access reviews instances for this access review series. Access reviews that don''t recur will only have one instance; otherwise, there''s an instance for each recurrence.'
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.passwordlessMicrosoftAuthenticatorAuthenticationMethod:
+ microsoft.graph.accessReviewStage:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: passwordlessMicrosoftAuthenticatorAuthenticationMethod
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: accessReviewStage
type: object
properties:
- createdDateTime:
+ endDateTime:
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 review stage is scheduled to end. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. This property is the cumulative total of the durationInDays for all stages. Read-only.'
format: date-time
nullable: true
- creationDateTime:
+ fallbackReviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ description: 'This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers are notified to take action if no users are found from the list of reviewers specified. This can occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user''s manager does not exist.'
+ reviewers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewReviewerScope'
+ description: 'This collection of access review scopes is used to define who the reviewers are. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.'
+ startDateTime:
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 when this method was registered to the user.
+ description: 'DateTime when review stage is scheduled to start. May be in the future. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
format: date-time
nullable: true
- displayName:
+ status:
type: string
- description: The display name of the mobile device as given by the user.
+ description: 'Specifies the status of an accessReviewStage. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $orderby, and $filter (eq only). Read-only.'
nullable: true
- device:
- $ref: '#/components/schemas/microsoft.graph.device'
+ decisions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.accessReviewInstanceDecisionItem'
+ description: 'Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.'
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.passwordAuthenticationMethod:
+ microsoft.graph.rankedEmailAddress:
+ title: rankedEmailAddress
+ type: object
+ properties:
+ address:
+ type: string
+ description: The email address.
+ nullable: true
+ rank:
+ type: number
+ description: 'The rank of the email address. A rank is used as a sort key, in relation to the other returned results. A higher rank value corresponds to a more relevant result. Relevance is determined by communication, collaboration, and business relationship signals.'
+ format: double
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.personDataSource:
+ title: personDataSource
+ type: object
+ properties:
+ type:
+ type: string
+ description: The type of data source.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.plannerDelta:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: passwordAuthenticationMethod
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: plannerDelta
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.plannerFavoritePlanReferenceCollection:
+ title: plannerFavoritePlanReferenceCollection
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.plannerRecentPlanReferenceCollection:
+ title: plannerRecentPlanReferenceCollection
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.plannerPlan:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.plannerDelta'
+ - title: plannerPlan
type: object
properties:
+ container:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlanContainer'
+ contexts:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlanContextCollection'
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
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 this password was last updated. This property is currently not populated. Read-only. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
+ description: 'Read-only. Date and time at which the plan 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 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
- password:
+ creationSource:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlanCreation'
+ owner:
type: string
- description: 'For security, the password is always returned as null from a LIST or GET operation.'
nullable: true
+ sharedWithContainers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerSharedWithContainer'
+ description: List of containers the plan is shared with.
+ title:
+ type: string
+ description: Required. Title of the plan.
+ buckets:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerBucket'
+ description: Collection of buckets in the plan. Read-only. Nullable.
+ x-ms-navigationProperty: true
+ details:
+ $ref: '#/components/schemas/microsoft.graph.plannerPlanDetails'
+ tasks:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.plannerTask'
+ description: Collection of tasks in the plan. Read-only. Nullable.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.phoneAuthenticationMethod:
+ microsoft.graph.plannerTask:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: phoneAuthenticationMethod
+ - $ref: '#/components/schemas/microsoft.graph.plannerDelta'
+ - title: plannerTask
type: object
properties:
- phoneNumber:
+ activeChecklistItemCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'Number of checklist items with value set to false, representing incomplete items.'
+ format: int32
+ nullable: true
+ appliedCategories:
+ $ref: '#/components/schemas/microsoft.graph.plannerAppliedCategories'
+ assigneePriority:
type: string
- description: 'The phone number to text or call for authentication. Phone numbers use the format ''+ x'', with extension optional. For example, +1 5555551234 or +1 5555551234x123 are valid. Numbers are rejected when creating/updating if they don''t match the required format.'
+ description: Hint used to order items of this type in a list view. The format is defined as outlined here.
nullable: true
- phoneType:
- $ref: '#/components/schemas/microsoft.graph.authenticationPhoneType'
- smsSignInState:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethodSignInState'
- additionalProperties:
- type: object
- microsoft.graph.platformCredentialAuthenticationMethod:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: platformCredentialAuthenticationMethod
- type: object
- properties:
- createdDateTime:
+ assignments:
+ $ref: '#/components/schemas/microsoft.graph.plannerAssignments'
+ bucketId:
+ type: string
+ description: Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. Format validation is done on the service.
+ nullable: true
+ checklistItemCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of checklist items that are present on the task.
+ format: int32
+ nullable: true
+ completedBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ completedDateTime:
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: 'Read-only. Date and time at which the ''percentComplete'' of the task is set to ''100''. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
- displayName:
+ conversationThreadId:
type: string
+ description: Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
nullable: true
- keyStrength:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
- platform:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethodPlatform'
- device:
- $ref: '#/components/schemas/microsoft.graph.device'
- additionalProperties:
- type: object
- microsoft.graph.softwareOathAuthenticationMethod:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: softwareOathAuthenticationMethod
- type: object
- properties:
- secretKey:
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ 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 secret key of the method. Always returns null.
+ description: 'Read-only. Date and time at which the task 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 is 2014-01-01T00:00:00Z'
+ format: date-time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.temporaryAccessPassAuthenticationMethod:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: temporaryAccessPassAuthenticationMethod
- type: object
- properties:
- createdDateTime:
+ creationSource:
+ $ref: '#/components/schemas/microsoft.graph.plannerTaskCreation'
+ dueDateTime:
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 Temporary Access Pass was created.
+ description: 'Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
- isUsableOnce:
+ hasDescription:
type: boolean
- description: 'Determines whether the pass is limited to a one-time use. If true, the pass can be used once; if false, the pass can be used multiple times within the Temporary Access Pass lifetime.'
+ description: Read-only. Value is true if the details object of the task has a nonempty description and false otherwise.
nullable: true
- lifetimeInMinutes:
+ orderHint:
+ type: string
+ description: Hint used to order items of this type in a list view. The format is defined as outlined here.
+ nullable: true
+ percentComplete:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).
+ description: 'Percentage of task completion. When set to 100, the task is considered completed.'
format: int32
nullable: true
- startDateTime:
- 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])$'
+ planId:
type: string
- description: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- format: date-time
+ description: Plan ID to which the task belongs.
nullable: true
- temporaryAccessPass:
- type: string
- description: The Temporary Access Pass used to authenticate. Returned only on creation of a new temporaryAccessPassAuthenticationMethod object; Hidden in subsequent read operations and returned as null with GET.
+ previewType:
+ $ref: '#/components/schemas/microsoft.graph.plannerPreviewType'
+ priority:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'Priority of the task. Valid range of values is between 0 and 10 (inclusive), with increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as ''urgent'', 2 and 3 and 4 as ''important'', 5, 6, and 7 as ''medium'', and 8, 9, and 10 as ''low''. Currently, Planner sets the value 1 for ''urgent'', 3 for ''important'', 5 for ''medium'', and 9 for ''low''.'
+ format: int32
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.windowsHelloForBusinessAuthenticationMethod:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.authenticationMethod'
- - title: windowsHelloForBusinessAuthenticationMethod
- type: object
- properties:
- createdDateTime:
+ recurrence:
+ $ref: '#/components/schemas/microsoft.graph.plannerTaskRecurrence'
+ referenceCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of external references that exist on the task.
+ format: int32
+ nullable: true
+ specifiedCompletionRequirements:
+ $ref: '#/components/schemas/microsoft.graph.plannerTaskCompletionRequirements'
+ startDateTime:
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 this Windows Hello for Business key was registered.
+ description: 'Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
format: date-time
nullable: true
- displayName:
+ title:
type: string
- description: The name of the device on which Windows Hello for Business is registered
- nullable: true
- keyStrength:
- $ref: '#/components/schemas/microsoft.graph.authenticationMethodKeyStrength'
- device:
- $ref: '#/components/schemas/microsoft.graph.device'
+ description: Title of the task.
+ assignedToTaskBoardFormat:
+ $ref: '#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat'
+ bucketTaskBoardFormat:
+ $ref: '#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat'
+ details:
+ $ref: '#/components/schemas/microsoft.graph.plannerTaskDetails'
+ progressTaskBoardFormat:
+ $ref: '#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat'
additionalProperties:
type: object
- microsoft.graph.chatType:
- title: chatType
- enum:
- - oneOnOne
- - group
- - meeting
- - unknownFutureValue
- type: string
- microsoft.graph.teamworkOnlineMeetingInfo:
- title: teamworkOnlineMeetingInfo
+ microsoft.graph.outOfOfficeSettings:
+ title: outOfOfficeSettings
type: object
properties:
- calendarEventId:
- type: string
- description: The identifier of the calendar event associated with the meeting.
+ isOutOfOffice:
+ type: boolean
+ description: 'True if either:It is currently in the out of office time window configured on the Outlook or Teams client.There is currently an event on the user''s calendar that''s marked as Show as Out of OfficeOtherwise, false.'
nullable: true
- joinWebUrl:
+ message:
type: string
- description: The URL which can be clicked on to join or uniquely identify the meeting.
+ description: The out of office message that the user configured on Outlook client (Automatic Replies (Out of Office)) or the Teams client (Schedule out of office).
nullable: true
- organizer:
- $ref: '#/components/schemas/microsoft.graph.teamworkUserIdentity'
additionalProperties:
type: object
- microsoft.graph.chatViewpoint:
- title: chatViewpoint
+ microsoft.graph.presenceStatusMessage:
+ title: presenceStatusMessage
type: object
properties:
- isHidden:
- type: boolean
- description: Indicates whether the chat is hidden for the current user.
- nullable: true
- lastMessageReadDateTime:
+ expiryDateTime:
+ $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+ message:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ 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: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
+ description: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.teamsAppInstallation:
+ microsoft.graph.userAccountInformation:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: teamsAppInstallation
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: userAccountInformation
+ type: object
+ properties:
+ ageGroup:
+ type: string
+ description: 'Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and can''t be changed.'
+ nullable: true
+ countryCode:
+ type: string
+ description: Contains the two-character country code associated with the users' account.
+ preferredLanguageTag:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ userPrincipalName:
+ type: string
+ description: The user principal name (UPN) of the user associated with the account.
+ additionalProperties:
+ type: object
+ microsoft.graph.itemAddress:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: itemAddress
type: object
properties:
- consentedPermissionSet:
- $ref: '#/components/schemas/microsoft.graph.teamsAppPermissionSet'
- teamsApp:
- $ref: '#/components/schemas/microsoft.graph.teamsApp'
- teamsAppDefinition:
- $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
+ detail:
+ $ref: '#/components/schemas/microsoft.graph.physicalAddress'
+ displayName:
+ type: string
+ description: Friendly name the user has assigned to this address.
+ nullable: true
+ geoCoordinates:
+ $ref: '#/components/schemas/microsoft.graph.geoCoordinates'
additionalProperties:
type: object
- microsoft.graph.chatMessageInfo:
+ microsoft.graph.personAnnualEvent:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: chatMessageInfo
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personAnnualEvent
type: object
properties:
- body:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- 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])$'
+ date:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: Date time object representing the time at which message was created.
- format: date-time
+ format: date
nullable: true
- eventDetail:
- $ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
- from:
- $ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
- isDeleted:
- type: boolean
- description: 'If set to true, the original message has been deleted.'
+ displayName:
+ type: string
nullable: true
- messageType:
- $ref: '#/components/schemas/microsoft.graph.chatMessageType'
+ type:
+ $ref: '#/components/schemas/microsoft.graph.personAnnualEventType'
additionalProperties:
type: object
- microsoft.graph.conversationMember:
+ microsoft.graph.personAward:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: conversationMember
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personAward
type: object
properties:
+ description:
+ type: string
+ description: Descpription of the award or honor.
+ nullable: true
displayName:
type: string
- description: The display name of the user.
+ description: Name of the award or honor.
+ issuedDate:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ type: string
+ description: The date that the award or honor was granted.
+ format: date
nullable: true
- roles:
- type: array
- items:
- type: string
- nullable: true
- description: 'The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.'
- visibleHistoryStartDateTime:
- 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])$'
+ issuingAuthority:
type: string
- description: The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.
- format: date-time
+ description: Authority which granted the award or honor.
+ nullable: true
+ thumbnailUrl:
+ type: string
+ description: URL referencing a thumbnail of the award or honor.
+ nullable: true
+ webUrl:
+ type: string
+ description: URL referencing the award or honor.
nullable: true
additionalProperties:
type: object
- microsoft.graph.chatMessage:
+ microsoft.graph.personCertification:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: chatMessage
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personCertification
type: object
properties:
- attachments:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessageAttachment'
- description: 'References to attached objects like files, tabs, meetings etc.'
- body:
- $ref: '#/components/schemas/microsoft.graph.itemBody'
- channelIdentity:
- $ref: '#/components/schemas/microsoft.graph.channelIdentity'
- chatId:
+ certificationId:
type: string
- description: 'If the message was sent in a chat, represents the identity of the chat.'
+ description: The referenceable identifier for the certification.
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])$'
+ description:
type: string
- description: Timestamp of when the chat message was created.
- format: date-time
+ description: Description of the certification.
nullable: true
- deletedDateTime:
- 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])$'
+ displayName:
type: string
- description: 'Read only. Timestamp at which the chat message was deleted, or null if not deleted.'
- format: date-time
+ description: Title of the certification.
+ endDate:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ type: string
+ description: The date that the certification expires.
+ format: date
nullable: true
- etag:
+ issuedDate:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: Read-only. Version number of the chat message.
+ description: The date that the certification was issued.
+ format: date
nullable: true
- eventDetail:
- $ref: '#/components/schemas/microsoft.graph.eventMessageDetail'
- from:
- $ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
- importance:
- $ref: '#/components/schemas/microsoft.graph.chatMessageImportance'
- lastEditedDateTime:
- 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])$'
+ issuingAuthority:
type: string
- description: Read only. Timestamp when edits to the chat message were made. Triggers an 'Edited' flag in the Teams UI. If no edits are made the value is null.
- format: date-time
+ description: Authority which granted the certification.
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])$'
+ issuingCompany:
type: string
- description: 'Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.'
- format: date-time
+ description: Company which granted the certification.
nullable: true
- locale:
+ startDate:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: Locale of the chat message set by the client. Always set to en-us.
- mentions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessageMention'
- description: 'List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, and tag.'
- messageHistory:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessageHistoryItem'
- description: 'List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.'
- messageType:
- $ref: '#/components/schemas/microsoft.graph.chatMessageType'
- onBehalfOf:
- $ref: '#/components/schemas/microsoft.graph.chatMessageFromIdentitySet'
- policyViolation:
- $ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolation'
- reactions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
- description: 'Reactions for this chat message (for example, Like).'
- replyToId:
+ description: The date that the certification became valid.
+ format: date
+ nullable: true
+ thumbnailUrl:
type: string
- description: 'Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)'
+ description: URL referencing a thumbnail of the certification.
nullable: true
- subject:
+ webUrl:
type: string
- description: 'The subject of the chat message, in plaintext.'
+ description: URL referencing the certification.
nullable: true
- summary:
+ additionalProperties:
+ type: object
+ microsoft.graph.educationalActivity:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: educationalActivity
+ type: object
+ properties:
+ completionMonthYear:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: 'Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.'
+ description: The month and year the user graduated or completed the activity.
+ format: date
nullable: true
- webUrl:
+ endMonthYear:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: Read-only. Link to the message in Microsoft Teams.
+ description: The month and year the user completed the educational activity referenced.
+ format: date
+ nullable: true
+ institution:
+ $ref: '#/components/schemas/microsoft.graph.institutionData'
+ program:
+ $ref: '#/components/schemas/microsoft.graph.educationalActivityDetail'
+ startMonthYear:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
+ type: string
+ description: The month and year the user commenced the activity referenced.
+ format: date
nullable: true
- hostedContents:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessageHostedContent'
- description: 'Content in a message hosted by Microsoft Teams - for example, images or code snippets.'
- x-ms-navigationProperty: true
- replies:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
- description: Replies for a specified message. Supports $expand for channel messages.
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.teamsAsyncOperation:
+ microsoft.graph.itemEmail:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: teamsAsyncOperation
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: itemEmail
type: object
properties:
- attemptsCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Number of times the operation was attempted before being marked successful or failed.
- format: int32
- 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])$'
+ address:
type: string
- description: Time when the operation was created.
- format: date-time
- error:
- $ref: '#/components/schemas/microsoft.graph.operationError'
- lastActionDateTime:
- 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])$'
+ description: The email address itself.
+ displayName:
type: string
- description: Time when the async operation was last updated.
- format: date-time
- operationType:
- $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationType'
- status:
- $ref: '#/components/schemas/microsoft.graph.teamsAsyncOperationStatus'
- targetResourceId:
+ description: The name or label a user has associated with a particular email address.
+ nullable: true
+ type:
+ $ref: '#/components/schemas/microsoft.graph.emailType'
+ additionalProperties:
+ type: object
+ microsoft.graph.personInterest:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personInterest
+ type: object
+ properties:
+ categories:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'Contains categories a user has associated with the interest (for example, personal, recipies).'
+ collaborationTags:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.'
+ description:
type: string
- description: 'The ID of the object that''s created or modified as result of this async operation, typically a team.'
+ description: Contains a description of the interest.
nullable: true
- targetResourceLocation:
+ displayName:
type: string
- description: The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.
+ description: Contains a friendly name for the interest.
+ thumbnailUrl:
+ type: string
+ nullable: true
+ webUrl:
+ type: string
+ description: Contains a link to a web page or resource about the interest.
nullable: true
additionalProperties:
type: object
- microsoft.graph.pinnedChatMessageInfo:
+ microsoft.graph.languageProficiency:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: pinnedChatMessageInfo
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: languageProficiency
type: object
properties:
- message:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
+ displayName:
+ type: string
+ description: Contains the long-form name for the language.
+ proficiency:
+ $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
+ reading:
+ $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
+ spoken:
+ $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
+ tag:
+ type: string
+ description: 'Contains the four-character BCP47 name for the language (en-US, no-NB, en-AU).'
+ nullable: true
+ thumbnailUrl:
+ type: string
+ nullable: true
+ written:
+ $ref: '#/components/schemas/microsoft.graph.languageProficiencyLevel'
additionalProperties:
type: object
- microsoft.graph.teamsTab:
+ microsoft.graph.personName:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: teamsTab
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personName
type: object
properties:
- configuration:
- $ref: '#/components/schemas/microsoft.graph.teamsTabConfiguration'
displayName:
type: string
- description: Name of the tab.
+ description: Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.
nullable: true
- messageId:
+ first:
type: string
+ description: First name of the user.
nullable: true
- sortOrderIndex:
+ initials:
type: string
- description: Index of the order used for sorting tabs.
+ description: Initials of the user.
nullable: true
- teamsAppId:
+ languageTag:
type: string
+ description: 'Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.'
nullable: true
- webUrl:
+ last:
type: string
- description: Deep link URL of the tab instance. Read only.
+ description: Last name of the user.
+ nullable: true
+ maiden:
+ type: string
+ description: Maiden name of the user.
+ nullable: true
+ middle:
+ type: string
+ description: Middle name of the user.
+ nullable: true
+ nickname:
+ type: string
+ description: Nickname of the user.
+ nullable: true
+ pronunciation:
+ $ref: '#/components/schemas/microsoft.graph.personNamePronounciation'
+ suffix:
+ type: string
+ description: 'Designators used after the users name (eg: PhD.)'
+ nullable: true
+ title:
+ type: string
+ description: 'Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)'
nullable: true
- teamsApp:
- $ref: '#/components/schemas/microsoft.graph.teamsApp'
additionalProperties:
type: object
- microsoft.graph.teamDiscoverySettings:
- title: teamDiscoverySettings
- type: object
- properties:
- showInTeamsSearchAndSuggestions:
- type: boolean
- description: 'If set to true, the team is visible via search and suggestions from the Teams client.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.teamFunSettings:
- title: teamFunSettings
- type: object
- properties:
- allowCustomMemes:
- type: boolean
- description: 'If set to true, enables users to include custom memes.'
- nullable: true
- allowGiphy:
- type: boolean
- description: 'If set to true, enables Giphy use.'
- nullable: true
- allowStickersAndMemes:
- type: boolean
- description: 'If set to true, enables users to include stickers and memes.'
- nullable: true
- giphyContentRating:
- $ref: '#/components/schemas/microsoft.graph.giphyRatingType'
- additionalProperties:
- type: object
- microsoft.graph.teamGuestSettings:
- title: teamGuestSettings
- type: object
- properties:
- allowCreateUpdateChannels:
- type: boolean
- description: 'If set to true, guests can add and update channels.'
- nullable: true
- allowDeleteChannels:
- type: boolean
- description: 'If set to true, guests can delete channels.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.teamMemberSettings:
- title: teamMemberSettings
- type: object
- properties:
- allowAddRemoveApps:
- type: boolean
- description: 'If set to true, members can add and remove apps.'
- nullable: true
- allowCreatePrivateChannels:
- type: boolean
- description: 'If set to true, members can add and update private channels.'
- nullable: true
- allowCreateUpdateChannels:
- type: boolean
- description: 'If set to true, members can add and update any channels.'
- nullable: true
- allowCreateUpdateRemoveConnectors:
- type: boolean
- description: 'If set to true, members can add, update, and remove connectors.'
- nullable: true
- allowCreateUpdateRemoveTabs:
- type: boolean
- description: 'If set to true, members can add, update, and remove tabs.'
- nullable: true
- allowDeleteChannels:
- type: boolean
- description: 'If set to true, members can delete channels.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.teamMessagingSettings:
- title: teamMessagingSettings
- type: object
- properties:
- allowChannelMentions:
- type: boolean
- description: 'If set to true, @channel mentions are allowed.'
- nullable: true
- allowOwnerDeleteMessages:
- type: boolean
- description: 'If set to true, owners can delete any message.'
- nullable: true
- allowTeamMentions:
- type: boolean
- description: 'If set to true, @team mentions are allowed.'
- nullable: true
- allowUserDeleteMessages:
- type: boolean
- description: 'If set to true, users can delete their messages.'
- nullable: true
- allowUserEditMessages:
- type: boolean
- description: 'If set to true, users can edit their messages.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.teamSpecialization:
- title: teamSpecialization
- enum:
- - none
- - educationStandard
- - educationClass
- - educationProfessionalLearningCommunity
- - educationStaff
- - healthcareStandard
- - healthcareCareCoordination
- - unknownFutureValue
- type: string
- microsoft.graph.teamSummary:
- title: teamSummary
- type: object
- properties:
- guestsCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Count of guests in a team.
- format: int32
- nullable: true
- membersCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Count of members in a team.
- format: int32
- nullable: true
- ownersCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Count of owners in a team.
- format: int32
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.teamVisibilityType:
- title: teamVisibilityType
- enum:
- - private
- - public
- - hiddenMembership
- - unknownFutureValue
- type: string
- microsoft.graph.channel:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: channel
+ microsoft.graph.personAnnotation:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personAnnotation
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])$'
+ detail:
+ $ref: '#/components/schemas/microsoft.graph.itemBody'
+ displayName:
+ type: string
+ description: Contains a friendly name for the note.
+ nullable: true
+ thumbnailUrl:
type: string
- description: Read only. Timestamp at which the channel was created.
- format: date-time
nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.itemPatent:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: itemPatent
+ type: object
+ properties:
description:
type: string
- description: Optional textual description for the channel.
+ description: Descpription of the patent or filing.
nullable: true
displayName:
type: string
- description: Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.
- email:
+ description: Title of the patent or filing.
+ isPending:
+ type: boolean
+ description: Indicates the patent is pending.
+ nullable: true
+ issuedDate:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: The email address for sending messages to the channel. Read-only.
+ description: The date that the patent was granted.
+ format: date
nullable: true
- isFavoriteByDefault:
- type: boolean
- description: 'Indicates whether the channel should automatically be marked ''favorite'' for all members of the team. Can only be set programmatically with Create team. Default: false.'
+ issuingAuthority:
+ type: string
+ description: Authority which granted the patent.
nullable: true
- membershipType:
- $ref: '#/components/schemas/microsoft.graph.channelMembershipType'
- moderationSettings:
- $ref: '#/components/schemas/microsoft.graph.channelModerationSettings'
- summary:
- $ref: '#/components/schemas/microsoft.graph.channelSummary'
- tenantId:
+ number:
type: string
- description: The ID of the Microsoft Entra tenant.
+ description: The patent number.
nullable: true
webUrl:
type: string
- description: 'A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.'
+ description: URL referencing the patent or filing.
nullable: true
- filesFolder:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
- members:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.conversationMember'
- description: A collection of membership records associated with the channel.
- x-ms-navigationProperty: true
- messages:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.chatMessage'
- description: A collection of all the messages in the channel. A navigation property. Nullable.
- x-ms-navigationProperty: true
- sharedWithTeams:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo'
- description: A collection of teams with which a channel is shared.
- x-ms-navigationProperty: true
- tabs:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamsTab'
- description: A collection of all the tabs in the channel. A navigation property.
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.teamworkTag:
+ microsoft.graph.itemPhone:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: teamworkTag
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: itemPhone
type: object
properties:
- description:
- type: string
- description: Tag description as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.
- nullable: true
displayName:
type: string
- description: Tag name as it appears to the user in Microsoft Teams.
- nullable: true
- memberCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The number of users assigned to the tag.
- format: int32
+ description: Friendly name the user has assigned this phone number.
nullable: true
- tagType:
- $ref: '#/components/schemas/microsoft.graph.teamworkTagType'
- teamId:
+ number:
type: string
- description: ID of the team in which the tag is defined.
- nullable: true
- members:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.teamworkTagMember'
- description: Users assigned to the tag.
- x-ms-navigationProperty: true
+ description: Phone number provided by the user.
+ type:
+ $ref: '#/components/schemas/microsoft.graph.phoneType'
additionalProperties:
type: object
- microsoft.graph.teamsTemplate:
+ microsoft.graph.workPosition:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: teamsTemplate
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: workPosition
type: object
+ properties:
+ categories:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: Categories that the user has associated with this position.
+ colleagues:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.relatedPerson'
+ description: Colleagues that are associated with this position.
+ detail:
+ $ref: '#/components/schemas/microsoft.graph.positionDetail'
+ isCurrent:
+ type: boolean
+ description: Denotes whether or not the position is current.
+ nullable: true
+ manager:
+ $ref: '#/components/schemas/microsoft.graph.relatedPerson'
additionalProperties:
type: object
- microsoft.graph.teamTemplateDefinition:
+ microsoft.graph.projectParticipation:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: teamTemplateDefinition
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: projectParticipation
type: object
properties:
- audience:
- $ref: '#/components/schemas/microsoft.graph.teamTemplateAudience'
categories:
type: array
items:
type: string
nullable: true
- description: The assigned categories for the team template.
+ description: 'Contains categories a user has associated with the project (for example, digital transformation, oil rig).'
+ client:
+ $ref: '#/components/schemas/microsoft.graph.companyDetail'
+ collaborationTags:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.'
+ colleagues:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.relatedPerson'
+ description: Lists people that also worked on the project.
+ detail:
+ $ref: '#/components/schemas/microsoft.graph.positionDetail'
+ displayName:
+ type: string
+ description: Contains a friendly name for the project.
+ sponsors:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.relatedPerson'
+ description: The Person or people who sponsored the project.
+ thumbnailUrl:
+ type: string
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.itemPublication:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: itemPublication
+ type: object
+ properties:
description:
type: string
- description: A brief description of the team template as it will appear to the users in Microsoft Teams.
+ description: Description of the publication.
nullable: true
displayName:
type: string
- description: The user defined name of the team template.
- nullable: true
- iconUrl:
+ description: Title of the publication.
+ publishedDate:
+ pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$'
type: string
- description: The icon url for the team template.
+ description: The date that the publication was published.
+ format: date
nullable: true
- languageTag:
+ publisher:
type: string
- description: Language the template is available in.
+ description: Publication or publisher for the publication.
nullable: true
- lastModifiedBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- 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])$'
+ thumbnailUrl:
type: string
- description: The date time of when the team template was last modified.
- format: date-time
+ description: URL referencing a thumbnail of the publication.
nullable: true
- parentTemplateId:
+ webUrl:
type: string
- description: The templateId for the team template
+ description: URL referencing the publication.
nullable: true
- publisherName:
+ additionalProperties:
+ type: object
+ microsoft.graph.skillProficiency:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: skillProficiency
+ type: object
+ properties:
+ categories:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'Contains categories a user has associated with the skill (for example, personal, professional, hobby).'
+ collaborationTags:
+ type: array
+ items:
+ type: string
+ nullable: true
+ description: 'Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.'
+ displayName:
+ type: string
+ description: Contains a friendly name for the skill.
+ proficiency:
+ $ref: '#/components/schemas/microsoft.graph.skillProficiencyLevel'
+ thumbnailUrl:
type: string
- description: The organization which published the team template.
nullable: true
- shortDescription:
+ webUrl:
type: string
- description: A short-description of the team template as it will appear to the users in Microsoft Teams.
+ description: Contains a link to an information source about the skill.
nullable: true
- teamDefinition:
- $ref: '#/components/schemas/microsoft.graph.team'
additionalProperties:
type: object
- microsoft.graph.schedule:
+ microsoft.graph.webAccount:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: schedule
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: webAccount
type: object
properties:
- enabled:
- type: boolean
- description: Indicates whether the schedule is enabled for the team. Required.
- nullable: true
- offerShiftRequestsEnabled:
- type: boolean
- description: Indicates whether offer shift requests are enabled for the schedule.
- nullable: true
- openShiftsEnabled:
- type: boolean
- description: Indicates whether open shifts are enabled for the schedule.
- nullable: true
- provisionStatus:
- $ref: '#/components/schemas/microsoft.graph.operationStatus'
- provisionStatusCode:
+ description:
type: string
- description: Additional information about why schedule provisioning failed.
- nullable: true
- readOnly: true
- swapShiftsRequestsEnabled:
- type: boolean
- description: Indicates whether swap shifts requests are enabled for the schedule.
+ description: Contains the description the user has provided for the account on the service being referenced.
nullable: true
- timeClockEnabled:
- type: boolean
- description: Indicates whether time clock is enabled for the schedule.
+ service:
+ $ref: '#/components/schemas/microsoft.graph.serviceInformation'
+ statusMessage:
+ type: string
+ description: Contains a status message from the cloud service if provided or synchronized.
nullable: true
- timeClockSettings:
- $ref: '#/components/schemas/microsoft.graph.timeClockSettings'
- timeOffRequestsEnabled:
- type: boolean
- description: Indicates whether time off requests are enabled for the schedule.
+ thumbnailUrl:
+ type: string
nullable: true
- timeZone:
+ userId:
type: string
- description: Indicates the time zone of the schedule team using tz database format. Required.
+ description: The user name displayed for the webaccount.
+ webUrl:
+ type: string
+ description: Contains a link to the user's profile on the cloud service if one exists.
nullable: true
- workforceIntegrationIds:
+ additionalProperties:
+ type: object
+ microsoft.graph.personWebsite:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.itemFacet'
+ - title: personWebsite
+ type: object
+ properties:
+ categories:
type: array
items:
type: string
nullable: true
- offerShiftRequests:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.offerShiftRequest'
- description: The offer requests for shifts in the schedule.
- x-ms-navigationProperty: true
- openShiftChangeRequests:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.openShiftChangeRequest'
- description: The open shift requests in the schedule.
- x-ms-navigationProperty: true
- openShifts:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.openShift'
- description: The set of open shifts in a scheduling group in the schedule.
- x-ms-navigationProperty: true
- schedulingGroups:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.schedulingGroup'
- description: The logical grouping of users in the schedule (usually by role).
- x-ms-navigationProperty: true
- shifts:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.shift'
- description: The shifts in the schedule.
- x-ms-navigationProperty: true
- swapShiftsChangeRequests:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.swapShiftsChangeRequest'
- description: The swap requests for shifts in the schedule.
- x-ms-navigationProperty: true
- timeCards:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.timeCard'
- x-ms-navigationProperty: true
- timeOffReasons:
+ description: 'Contains categories a user has associated with the website (for example, personal, recipes).'
+ description:
+ type: string
+ description: Contains a description of the website.
+ nullable: true
+ displayName:
+ type: string
+ description: Contains a friendly name for the website.
+ thumbnailUrl:
+ type: string
+ nullable: true
+ webUrl:
+ type: string
+ description: Contains a link to the website itself.
+ additionalProperties:
+ type: object
+ microsoft.graph.identity:
+ title: identity
+ type: object
+ properties:
+ displayName:
+ type: string
+ description: The display name of the identity. This property is read-only.
+ nullable: true
+ id:
+ type: string
+ description: The identifier of the identity. This property is read-only.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.security.informationProtection:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: informationProtection
+ type: object
+ properties:
+ labelPolicySettings:
+ $ref: '#/components/schemas/microsoft.graph.security.informationProtectionPolicySetting'
+ sensitivityLabels:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.timeOffReason'
- description: The set of reasons for a time off in the schedule.
+ $ref: '#/components/schemas/microsoft.graph.security.sensitivityLabel'
+ description: Read the Microsoft Purview Information Protection labels for the user or organization.
x-ms-navigationProperty: true
- timeOffRequests:
+ additionalProperties:
+ type: object
+ microsoft.graph.contactMergeSuggestions:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: contactMergeSuggestions
+ type: object
+ properties:
+ isEnabled:
+ type: boolean
+ description: true if the duplicate contact merge suggestions feature is enabled for the user; false if the feature is disabled. Default value is true.
+ nullable: true
+ additionalProperties:
+ type: object
+ microsoft.graph.userInsightsSettings:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: userInsightsSettings
+ type: object
+ properties:
+ isEnabled:
+ type: boolean
+ description: true if user's itemInsights and meeting hours insights are enabled; false if user's itemInsights and meeting hours insights are disabled. Default is true. Optional.
+ additionalProperties:
+ type: object
+ microsoft.graph.regionalAndLanguageSettings:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: regionalAndLanguageSettings
+ type: object
+ properties:
+ authoringLanguages:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.timeOffRequest'
- description: The time off requests in the schedule.
- x-ms-navigationProperty: true
- timesOff:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ description: Prioritized list of languages the user reads and authors in.Returned by default. Not nullable.
+ defaultDisplayLanguage:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ defaultRegionalFormat:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ defaultSpeechInputLanguage:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ defaultTranslationLanguage:
+ $ref: '#/components/schemas/microsoft.graph.localeInfo'
+ regionalFormatOverrides:
+ $ref: '#/components/schemas/microsoft.graph.regionalFormatOverrides'
+ translationPreferences:
+ $ref: '#/components/schemas/microsoft.graph.translationPreferences'
+ additionalProperties:
+ type: object
+ microsoft.graph.shiftPreferences:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.changeTrackedEntity'
+ - title: shiftPreferences
+ type: object
+ properties:
+ availability:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.timeOff'
- description: The instances of times off in the schedule.
- x-ms-navigationProperty: true
+ $ref: '#/components/schemas/microsoft.graph.shiftAvailability'
+ description: Availability of the user to be scheduled for work and its recurrence pattern.
additionalProperties:
type: object
microsoft.graph.associatedTeamInfo:
@@ -37537,41 +37439,36 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.learningCourseActivity:
+ microsoft.graph.usageRightState:
+ title: usageRightState
+ enum:
+ - active
+ - inactive
+ - warning
+ - suspended
+ - unknownFutureValue
+ type: string
+ microsoft.graph.virtualEventWebinar:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: learningCourseActivity
+ - $ref: '#/components/schemas/microsoft.graph.virtualEvent'
+ - title: virtualEventWebinar
type: object
properties:
- completedDateTime:
- 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 when the assignment was completed. Optional.
- format: date-time
- nullable: true
- completionPercentage:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The percentage completion value of the course activity. Optional.
- format: int32
- nullable: true
- externalcourseActivityId:
- type: string
- description: A course activity ID generated by the provider. Optional.
- nullable: true
- learnerUserId:
- type: string
- description: The user ID of the learner to whom the activity is assigned. Required.
- learningContentId:
- type: string
- description: The ID of the learning content created in Viva Learning. Required.
- learningProviderId:
- type: string
- description: The registration ID of the provider. Required.
- nullable: true
- status:
- $ref: '#/components/schemas/microsoft.graph.courseStatus'
+ audience:
+ $ref: '#/components/schemas/microsoft.graph.meetingAudience'
+ coOrganizers:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.communicationsUserIdentity'
+ description: Identity information of coorganizers of the webinar.
+ registrationConfiguration:
+ $ref: '#/components/schemas/microsoft.graph.virtualEventWebinarRegistrationConfiguration'
+ registrations:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.virtualEventRegistration'
+ description: Registration records of the webinar.
+ x-ms-navigationProperty: true
additionalProperties:
type: object
microsoft.graph.synchronizationScheduleState:
@@ -37950,6 +37847,15 @@ components:
$ref: '#/components/schemas/microsoft.graph.appCredentialRestrictionType'
additionalProperties:
type: object
+ microsoft.graph.MembershipRuleProcessingStatusDetails:
+ title: MembershipRuleProcessingStatusDetails
+ enum:
+ - NotStarted
+ - Running
+ - Failed
+ - Succeeded
+ - UnsupportedFutureValue
+ type: string
microsoft.graph.writebackConfiguration:
title: writebackConfiguration
type: object
@@ -37960,15 +37866,6 @@ components:
nullable: true
additionalProperties:
type: object
- microsoft.graph.MembershipRuleProcessingStatusDetails:
- title: MembershipRuleProcessingStatusDetails
- enum:
- - NotStarted
- - Running
- - Failed
- - Succeeded
- - UnsupportedFutureValue
- type: string
microsoft.graph.settingValue:
title: settingValue
type: object
@@ -38261,238 +38158,140 @@ components:
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.analyticsActivityType:
- title: analyticsActivityType
- enum:
- - Email
- - Meeting
- - Focus
- - Chat
- - Call
- type: string
- microsoft.graph.cloudPcHealthCheckItem:
- title: cloudPcHealthCheckItem
+ microsoft.graph.imageInfo:
+ title: imageInfo
type: object
properties:
- additionalDetails:
+ addImageQuery:
+ type: boolean
+ description: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example – a high contrast image
+ nullable: true
+ alternateText:
type: string
- description: Additional message for this health check.
+ description: Optional; alt-text accessible content for the image
nullable: true
- displayName:
+ alternativeText:
type: string
- description: The connectivity health check item name.
- lastHealthCheckDateTime:
- 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])$'
+ nullable: true
+ iconUrl:
type: string
- description: 'Timestamp when the last check occurs. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as 2014-01-01T00:00:00Z.'
- format: date-time
+ description: Optional; URI that points to an icon which represents the application used to generate the activity
nullable: true
- result:
- $ref: '#/components/schemas/microsoft.graph.cloudPcConnectivityEventResult'
additionalProperties:
type: object
- microsoft.graph.cloudPcConnectivityStatus:
- title: cloudPcConnectivityStatus
- enum:
- - unknown
- - available
- - availableWithWarning
- - unavailable
- - unknownFutureValue
- type: string
- microsoft.graph.actionState:
- title: actionState
- enum:
- - none
- - pending
- - canceled
- - active
- - done
- - failed
- - notSupported
- type: string
- microsoft.graph.cloudPcPartnerAgentInstallStatus:
- title: cloudPcPartnerAgentInstallStatus
- enum:
- - installed
- - installFailed
- - installing
- - uninstalling
- - uninstallFailed
- - licensed
- - unknownFutureValue
- type: string
- microsoft.graph.cloudPcPartnerAgentName:
- title: cloudPcPartnerAgentName
+ microsoft.graph.analyticsActivityType:
+ title: analyticsActivityType
enum:
- - citrix
- - unknownFutureValue
- - vMware
+ - Email
+ - Meeting
+ - Focus
+ - Chat
+ - Call
type: string
- microsoft.graph.bitlockerRecoveryKey:
+ microsoft.graph.request:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- - title: bitlockerRecoveryKey
+ - title: request
type: object
properties:
+ approvalId:
+ type: string
+ description: The identifier of the approval of the request.
+ nullable: true
+ completedDateTime:
+ 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 request completion date time.
+ format: date-time
+ nullable: true
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
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 key was originally backed up to Microsoft Entra ID.
+ description: The request creation date time.
format: date-time
- deviceId:
+ nullable: true
+ customData:
type: string
- description: ID of the device the BitLocker key is originally backed up from.
+ description: Free text field to define any custom data for the request. Not used.
nullable: true
- key:
+ status:
type: string
- description: The BitLocker recovery key.
- volumeType:
- $ref: '#/components/schemas/microsoft.graph.volumeType'
+ description: 'The status of the request. Not nullable. The possible values are: Canceled, Denied, Failed, Granted, PendingAdminDecision, PendingApproval, PendingProvisioning, PendingScheduleCreation, Provisioned, Revoked, and ScheduleCreated. Not nullable.'
additionalProperties:
type: object
- microsoft.graph.sensitivityLabelTarget:
- title: sensitivityLabelTarget
+ microsoft.graph.userDefaultAuthenticationMethodType:
+ title: userDefaultAuthenticationMethodType
enum:
- - email
- - site
- - unifiedGroup
- - teamwork
+ - push
+ - oath
+ - voiceMobile
+ - voiceAlternateMobile
+ - voiceOffice
+ - sms
- unknownFutureValue
type: string
- x-ms-enum-flags:
- isFlags: true
- microsoft.graph.applicationMode:
- title: applicationMode
+ microsoft.graph.attestationLevel:
+ title: attestationLevel
enum:
- - manual
- - automatic
- - recommended
+ - attested
+ - notAttested
+ - unknownFutureValue
type: string
- microsoft.graph.labelPolicy:
- title: labelPolicy
- type: object
- properties:
- id:
- type: string
- name:
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.autoLabeling:
- title: autoLabeling
- type: object
- properties:
- message:
- type: string
- nullable: true
- sensitiveTypeIds:
- type: array
- items:
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.labelActionBase:
- title: labelActionBase
- type: object
- properties:
- name:
- type: string
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.informationProtectionLabel:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: informationProtectionLabel
- type: object
- properties:
- color:
- type: string
- description: 'The color that the UI should display for the label, if configured.'
- nullable: true
- description:
- type: string
- description: The admin-defined description for the label.
- nullable: true
- isActive:
- type: boolean
- description: Indicates whether the label is active or not. Active labels should be hidden or disabled in UI.
- name:
- type: string
- description: The plaintext name of the label.
- nullable: true
- parent:
- $ref: '#/components/schemas/microsoft.graph.parentLabelDetails'
- sensitivity:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'The sensitivity value of the label, where lower is less sensitive.'
- format: int32
- tooltip:
- type: string
- description: The tooltip that should be displayed for the label in a UI.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.threatCategory:
- title: threatCategory
+ microsoft.graph.microsoftAuthenticatorAuthenticationMethodClientAppName:
+ title: microsoftAuthenticatorAuthenticationMethodClientAppName
enum:
- - undefined
- - spam
- - phishing
- - malware
+ - microsoftAuthenticator
+ - outlookMobile
- unknownFutureValue
type: string
- microsoft.graph.threatAssessmentContentType:
- title: threatAssessmentContentType
+ microsoft.graph.longRunningOperationStatus:
+ title: longRunningOperationStatus
enum:
- - mail
- - url
- - file
+ - notStarted
+ - running
+ - succeeded
+ - failed
+ - unknownFutureValue
type: string
- microsoft.graph.threatExpectedAssessment:
- title: threatExpectedAssessment
+ microsoft.graph.authenticationPhoneType:
+ title: authenticationPhoneType
enum:
- - block
- - unblock
+ - mobile
+ - alternateMobile
+ - office
+ - unknownFutureValue
type: string
- microsoft.graph.threatAssessmentRequestSource:
- title: threatAssessmentRequestSource
+ microsoft.graph.authenticationMethodSignInState:
+ title: authenticationMethodSignInState
+ enum:
+ - notSupported
+ - notAllowedByPolicy
+ - notEnabled
+ - phoneNumberNotUnique
+ - ready
+ - notConfigured
+ - unknownFutureValue
+ type: string
+ microsoft.graph.authenticationMethodKeyStrength:
+ title: authenticationMethodKeyStrength
enum:
- - undefined
- - user
- - administrator
+ - normal
+ - weak
+ - unknown
type: string
- microsoft.graph.threatAssessmentStatus:
- title: threatAssessmentStatus
+ microsoft.graph.authenticationMethodPlatform:
+ title: authenticationMethodPlatform
enum:
- - pending
- - completed
+ - unknown
+ - windows
+ - macOS
+ - iOS
+ - android
+ - linux
+ - unknownFutureValue
type: string
- microsoft.graph.threatAssessmentResult:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: threatAssessmentResult
- 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: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.'
- format: date-time
- nullable: true
- message:
- type: string
- description: The result message for each threat assessment.
- nullable: true
- resultType:
- $ref: '#/components/schemas/microsoft.graph.threatAssessmentResultType'
- additionalProperties:
- type: object
microsoft.graph.calendarRoleType:
title: calendarRoleType
enum:
@@ -38660,7114 +38459,6857 @@ components:
- declined
- notResponded
type: string
- microsoft.graph.emailType:
- title: emailType
- enum:
- - unknown
- - work
- - personal
- - main
- - other
- type: string
- microsoft.graph.followupFlagStatus:
- title: followupFlagStatus
- enum:
- - notFlagged
- - complete
- - flagged
- type: string
- microsoft.graph.phoneType:
- title: phoneType
- enum:
- - home
- - business
- - mobile
- - other
- - assistant
- - homeFax
- - businessFax
- - otherFax
- - pager
- - radio
- type: string
- microsoft.graph.physicalAddressType:
- title: physicalAddressType
- enum:
- - unknown
- - home
- - business
- - other
- type: string
- microsoft.graph.websiteType:
- title: websiteType
- enum:
- - other
- - home
- - work
- - blog
- - profile
- type: string
- microsoft.graph.messageRuleActions:
- title: messageRuleActions
- type: object
- properties:
- assignCategories:
- type: array
- items:
- type: string
- nullable: true
- description: A list of categories to be assigned to a message.
- copyToFolder:
- type: string
- description: The ID of a folder that a message is to be copied to.
- nullable: true
- delete:
- type: boolean
- description: Indicates whether a message should be moved to the Deleted Items folder.
- nullable: true
- forwardAsAttachmentTo:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: The email addresses of the recipients to which a message should be forwarded as an attachment.
- forwardTo:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: The email addresses of the recipients to which a message should be forwarded.
- markAsRead:
- type: boolean
- description: Indicates whether a message should be marked as read.
- nullable: true
- markImportance:
- $ref: '#/components/schemas/microsoft.graph.importance'
- moveToFolder:
- type: string
- description: The ID of the folder that a message will be moved to.
- nullable: true
- permanentDelete:
- type: boolean
- description: Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder.
- nullable: true
- redirectTo:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: The email address to which a message should be redirected.
- stopProcessingRules:
- type: boolean
- description: Indicates whether subsequent rules should be evaluated.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.messageRulePredicates:
- title: messageRulePredicates
+ microsoft.graph.teamworkUserIdentity:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.identity'
+ - title: teamworkUserIdentity
+ type: object
+ properties:
+ userIdentityType:
+ $ref: '#/components/schemas/microsoft.graph.teamworkUserIdentityType'
+ additionalProperties:
+ type: object
+ microsoft.graph.teamsAppPermissionSet:
+ title: teamsAppPermissionSet
type: object
properties:
- bodyContains:
- type: array
- items:
- type: string
- nullable: true
- description: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.
- bodyOrSubjectContains:
- type: array
- items:
- type: string
- nullable: true
- description: Represents the strings that should appear in the body or subject of an incoming message in order for the condition or exception to apply.
- categories:
- type: array
- items:
- type: string
- nullable: true
- description: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.
- fromAddresses:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.
- hasAttachments:
- type: boolean
- description: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.
- nullable: true
- headerContains:
- type: array
- items:
- type: string
- nullable: true
- description: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.
- importance:
- $ref: '#/components/schemas/microsoft.graph.importance'
- isApprovalRequest:
- type: boolean
- description: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.
- nullable: true
- isAutomaticForward:
- type: boolean
- description: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.
- nullable: true
- isAutomaticReply:
- type: boolean
- description: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.
- nullable: true
- isEncrypted:
- type: boolean
- description: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.
- nullable: true
- isMeetingRequest:
- type: boolean
- description: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.
- nullable: true
- isMeetingResponse:
- type: boolean
- description: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.
- nullable: true
- isNonDeliveryReport:
- type: boolean
- description: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.
- nullable: true
- isPermissionControlled:
- type: boolean
- description: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.
- nullable: true
- isReadReceipt:
- type: boolean
- description: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.
- nullable: true
- isSigned:
- type: boolean
- description: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.
- nullable: true
- isVoicemail:
- type: boolean
- description: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.
- nullable: true
- messageActionFlag:
- $ref: '#/components/schemas/microsoft.graph.messageActionFlag'
- notSentToMe:
- type: boolean
- description: Indicates whether the owner of the mailbox must not be a recipient of an incoming message in order for the condition or exception to apply.
- nullable: true
- recipientContains:
- type: array
- items:
- type: string
- nullable: true
- description: Represents the strings that appear in either the toRecipients or ccRecipients properties of an incoming message in order for the condition or exception to apply.
- senderContains:
- type: array
- items:
- type: string
- nullable: true
- description: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.
- sensitivity:
- $ref: '#/components/schemas/microsoft.graph.sensitivity'
- sentCcMe:
- type: boolean
- description: Indicates whether the owner of the mailbox must be in the ccRecipients property of an incoming message in order for the condition or exception to apply.
- nullable: true
- sentOnlyToMe:
- type: boolean
- description: Indicates whether the owner of the mailbox must be the only recipient in an incoming message in order for the condition or exception to apply.
- nullable: true
- sentToAddresses:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.recipient'
- description: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.
- sentToMe:
- type: boolean
- description: Indicates whether the owner of the mailbox must be in the toRecipients property of an incoming message in order for the condition or exception to apply.
- nullable: true
- sentToOrCcMe:
- type: boolean
- description: Indicates whether the owner of the mailbox must be in either a toRecipients or ccRecipients property of an incoming message in order for the condition or exception to apply.
- nullable: true
- subjectContains:
+ resourceSpecificPermissions:
type: array
items:
- type: string
- nullable: true
- description: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.
- withinSizeRange:
- $ref: '#/components/schemas/microsoft.graph.sizeRange'
- additionalProperties:
- type: object
- microsoft.graph.categoryColor:
- title: categoryColor
- enum:
- - none
- - preset0
- - preset1
- - preset2
- - preset3
- - preset4
- - preset5
- - preset6
- - preset7
- - preset8
- - preset9
- - preset10
- - preset11
- - preset12
- - preset13
- - preset14
- - preset15
- - preset16
- - preset17
- - preset18
- - preset19
- - preset20
- - preset21
- - preset22
- - preset23
- - preset24
- type: string
- microsoft.graph.taskStatus:
- title: taskStatus
- enum:
- - notStarted
- - inProgress
- - completed
- - waitingOnOthers
- - deferred
- type: string
- ReferenceNumeric:
- enum:
- - '-INF'
- - INF
- - NaN
- microsoft.graph.itemReference:
- title: itemReference
- type: object
- properties:
- driveId:
- type: string
- description: 'Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a [drive][]. Read-only.'
- nullable: true
- driveType:
- type: string
- description: 'Identifies the type of drive. Only returned if the item is located in a [drive][]. See [drive][] resource for values.'
- nullable: true
- id:
- type: string
- description: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
- nullable: true
- name:
- type: string
- description: The name of the item being referenced. Read-only.
- nullable: true
- path:
- type: string
- description: Path that can be used to navigate to the item. Read-only.
- nullable: true
- shareId:
- type: string
- description: 'A unique identifier for a shared resource that can be accessed via the [Shares][] API.'
- nullable: true
- sharepointIds:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
- siteId:
- type: string
- description: 'For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that [site][] resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.'
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.storagePlanInformation:
- title: storagePlanInformation
- type: object
- properties:
- upgradeAvailable:
- type: boolean
- description: Indicates if there are higher storage quota plans available. Read-only.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.itemActionSet:
- title: itemActionSet
- type: object
- properties:
- comment:
- $ref: '#/components/schemas/microsoft.graph.commentAction'
- create:
- $ref: '#/components/schemas/microsoft.graph.createAction'
- delete:
- $ref: '#/components/schemas/microsoft.graph.deleteAction'
- edit:
- $ref: '#/components/schemas/microsoft.graph.editAction'
- mention:
- $ref: '#/components/schemas/microsoft.graph.mentionAction'
- move:
- $ref: '#/components/schemas/microsoft.graph.moveAction'
- rename:
- $ref: '#/components/schemas/microsoft.graph.renameAction'
- restore:
- $ref: '#/components/schemas/microsoft.graph.restoreAction'
- share:
- $ref: '#/components/schemas/microsoft.graph.shareAction'
- version:
- $ref: '#/components/schemas/microsoft.graph.versionAction'
- additionalProperties:
- type: object
- microsoft.graph.itemActivityTimeSet:
- title: itemActivityTimeSet
- type: object
- properties:
- lastRecordedDateTime:
- 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
- observedDateTime:
- 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: When the activity was observed to take place.
- format: date-time
- nullable: true
- recordedDateTime:
- 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: When the observation was recorded on the service.
- format: date-time
- nullable: true
+ $ref: '#/components/schemas/microsoft.graph.teamsAppResourceSpecificPermission'
+ description: A collection of resource-specific permissions.
additionalProperties:
type: object
- microsoft.graph.listItem:
+ microsoft.graph.teamsApp:
allOf:
- - $ref: '#/components/schemas/microsoft.graph.baseItem'
- - title: listItem
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: teamsApp
type: object
properties:
- contentType:
- $ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
- deleted:
- $ref: '#/components/schemas/microsoft.graph.deleted'
- sharepointIds:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
- activities:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.itemActivityOLD'
- description: The list of recent activities that took place on this item.
- x-ms-navigationProperty: true
- analytics:
- $ref: '#/components/schemas/microsoft.graph.itemAnalytics'
- documentSetVersions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.documentSetVersion'
- description: Version information for a document set version created by a user.
- x-ms-navigationProperty: true
- driveItem:
- $ref: '#/components/schemas/microsoft.graph.driveItem'
- fields:
- $ref: '#/components/schemas/microsoft.graph.fieldValueSet'
- versions:
+ displayName:
+ type: string
+ description: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
+ nullable: true
+ distributionMethod:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppDistributionMethod'
+ externalId:
+ type: string
+ description: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
+ nullable: true
+ appDefinitions:
type: array
items:
- $ref: '#/components/schemas/microsoft.graph.listItemVersion'
- description: The list of previous versions of the list item.
+ $ref: '#/components/schemas/microsoft.graph.teamsAppDefinition'
+ description: The details for each version of the app.
x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.audio:
- title: audio
+ microsoft.graph.teamsAppDefinition:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: teamsAppDefinition
+ type: object
+ properties:
+ allowedInstallationScopes:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppInstallationScopes'
+ authorization:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppAuthorization'
+ azureADAppId:
+ type: string
+ description: The WebApplicationInfo.Id from the Teams app manifest.
+ nullable: true
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ description:
+ type: string
+ nullable: true
+ displayName:
+ type: string
+ description: The name of the app provided by the app developer.
+ 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
+ format: date-time
+ nullable: true
+ publishingState:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppPublishingState'
+ shortdescription:
+ type: string
+ nullable: true
+ teamsAppId:
+ type: string
+ description: The ID from the Teams app manifest.
+ nullable: true
+ version:
+ type: string
+ description: The version number of the application.
+ nullable: true
+ bot:
+ $ref: '#/components/schemas/microsoft.graph.teamworkBot'
+ colorIcon:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppIcon'
+ outlineIcon:
+ $ref: '#/components/schemas/microsoft.graph.teamsAppIcon'
+ additionalProperties:
+ type: object
+ microsoft.graph.eventMessageDetail:
+ title: eventMessageDetail
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.chatMessageFromIdentitySet:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.identitySet'
+ - title: chatMessageFromIdentitySet
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.chatMessageType:
+ title: chatMessageType
+ enum:
+ - message
+ - chatEvent
+ - typing
+ - unknownFutureValue
+ - systemEventMessage
+ type: string
+ microsoft.graph.chatMessageAttachment:
+ title: chatMessageAttachment
type: object
properties:
- album:
+ content:
type: string
- description: The title of the album for this audio file.
+ description: 'The content of the attachment. If the attachment is a rich card, set the property to the rich card object. This property and contentUrl are mutually exclusive.'
nullable: true
- albumArtist:
+ contentType:
type: string
- description: The artist named on the album for the audio file.
+ description: 'The media type of the content attachment. It can have the following values: reference: Attachment is a link to another file. Populate the contentURL with the link to the object.Any contentTypes supported by the Bot Framework''s Attachment objectapplication/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.'
nullable: true
- artist:
+ contentUrl:
type: string
- description: The performing artist for the audio file.
- nullable: true
- bitrate:
- type: integer
- description: Bitrate expressed in kbps.
- format: int64
+ description: 'URL for the content of the attachment. Supported protocols: http, https, file and data.'
nullable: true
- composers:
+ id:
type: string
- description: The name of the composer of the audio file.
+ description: Read-only. Unique id of the attachment.
nullable: true
- copyright:
+ name:
type: string
- description: Copyright information for the audio file.
- nullable: true
- disc:
- maximum: 32767
- minimum: -32768
- type: integer
- description: The number of the disc this audio file came from.
- format: int16
- nullable: true
- discCount:
- maximum: 32767
- minimum: -32768
- type: integer
- description: The total number of discs in this album.
- format: int16
- nullable: true
- duration:
- type: integer
- description: 'Duration of the audio file, expressed in milliseconds'
- format: int64
+ description: Name of the attachment.
nullable: true
- genre:
+ teamsAppId:
type: string
- description: The genre of this audio file.
- nullable: true
- hasDrm:
- type: boolean
- description: Indicates if the file is protected with digital rights management.
- nullable: true
- isVariableBitrate:
- type: boolean
- description: Indicates if the file is encoded with a variable bitrate.
+ description: The ID of the Teams app that is associated with the attachment. The property is specifically used to attribute a Teams message card to the specified app.
nullable: true
- title:
+ thumbnailUrl:
type: string
- description: The title of the audio file.
- nullable: true
- track:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The number of the track on the original disc for this audio file.
- format: int32
+ description: 'URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of content or contentUrl. For example, if you set contentType to application/word and set contentUrl to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user clicks the image, the channel would open the document.'
nullable: true
- trackCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The total number of tracks on the original disc for this audio file.
- format: int32
+ additionalProperties:
+ type: object
+ microsoft.graph.channelIdentity:
+ title: channelIdentity
+ type: object
+ properties:
+ channelId:
+ type: string
+ description: The identity of the channel in which the message was posted.
nullable: true
- year:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The year the audio file was recorded.
- format: int32
+ teamId:
+ type: string
+ description: The identity of the team in which the message was posted.
nullable: true
additionalProperties:
type: object
- microsoft.graph.bundle:
- title: bundle
+ microsoft.graph.chatMessageImportance:
+ title: chatMessageImportance
+ enum:
+ - normal
+ - high
+ - urgent
+ type: string
+ microsoft.graph.chatMessageMention:
+ title: chatMessageMention
type: object
properties:
- album:
- $ref: '#/components/schemas/microsoft.graph.album'
- childCount:
+ id:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: Number of children contained immediately within this container.
+ description: 'Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding tag in the message body.'
format: int32
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.file:
- title: file
- type: object
- properties:
- hashes:
- $ref: '#/components/schemas/microsoft.graph.hashes'
- mimeType:
+ mentioned:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageMentionedIdentitySet'
+ mentionText:
type: string
- description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only.
- nullable: true
- processingMetadata:
- type: boolean
+ description: 'String used to represent the mention. For example, a user''s display name, a team name.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.fileSystemInfo:
- title: fileSystemInfo
+ microsoft.graph.chatMessageHistoryItem:
+ title: chatMessageHistoryItem
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: The UTC date and time the file was created on a client.
- format: date-time
- nullable: true
- lastAccessedDateTime:
- 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 UTC date and time the file was last accessed. Available for the recent file list only.
- format: date-time
- nullable: true
- lastModifiedDateTime:
+ actions:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageActions'
+ modifiedDateTime:
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 UTC date and time the file was last modified on a client.
+ description: The date and time when the message was modified.
format: date-time
- nullable: true
+ reaction:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageReaction'
additionalProperties:
type: object
- microsoft.graph.folder:
- title: folder
+ microsoft.graph.chatMessagePolicyViolation:
+ title: chatMessagePolicyViolation
type: object
properties:
- childCount:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Number of children contained immediately within this container.
- format: int32
+ dlpAction:
+ $ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationDlpActionTypes'
+ justificationText:
+ type: string
+ description: Justification text provided by the sender of the message when overriding a policy violation.
nullable: true
- view:
- $ref: '#/components/schemas/microsoft.graph.folderView'
+ policyTip:
+ $ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationPolicyTip'
+ userAction:
+ $ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationUserActionTypes'
+ verdictDetails:
+ $ref: '#/components/schemas/microsoft.graph.chatMessagePolicyViolationVerdictDetailsTypes'
additionalProperties:
type: object
- microsoft.graph.image:
- title: image
+ microsoft.graph.chatMessageReaction:
+ title: chatMessageReaction
type: object
properties:
- height:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'Optional. Height of the image, in pixels. Read-only.'
- format: int32
- nullable: true
- width:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: 'Optional. Width of the image, in pixels. Read-only.'
- 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: 'The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z'
+ format: date-time
+ reactionType:
+ type: string
+ description: 'Supported values are like, angry, sad, laugh, heart, surprised.'
+ user:
+ $ref: '#/components/schemas/microsoft.graph.chatMessageReactionIdentitySet'
additionalProperties:
type: object
- microsoft.graph.geoCoordinates:
- title: geoCoordinates
+ microsoft.graph.chatMessageHostedContent:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.teamworkHostedContent'
+ - title: chatMessageHostedContent
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.operationError:
+ title: operationError
type: object
properties:
- altitude:
- type: number
- description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.'
- format: double
- nullable: true
- latitude:
- type: number
- description: 'Optional. The latitude, in decimal, for the item. Writable on OneDrive Personal.'
- format: double
+ code:
+ type: string
+ description: Operation error code.
nullable: true
- longitude:
- type: number
- description: 'Optional. The longitude, in decimal, for the item. Writable on OneDrive Personal.'
- format: double
+ message:
+ type: string
+ description: Operation error message.
nullable: true
additionalProperties:
type: object
- microsoft.graph.malware:
- title: malware
+ microsoft.graph.teamsAsyncOperationType:
+ title: teamsAsyncOperationType
+ enum:
+ - invalid
+ - cloneTeam
+ - archiveTeam
+ - unarchiveTeam
+ - createTeam
+ - unknownFutureValue
+ - teamifyGroup
+ - createChannel
+ - createChat
+ type: string
+ microsoft.graph.teamsAsyncOperationStatus:
+ title: teamsAsyncOperationStatus
+ enum:
+ - invalid
+ - notStarted
+ - inProgress
+ - succeeded
+ - failed
+ - unknownFutureValue
+ type: string
+ microsoft.graph.teamsTabConfiguration:
+ title: teamsTabConfiguration
type: object
properties:
- description:
+ contentUrl:
type: string
- description: Contains the virus details for the malware facet.
+ description: Url used for rendering tab contents in Teams. Required.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.media:
- title: media
- type: object
- properties:
- isTranscriptionShown:
- type: boolean
- description: 'If a file has a transcript, this setting controls if the closed captions / transcription for the media file should be shown to people during viewing. Read-Write.'
+ entityId:
+ type: string
+ description: Identifier for the entity hosted by the tab provider.
nullable: true
- mediaSource:
- $ref: '#/components/schemas/microsoft.graph.mediaSource'
- additionalProperties:
- type: object
- microsoft.graph.package:
- title: package
- type: object
- properties:
- type:
+ removeUrl:
type: string
+ description: Url called by Teams client when a Tab is removed using the Teams Client.
+ nullable: true
+ websiteUrl:
+ type: string
+ description: Url for showing tab contents outside of Teams.
nullable: true
additionalProperties:
type: object
- microsoft.graph.pendingOperations:
- title: pendingOperations
- type: object
- properties:
- pendingContentUpdate:
- $ref: '#/components/schemas/microsoft.graph.pendingContentUpdate'
- additionalProperties:
- type: object
- microsoft.graph.photo:
- title: photo
+ microsoft.graph.cloudPcHealthCheckItem:
+ title: cloudPcHealthCheckItem
type: object
properties:
- cameraMake:
+ additionalDetails:
type: string
- description: Camera manufacturer. Read-only.
+ description: Additional message for this health check.
nullable: true
- cameraModel:
+ displayName:
type: string
- description: Camera model. Read-only.
- nullable: true
- exposureDenominator:
- type: number
- description: The denominator for the exposure time fraction from the camera. Read-only.
- format: double
- nullable: true
- exposureNumerator:
- type: number
- description: The numerator for the exposure time fraction from the camera. Read-only.
- format: double
- nullable: true
- fNumber:
- type: number
- description: The F-stop value from the camera. Read-only.
- format: double
- nullable: true
- focalLength:
- type: number
- description: The focal length from the camera. Read-only.
- format: double
- nullable: true
- iso:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The ISO value from the camera. Read-only.
- format: int32
- nullable: true
- orientation:
- maximum: 32767
- minimum: -32768
- type: integer
- description: The orientation value from the camera. Writable on OneDrive Personal.
- format: int16
- nullable: true
- takenDateTime:
+ description: The connectivity health check item name.
+ lastHealthCheckDateTime:
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 photo was taken in UTC time. Read-only.
+ description: 'Timestamp when the last check occurs. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 appears as 2014-01-01T00:00:00Z.'
format: date-time
nullable: true
+ result:
+ $ref: '#/components/schemas/microsoft.graph.cloudPcConnectivityEventResult'
additionalProperties:
type: object
- microsoft.graph.publicationFacet:
- title: publicationFacet
+ microsoft.graph.cloudPcConnectivityStatus:
+ title: cloudPcConnectivityStatus
+ enum:
+ - unknown
+ - available
+ - availableWithWarning
+ - unavailable
+ - unknownFutureValue
+ type: string
+ microsoft.graph.actionState:
+ title: actionState
+ enum:
+ - none
+ - pending
+ - canceled
+ - active
+ - done
+ - failed
+ - notSupported
+ type: string
+ microsoft.graph.cloudPcPartnerAgentInstallStatus:
+ title: cloudPcPartnerAgentInstallStatus
+ enum:
+ - installed
+ - installFailed
+ - installing
+ - uninstalling
+ - uninstallFailed
+ - licensed
+ - unknownFutureValue
+ type: string
+ microsoft.graph.cloudPcPartnerAgentName:
+ title: cloudPcPartnerAgentName
+ enum:
+ - citrix
+ - unknownFutureValue
+ - vMware
+ - hp
+ type: string
+ microsoft.graph.emailType:
+ title: emailType
+ enum:
+ - unknown
+ - work
+ - personal
+ - main
+ - other
+ type: string
+ microsoft.graph.followupFlagStatus:
+ title: followupFlagStatus
+ enum:
+ - notFlagged
+ - complete
+ - flagged
+ type: string
+ microsoft.graph.phoneType:
+ title: phoneType
+ enum:
+ - home
+ - business
+ - mobile
+ - other
+ - assistant
+ - homeFax
+ - businessFax
+ - otherFax
+ - pager
+ - radio
+ type: string
+ microsoft.graph.physicalAddressType:
+ title: physicalAddressType
+ enum:
+ - unknown
+ - home
+ - business
+ - other
+ type: string
+ microsoft.graph.websiteType:
+ title: websiteType
+ enum:
+ - other
+ - home
+ - work
+ - blog
+ - profile
+ type: string
+ microsoft.graph.deviceAndAppManagementAssignmentSource:
+ title: deviceAndAppManagementAssignmentSource
+ enum:
+ - direct
+ - policySets
+ type: string
+ description: Represents source of assignment.
+ x-ms-enum:
+ name: deviceAndAppManagementAssignmentSource
+ modelAsString: false
+ values:
+ - value: direct
+ description: Direct indicates a direct assignment.
+ name: direct
+ - value: policySets
+ description: PolicySets indicates assignment was made via PolicySet assignment.
+ name: policySets
+ microsoft.graph.deviceAndAppManagementAssignmentTarget:
+ title: deviceAndAppManagementAssignmentTarget
type: object
properties:
- checkedOutBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- level:
+ deviceAndAppManagementAssignmentFilterId:
type: string
- description: The state of publication for this document. Either published or checkout. Read-only.
+ description: The Id of the filter for the target assignment.
nullable: true
- versionId:
+ deviceAndAppManagementAssignmentFilterType:
+ $ref: '#/components/schemas/microsoft.graph.deviceAndAppManagementAssignmentFilterType'
+ additionalProperties:
+ type: object
+ description: Base type for assignment targets.
+ microsoft.graph.deviceManagementTroubleshootingErrorResource:
+ title: deviceManagementTroubleshootingErrorResource
+ type: object
+ properties:
+ link:
type: string
- description: The unique identifier for the version that is visible to the current caller. Read-only.
+ description: 'The link to the web resource. Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}'
+ nullable: true
+ text:
+ type: string
+ description: Not yet documented
nullable: true
additionalProperties:
type: object
- microsoft.graph.remoteItem:
- title: remoteItem
+ description: 'Object representing a link to troubleshooting information, the link could be to the Azure Portal or a Microsoft doc.'
+ microsoft.graph.payloadRequest:
+ title: payloadRequest
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.payloadResponse:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.entity'
+ - title: payloadResponse
+ type: object
+ additionalProperties:
+ type: object
+ microsoft.graph.itemReference:
+ title: itemReference
type: object
properties:
- createdBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- 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])$'
+ driveId:
type: string
- description: Date and time of item creation. Read-only.
- format: date-time
+ description: 'Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a [drive][]. Read-only.'
nullable: true
- file:
- $ref: '#/components/schemas/microsoft.graph.file'
- fileSystemInfo:
- $ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
- folder:
- $ref: '#/components/schemas/microsoft.graph.folder'
- id:
+ driveType:
type: string
- description: Unique identifier for the remote item in its drive. Read-only.
+ description: 'Identifies the type of drive. Only returned if the item is located in a [drive][]. See [drive][] resource for values.'
nullable: true
- image:
- $ref: '#/components/schemas/microsoft.graph.image'
- lastModifiedBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- 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])$'
+ id:
type: string
- description: Date and time the item was last modified. Read-only.
- format: date-time
+ description: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.
nullable: true
name:
type: string
- description: Optional. Filename of the remote item. Read-only.
+ description: The name of the item being referenced. Read-only.
nullable: true
- package:
- $ref: '#/components/schemas/microsoft.graph.package'
- parentReference:
- $ref: '#/components/schemas/microsoft.graph.itemReference'
- shared:
- $ref: '#/components/schemas/microsoft.graph.shared'
- sharepointIds:
- $ref: '#/components/schemas/microsoft.graph.sharepointIds'
- size:
- type: integer
- description: Size of the remote item. Read-only.
- format: int64
+ path:
+ type: string
+ description: Path that can be used to navigate to the item. Read-only.
nullable: true
- specialFolder:
- $ref: '#/components/schemas/microsoft.graph.specialFolder'
- video:
- $ref: '#/components/schemas/microsoft.graph.video'
- webDavUrl:
+ shareId:
type: string
- description: DAV compatible URL for the item.
+ description: 'A unique identifier for a shared resource that can be accessed via the [Shares][] API.'
nullable: true
- webUrl:
+ sharepointIds:
+ $ref: '#/components/schemas/microsoft.graph.sharepointIds'
+ siteId:
type: string
- description: URL that displays the resource in the browser. Read-only.
+ description: 'For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that [site][] resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.searchResult:
- title: searchResult
+ microsoft.graph.storagePlanInformation:
+ title: storagePlanInformation
type: object
properties:
- onClickTelemetryUrl:
- type: string
- description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results.
+ upgradeAvailable:
+ type: boolean
+ description: Indicates if there are higher storage quota plans available. Read-only.
nullable: true
additionalProperties:
type: object
- microsoft.graph.shared:
- title: shared
+ microsoft.graph.itemActionSet:
+ title: itemActionSet
type: object
properties:
- owner:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- scope:
+ comment:
+ $ref: '#/components/schemas/microsoft.graph.commentAction'
+ create:
+ $ref: '#/components/schemas/microsoft.graph.createAction'
+ delete:
+ $ref: '#/components/schemas/microsoft.graph.deleteAction'
+ edit:
+ $ref: '#/components/schemas/microsoft.graph.editAction'
+ mention:
+ $ref: '#/components/schemas/microsoft.graph.mentionAction'
+ move:
+ $ref: '#/components/schemas/microsoft.graph.moveAction'
+ rename:
+ $ref: '#/components/schemas/microsoft.graph.renameAction'
+ restore:
+ $ref: '#/components/schemas/microsoft.graph.restoreAction'
+ share:
+ $ref: '#/components/schemas/microsoft.graph.shareAction'
+ version:
+ $ref: '#/components/schemas/microsoft.graph.versionAction'
+ additionalProperties:
+ type: object
+ microsoft.graph.itemActivityTimeSet:
+ title: itemActivityTimeSet
+ type: object
+ properties:
+ lastRecordedDateTime:
+ 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 scope of how the item is shared: anonymous, organization, or users. Read-only.'
+ format: date-time
nullable: true
- sharedBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- sharedDateTime:
+ observedDateTime:
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 UTC date and time when the item was shared. Read-only.
+ description: When the activity was observed to take place.
format: date-time
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.driveItemSource:
- title: driveItemSource
- type: object
- properties:
- application:
- $ref: '#/components/schemas/microsoft.graph.driveItemSourceApplication'
- externalId:
+ recordedDateTime:
+ 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 external identifier for the drive item from the source.
+ description: When the observation was recorded on the service.
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.specialFolder:
- title: specialFolder
+ microsoft.graph.listItem:
+ allOf:
+ - $ref: '#/components/schemas/microsoft.graph.baseItem'
+ - title: listItem
+ type: object
+ properties:
+ contentType:
+ $ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
+ deleted:
+ $ref: '#/components/schemas/microsoft.graph.deleted'
+ sharepointIds:
+ $ref: '#/components/schemas/microsoft.graph.sharepointIds'
+ activities:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.itemActivityOLD'
+ description: The list of recent activities that took place on this item.
+ x-ms-navigationProperty: true
+ analytics:
+ $ref: '#/components/schemas/microsoft.graph.itemAnalytics'
+ documentSetVersions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.documentSetVersion'
+ description: Version information for a document set version created by a user.
+ x-ms-navigationProperty: true
+ driveItem:
+ $ref: '#/components/schemas/microsoft.graph.driveItem'
+ fields:
+ $ref: '#/components/schemas/microsoft.graph.fieldValueSet'
+ versions:
+ type: array
+ items:
+ $ref: '#/components/schemas/microsoft.graph.listItemVersion'
+ description: The list of previous versions of the list item.
+ x-ms-navigationProperty: true
+ additionalProperties:
+ type: object
+ microsoft.graph.audio:
+ title: audio
type: object
properties:
- name:
+ album:
type: string
- description: The unique identifier for this item in the /drive/special collection
+ description: The title of the album for this audio file.
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.video:
- title: video
- type: object
- properties:
- audioBitsPerSample:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: Number of audio bits per sample.
- format: int32
+ albumArtist:
+ type: string
+ description: The artist named on the album for the audio file.
nullable: true
- audioChannels:
- maximum: 2147483647
- minimum: -2147483648
+ artist:
+ type: string
+ description: The performing artist for the audio file.
+ nullable: true
+ bitrate:
type: integer
- description: Number of audio channels.
- format: int32
+ description: Bitrate expressed in kbps.
+ format: int64
nullable: true
- audioFormat:
+ composers:
type: string
- description: 'Name of the audio format (AAC, MP3, etc.).'
+ description: The name of the composer of the audio file.
nullable: true
- audioSamplesPerSecond:
- maximum: 2147483647
- minimum: -2147483648
+ copyright:
+ type: string
+ description: Copyright information for the audio file.
+ nullable: true
+ disc:
+ maximum: 32767
+ minimum: -32768
type: integer
- description: Number of audio samples per second.
- format: int32
+ description: The number of the disc this audio file came from.
+ format: int16
nullable: true
- bitrate:
- maximum: 2147483647
- minimum: -2147483648
+ discCount:
+ maximum: 32767
+ minimum: -32768
type: integer
- description: Bit rate of the video in bits per second.
- format: int32
+ description: The total number of discs in this album.
+ format: int16
nullable: true
duration:
type: integer
- description: Duration of the file in milliseconds.
+ description: 'Duration of the audio file, expressed in milliseconds'
format: int64
nullable: true
- fourCC:
+ genre:
type: string
- description: '''Four character code'' name of the video format.'
+ description: The genre of this audio file.
nullable: true
- frameRate:
- type: number
- format: double
+ hasDrm:
+ type: boolean
+ description: Indicates if the file is protected with digital rights management.
nullable: true
- height:
+ isVariableBitrate:
+ type: boolean
+ description: Indicates if the file is encoded with a variable bitrate.
+ nullable: true
+ title:
+ type: string
+ description: The title of the audio file.
+ nullable: true
+ track:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: 'Height of the video, in pixels.'
+ description: The number of the track on the original disc for this audio file.
format: int32
nullable: true
- width:
+ trackCount:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: 'Width of the video, in pixels.'
+ description: The total number of tracks on the original disc for this audio file.
+ format: int32
+ nullable: true
+ year:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The year the audio file was recorded.
format: int32
nullable: true
additionalProperties:
type: object
- microsoft.graph.workbook:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: workbook
- type: object
- properties:
- application:
- $ref: '#/components/schemas/microsoft.graph.workbookApplication'
- comments:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.workbookComment'
- x-ms-navigationProperty: true
- functions:
- $ref: '#/components/schemas/microsoft.graph.workbookFunctions'
- names:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
- description: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.
- x-ms-navigationProperty: true
- operations:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.workbookOperation'
- description: 'The status of Workbook operations. Getting an operation collection is not supported, but you can get the status of a long-running operation if the Location header is returned in the response. Read-only. Nullable.'
- x-ms-navigationProperty: true
- tables:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.workbookTable'
- description: Represents a collection of tables associated with the workbook. Read-only.
- x-ms-navigationProperty: true
- worksheets:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheet'
- description: Represents a collection of worksheets associated with the workbook. Read-only.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.itemRetentionLabel:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: itemRetentionLabel
- type: object
- properties:
- isLabelAppliedExplicitly:
- type: boolean
- description: 'Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only.'
- nullable: true
- labelAppliedBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- labelAppliedDateTime:
- 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 label was applied on the item. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.'
- format: date-time
- nullable: true
- name:
- type: string
- description: The retention label on the document. Read-write.
- nullable: true
- retentionSettings:
- $ref: '#/components/schemas/microsoft.graph.retentionLabelSettings'
- additionalProperties:
- type: object
- microsoft.graph.subscription:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: subscription
- type: object
- properties:
- applicationId:
- type: string
- description: Optional. Identifier of the application used to create the subscription. Read-only.
- nullable: true
- changeType:
- type: string
- description: 'Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list. Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType. Use updated to receive notifications when user or group is created, updated or soft deleted. Use deleted to receive notifications when user or group is permanently deleted.'
- clientState:
- type: string
- description: Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 255 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.
- nullable: true
- creatorId:
- type: string
- description: 'Optional. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the ID of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the ID of the service principal corresponding to the app. Read-only.'
- nullable: true
- encryptionCertificate:
- type: string
- description: Optional. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional but required when includeResourceData is true.
- nullable: true
- encryptionCertificateId:
- type: string
- description: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when includeResourceData is true.
- 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: 'Required. 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. For the maximum supported subscription length of time, see the table below.'
- format: date-time
- includeResourceData:
- type: boolean
- description: 'Optional. When set to true, change notifications include resource data (such as content of a chat message).'
- nullable: true
- latestSupportedTlsVersion:
- type: string
- description: 'Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v10, v11, v12, v13. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.'
- nullable: true
- lifecycleNotificationUrl:
- type: string
- description: '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. This URL must make use of the HTTPS protocol. For more information, see Reduce missing subscriptions and change notifications.'
- nullable: true
- notificationContentType:
- type: string
- description: Optional. Desired content-type for Microsoft Graph change notifications for supported resource types. The default content-type is application/json.
- nullable: true
- notificationQueryOptions:
- type: string
- description: 'Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.'
- nullable: true
- notificationUrl:
- type: string
- description: Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol. Any query string parameter included in the notificationUrl property will be included in the HTTP POST request when Microsoft Graph sends the change notifications.
- notificationUrlAppId:
- type: string
- description: Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received.
- nullable: true
- resource:
- type: string
- description: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/beta/). See the possible resource path values for each supported resource.
- additionalProperties:
- type: object
- microsoft.graph.thumbnailSet:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: thumbnailSet
- type: object
- properties:
- large:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
- medium:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
- small:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
- source:
- $ref: '#/components/schemas/microsoft.graph.thumbnail'
- additionalProperties:
- type: object
- microsoft.graph.driveItemVersion:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.baseItemVersion'
- - title: driveItemVersion
- type: object
- properties:
- content:
- type: string
- 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
- additionalProperties:
- type: object
- microsoft.graph.listInfo:
- title: listInfo
+ microsoft.graph.bundle:
+ title: bundle
type: object
properties:
- contentTypesEnabled:
- type: boolean
- description: 'If true, indicates that content types are enabled for this list.'
- nullable: true
- hidden:
- type: boolean
- description: 'If true, indicates that the list isn''t normally visible in the SharePoint user experience.'
- nullable: true
- template:
- type: string
- description: 'An enumerated value that represents the base list template used in creating the list. Possible values include documentLibrary, genericList, task, survey, announcements, contacts, and more.'
+ album:
+ $ref: '#/components/schemas/microsoft.graph.album'
+ childCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of children contained immediately within this container.
+ format: int32
nullable: true
additionalProperties:
type: object
- microsoft.graph.itemActivityStat:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.entity'
- - title: itemActivityStat
- type: object
- properties:
- access:
- $ref: '#/components/schemas/microsoft.graph.itemActionStat'
- create:
- $ref: '#/components/schemas/microsoft.graph.itemActionStat'
- delete:
- $ref: '#/components/schemas/microsoft.graph.itemActionStat'
- edit:
- $ref: '#/components/schemas/microsoft.graph.itemActionStat'
- endDateTime:
- 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: When the interval ends. Read-only.
- format: date-time
- nullable: true
- incompleteData:
- $ref: '#/components/schemas/microsoft.graph.incompleteData'
- isTrending:
- type: boolean
- description: Indicates whether the item is 'trending.' Read-only.
- nullable: true
- move:
- $ref: '#/components/schemas/microsoft.graph.itemActionStat'
- startDateTime:
- 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: When the interval starts. Read-only.
- format: date-time
- nullable: true
- activities:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.itemActivity'
- description: Exposes the itemActivities represented in this itemActivityStat resource.
- x-ms-navigationProperty: true
- additionalProperties:
- type: object
- microsoft.graph.booleanColumn:
- title: booleanColumn
+ microsoft.graph.file:
+ title: file
type: object
+ properties:
+ hashes:
+ $ref: '#/components/schemas/microsoft.graph.hashes'
+ mimeType:
+ type: string
+ description: The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only.
+ nullable: true
+ processingMetadata:
+ type: boolean
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.calculatedColumn:
- title: calculatedColumn
+ microsoft.graph.fileSystemInfo:
+ title: fileSystemInfo
type: object
properties:
- format:
+ 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: 'For dateTime output types, the format of the value. Possible values are: dateOnly or dateTime.'
+ description: The UTC date and time the file was created on a client.
+ format: date-time
nullable: true
- formula:
+ lastAccessedDateTime:
+ 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 formula used to compute the value for this column.
+ description: The UTC date and time the file was last accessed. Available for the recent file list only.
+ format: date-time
nullable: true
- outputType:
+ 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 output type used to format values in this column. Possible values are: boolean, currency, dateTime, number, or text.'
+ description: The UTC date and time the file was last modified on a client.
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.choiceColumn:
- title: choiceColumn
+ microsoft.graph.folder:
+ title: folder
type: object
properties:
- allowTextEntry:
- type: boolean
- description: 'If true, allows custom values that aren''t in the configured choices.'
- nullable: true
- choices:
- type: array
- items:
- type: string
- nullable: true
- description: The list of values available for this column.
- displayAs:
- type: string
- description: 'How the choices are to be presented in the UX. Must be one of checkBoxes, dropDownMenu, or radioButtons'
+ childCount:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of children contained immediately within this container.
+ format: int32
nullable: true
+ view:
+ $ref: '#/components/schemas/microsoft.graph.folderView'
additionalProperties:
type: object
- microsoft.graph.contentApprovalStatusColumn:
- title: contentApprovalStatusColumn
- type: object
- additionalProperties:
- type: object
- microsoft.graph.currencyColumn:
- title: currencyColumn
+ microsoft.graph.image:
+ title: image
type: object
properties:
- locale:
- type: string
- description: Specifies the locale from which to infer the currency symbol.
+ height:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'Optional. Height of the image, in pixels. Read-only.'
+ format: int32
+ nullable: true
+ width:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: 'Optional. Width of the image, in pixels. Read-only.'
+ format: int32
nullable: true
additionalProperties:
type: object
- microsoft.graph.dateTimeColumn:
- title: dateTimeColumn
+ microsoft.graph.geoCoordinates:
+ title: geoCoordinates
type: object
properties:
- displayAs:
- type: string
- description: 'How the value should be presented in the UX. Must be one of default, friendly, or standard. See below for more details. If unspecified, treated as default.'
+ altitude:
+ type: number
+ description: 'Optional. The altitude (height), in feet, above sea level for the item. Read-only.'
+ format: double
nullable: true
- format:
- type: string
- description: Indicates whether the value should be presented as a date only or a date and time. Must be one of dateOnly or dateTime
+ latitude:
+ type: number
+ description: 'Optional. The latitude, in decimal, for the item. Writable on OneDrive Personal.'
+ format: double
+ nullable: true
+ longitude:
+ type: number
+ description: 'Optional. The longitude, in decimal, for the item. Writable on OneDrive Personal.'
+ format: double
nullable: true
additionalProperties:
type: object
- microsoft.graph.defaultColumnValue:
- title: defaultColumnValue
+ microsoft.graph.malware:
+ title: malware
type: object
properties:
- formula:
- type: string
- description: The formula used to compute the default value for the column.
- nullable: true
- value:
+ description:
type: string
- description: The direct value to use as the default value for the column.
+ description: Contains the virus details for the malware facet.
nullable: true
additionalProperties:
type: object
- microsoft.graph.geolocationColumn:
- title: geolocationColumn
- type: object
- additionalProperties:
- type: object
- microsoft.graph.hyperlinkOrPictureColumn:
- title: hyperlinkOrPictureColumn
+ microsoft.graph.media:
+ title: media
type: object
properties:
- isPicture:
+ isTranscriptionShown:
type: boolean
- description: Specifies whether the display format used for URL columns is an image or a hyperlink.
+ description: 'If a file has a transcript, this setting controls if the closed captions / transcription for the media file should be shown to people during viewing. Read-Write.'
nullable: true
+ mediaSource:
+ $ref: '#/components/schemas/microsoft.graph.mediaSource'
additionalProperties:
type: object
- microsoft.graph.lookupColumn:
- title: lookupColumn
+ microsoft.graph.package:
+ title: package
type: object
properties:
- allowMultipleValues:
- type: boolean
- description: Indicates whether multiple values can be selected from the source.
- nullable: true
- allowUnlimitedLength:
- type: boolean
- description: Indicates whether values in the column should be able to exceed the standard limit of 255 characters.
- nullable: true
- columnName:
- type: string
- description: The name of the lookup source column.
- nullable: true
- listId:
- type: string
- description: The unique identifier of the lookup source list.
- nullable: true
- primaryLookupColumnId:
+ type:
type: string
- description: 'If specified, this column is a secondary lookup, pulling an additional field from the list item looked up by the primary lookup. Use the list item looked up by the primary as the source for the column named here.'
nullable: true
additionalProperties:
type: object
- microsoft.graph.numberColumn:
- title: numberColumn
+ microsoft.graph.pendingOperations:
+ title: pendingOperations
type: object
properties:
- decimalPlaces:
+ pendingContentUpdate:
+ $ref: '#/components/schemas/microsoft.graph.pendingContentUpdate'
+ additionalProperties:
+ type: object
+ microsoft.graph.photo:
+ title: photo
+ type: object
+ properties:
+ cameraMake:
type: string
- description: How many decimal places to display. See below for information about the possible values.
+ description: Camera manufacturer. Read-only.
nullable: true
- displayAs:
+ cameraModel:
type: string
- description: 'How the value should be presented in the UX. Must be one of number or percentage. If unspecified, treated as number.'
+ description: Camera model. Read-only.
nullable: true
- maximum:
+ exposureDenominator:
type: number
- description: The maximum permitted value.
+ description: The denominator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
- minimum:
+ exposureNumerator:
type: number
- description: The minimum permitted value.
+ description: The numerator for the exposure time fraction from the camera. Read-only.
format: double
nullable: true
- additionalProperties:
- type: object
- microsoft.graph.personOrGroupColumn:
- title: personOrGroupColumn
- type: object
- properties:
- allowMultipleSelection:
- type: boolean
- description: Indicates whether multiple values can be selected from the source.
+ fNumber:
+ type: number
+ description: The F-stop value from the camera. Read-only.
+ format: double
nullable: true
- chooseFromType:
- type: string
- description: 'Whether to allow selection of people only, or people and groups. Must be one of peopleAndGroups or peopleOnly.'
+ focalLength:
+ type: number
+ description: The focal length from the camera. Read-only.
+ format: double
nullable: true
- displayAs:
+ iso:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: The ISO value from the camera. Read-only.
+ format: int32
+ nullable: true
+ orientation:
+ maximum: 32767
+ minimum: -32768
+ type: integer
+ description: The orientation value from the camera. Writable on OneDrive Personal.
+ format: int16
+ nullable: true
+ takenDateTime:
+ 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: How to display the information about the person or group chosen. See below.
+ description: The date and time the photo was taken in UTC time. Read-only.
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.contentTypeInfo:
- title: contentTypeInfo
+ microsoft.graph.publicationFacet:
+ title: publicationFacet
type: object
properties:
- id:
+ checkedOutBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ level:
type: string
- description: The ID of the content type.
+ description: The state of publication for this document. Either published or checkout. Read-only.
nullable: true
- name:
+ versionId:
type: string
- description: The name of the content type.
+ description: The unique identifier for the version that is visible to the current caller. Read-only.
nullable: true
additionalProperties:
type: object
- microsoft.graph.termColumn:
- title: termColumn
+ microsoft.graph.remoteItem:
+ title: remoteItem
type: object
properties:
- allowMultipleValues:
- type: boolean
- description: Specifies whether the column allows more than one value
+ createdBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ 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
- showFullyQualifiedName:
- type: boolean
- description: Specifies whether to display the entire term path or only the term label.
+ file:
+ $ref: '#/components/schemas/microsoft.graph.file'
+ fileSystemInfo:
+ $ref: '#/components/schemas/microsoft.graph.fileSystemInfo'
+ folder:
+ $ref: '#/components/schemas/microsoft.graph.folder'
+ id:
+ type: string
+ description: Unique identifier for the remote item in its drive. Read-only.
nullable: true
- parentTerm:
- $ref: '#/components/schemas/microsoft.graph.termStore.term'
- termSet:
- $ref: '#/components/schemas/microsoft.graph.termStore.set'
- additionalProperties:
- type: object
- microsoft.graph.textColumn:
- title: textColumn
- type: object
- properties:
- allowMultipleLines:
- type: boolean
- description: Whether to allow multiple lines of text.
+ image:
+ $ref: '#/components/schemas/microsoft.graph.image'
+ lastModifiedBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ 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
- appendChangesToExistingText:
- type: boolean
- description: 'Whether updates to this column should replace existing text, or append to it.'
+ name:
+ type: string
+ description: Optional. Filename of the remote item. Read-only.
nullable: true
- linesForEditing:
- maximum: 2147483647
- minimum: -2147483648
+ package:
+ $ref: '#/components/schemas/microsoft.graph.package'
+ parentReference:
+ $ref: '#/components/schemas/microsoft.graph.itemReference'
+ shared:
+ $ref: '#/components/schemas/microsoft.graph.shared'
+ sharepointIds:
+ $ref: '#/components/schemas/microsoft.graph.sharepointIds'
+ size:
type: integer
- description: The size of the text box.
- format: int32
+ description: Size of the remote item. Read-only.
+ format: int64
nullable: true
- maxLength:
- maximum: 2147483647
- minimum: -2147483648
- type: integer
- description: The maximum number of characters for the value.
- format: int32
+ specialFolder:
+ $ref: '#/components/schemas/microsoft.graph.specialFolder'
+ video:
+ $ref: '#/components/schemas/microsoft.graph.video'
+ webDavUrl:
+ type: string
+ description: DAV compatible URL for the item.
nullable: true
- textType:
+ webUrl:
type: string
- description: The type of text being stored. Must be one of plain or richText
+ description: URL that displays the resource in the browser. Read-only.
nullable: true
additionalProperties:
type: object
- microsoft.graph.thumbnailColumn:
- title: thumbnailColumn
+ microsoft.graph.searchResult:
+ title: searchResult
type: object
+ properties:
+ onClickTelemetryUrl:
+ type: string
+ description: A callback URL that can be used to record telemetry information. The application should issue a GET on this URL if the user interacts with this item to improve the quality of results.
+ nullable: true
additionalProperties:
type: object
- microsoft.graph.columnTypes:
- title: columnTypes
- enum:
- - note
- - text
- - choice
- - multichoice
- - number
- - currency
- - dateTime
- - lookup
- - boolean
- - user
- - url
- - calculated
- - location
- - geolocation
- - term
- - multiterm
- - thumbnail
- - approvalStatus
- - unknownFutureValue
- type: string
- microsoft.graph.columnValidation:
- title: columnValidation
+ microsoft.graph.shared:
+ title: shared
type: object
properties:
- defaultLanguage:
+ owner:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ scope:
type: string
- description: Default BCP 47 language tag for the description.
+ description: 'Indicates the scope of how the item is shared: anonymous, organization, or users. Read-only.'
nullable: true
- descriptions:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.displayNameLocalization'
- description: Localized messages that explain what is needed for this column's value to be considered valid. User will be prompted with this message if validation fails.
- formula:
+ sharedBy:
+ $ref: '#/components/schemas/microsoft.graph.identitySet'
+ sharedDateTime:
+ 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 formula to validate column value. For examples, see Examples of common formulas in lists'
+ description: The UTC date and time when the item was shared. Read-only.
+ format: date-time
nullable: true
additionalProperties:
type: object
- microsoft.graph.documentSet:
- title: documentSet
+ microsoft.graph.driveItemSource:
+ title: driveItemSource
type: object
properties:
- allowedContentTypes:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
- description: Content types allowed in document set.
- defaultContents:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.documentSetContent'
- description: Default contents of document set.
- propagateWelcomePageChanges:
- type: boolean
- description: Indicates whether to add the name of the document set to each file name.
- nullable: true
- shouldPrefixNameToFile:
- type: boolean
- description: Add the name of the Document Set to each file name.
- nullable: true
- welcomePageUrl:
+ application:
+ $ref: '#/components/schemas/microsoft.graph.driveItemSourceApplication'
+ externalId:
type: string
- description: Welcome page absolute URL.
+ description: The external identifier for the drive item from the source.
nullable: true
- sharedColumns:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.columnDefinition'
- x-ms-navigationProperty: true
- welcomePageColumns:
- type: array
- items:
- $ref: '#/components/schemas/microsoft.graph.columnDefinition'
- x-ms-navigationProperty: true
additionalProperties:
type: object
- microsoft.graph.documentSetContent:
- title: documentSetContent
+ microsoft.graph.specialFolder:
+ title: specialFolder
type: object
properties:
- contentType:
- $ref: '#/components/schemas/microsoft.graph.contentTypeInfo'
- fileName:
- type: string
- description: Name of the file in resource folder that should be added as a default content or a template in the document set
- nullable: true
- folderName:
+ name:
type: string
- description: Folder name in which the file will be placed when a new document set is created in the library.
+ description: The unique identifier for this item in the /drive/special collection
nullable: true
additionalProperties:
type: object
- microsoft.graph.contentTypeOrder:
- title: contentTypeOrder
+ microsoft.graph.video:
+ title: video
type: object
properties:
- default:
- type: boolean
- description: Indicates whether this is the default content type.
- nullable: true
- position:
+ audioBitsPerSample:
maximum: 2147483647
minimum: -2147483648
type: integer
- description: Specifies the position in which the content type appears in the selection UI.
+ description: Number of audio bits per sample.
format: int32
nullable: true
- additionalProperties:
- type: object
- 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
- additionalProperties:
- type: object
- microsoft.graph.pageLayoutType:
- title: pageLayoutType
- enum:
- - microsoftReserved
- - article
- - home
- - unknownFutureValue
- type: string
- microsoft.graph.sharePointIdentitySet:
- allOf:
- - $ref: '#/components/schemas/microsoft.graph.identitySet'
- - title: sharePointIdentitySet
- type: object
- properties:
- group:
- $ref: '#/components/schemas/microsoft.graph.identity'
- siteGroup:
- $ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
- siteUser:
- $ref: '#/components/schemas/microsoft.graph.sharePointIdentity'
- additionalProperties:
- type: object
- microsoft.graph.sharingInvitation:
- title: sharingInvitation
- type: object
- properties:
- email:
- type: string
- description: The email address provided for the recipient of the sharing invitation. Read-only.
+ audioChannels:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of audio channels.
+ format: int32
nullable: true
- invitedBy:
- $ref: '#/components/schemas/microsoft.graph.identitySet'
- redeemedBy:
+ audioFormat:
type: string
+ description: 'Name of the audio format (AAC, MP3, etc.).'
nullable: true
- signInRequired:
- type: boolean
- description: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only.
- nullable: true
- additionalProperties:
- type: object
- microsoft.graph.sharingLink:
- title: sharingLink
- type: object
- properties:
- application:
- $ref: '#/components/schemas/microsoft.graph.identity'
- configuratorUrl:
- type: string
+ audioSamplesPerSecond:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Number of audio samples per second.
+ format: int32
nullable: true
- preventsDownload:
- type: boolean
- description: 'If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint.'
+ bitrate:
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ description: Bit rate of the video in bits per second.
+ format: int32
nullable: true
- scope:
- type: string
- description: 'The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant.'
+ duration:
+ type: integer
+ description: Duration of the file in milliseconds.
+ format: int64
nullable: true
- type:
+ fourCC:
type: string
- description: The type of the link created.
+ description: '''Four character code'' name of the video format.'
nullable: true
- webHtml:
- type: string
- description: 'For embed links, this property contains the HTML code for an