Update-MgBetaUser
Update the properties of a user object.
Note
To view the v1.0 release of this cmdlet, view Update-MgUser
Syntax
Update-MgBetaUser
-UserId <String>
[-ResponseHeadersVariable <String>]
[-AboutMe <String>]
[-AccountEnabled]
[-Activities <IMicrosoftGraphUserActivity[]>]
[-AdditionalProperties <Hashtable>]
[-AgeGroup <String>]
[-AgreementAcceptances <IMicrosoftGraphAgreementAcceptance[]>]
[-Analytics <IMicrosoftGraphUserAnalytics>]
[-AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest[]>]
[-AppRoleAssignedResources <IMicrosoftGraphServicePrincipal[]>]
[-AppRoleAssignments <IMicrosoftGraphAppRoleAssignment[]>]
[-Approvals <IMicrosoftGraphApproval[]>]
[-AssignedLicenses <IMicrosoftGraphAssignedLicense[]>]
[-AssignedPlans <IMicrosoftGraphAssignedPlan[]>]
[-Authentication <IMicrosoftGraphAuthentication>]
[-AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
[-Birthday <DateTime>]
[-BusinessPhones <String[]>]
[-Calendar <IMicrosoftGraphCalendar>]
[-CalendarGroups <IMicrosoftGraphCalendarGroup[]>]
[-CalendarView <IMicrosoftGraphEvent[]>]
[-Calendars <IMicrosoftGraphCalendar[]>]
[-Chats <IMicrosoftGraphChat[]>]
[-City <String>]
[-CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
[-CloudPCs <IMicrosoftGraphCloudPc[]>]
[-CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
[-CompanyName <String>]
[-ConsentProvidedForMinor <String>]
[-ContactFolders <IMicrosoftGraphContactFolder[]>]
[-Contacts <IMicrosoftGraphContact[]>]
[-Country <String>]
[-CreatedDateTime <DateTime>]
[-CreatedObjects <IMicrosoftGraphDirectoryObject[]>]
[-CreationType <String>]
[-CustomSecurityAttributes <Hashtable>]
[-DeletedDateTime <DateTime>]
[-Department <String>]
[-DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration[]>]
[-DeviceEnrollmentLimit <Int32>]
[-DeviceKeys <IMicrosoftGraphDeviceKey[]>]
[-DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent[]>]
[-Devices <IMicrosoftGraphDevice[]>]
[-DirectReports <IMicrosoftGraphDirectoryObject[]>]
[-DisplayName <String>]
[-Drive <IMicrosoftGraphDrive>]
[-Drives <IMicrosoftGraphDrive[]>]
[-EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
[-EmployeeHireDate <DateTime>]
[-EmployeeId <String>]
[-EmployeeLeaveDateTime <DateTime>]
[-EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
[-EmployeeType <String>]
[-Events <IMicrosoftGraphEvent[]>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-ExternalUserState <String>]
[-ExternalUserStateChangeDateTime <String>]
[-FaxNumber <String>]
[-FollowedSites <IMicrosoftGraphSite[]>]
[-GivenName <String>]
[-HireDate <DateTime>]
[-Id <String>]
[-Identities <IMicrosoftGraphObjectIdentity[]>]
[-ImAddresses <String[]>]
[-InferenceClassification <IMicrosoftGraphInferenceClassification>]
[-InfoCatalogs <String[]>]
[-InformationProtection <IMicrosoftGraphInformationProtection>]
[-Insights <Hashtable>]
[-Interests <String[]>]
[-InvitedBy <IMicrosoftGraphDirectoryObject>]
[-IsLicenseReconciliationNeeded]
[-IsManagementRestricted]
[-IsResourceAccount]
[-JobTitle <String>]
[-JoinedGroups <IMicrosoftGraphGroup[]>]
[-JoinedTeams <IMicrosoftGraphTeam[]>]
[-LastPasswordChangeDateTime <DateTime>]
[-LegalAgeGroupClassification <String>]
[-LicenseAssignmentStates <IMicrosoftGraphLicenseAssignmentState[]>]
[-LicenseDetails <IMicrosoftGraphLicenseDetails[]>]
[-Mail <String>]
[-MailFolders <IMicrosoftGraphMailFolder[]>]
[-MailNickname <String>]
[-MailboxSettings <IMicrosoftGraphMailboxSettings>]
[-ManagedAppLogCollectionRequests <IMicrosoftGraphManagedAppLogCollectionRequest[]>]
[-ManagedAppRegistrations <IMicrosoftGraphManagedAppRegistration[]>]
[-ManagedDevices <IMicrosoftGraphManagedDevice[]>]
[-Manager <IMicrosoftGraphDirectoryObject>]
[-MemberOf <IMicrosoftGraphDirectoryObject[]>]
[-Messages <IMicrosoftGraphMessage[]>]
[-MobileAppIntentAndStates <IMicrosoftGraphMobileAppIntentAndState[]>]
[-MobileAppTroubleshootingEvents <IMicrosoftGraphMobileAppTroubleshootingEvent[]>]
[-MobilePhone <String>]
[-MySite <String>]
[-Notifications <IMicrosoftGraphNotification[]>]
[-Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant[]>]
[-OfficeLocation <String>]
[-OnPremisesDistinguishedName <String>]
[-OnPremisesDomainName <String>]
[-OnPremisesExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
[-OnPremisesImmutableId <String>]
[-OnPremisesLastSyncDateTime <DateTime>]
[-OnPremisesProvisioningErrors <IMicrosoftGraphOnPremisesProvisioningError[]>]
[-OnPremisesSamAccountName <String>]
[-OnPremisesSecurityIdentifier <String>]
[-OnPremisesSipInfo <IMicrosoftGraphOnPremisesSipInfo>]
[-OnPremisesSyncEnabled]
[-OnPremisesUserPrincipalName <String>]
[-Onenote <IMicrosoftGraphOnenote>]
[-OnlineMeetings <IMicrosoftGraphOnlineMeeting[]>]
[-OtherMails <String[]>]
[-Outlook <IMicrosoftGraphOutlookUser>]
[-OwnedDevices <IMicrosoftGraphDirectoryObject[]>]
[-OwnedObjects <IMicrosoftGraphDirectoryObject[]>]
[-PasswordPolicies <String>]
[-PasswordProfile <IMicrosoftGraphPasswordProfile>]
[-PastProjects <String[]>]
[-PendingAccessReviewInstances <IMicrosoftGraphAccessReviewInstance[]>]
[-People <IMicrosoftGraphPerson[]>]
[-PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant[]>]
[-Photo <IMicrosoftGraphProfilePhoto>]
[-Photos <IMicrosoftGraphProfilePhoto[]>]
[-Planner <IMicrosoftGraphPlannerUser>]
[-PostalCode <String>]
[-PreferredDataLocation <String>]
[-PreferredLanguage <String>]
[-PreferredName <String>]
[-Presence <IMicrosoftGraphPresence>]
[-Print <IMicrosoftGraphUserPrint>]
[-Profile <IMicrosoftGraphProfile>]
[-ProvisionedPlans <IMicrosoftGraphProvisionedPlan[]>]
[-ProxyAddresses <String[]>]
[-RefreshTokensValidFromDateTime <DateTime>]
[-RegisteredDevices <IMicrosoftGraphDirectoryObject[]>]
[-Responsibilities <String[]>]
[-Schools <String[]>]
[-ScopedRoleMemberOf <IMicrosoftGraphScopedRoleMembership[]>]
[-Security <IMicrosoftGraphSecurity>]
[-SecurityIdentifier <String>]
[-ServiceProvisioningErrors <IMicrosoftGraphServiceProvisioningError[]>]
[-Settings <IMicrosoftGraphUserSettings>]
[-ShowInAddressList]
[-SignInActivity <IMicrosoftGraphSignInActivity>]
[-SignInSessionsValidFromDateTime <DateTime>]
[-Skills <String[]>]
[-Solutions <IMicrosoftGraphUserSolutionRoot>]
[-Sponsors <IMicrosoftGraphDirectoryObject[]>]
[-State <String>]
[-StreetAddress <String>]
[-Surname <String>]
[-Teamwork <IMicrosoftGraphUserTeamwork>]
[-Todo <IMicrosoftGraphTodo>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-TransitiveReports <IMicrosoftGraphDirectoryObject[]>]
[-UsageLocation <String>]
[-UsageRights <IMicrosoftGraphUsageRight[]>]
[-UserPrincipalName <String>]
[-UserType <String>]
[-VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
[-WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaUser
-UserId <String>
-BodyParameter <IMicrosoftGraphUser>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaUser
-InputObject <IUsersIdentity>
[-ResponseHeadersVariable <String>]
[-AboutMe <String>]
[-AccountEnabled]
[-Activities <IMicrosoftGraphUserActivity[]>]
[-AdditionalProperties <Hashtable>]
[-AgeGroup <String>]
[-AgreementAcceptances <IMicrosoftGraphAgreementAcceptance[]>]
[-Analytics <IMicrosoftGraphUserAnalytics>]
[-AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest[]>]
[-AppRoleAssignedResources <IMicrosoftGraphServicePrincipal[]>]
[-AppRoleAssignments <IMicrosoftGraphAppRoleAssignment[]>]
[-Approvals <IMicrosoftGraphApproval[]>]
[-AssignedLicenses <IMicrosoftGraphAssignedLicense[]>]
[-AssignedPlans <IMicrosoftGraphAssignedPlan[]>]
[-Authentication <IMicrosoftGraphAuthentication>]
[-AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
[-Birthday <DateTime>]
[-BusinessPhones <String[]>]
[-Calendar <IMicrosoftGraphCalendar>]
[-CalendarGroups <IMicrosoftGraphCalendarGroup[]>]
[-CalendarView <IMicrosoftGraphEvent[]>]
[-Calendars <IMicrosoftGraphCalendar[]>]
[-Chats <IMicrosoftGraphChat[]>]
[-City <String>]
[-CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
[-CloudPCs <IMicrosoftGraphCloudPc[]>]
[-CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
[-CompanyName <String>]
[-ConsentProvidedForMinor <String>]
[-ContactFolders <IMicrosoftGraphContactFolder[]>]
[-Contacts <IMicrosoftGraphContact[]>]
[-Country <String>]
[-CreatedDateTime <DateTime>]
[-CreatedObjects <IMicrosoftGraphDirectoryObject[]>]
[-CreationType <String>]
[-CustomSecurityAttributes <Hashtable>]
[-DeletedDateTime <DateTime>]
[-Department <String>]
[-DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration[]>]
[-DeviceEnrollmentLimit <Int32>]
[-DeviceKeys <IMicrosoftGraphDeviceKey[]>]
[-DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent[]>]
[-Devices <IMicrosoftGraphDevice[]>]
[-DirectReports <IMicrosoftGraphDirectoryObject[]>]
[-DisplayName <String>]
[-Drive <IMicrosoftGraphDrive>]
[-Drives <IMicrosoftGraphDrive[]>]
[-EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
[-EmployeeHireDate <DateTime>]
[-EmployeeId <String>]
[-EmployeeLeaveDateTime <DateTime>]
[-EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
[-EmployeeType <String>]
[-Events <IMicrosoftGraphEvent[]>]
[-Extensions <IMicrosoftGraphExtension[]>]
[-ExternalUserState <String>]
[-ExternalUserStateChangeDateTime <String>]
[-FaxNumber <String>]
[-FollowedSites <IMicrosoftGraphSite[]>]
[-GivenName <String>]
[-HireDate <DateTime>]
[-Id <String>]
[-Identities <IMicrosoftGraphObjectIdentity[]>]
[-ImAddresses <String[]>]
[-InferenceClassification <IMicrosoftGraphInferenceClassification>]
[-InfoCatalogs <String[]>]
[-InformationProtection <IMicrosoftGraphInformationProtection>]
[-Insights <Hashtable>]
[-Interests <String[]>]
[-InvitedBy <IMicrosoftGraphDirectoryObject>]
[-IsLicenseReconciliationNeeded]
[-IsManagementRestricted]
[-IsResourceAccount]
[-JobTitle <String>]
[-JoinedGroups <IMicrosoftGraphGroup[]>]
[-JoinedTeams <IMicrosoftGraphTeam[]>]
[-LastPasswordChangeDateTime <DateTime>]
[-LegalAgeGroupClassification <String>]
[-LicenseAssignmentStates <IMicrosoftGraphLicenseAssignmentState[]>]
[-LicenseDetails <IMicrosoftGraphLicenseDetails[]>]
[-Mail <String>]
[-MailFolders <IMicrosoftGraphMailFolder[]>]
[-MailNickname <String>]
[-MailboxSettings <IMicrosoftGraphMailboxSettings>]
[-ManagedAppLogCollectionRequests <IMicrosoftGraphManagedAppLogCollectionRequest[]>]
[-ManagedAppRegistrations <IMicrosoftGraphManagedAppRegistration[]>]
[-ManagedDevices <IMicrosoftGraphManagedDevice[]>]
[-Manager <IMicrosoftGraphDirectoryObject>]
[-MemberOf <IMicrosoftGraphDirectoryObject[]>]
[-Messages <IMicrosoftGraphMessage[]>]
[-MobileAppIntentAndStates <IMicrosoftGraphMobileAppIntentAndState[]>]
[-MobileAppTroubleshootingEvents <IMicrosoftGraphMobileAppTroubleshootingEvent[]>]
[-MobilePhone <String>]
[-MySite <String>]
[-Notifications <IMicrosoftGraphNotification[]>]
[-Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant[]>]
[-OfficeLocation <String>]
[-OnPremisesDistinguishedName <String>]
[-OnPremisesDomainName <String>]
[-OnPremisesExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
[-OnPremisesImmutableId <String>]
[-OnPremisesLastSyncDateTime <DateTime>]
[-OnPremisesProvisioningErrors <IMicrosoftGraphOnPremisesProvisioningError[]>]
[-OnPremisesSamAccountName <String>]
[-OnPremisesSecurityIdentifier <String>]
[-OnPremisesSipInfo <IMicrosoftGraphOnPremisesSipInfo>]
[-OnPremisesSyncEnabled]
[-OnPremisesUserPrincipalName <String>]
[-Onenote <IMicrosoftGraphOnenote>]
[-OnlineMeetings <IMicrosoftGraphOnlineMeeting[]>]
[-OtherMails <String[]>]
[-Outlook <IMicrosoftGraphOutlookUser>]
[-OwnedDevices <IMicrosoftGraphDirectoryObject[]>]
[-OwnedObjects <IMicrosoftGraphDirectoryObject[]>]
[-PasswordPolicies <String>]
[-PasswordProfile <IMicrosoftGraphPasswordProfile>]
[-PastProjects <String[]>]
[-PendingAccessReviewInstances <IMicrosoftGraphAccessReviewInstance[]>]
[-People <IMicrosoftGraphPerson[]>]
[-PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant[]>]
[-Photo <IMicrosoftGraphProfilePhoto>]
[-Photos <IMicrosoftGraphProfilePhoto[]>]
[-Planner <IMicrosoftGraphPlannerUser>]
[-PostalCode <String>]
[-PreferredDataLocation <String>]
[-PreferredLanguage <String>]
[-PreferredName <String>]
[-Presence <IMicrosoftGraphPresence>]
[-Print <IMicrosoftGraphUserPrint>]
[-Profile <IMicrosoftGraphProfile>]
[-ProvisionedPlans <IMicrosoftGraphProvisionedPlan[]>]
[-ProxyAddresses <String[]>]
[-RefreshTokensValidFromDateTime <DateTime>]
[-RegisteredDevices <IMicrosoftGraphDirectoryObject[]>]
[-Responsibilities <String[]>]
[-Schools <String[]>]
[-ScopedRoleMemberOf <IMicrosoftGraphScopedRoleMembership[]>]
[-Security <IMicrosoftGraphSecurity>]
[-SecurityIdentifier <String>]
[-ServiceProvisioningErrors <IMicrosoftGraphServiceProvisioningError[]>]
[-Settings <IMicrosoftGraphUserSettings>]
[-ShowInAddressList]
[-SignInActivity <IMicrosoftGraphSignInActivity>]
[-SignInSessionsValidFromDateTime <DateTime>]
[-Skills <String[]>]
[-Solutions <IMicrosoftGraphUserSolutionRoot>]
[-Sponsors <IMicrosoftGraphDirectoryObject[]>]
[-State <String>]
[-StreetAddress <String>]
[-Surname <String>]
[-Teamwork <IMicrosoftGraphUserTeamwork>]
[-Todo <IMicrosoftGraphTodo>]
[-TransitiveMemberOf <IMicrosoftGraphDirectoryObject[]>]
[-TransitiveReports <IMicrosoftGraphDirectoryObject[]>]
[-UsageLocation <String>]
[-UsageRights <IMicrosoftGraphUsageRight[]>]
[-UserPrincipalName <String>]
[-UserType <String>]
[-VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
[-WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-MgBetaUser
-InputObject <IUsersIdentity>
-BodyParameter <IMicrosoftGraphUser>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update the properties of a user object.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | User.ReadWrite | User.ManageIdentities.All, User.EnableDisableAccount.All, User.ReadWrite.All, Directory.ReadWrite.All |
Delegated (personal Microsoft account) | User.ReadWrite | Not available. |
Application | User.ManageIdentities.All | User.EnableDisableAccount.All, User.ReadWrite.All, Directory.ReadWrite.All |
Examples
Example 1: Update a user's display name
Update-MgBetaUser -UserId '2a1fa0b8-87d6-4f39-be8d-68d0db617b02' -DisplayName 'Kristi Laar'
This example updates the specified user's display name.
Parameters
-AboutMe
A freeform text entry field for users to describe themselves. Returned only on $select.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AccountEnabled
true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Activities
The user's activities across devices. Read-only. Nullable. To construct, see NOTES section for ACTIVITIES properties and create a hash table.
Type: | IMicrosoftGraphUserActivity[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AgeGroup
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AgreementAcceptances
The user's terms of use acceptance statuses. Read-only. Nullable. To construct, see NOTES section for AGREEMENTACCEPTANCES properties and create a hash table.
Type: | IMicrosoftGraphAgreementAcceptance[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Analytics
userAnalytics To construct, see NOTES section for ANALYTICS properties and create a hash table.
Type: | IMicrosoftGraphUserAnalytics |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AppConsentRequestsForApproval
. To construct, see NOTES section for APPCONSENTREQUESTSFORAPPROVAL properties and create a hash table.
Type: | IMicrosoftGraphAppConsentRequest[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AppRoleAssignedResources
. To construct, see NOTES section for APPROLEASSIGNEDRESOURCES properties and create a hash table.
Type: | IMicrosoftGraphServicePrincipal[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AppRoleAssignments
Represents the app roles a user has been granted for an application. Supports $expand. To construct, see NOTES section for APPROLEASSIGNMENTS properties and create a hash table.
Type: | IMicrosoftGraphAppRoleAssignment[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Approvals
. To construct, see NOTES section for APPROVALS properties and create a hash table.
Type: | IMicrosoftGraphApproval[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AssignedLicenses
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). To construct, see NOTES section for ASSIGNEDLICENSES properties and create a hash table.
Type: | IMicrosoftGraphAssignedLicense[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AssignedPlans
The plans that are assigned to the user. Read-only. Not nullable.Supports $filter (eq and not). To construct, see NOTES section for ASSIGNEDPLANS properties and create a hash table.
Type: | IMicrosoftGraphAssignedPlan[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Authentication
authentication To construct, see NOTES section for AUTHENTICATION properties and create a hash table.
Type: | IMicrosoftGraphAuthentication |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AuthorizationInfo
authorizationInfo To construct, see NOTES section for AUTHORIZATIONINFO properties and create a hash table.
Type: | IMicrosoftGraphAuthorizationInfo |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Birthday
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
user To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphUser |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-BusinessPhones
The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced from on-premises directory. Supports $filter (eq, not, ge, le, startsWith).
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Calendar
calendar To construct, see NOTES section for CALENDAR properties and create a hash table.
Type: | IMicrosoftGraphCalendar |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CalendarGroups
The user's calendar groups. Read-only. Nullable. To construct, see NOTES section for CALENDARGROUPS properties and create a hash table.
Type: | IMicrosoftGraphCalendarGroup[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Calendars
The user's calendars. Read-only. Nullable. To construct, see NOTES section for CALENDARS properties and create a hash table.
Type: | IMicrosoftGraphCalendar[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CalendarView
The calendar view for the calendar. Read-only. Nullable. To construct, see NOTES section for CALENDARVIEW properties and create a hash table.
Type: | IMicrosoftGraphEvent[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Chats
. To construct, see NOTES section for CHATS properties and create a hash table.
Type: | IMicrosoftGraphChat[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-City
The city where the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CloudClipboard
cloudClipboardRoot To construct, see NOTES section for CLOUDCLIPBOARD properties and create a hash table.
Type: | IMicrosoftGraphCloudClipboardRoot |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CloudPCs
. To construct, see NOTES section for CLOUDPCS properties and create a hash table.
Type: | IMicrosoftGraphCloudPc[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CloudRealtimeCommunicationInfo
cloudRealtimeCommunicationInfo To construct, see NOTES section for CLOUDREALTIMECOMMUNICATIONINFO properties and create a hash table.
Type: | IMicrosoftGraphCloudRealtimeCommunicationInfo |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CompanyName
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConsentProvidedForMinor
Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, not, and in).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ContactFolders
The user's contacts folders. Read-only. Nullable. To construct, see NOTES section for CONTACTFOLDERS properties and create a hash table.
Type: | IMicrosoftGraphContactFolder[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Contacts
The user's contacts. Read-only. Nullable. To construct, see NOTES section for CONTACTS properties and create a hash table.
Type: | IMicrosoftGraphContact[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Country
The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CreatedDateTime
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).
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CreatedObjects
Directory objects that the user created. Read-only. Nullable. To construct, see NOTES section for CREATEDOBJECTS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CreationType
Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Supports $filter (eq, ne, not, and in).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CustomSecurityAttributes
customSecurityAttributeValue
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeletedDateTime
Date and time when this object was deleted. Always null when the object hasn't been deleted.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Department
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceEnrollmentConfigurations
Get enrollment configurations targeted to the user To construct, see NOTES section for DEVICEENROLLMENTCONFIGURATIONS properties and create a hash table.
Type: | IMicrosoftGraphDeviceEnrollmentConfiguration[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceEnrollmentLimit
The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceKeys
. To construct, see NOTES section for DEVICEKEYS properties and create a hash table.
Type: | IMicrosoftGraphDeviceKey[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceManagementTroubleshootingEvents
The list of troubleshooting events for this user. To construct, see NOTES section for DEVICEMANAGEMENTTROUBLESHOOTINGEVENTS properties and create a hash table.
Type: | IMicrosoftGraphDeviceManagementTroubleshootingEvent[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Devices
. To construct, see NOTES section for DEVICES properties and create a hash table.
Type: | IMicrosoftGraphDevice[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DirectReports
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. To construct, see NOTES section for DIRECTREPORTS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Drive
drive To construct, see NOTES section for DRIVE properties and create a hash table.
Type: | IMicrosoftGraphDrive |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Drives
A collection of drives available for this user. Read-only. To construct, see NOTES section for DRIVES properties and create a hash table.
Type: | IMicrosoftGraphDrive[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmployeeExperience
employeeExperienceUser To construct, see NOTES section for EMPLOYEEEXPERIENCE properties and create a hash table.
Type: | IMicrosoftGraphEmployeeExperienceUser |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmployeeHireDate
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).
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmployeeId
The employee identifier assigned to the user by the organization. The maximum length is 16 characters.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmployeeLeaveDateTime
The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmployeeOrgData
employeeOrgData To construct, see NOTES section for EMPLOYEEORGDATA properties and create a hash table.
Type: | IMicrosoftGraphEmployeeOrgData |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmployeeType
Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Supports $filter (eq, ne, not , ge, le, in, startsWith).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Events
The user's events. The default is to show events under the Default Calendar. Read-only. Nullable. To construct, see NOTES section for EVENTS properties and create a hash table.
Type: | IMicrosoftGraphEvent[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Extensions
The collection of open extensions defined for the user. Supports $expand. Nullable. To construct, see NOTES section for EXTENSIONS properties and create a hash table.
Type: | IMicrosoftGraphExtension[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExternalUserState
For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Supports $filter (eq, ne, not , in).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExternalUserStateChangeDateTime
Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, not , in).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FaxNumber
The fax number of the user. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FollowedSites
. To construct, see NOTES section for FOLLOWEDSITES properties and create a hash table.
Type: | IMicrosoftGraphSite[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GivenName
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-HireDate
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Identities
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) with limitations. To construct, see NOTES section for IDENTITIES properties and create a hash table.
Type: | IMicrosoftGraphObjectIdentity[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImAddresses
The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Supports $filter (eq, not, ge, le, startsWith).
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InferenceClassification
inferenceClassification To construct, see NOTES section for INFERENCECLASSIFICATION properties and create a hash table.
Type: | IMicrosoftGraphInferenceClassification |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InfoCatalogs
Identifies the info segments assigned to the user. Supports $filter (eq, not, ge, le, startsWith).
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InformationProtection
informationProtection To construct, see NOTES section for INFORMATIONPROTECTION properties and create a hash table.
Type: | IMicrosoftGraphInformationProtection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Type: | IUsersIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Insights
itemInsights
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Interests
A list for users to describe their interests. Returned only on $select.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InvitedBy
directoryObject To construct, see NOTES section for INVITEDBY properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsLicenseReconciliationNeeded
Indicates whether the user is pending an exchange mailbox license assignment. Read-only. Supports $filter (eq where true only).
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsManagementRestricted
true if the user is a member of a restricted management administrative unit. Default value is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsResourceAccount
Do not use - reserved for future use.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobTitle
The user's job title. Maximum length is 128 characters. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JoinedGroups
. To construct, see NOTES section for JOINEDGROUPS properties and create a hash table.
Type: | IMicrosoftGraphGroup[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JoinedTeams
The Microsoft Teams teams the user is a member of. Read-only. Nullable. To construct, see NOTES section for JOINEDTEAMS properties and create a hash table.
Type: | IMicrosoftGraphTeam[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LastPasswordChangeDateTime
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LegalAgeGroupClassification
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LicenseAssignmentStates
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. To construct, see NOTES section for LICENSEASSIGNMENTSTATES properties and create a hash table.
Type: | IMicrosoftGraphLicenseAssignmentState[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LicenseDetails
. To construct, see NOTES section for LICENSEDETAILS properties and create a hash table.
Type: | IMicrosoftGraphLicenseDetails[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MailboxSettings
mailboxSettings To construct, see NOTES section for MAILBOXSETTINGS properties and create a hash table.
Type: | IMicrosoftGraphMailboxSettings |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MailFolders
The user's mail folders. Read-only. Nullable. To construct, see NOTES section for MAILFOLDERS properties and create a hash table.
Type: | IMicrosoftGraphMailFolder[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MailNickname
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagedAppLogCollectionRequests
Zero or more log collection requests triggered for the user. To construct, see NOTES section for MANAGEDAPPLOGCOLLECTIONREQUESTS properties and create a hash table.
Type: | IMicrosoftGraphManagedAppLogCollectionRequest[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagedAppRegistrations
Zero or more managed app registrations that belong to the user. To construct, see NOTES section for MANAGEDAPPREGISTRATIONS properties and create a hash table.
Type: | IMicrosoftGraphManagedAppRegistration[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManagedDevices
The managed devices associated with the user. To construct, see NOTES section for MANAGEDDEVICES properties and create a hash table.
Type: | IMicrosoftGraphManagedDevice[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Manager
directoryObject To construct, see NOTES section for MANAGER properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MemberOf
The groups, directory roles, and administrative units that the user is a member of. Read-only. Nullable. Supports $expand. To construct, see NOTES section for MEMBEROF properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Messages
The messages in a mailbox or folder. Read-only. Nullable. To construct, see NOTES section for MESSAGES properties and create a hash table.
Type: | IMicrosoftGraphMessage[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MobileAppIntentAndStates
The list of troubleshooting events for this user. To construct, see NOTES section for MOBILEAPPINTENTANDSTATES properties and create a hash table.
Type: | IMicrosoftGraphMobileAppIntentAndState[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MobileAppTroubleshootingEvents
The list of mobile app troubleshooting events for this user. To construct, see NOTES section for MOBILEAPPTROUBLESHOOTINGEVENTS properties and create a hash table.
Type: | IMicrosoftGraphMobileAppTroubleshootingEvent[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MobilePhone
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MySite
The URL for the user's site. Returned only on $select.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Notifications
. To construct, see NOTES section for NOTIFICATIONS properties and create a hash table.
Type: | IMicrosoftGraphNotification[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Oauth2PermissionGrants
. To construct, see NOTES section for OAUTH2PERMISSIONGRANTS properties and create a hash table.
Type: | IMicrosoftGraphOAuth2PermissionGrant[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OfficeLocation
The office location in the user's place of business. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Onenote
onenote To construct, see NOTES section for ONENOTE properties and create a hash table.
Type: | IMicrosoftGraphOnenote |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnlineMeetings
Information about a meeting, including the URL used to join a meeting, the attendees list, and the description. To construct, see NOTES section for ONLINEMEETINGS properties and create a hash table.
Type: | IMicrosoftGraphOnlineMeeting[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesDistinguishedName
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesDomainName
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesExtensionAttributes
onPremisesExtensionAttributes To construct, see NOTES section for ONPREMISESEXTENSIONATTRIBUTES properties and create a hash table.
Type: | IMicrosoftGraphOnPremisesExtensionAttributes |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesImmutableId
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesLastSyncDateTime
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).
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesProvisioningErrors
Errors when using Microsoft synchronization product during provisioning. Supports $filter (eq, not, ge, le). To construct, see NOTES section for ONPREMISESPROVISIONINGERRORS properties and create a hash table.
Type: | IMicrosoftGraphOnPremisesProvisioningError[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesSamAccountName
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesSecurityIdentifier
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesSipInfo
onPremisesSipInfo To construct, see NOTES section for ONPREMISESSIPINFO properties and create a hash table.
Type: | IMicrosoftGraphOnPremisesSipInfo |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesSyncEnabled
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).
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OnPremisesUserPrincipalName
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OtherMails
A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].NOTE: This property can't contain accent characters.Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Outlook
outlookUser To construct, see NOTES section for OUTLOOK properties and create a hash table.
Type: | IMicrosoftGraphOutlookUser |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OwnedDevices
Devices owned by the user. Read-only. Nullable. Supports $expand. To construct, see NOTES section for OWNEDDEVICES properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OwnedObjects
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). To construct, see NOTES section for OWNEDOBJECTS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PasswordPolicies
Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PasswordProfile
passwordProfile To construct, see NOTES section for PASSWORDPROFILE properties and create a hash table.
Type: | IMicrosoftGraphPasswordProfile |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PastProjects
A list for users to enumerate their past projects. Returned only on $select.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PendingAccessReviewInstances
Navigation property to get a list of access reviews pending approval by the reviewer. To construct, see NOTES section for PENDINGACCESSREVIEWINSTANCES properties and create a hash table.
Type: | IMicrosoftGraphAccessReviewInstance[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-People
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. To construct, see NOTES section for PEOPLE properties and create a hash table.
Type: | IMicrosoftGraphPerson[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PermissionGrants
List all resource-specific permission grants of a user. To construct, see NOTES section for PERMISSIONGRANTS properties and create a hash table.
Type: | IMicrosoftGraphResourceSpecificPermissionGrant[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Photo
profilePhoto To construct, see NOTES section for PHOTO properties and create a hash table.
Type: | IMicrosoftGraphProfilePhoto |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Photos
The collection of the user's profile photos in different sizes. Read-only. To construct, see NOTES section for PHOTOS properties and create a hash table.
Type: | IMicrosoftGraphProfilePhoto[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Planner
plannerUser To construct, see NOTES section for PLANNER properties and create a hash table.
Type: | IMicrosoftGraphPlannerUser |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PostalCode
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PreferredDataLocation
The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PreferredLanguage
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PreferredName
The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Presence
presence To construct, see NOTES section for PRESENCE properties and create a hash table.
Type: | IMicrosoftGraphPresence |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
userPrint To construct, see NOTES section for PRINT properties and create a hash table.
Type: | IMicrosoftGraphUserPrint |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Profile
profile To construct, see NOTES section for PROFILE properties and create a hash table.
Type: | IMicrosoftGraphProfile |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
Type: | ActionPreference |
Aliases: | proga |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProvisionedPlans
The plans that are provisioned for the user. Read-only. Not nullable. Supports $filter (eq, not, ge, le). To construct, see NOTES section for PROVISIONEDPLANS properties and create a hash table.
Type: | IMicrosoftGraphProvisionedPlan[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyAddresses
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).
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RefreshTokensValidFromDateTime
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RegisteredDevices
Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects. To construct, see NOTES section for REGISTEREDDEVICES properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Type: | String |
Aliases: | RHV |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Responsibilities
A list for the user to enumerate their responsibilities. Returned only on $select.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Schools
A list for the user to enumerate the schools they have attended. Returned only on $select.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScopedRoleMemberOf
The scoped-role administrative unit memberships for this user. Read-only. Nullable. To construct, see NOTES section for SCOPEDROLEMEMBEROF properties and create a hash table.
Type: | IMicrosoftGraphScopedRoleMembership[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Security
security To construct, see NOTES section for SECURITY properties and create a hash table.
Type: | IMicrosoftGraphSecurity |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SecurityIdentifier
Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServiceProvisioningErrors
Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. To construct, see NOTES section for SERVICEPROVISIONINGERRORS properties and create a hash table.
Type: | IMicrosoftGraphServiceProvisioningError[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Settings
userSettings To construct, see NOTES section for SETTINGS properties and create a hash table.
Type: | IMicrosoftGraphUserSettings |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ShowInAddressList
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SignInActivity
signInActivity To construct, see NOTES section for SIGNINACTIVITY properties and create a hash table.
Type: | IMicrosoftGraphSignInActivity |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SignInSessionsValidFromDateTime
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.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Skills
A list for the user to enumerate their skills. Returned only on $select.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Solutions
userSolutionRoot To construct, see NOTES section for SOLUTIONS properties and create a hash table.
Type: | IMicrosoftGraphUserSolutionRoot |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Sponsors
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. To construct, see NOTES section for SPONSORS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-State
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StreetAddress
The street address of the user's place of business. Maximum length is 1024 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Surname
The user's surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Teamwork
userTeamwork To construct, see NOTES section for TEAMWORK properties and create a hash table.
Type: | IMicrosoftGraphUserTeamwork |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Todo
todo To construct, see NOTES section for TODO properties and create a hash table.
Type: | IMicrosoftGraphTodo |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TransitiveMemberOf
The groups, including nested groups and directory roles that a user is a member of. Nullable. To construct, see NOTES section for TRANSITIVEMEMBEROF properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TransitiveReports
The transitive reports for a user. Read-only. To construct, see NOTES section for TRANSITIVEREPORTS properties and create a hash table.
Type: | IMicrosoftGraphDirectoryObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UsageLocation
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).
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UsageRights
Represents the usage rights a user has been granted. To construct, see NOTES section for USAGERIGHTS properties and create a hash table.
Type: | IMicrosoftGraphUsageRight[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserId
The unique identifier of user
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserPrincipalName
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserType
A String value that can be used to classify user types in your directory. The possible values are 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
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VirtualEvents
userVirtualEventsRoot To construct, see NOTES section for VIRTUALEVENTS properties and create a hash table.
Type: | IMicrosoftGraphUserVirtualEventsRoot |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WindowsInformationProtectionDeviceRegistrations
Zero or more WIP device registrations that belong to the user. To construct, see NOTES section for WINDOWSINFORMATIONPROTECTIONDEVICEREGISTRATIONS properties and create a hash table.
Type: | IMicrosoftGraphWindowsInformationProtectionDeviceRegistration[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUser
Microsoft.Graph.Beta.PowerShell.Models.IUsersIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUser
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
ACTIVITIES <IMicrosoftGraphUserActivity- []
>: The user's activities across devices.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
AGREEMENTACCEPTANCES <IMicrosoftGraphAgreementAcceptance- []
>: The user's terms of use acceptance statuses.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
ANALYTICS <IMicrosoftGraphUserAnalytics>
: userAnalytics
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
APPCONSENTREQUESTSFORAPPROVAL <IMicrosoftGraphAppConsentRequest- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
APPROLEASSIGNEDRESOURCES <IMicrosoftGraphServicePrincipal- []
>: .
[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
[ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the app wasn't created from an application template.[ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal. Supports $expand.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:[Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.[IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.
[ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols. A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored. The value provided must be in the format of an absolute URI.[Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set. Inherited from customclaimbase.[Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.[Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase[(Any) <Object>]
: This indicates any property can be added to this object.
[Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase[(Any) <Object>]
: This indicates any property can be added to this object.
[Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.[Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute[(Any) <Object>]
: This indicates any property can be added to this object.[Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase[TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued. By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
[IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim. It is relevant only for SAML2.0 and if a custom signing key is used. the default value is true. Optional.[IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy. If set to true, all claims in the basic claim set are emitted in tokens affected by the policy. By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
[CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal. Read-only. Nullable.[CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue[(Any) <Object>]
: This indicates any property can be added to this object.
[DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[Classification <String>]
: permissionClassificationType[PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Required on create. Doesn't support $filter.[PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal. Doesn't support $filter.
[Description <String>]
: Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps displays the application description in this field. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.[DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not).[DisplayName <String>]
: The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery. Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[Capability <String>]
: Describes the capability that is associated with this resource. (for example, Messages, Conversations, etc.) Not nullable. Read-only.[ProviderId <String>]
: Application id of the publishing underlying service. Not nullable. Read-only.[ProviderName <String>]
: Name of the publishing underlying service. Read-only.[ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.). Not nullable. Read-only.[Uri <String>]
: URL of the published resource. Not nullable. Read-only.
[ErrorUrl <String>]
: Deprecated. Don't use.[FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Audiences <String-
[]>]
: The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.[Description <String>]
: The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional.[Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. It has a limit of 600 characters. Required.[Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Alternate key. Required. Not nullable. Supports $filter (eq).[Subject <String>]
: Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. The combination of issuer and subject must be unique on the app. It has a limit of 600 characters. Supports $filter (eq).
[HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal. Supports $expand.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:[Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.[IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.
[Homepage <String>]
: Home page or landing page of the application.[Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl[(Any) <Object>]
: This indicates any property can be added to this object.[LogoUrl <String>]
: CDN URL to the application's logo, Read-only.[MarketingUrl <String>]
: Link to the application's marketing page. For example, https://www.contoso.com/app/marketing[PrivacyStatementUrl <String>]
: Link to the application's privacy statement. For example, https://www.contoso.com/app/privacy[SupportUrl <String>]
: Link to the application's support page. For example, https://www.contoso.com/app/support[TermsOfServiceUrl <String>]
: Link to the application's terms of service statement. For example, https://www.contoso.com/app/termsofservice
[KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).[CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate.[DisplayName <String>]
: Friendly name for the key. Optional.[EndDateTime <DateTime?>]
: The date and time at which the credential expires. 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.[Key <Byte-
[]>]
: Value for the key credential. Should be a Base64 encoded value. Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null. From a .cer certificate, you can read the key using the Convert.ToBase64String() method. For more information, see Get the certificate key.[KeyId <String>]
: The unique identifier for the key.[StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.[Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.[Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign. If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
[LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license. Read-only. Not nullable.[AppliesTo <String>]
: 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.[ProvisioningStatus <String>]
: 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.[ServicePlanId <String>]
: The unique identifier of the service plan.[ServicePlanName <String>]
: The name of the service plan.
[SkuId <String>]
: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.[SkuPartNumber <String>]
: Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.
[LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate. Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps. When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.[LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of. HTTP Methods: GET Read-only. Nullable. Supports $expand.[Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1,024 characters.[NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.[Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).[ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).[ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant. Required.[PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only).[ResourceId <String>]
: The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).[Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.[StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant. Required.
[OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).[Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal. The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object. Read-only. Nullable. Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).[PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal. Not nullable.[CustomKeyIdentifier <Byte-
[]>]
: Do not use.[DisplayName <String>]
: Friendly name for the password. Optional.[EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.[Hint <String>]
: Contains the first three characters of the password. Read-only.[KeyId <String>]
: The unique identifier for the password.[SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future.[StartDateTime <DateTime?>]
: The date and time at which the password becomes valid. 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. Optional.
[PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings[(Any) <Object>]
: This indicates any property can be added to this object.[Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.[CustomizedLabel <String>]
: Title/label override for customization.[DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided. Read only.[FieldId <String>]
: Id used to identity the field type. This is an internal ID and possible values are param1, param2, paramuserName, parampassword.[Type <String>]
: Type of the credential. The values can be text, password.
[PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.[Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions[(Any) <Object>]
: This indicates any property can be added to this object.[PermissionKind <String>]
: permissionKind[PermissionType <String>]
: permissionType
[ScopeType <String>]
: resourceScopeType[SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels[(Any) <Object>]
: This indicates any property can be added to this object.[LabelKind <String>]
: labelKind
[PreferredSingleSignOnMode <String>]
: 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. Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.[PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint. Updating this attribute isn't currently supported. For details, see ServicePrincipal property differences.[PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property.[PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application. For more information, see the oauth2PermissionScopes property on the application entity's api property. Not nullable. Note: This property is named oauth2PermissionScopes in v1.0.[AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users. This text appears in tenant-wide admin consent experiences.[AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.[Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.[IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed.[Origin <String>]
:[Type <String>]
: The possible values are: User and Admin. Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required. While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission). For more information, see Configure how users consent to applications.[UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.[UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf. This text appears in consent experiences where the user is consenting only on behalf of themselves.[Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
[PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.[RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.[TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Display name for the target device group.
[ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable.[SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.[SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings[(Any) <Object>]
: This indicates any property can be added to this object.[RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
[ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application. More values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, not, ge, le, startsWith).[ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity. This is set by Microsoft Entra ID internally. For a service principal that represents an application this is set as Application. For a service principal that represents a managed identity this is set as ManagedIdentity. The SocialIdp type is for internal use.[SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.[Synchronization <IMicrosoftGraphSynchronization>]
: synchronization[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.[Id <String>]
: The unique identifier for an entity. Read-only.[BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[Expiration <DateTime?>]
: 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.[Interval <TimeSpan?>]
: The interval between synchronization iterations. The value is represented in ISO 8601 format for durations. For example, P1M represents a period of one month and PT1M represents a period of one minute.[State <String>]
: synchronizationScheduleState
[Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.[Id <String>]
: The unique identifier for an entity. Read-only.[Discoverabilities <String>]
: directoryDefinitionDiscoverabilities[DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[Name <String>]
: Name of the directory. Must be unique within the synchronization schema. Not nullable.[Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.[Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.[Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization.[ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:[Key <String>]
: Key.[Value <String>]
: Value.
[CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.[DefaultValue <String>]
: The default value of the attribute.[FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.[Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.[Key <String>]
: attributeDefinitionMetadata[Value <String>]
: Value of the metadata property.
[Multivalued <Boolean?>]
: true if an attribute can have multiple values. Default is false.[Mutability <String>]
: mutability[Name <String>]
: Name of the attribute. Must be unique within the object definition. Not nullable.[ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).[ReferencedObjectName <String>]
: Name of the referenced object. Must match one of the objects in the directory definition.[ReferencedProperty <String>]
: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.
[Required <Boolean?>]
: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.[Type <String>]
: attributeType
[Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.[Key <String>]
: objectDefinitionMetadata[Value <String>]
: Value of the metadata property.
[Name <String>]
: Name of the object. Must be unique within a directory definition. Not nullable.[SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
[ReadOnly <Boolean?>]
: Whether this object is read-only.[Version <String>]
: Read only value that indicates version discovered. null if discovery hasn't yet occurred.
[SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.[ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter[(Any) <Object>]
: This indicates any property can be added to this object.[IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule. For Active Directory organizational units, use the distinguished names. An empty list means no container filtering is configured.
[Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.[GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter[(Any) <Object>]
: This indicates any property can be added to this object.[IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule. For Active Directory groups, use the distinguished names. An empty list means no group filtering is configured.
[Id <String>]
: 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.[Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties. Unless instructed explicitly by the support team, metadata values shouldn't be changed.[Name <String>]
: Human-readable name of the synchronization rule. Not nullable.[ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule. Tells the synchronization engine which objects should be synchronized.[AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow. A number of functions are available to support the transformation of the original source values.[DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null. Optional.[ExportMissingReferences <Boolean?>]
: For internal use only.[FlowBehavior <String>]
: attributeFlowBehavior[FlowType <String>]
: attributeFlowType[MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories. The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first. If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left. Only attributes that are expected to have unique values, such as email, should be used as matching attributes.[Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource[(Any) <Object>]
: This indicates any property can be added to this object.[Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.[Name <String>]
: 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.[Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.[Key <String>]
: The name of the parameter.[Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
[Type <String>]
: attributeMappingSourceType
[TargetAttributeName <String>]
: Name of the attribute on the target object.
[Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization. When false, this object mapping will be skipped.[FlowTypes <String>]
: objectFlowTypes[Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties. Unless mentioned explicitly, metadata values should not be changed.[Key <String>]
: objectMappingMetadata[Value <String>]
: Value of the metadata property.
[Name <String>]
: Human-friendly name of the object mapping.[Scope <IMicrosoftGraphFilter>]
: filter[(Any) <Object>]
: This indicates any property can be added to this object.[CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping. An object is considered in scope if ANY of the groups in the collection is evaluated to true.[Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group. All clauses in a group must be satisfied in order for the filter group to evaluate to true.[OperatorName <String>]
: Name of the operator to be applied to the source and target operands. Must be one of the supported operators. Supported operators can be discovered.[SourceOperandName <String>]
: Name of source operand (the operand being tested). The source operand name must match one of the attribute names on the source object.[TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand[(Any) <Object>]
: This indicates any property can be added to this object.[Values <String-
[]>]
: Collection of values.
[Name <String>]
: Human-readable name of the filter group.
[Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning. This is the filter which should be used in most cases. If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'. An object is considered in scope if ANY of the groups in the collection is evaluated to true.[InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory. If an object doesn't satisfy this filter, it will not be processed further. Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned. An object is considered in scope if ANY of the groups in the collection is evaluated to true.
[SourceObjectName <String>]
: Name of the object in the source directory. Must match the object name from the source directory definition.[TargetObjectName <String>]
: Name of the object in target directory. Must match the object name from the target directory definition.
[Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema. Rules with the lowest priority number will be processed first.[SourceDirectoryName <String>]
: Name of the source directory. Must match one of the directory definitions in synchronizationSchema.[TargetDirectoryName <String>]
: Name of the target directory. Must match one of the directory definitions in synchronizationSchema.
[Version <String>]
: The version of the schema, updated automatically with every schema change.
[Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: synchronizationStatusCode[CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.[EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution[(Any) <Object>]
: This indicates any property can be added to this object.[ActivityIdentifier <String>]
: Identifier of the job run.[CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.[CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.[CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).[CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.[CountExported <Int64?>]
: Count of exported entries.[CountExports <Int64?>]
: Count of entries that were expected to be exported.[CountImported <Int64?>]
: Count of imported entries.[CountImportedDeltas <Int64?>]
: Count of imported delta-changes.[CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.[Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The error code. For example, AzureDirectoryB2BManagementPolicyCheckFailure.[Message <String>]
: The error message. For example, Policy permitting auto-redemption of invitations not configured.[TenantActionable <Boolean?>]
: The action to take to resolve the error. For example, false.
[State <String>]
: synchronizationTaskExecutionResult[TimeBegan <DateTime?>]
: Time when this job run began. 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.[TimeEnded <DateTime?>]
: Time when this job run ended. 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.
[LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution[LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution[Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.[CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.[ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.[TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.[Units <String>]
: An optional description of the units.
[Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine[(Any) <Object>]
: This indicates any property can be added to this object.[CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed. 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.[Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError[NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made. 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.[Reason <String>]
: quarantineReason[SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted). 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.[SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
[SteadyStateFirstAchievedTime <DateTime?>]
: 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.[SteadyStateLastAchievedTime <DateTime?>]
: 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.[SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.[Key <String>]
: The mapping of the user type from the source system to the target system. For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.[Value <Int64?>]
: Total number of synchronized objects.
[TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
[SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job. Some settings are inherited from the template.[Name <String>]
: Name for this key-value pair[Value <String>]
: Value for this key-value pair
[TemplateId <String>]
: Identifier of the synchronization template this job is based on.
[Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.[Key <String>]
: synchronizationSecret[Value <String>]
: The value of the secret.
[Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicationId <String>]
: Identifier of the application this template belongs to.[Default <Boolean?>]
: true if this template is recommended to be the default for the application.[Description <String>]
: Description of the template.[Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).[FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine. The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.[Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties. Unless mentioned explicitly, metadata values shouldn't be changed.[Key <String>]
: synchronizationMetadata[Value <String>]
: Value of the metadata property.
[Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
[Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).[TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.[TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal. Supports $expand.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:[Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.[IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.
[TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal. Supports $expand.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:[Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy. The syntax for the definition differs for each derived policy type. Required.[IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.
[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:[VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher[(Any) <Object>]
: This indicates any property can be added to this object.[AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.[DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.[VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
APPROLEASSIGNMENTS <IMicrosoftGraphAppRoleAssignment- []
>: Represents the app roles a user has been granted for an application.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
APPROVALS <IMicrosoftGraphApproval- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
ASSIGNEDLICENSES <IMicrosoftGraphAssignedLicense- []
>: 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).
[DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.[SkuId <String>]
: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
ASSIGNEDPLANS <IMicrosoftGraphAssignedPlan- []
>: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
[AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z. 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[CapabilityStatus <String>]
: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.[Service <String>]
: The name of the service; for example, exchange.[ServicePlanId <String>]
: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
AUTHENTICATION <IMicrosoftGraphAuthentication>
: authentication
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[EmailAddress <String>]
: The email address registered to this user.
[Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.[AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.[AttestationLevel <String>]
: attestationLevel[DisplayName <String>]
: The display name of the key as given by the user.[Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.[PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential[(Any) <Object>]
: This indicates any property can be added to this object.[ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs[(Any) <Object>]
: This indicates any property can be added to this object.
[Id <String>]
: The credential ID created by the WebAuthn Authenticator.[Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse[(Any) <Object>]
: This indicates any property can be added to this object.[AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.[ClientDataJson <String>]
:
[Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
:
[MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName[Device <IMicrosoftGraphDevice>]
: device[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.[AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).[IdentityProvider <String>]
: For internal use only.[Key <Byte-
[]>]
: For internal use only.[Type <Int32?>]
: For internal use only.
[ApproximateLastSignInDateTime <DateTime?>]
: 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.[Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.[Id <String>]
: The unique identifier for an entity. Read-only.[AppServiceName <String>]
:[Error <String>]
:[PackageFamilyName <String>]
:[Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest[(Any) <Object>]
: This indicates any property can be added to this object.
[PermissionTicket <String>]
:[PostBackUri <String>]
:[Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Status <String>]
:[Type <String>]
:
[ComplianceExpirationDateTime <DateTime?>]
: 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.[DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.[DeviceId <String>]
: 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).[DeviceMetadata <String>]
: For internal use only. Set to null.[DeviceOwnership <String>]
: Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.[DeviceVersion <Int32?>]
: For internal use only.[DisplayName <String>]
: The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.[EnrollmentProfileName <String>]
: 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.[EnrollmentType <String>]
: Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.[ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes[(Any) <Object>]
: This indicates any property can be added to this object.[ExtensionAttribute1 <String>]
: First customizable extension attribute.[ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.[ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.[ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.[ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.[ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.[ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.[ExtensionAttribute2 <String>]
: Second customizable extension attribute.[ExtensionAttribute3 <String>]
: Third customizable extension attribute.[ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.[ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.[ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.[ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.[ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.[ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[Hostnames <String-
[]>]
: List of host names for the device.[IsCompliant <Boolean?>]
: 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).[IsManaged <Boolean?>]
: 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).[IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsRooted <Boolean?>]
: true if the device is rooted or jail-broken. This property can only be updated by Intune.[Kind <String>]
: Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ManagementType <String>]
: 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.[Manufacturer <String>]
: Manufacturer of the device. Read-only.[MdmAppId <String>]
: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[Model <String>]
: Model of the device. Read-only.[Name <String>]
: Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.[OnPremisesLastSyncDateTime <DateTime?>]
: 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).[OnPremisesSecurityIdentifier <String>]
: 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).[OnPremisesSyncEnabled <Boolean?>]
: 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).[OperatingSystem <String>]
: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[OperatingSystemVersion <String>]
: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[PhysicalIds <String-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.[Platform <String>]
: Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ProfileType <String>]
: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.[RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[RegistrationDateTime <DateTime?>]
: 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.[Status <String>]
: Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.[SystemLabels <String-
[]>]
: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand.[TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.[UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.[Id <String>]
: The unique identifier for an entity. Read-only.[CatalogId <String>]
: Product id corresponding to the usage right.[ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.[State <String>]
: usageRightState
[DeviceTag <String>]
: Tags containing app metadata.[DisplayName <String>]
: The name of the device on which this app is registered.[PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
[Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The start time of the operation. 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.[LastActionDateTime <DateTime?>]
: 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[ResourceLocation <String>]
: URI of the resource that the operation is performed on.[Status <String>]
: longRunningOperationStatus[StatusDetail <String>]
: Details about the status of the operation.
[PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
[PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.[Device <IMicrosoftGraphDevice>]
: device[DisplayName <String>]
: The display name of the mobile device as given by the user.
[PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[PhoneNumber <String>]
: The phone number to text or call for authentication. Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.[PhoneType <String>]
: authenticationPhoneType[SmsSignInState <String>]
: authenticationMethodSignInState
[PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Device <IMicrosoftGraphDevice>]
: device[DisplayName <String>]
: The name of the device on which Platform Credential is registered.[KeyStrength <String>]
: authenticationMethodKeyStrength[Platform <String>]
: authenticationMethodPlatform
[Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements[(Any) <Object>]
: This indicates any property can be added to this object.[PerUserMfaState <String>]
: perUserMfaState
[SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences[(Any) <Object>]
: This indicates any property can be added to this object.[IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.[UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
[SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[SecretKey <String>]
: The secret key of the method. Always returns null.
[TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[IsUsableOnce <Boolean?>]
: 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.[LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).[StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.[TemporaryAccessPass <String>]
: 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.
[WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Device <IMicrosoftGraphDevice>]
: device[DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered[KeyStrength <String>]
: authenticationMethodKeyStrength
AUTHORIZATIONINFO <IMicrosoftGraphAuthorizationInfo>
: authorizationInfo
[(Any) <Object>]
: This indicates any property can be added to this object.[CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments. The identifiers must be unique in the tenant.
BODYPARAMETER <IMicrosoftGraphUser>
: user
[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application. Supports $expand.[Approvals <IMicrosoftGraphApproval-
[]>]
:[AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).[DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.[SkuId <String>]
: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
[AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user. Read-only. Not nullable.Supports $filter (eq and not).[AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z. 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[CapabilityStatus <String>]
: Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.[Service <String>]
: The name of the service; for example, exchange.[ServicePlanId <String>]
: A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
[Authentication <IMicrosoftGraphAuthentication>]
: authentication[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[EmailAddress <String>]
: The email address registered to this user.
[Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.[AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.[AttestationLevel <String>]
: attestationLevel[DisplayName <String>]
: The display name of the key as given by the user.[Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.[PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential[(Any) <Object>]
: This indicates any property can be added to this object.[ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs[(Any) <Object>]
: This indicates any property can be added to this object.
[Id <String>]
: The credential ID created by the WebAuthn Authenticator.[Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse[(Any) <Object>]
: This indicates any property can be added to this object.[AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.[ClientDataJson <String>]
:
[Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
:
[MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName[Device <IMicrosoftGraphDevice>]
: device[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.[AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).[IdentityProvider <String>]
: For internal use only.[Key <Byte-
[]>]
: For internal use only.[Type <Int32?>]
: For internal use only.
[ApproximateLastSignInDateTime <DateTime?>]
: 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.[Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.[Id <String>]
: The unique identifier for an entity. Read-only.[AppServiceName <String>]
:[Error <String>]
:[PackageFamilyName <String>]
:[Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest[(Any) <Object>]
: This indicates any property can be added to this object.
[PermissionTicket <String>]
:[PostBackUri <String>]
:[Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Status <String>]
:[Type <String>]
:
[ComplianceExpirationDateTime <DateTime?>]
: 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.[DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.[DeviceId <String>]
: 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).[DeviceMetadata <String>]
: For internal use only. Set to null.[DeviceOwnership <String>]
: Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.[DeviceVersion <Int32?>]
: For internal use only.[DisplayName <String>]
: The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.[EnrollmentProfileName <String>]
: 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.[EnrollmentType <String>]
: Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.[ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes[(Any) <Object>]
: This indicates any property can be added to this object.[ExtensionAttribute1 <String>]
: First customizable extension attribute.[ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.[ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.[ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.[ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.[ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.[ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.[ExtensionAttribute2 <String>]
: Second customizable extension attribute.[ExtensionAttribute3 <String>]
: Third customizable extension attribute.[ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.[ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.[ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.[ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.[ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.[ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[Hostnames <String-
[]>]
: List of host names for the device.[IsCompliant <Boolean?>]
: 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).[IsManaged <Boolean?>]
: 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).[IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsRooted <Boolean?>]
: true if the device is rooted or jail-broken. This property can only be updated by Intune.[Kind <String>]
: Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ManagementType <String>]
: 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.[Manufacturer <String>]
: Manufacturer of the device. Read-only.[MdmAppId <String>]
: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.[Model <String>]
: Model of the device. Read-only.[Name <String>]
: Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.[OnPremisesLastSyncDateTime <DateTime?>]
: 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).[OnPremisesSecurityIdentifier <String>]
: 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).[OnPremisesSyncEnabled <Boolean?>]
: 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).[OperatingSystem <String>]
: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[OperatingSystemVersion <String>]
: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[PhysicalIds <String-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.[Platform <String>]
: Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ProfileType <String>]
: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.[RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[RegistrationDateTime <DateTime?>]
: 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.[Status <String>]
: Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.[SystemLabels <String-
[]>]
: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand.[TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.[UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.[Id <String>]
: The unique identifier for an entity. Read-only.[CatalogId <String>]
: Product id corresponding to the usage right.[ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.[State <String>]
: usageRightState
[DeviceTag <String>]
: Tags containing app metadata.[DisplayName <String>]
: The name of the device on which this app is registered.[PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
[Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The start time of the operation. 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.[LastActionDateTime <DateTime?>]
: 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[ResourceLocation <String>]
: URI of the resource that the operation is performed on.[Status <String>]
: longRunningOperationStatus[StatusDetail <String>]
: Details about the status of the operation.
[PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
[PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.[Device <IMicrosoftGraphDevice>]
: device[DisplayName <String>]
: The display name of the mobile device as given by the user.
[PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[PhoneNumber <String>]
: The phone number to text or call for authentication. Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.[PhoneType <String>]
: authenticationPhoneType[SmsSignInState <String>]
: authenticationMethodSignInState
[PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Device <IMicrosoftGraphDevice>]
: device[DisplayName <String>]
: The name of the device on which Platform Credential is registered.[KeyStrength <String>]
: authenticationMethodKeyStrength[Platform <String>]
: authenticationMethodPlatform
[Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements[(Any) <Object>]
: This indicates any property can be added to this object.[PerUserMfaState <String>]
: perUserMfaState
[SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences[(Any) <Object>]
: This indicates any property can be added to this object.[IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.[UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
[SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[SecretKey <String>]
: The secret key of the method. Always returns null.
[TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[IsUsableOnce <Boolean?>]
: 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.[LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime. Must be between 10 and 43200 inclusive (equivalent to 30 days).[StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.[TemporaryAccessPass <String>]
: 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.
[WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.[CreatedDateTime <DateTime?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Device <IMicrosoftGraphDevice>]
: device[DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered[KeyStrength <String>]
: authenticationMethodKeyStrength
[AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo[(Any) <Object>]
: This indicates any property can be added to this object.[CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments. The identifiers must be unique in the tenant.
[Birthday <DateTime?>]
: 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.[BusinessPhones <String-
[]>]
: The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced from on-premises directory. Supports $filter (eq, not, ge, le, startsWith).[Calendar <IMicrosoftGraphCalendar>]
: calendar[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
[CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group. Navigation property. Read-only. Nullable.[ChangeKey <String>]
: Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[ClassId <String>]
: The class identifier. Read-only.[Name <String>]
: The group name.
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Read-only. Nullable.[Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars. Read-only. Nullable.[Chats <IMicrosoftGraphChat-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ChatType <String>]
: chatType[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Date and time at which the chat was created. Read-only.[InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet[(Any) <Object>]
: This indicates any property can be added to this object.[ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.[PermissionType <String>]
: teamsAppResourceSpecificPermissionType[PermissionValue <String>]
: The name of the resource-specific permission.
[ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Scope <String>]
: teamsAppInstallationScopes
[TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedInstallationScopes <String>]
: teamsAppInstallationScopes[Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization[(Any) <Object>]
: This indicates any property can be added to this object.[ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.[RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
[AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.[Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentBytes <Byte-
[]>]
: Write only. Bytes for the hosted content (such as images).[ContentType <String>]
: Write only. Content type, such as image/png, image/jpg.
[WebUrl <String>]
: The web URL that can be used for downloading the image.
[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource[(Any) <Object>]
: This indicates any property can be added to this object.[BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition. This is a unique app ID for the bot as registered with the Bot Framework.
[SourceType <String>]
: teamsAppDashboardCardSourceType
[DefaultSize <String>]
: teamsAppDashboardCardSize[Description <String>]
: The description for the card. Required.[DisplayName <String>]
: The name of the card. Required.[Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon[(Any) <Object>]
: This indicates any property can be added to this object.[IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL. The preferred size for raster images is 28x28 pixels. If this property has a value, the officeFabricIconFontName property is ignored.[OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified. For example, 'officeUIFabricIconName': 'Search'.
[PickerGroupId <String>]
: ID for the group in the card picker. Required.
[Description <String>]
:[DisplayName <String>]
: The name of the app provided by the app developer.[LastModifiedDateTime <DateTime?>]
:[OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon[PublishingState <String>]
: teamsAppPublishingState[Shortdescription <String>]
:[TeamsAppId <String>]
: The ID from the Teams app manifest.[Version <String>]
: The version number of the application.
[DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.[DistributionMethod <String>]
: teamsAppDistributionMethod[ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
[TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
[IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members. Read-only.[LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Body <IMicrosoftGraphItemBody>]
: itemBody[CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.[EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail[(Any) <Object>]
: This indicates any property can be added to this object.
[From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.[MessageType <String>]
: chatMessageType
[LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed. Read-only.[Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the user.[Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
[Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.[Content <String>]
: 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.[ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.[ContentUrl <String>]
: The URL for the content of the attachment.[Id <String>]
: Read-only. The unique id of the attachment.[Name <String>]
: Name of the attachment.[TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.[ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
[Body <IMicrosoftGraphItemBody>]
: itemBody[ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[ChannelId <String>]
: The identity of the channel in which the message was posted.[TeamId <String>]
: The identity of the team in which the message was posted.
[ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.[CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.[DeletedDateTime <DateTime?>]
: Read only. Timestamp at which the chat message was deleted, or null if not deleted.[Etag <String>]
: Read-only. Version number of the chat message.[EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail[From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet[HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.[ContentBytes <Byte-
[]>]
: Write only. Bytes for the hosted content (such as images).[ContentType <String>]
: Write only. Content type, such as image/png, image/jpg.[Id <String>]
: The unique identifier for an entity. Read-only.
[Importance <String>]
: chatMessageImportance[LastEditedDateTime <DateTime?>]
: 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.[LastModifiedDateTime <DateTime?>]
: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.[Locale <String>]
: Locale of the chat message set by the client. Always set to en-us.[Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.[Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding<at id='{index}'>
tag in the message body.[MentionText <String>]
: String used to represent the mention. For example, a user's display name, a team name.[Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity[Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[ConversationIdentityType <String>]
: teamworkConversationIdentityType
[Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.[Actions <String>]
: chatMessageActions[ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.[Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedDateTime <DateTime?>]
: 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.[DisplayName <String>]
: The name of the reaction.[ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.[ReactionType <String>]
: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.[User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[MessageType <String>]
: chatMessageType[OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet[PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation[(Any) <Object>]
: This indicates any property can be added to this object.[DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes[JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.[PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip[(Any) <Object>]
: This indicates any property can be added to this object.[ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn't say in chats)[GeneralText <String>]
: Explanatory text shown to the sender of the message.[MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
[UserAction <String>]
: chatMessagePolicyViolationUserActionTypes[VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
[Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).[Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message. Supports $expand for channel messages.[ReplyToId <String>]
: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)[Subject <String>]
: The subject of the chat message, in plaintext.[Summary <String>]
: 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.[WebUrl <String>]
: Read-only. Link to the message in Microsoft Teams.
[OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.[JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.[Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[UserIdentityType <String>]
: teamworkUserIdentityType
[Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.[CreatedDateTime <DateTime?>]
: Time when the operation was created.[Error <IMicrosoftGraphOperationError>]
: operationError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: Operation error code.[Message <String>]
: Operation error message.
[LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.[OperationType <String>]
: teamsAsyncOperationType[Status <String>]
: teamsAsyncOperationStatus[TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.[TargetResourceLocation <String>]
: 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.
[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.[ClientId <String>]
: ID of the Microsoft Entra app that has been granted access. Read-only.[Permission <String>]
: The name of the resource-specific permission. Read-only.[PermissionType <String>]
: The type of permission. Possible values are: Application, Delegated. Read-only.[ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource. Read-only.
[PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Message <IMicrosoftGraphChatMessage>]
: chatMessage
[Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[ContentUrl <String>]
: Url used for rendering tab contents in Teams. Required.[EntityId <String>]
: Identifier for the entity hosted by the tab provider.[RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.[WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
[DisplayName <String>]
: Name of the tab.[MessageId <String>]
:[SortOrderIndex <String>]
: Index of the order used for sorting tabs.[TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp[TeamsAppId <String>]
: App definition identifier of the tab. This value can't be changed after tab creation. Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.[WebUrl <String>]
: Deep link URL of the tab instance. Read only.
[TenantId <String>]
: The identifier of the tenant in which the chat was created. Read-only.[Topic <String>]
: (Optional) Subject or topic for the chat. Only available for group chats.[Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint[(Any) <Object>]
: This indicates any property can be added to this object.[IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.[LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
[WebUrl <String>]
: The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.
[City <String>]
: The city where the user is located. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expires and after that the object is no longer available. The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.[LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request. DateTime in UTC when the object was modified by the client.[Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads. A window can place more than one clipboard object on the clipboard. Each one represents the same information in a different clipboard format.[Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.[FormatName <String>]
: For a list of possible values see formatName values.
[CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.[AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment. When the provisioningType is dedicated, the allotment name is null. Read-only.[ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting[(Any) <Object>]
: This indicates any property can be added to this object.[EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled. The default value is false.
[ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings[(Any) <Object>]
: This indicates any property can be added to this object.[EnableSingleSignOn <Boolean?>]
:
[ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult[(Any) <Object>]
: This indicates any property can be added to this object.[FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items. If the status property is available, this property is empty.[AdditionalDetails <String>]
: Additional message for this health check.[DisplayName <String>]
: The connectivity health check item name.[LastHealthCheckDateTime <DateTime?>]
: 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.[Result <String>]
: cloudPcConnectivityEventResult
[LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.[Status <String>]
: cloudPcConnectivityStatus[UpdatedDateTime <DateTime?>]
: Datetime when the status was updated. This property is deprecated and will no longer be supported effective August 31, 2024. Use lastModifiedDateTime instead. Read-Only.
[DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned. For example, westus3, eastus2, and southeastasia. Read-only.[DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability[(Any) <Object>]
: This indicates any property can be added to this object.[CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType[PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.[SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
[DiskEncryptionState <String>]
: cloudPcDiskEncryptionState[DisplayName <String>]
: The display name of the Cloud PC.[GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens. 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.[ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.[LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult[(Any) <Object>]
: This indicates any property can be added to this object.[Time <DateTime?>]
: 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.
[LastModifiedDateTime <DateTime?>]
: 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.[LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult[(Any) <Object>]
: This indicates any property can be added to this object.[ActionName <String>]
: 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.[ActionState <String>]
: actionState[CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed. Read-only.[LastUpdatedDateTime <DateTime?>]
: 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'.[ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed. Read-only.[StartDateTime <DateTime?>]
: 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'.[StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail[(Any) <Object>]
: This indicates any property can be added to this object.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status. For example, 'additionalInformation': -['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'[Code <String>]
: The error/warning code associated with the Cloud PC status. Example: 'code': 'internalServerError'.[Message <String>]
: The status message associated with error code. Example: 'message': 'There was an internal server error. Please contact support xxx.'.
[StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails[(Any) <Object>]
: This indicates any property can be added to this object.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.[Code <String>]
: The code associated with the Cloud PC status.[Message <String>]
: The status message.
[ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.[ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.[OSVersion <String>]
: cloudPcOperatingSystem[OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.[PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.[ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.[InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus[IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.[PartnerAgentName <String>]
: cloudPcPartnerAgentName[Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried. The default value is false.
[PowerState <String>]
: cloudPcPowerState[ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.[ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.[ProvisioningType <String>]
: cloudPcProvisioningType[ScopeIds <String-
[]>]
:[ServicePlanId <String>]
: The service plan ID of the Cloud PC.[ServicePlanName <String>]
: The service plan name of the Cloud PC.[ServicePlanType <String>]
: cloudPcServicePlanType[Status <String>]
: cloudPcStatus[StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail[StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails[UserAccountType <String>]
: cloudPcUserAccountType[UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
[CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo[(Any) <Object>]
: This indicates any property can be added to this object.[IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them. Read-only.
[CompanyName <String>]
: 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).[ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information. Supports $filter (eq, ne, not, and in).[ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder. Navigation property. Read-only. Nullable.[Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder. Navigation property. Read-only. Nullable.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AssistantName <String>]
: The name of the contact's assistant.[Birthday <DateTime?>]
: The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Children <String-
[]>]
: The names of the contact's children.[CompanyName <String>]
: The name of the contact's company.[Department <String>]
: The contact's department.[DisplayName <String>]
: The contact's display name. You can specify the display name in a create or update operation. Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified. To preserve a pre-existing value, always include it as displayName in an update operation.[EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.[OtherLabel <String>]
: 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.[Type <String>]
: emailType
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact. Nullable.[FileAs <String>]
: The name the contact is filed under.[Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag[(Any) <Object>]
: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[FlagStatus <String>]
: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Gender <String>]
: The contact's gender.[Generation <String>]
: The contact's suffix.[GivenName <String>]
: The contact's given name.[ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.[Initials <String>]
: The contact's initials.[IsFavorite <Boolean?>]
:[JobTitle <String>]
: The contact's job title.[Manager <String>]
: The name of the contact's manager.[MiddleName <String>]
: The contact's middle name.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.[NickName <String>]
: The contact's nickname.[OfficeLocation <String>]
: The location of the contact's office.[ParentFolderId <String>]
: The ID of the contact's parent folder.[PersonalNotes <String>]
: The user's notes about the contact.[Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Height <Int32?>]
: The height of the photo. Read-only.[Width <Int32?>]
: The width of the photo. Read-only.
[PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.[Profession <String>]
: The contact's profession.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact. Read-only. Nullable.[SpouseName <String>]
: The name of the contact's spouse/partner.[Surname <String>]
: The contact's surname.[Title <String>]
: The contact's title.[Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.[Address <String>]
: The URL of the website.[DisplayName <String>]
: The display name of the web site.[Type <String>]
: websiteType
[WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.[YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.[YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.[YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
[DisplayName <String>]
: The folder's display name.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.[ParentFolderId <String>]
: The ID of the folder's parent folder.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.[WellKnownName <String>]
: The name of the folder if the folder is a recognized folder. Currently contacts is the only recognized contacts folder.
[Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts. Read-only. Nullable.[Country <String>]
: The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[CreatedDateTime <DateTime?>]
: 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).[CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created. Read-only. Nullable.[CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Supports $filter (eq, ne, not, and in).[CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue[Department <String>]
: 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).[DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user[Id <String>]
: The unique identifier for an entity. Read-only.[Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile[Id <String>]
: The unique identifier for an entity. Read-only.[Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.[SourceId <String>]
: Identifier for resource used for deployment to a group[Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.[(Any) <Object>]
: This indicates any property can be added to this object.[DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.[DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
[CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration[Description <String>]
: The description of the device enrollment configuration[DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity[DisplayName <String>]
: The display name of the device enrollment configuration[LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration[Priority <Int32?>]
: 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.[RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.[Version <Int32?>]
: The version of the device enrollment configuration
[DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.[DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:[DeviceId <String>]
:[KeyMaterial <Byte-
[]>]
:[KeyType <String>]
:
[DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.[Id <String>]
: The unique identifier for an entity. Read-only.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event[CorrelationId <String>]
: Id used for tracing the failure in the service.[EventDateTime <DateTime?>]
: Time when the event occurred .[EventName <String>]
: Event Name corresponding to the Troubleshooting Event. It is an Optional field[TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.[(Any) <Object>]
: This indicates any property can be added to this object.[Context <String>]
:[Failure <String>]
:[FailureDetails <String>]
: The detailed description of what went wrong.[Remediation <String>]
: The detailed description of how to remediate this issue.[Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.[Link <String>]
: The link to the web resource. Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}[Text <String>]
:
[Devices <IMicrosoftGraphDevice-
[]>]
:[DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[DisplayName <String>]
: 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.[Drive <IMicrosoftGraphDrive>]
: drive[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[(Any) <Object>]
: This indicates any property can be added to this object.[DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only.[DriveType <String>]
: Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values.[Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list. Read-only.[Name <String>]
: The name of the item being referenced. Read-only.[Path <String>]
: Percent-encoded path that can be used to navigate to the item. Read-only.[ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[(Any) <Object>]
: This indicates any property can be added to this object.[ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.[ListItemId <String>]
: An integer identifier for the item within the containing list.[ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.[SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).[SiteUrl <String>]
: The SharePoint URL for the site that contains the item.[TenantId <String>]
: The unique identifier (guid) for the tenancy.[WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
[SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site. For OneDrive, this property isn't populated.
[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.[Id <String>]
: The unique identifier for an entity. Read-only.[Action <IMicrosoftGraphItemActionSet>]
: itemActionSet[(Any) <Object>]
: This indicates any property can be added to this object.[Comment <IMicrosoftGraphCommentAction>]
: commentAction[(Any) <Object>]
: This indicates any property can be added to this object.[IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.[ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet[Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
[Create <IMicrosoftGraphCreateAction>]
: createAction[(Any) <Object>]
: This indicates any property can be added to this object.
[Delete <IMicrosoftGraphDeleteAction>]
: deleteAction[(Any) <Object>]
: This indicates any property can be added to this object.[Name <String>]
: The name of the item that was deleted.[ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
[Edit <IMicrosoftGraphEditAction>]
: editAction[(Any) <Object>]
: This indicates any property can be added to this object.
[Mention <IMicrosoftGraphMentionAction>]
: mentionAction[(Any) <Object>]
: This indicates any property can be added to this object.[Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
[Move <IMicrosoftGraphMoveAction>]
: moveAction[(Any) <Object>]
: This indicates any property can be added to this object.[From <String>]
: The name of the location the item was moved from.[To <String>]
: The name of the location the item was moved to.
[Rename <IMicrosoftGraphRenameAction>]
: renameAction[(Any) <Object>]
: This indicates any property can be added to this object.[NewName <String>]
: The new name of the item.[OldName <String>]
: The previous name of the item.
[Restore <IMicrosoftGraphRestoreAction>]
: restoreAction[(Any) <Object>]
: This indicates any property can be added to this object.
[Share <IMicrosoftGraphShareAction>]
: shareAction[(Any) <Object>]
: This indicates any property can be added to this object.[Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
[Version <IMicrosoftGraphVersionAction>]
: versionAction[(Any) <Object>]
: This indicates any property can be added to this object.[NewVersion <String>]
: The name of the new version that was created by this action.
[Actor <IMicrosoftGraphIdentitySet>]
: identitySet[DriveItem <IMicrosoftGraphDriveItem>]
: driveItem[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.[Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Access <IMicrosoftGraphItemActionStat>]
: itemActionStat[(Any) <Object>]
: This indicates any property can be added to this object.[ActionCount <Int32?>]
: The number of times the action took place. Read-only.[ActorCount <Int32?>]
: The number of distinct actors that performed the action. Read-only.
[Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.[Id <String>]
: The unique identifier for an entity. Read-only.[Access <IMicrosoftGraphAccessAction>]
: accessAction[(Any) <Object>]
: This indicates any property can be added to this object.
[ActivityDateTime <DateTime?>]
:[Actor <IMicrosoftGraphIdentitySet>]
: identitySet[DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
[Create <IMicrosoftGraphItemActionStat>]
: itemActionStat[Delete <IMicrosoftGraphItemActionStat>]
: itemActionStat[Edit <IMicrosoftGraphItemActionStat>]
: itemActionStat[EndDateTime <DateTime?>]
: When the interval ends. Read-only.[IncompleteData <IMicrosoftGraphIncompleteData>]
: incompleteData[(Any) <Object>]
: This indicates any property can be added to this object.[MissingDataBeforeDateTime <DateTime?>]
: The service doesn't have source data before the specified time.[WasThrottled <Boolean?>]
: Some data wasn't recorded due to excessive activity.
[IsTrending <Boolean?>]
: Indicates whether the item is 'trending.' Read-only.[Move <IMicrosoftGraphItemActionStat>]
: itemActionStat[StartDateTime <DateTime?>]
: When the interval starts. Read-only.
[ItemActivityStats <IMicrosoftGraphItemActivityStat-
[]>]
:[LastSevenDays <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
[Audio <IMicrosoftGraphAudio>]
: audio[(Any) <Object>]
: This indicates any property can be added to this object.[Album <String>]
: The title of the album for this audio file.[AlbumArtist <String>]
: The artist named on the album for the audio file.[Artist <String>]
: The performing artist for the audio file.[Bitrate <Int64?>]
: Bitrate expressed in kbps.[Composers <String>]
: The name of the composer of the audio file.[Copyright <String>]
: Copyright information for the audio file.[Disc <Int32?>]
: The number of the disc this audio file came from.[DiscCount <Int32?>]
: The total number of discs in this album.[Duration <Int64?>]
: Duration of the audio file, expressed in milliseconds[Genre <String>]
: The genre of this audio file.[HasDrm <Boolean?>]
: Indicates if the file is protected with digital rights management.[IsVariableBitrate <Boolean?>]
: Indicates if the file is encoded with a variable bitrate.[Title <String>]
: The title of the audio file.[Track <Int32?>]
: The number of the track on the original disc for this audio file.[TrackCount <Int32?>]
: The total number of tracks on the original disc for this audio file.[Year <Int32?>]
: The year the audio file was recorded.
[Bundle <IMicrosoftGraphBundle>]
: bundle[(Any) <Object>]
: This indicates any property can be added to this object.[Album <IMicrosoftGraphAlbum>]
: album[(Any) <Object>]
: This indicates any property can be added to this object.[CoverImageItemId <String>]
: Unique identifier of the driveItem that is the cover of the album.
[ChildCount <Int32?>]
: Number of children contained immediately within this container.
[CTag <String>]
: An eTag for the content of the item. This eTag isn't changed if only the metadata is changed. Note This property isn't returned if the item is a folder. Read-only.[Children <IMicrosoftGraphDriveItem-
[]>]
: Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.[Content <Byte-
[]>]
: The content stream, if the item represents a file. The content property will have a potentially breaking change in behavior in the future. It will stream content directly instead of redirecting. To proactively opt in to the new behavior ahead of time, use the contentStream property instead.[ContentStream <Byte-
[]>]
: The content stream, if the item represents a file.[Deleted <IMicrosoftGraphDeleted>]
: deleted[(Any) <Object>]
: This indicates any property can be added to this object.[State <String>]
: Represents the state of the deleted item.
[File <IMicrosoftGraphFile>]
: file[(Any) <Object>]
: This indicates any property can be added to this object.[Hashes <IMicrosoftGraphHashes>]
: hashes[(Any) <Object>]
: This indicates any property can be added to this object.[Crc32Hash <String>]
: The CRC32 value of the file (if available). Read-only.[QuickXorHash <String>]
: A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available). Read-only.[Sha1Hash <String>]
: SHA1 hash for the contents of the file (if available). Read-only.[Sha256Hash <String>]
: SHA256 hash for the contents of the file (if available). Read-only.
[MimeType <String>]
: 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.[ProcessingMetadata <Boolean?>]
:
[FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedDateTime <DateTime?>]
: The UTC date and time the file was created on a client.[LastAccessedDateTime <DateTime?>]
: The UTC date and time the file was last accessed. Available for the recent file list only.[LastModifiedDateTime <DateTime?>]
: The UTC date and time the file was last modified on a client.
[Folder <IMicrosoftGraphFolder>]
: folder[(Any) <Object>]
: This indicates any property can be added to this object.[ChildCount <Int32?>]
: Number of children contained immediately within this container.[View <IMicrosoftGraphFolderView>]
: folderView[(Any) <Object>]
: This indicates any property can be added to this object.[SortBy <String>]
: The method by which the folder should be sorted.[SortOrder <String>]
: If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending.[ViewType <String>]
: The type of view that should be used to represent the folder.
[Image <IMicrosoftGraphImage>]
: image[(Any) <Object>]
: This indicates any property can be added to this object.[Height <Int32?>]
: Optional. Height of the image, in pixels. Read-only.[Width <Int32?>]
: Optional. Width of the image, in pixels. Read-only.
[ListItem <IMicrosoftGraphListItem>]
: listItem[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.[Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics[ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The ID of the content type.[Name <String>]
: The name of the content type.
[Deleted <IMicrosoftGraphDeleted>]
: deleted[DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.[Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified. Read-only.[Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet[(Any) <Object>]
: This indicates any property can be added to this object.[CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet[Level <String>]
: The state of publication for this document. Either published or checkout. Read-only.[VersionId <String>]
: The unique identifier for the version that is visible to the current caller. Read-only.
[Id <String>]
: The unique identifier for an entity. Read-only.[Comment <String>]
: Comment about the captured version.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Date and time when this version was created.[Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.[ItemId <String>]
: The unique identifier for the item.[Title <String>]
: The title of the item.[VersionId <String>]
: The version ID of the item.
[ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured. The default value is false.
[DriveItem <IMicrosoftGraphDriveItem>]
: driveItem[Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet[Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there's no expiration set for this permission. Optional.[GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet[GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted. Read-only.[GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted. Read-only.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity[Group <IMicrosoftGraphIdentity>]
: identity[SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[LoginName <String>]
: The sign in name of the SharePoint identity.
[SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
[GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet[HasPassword <Boolean?>]
: Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only.[InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference[Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation[(Any) <Object>]
: This indicates any property can be added to this object.[Email <String>]
: The email address provided for the recipient of the sharing invitation. Read-only.[InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet[RedeemedBy <String>]
:[SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only.
[Link <IMicrosoftGraphSharingLink>]
: sharingLink[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[ConfiguratorUrl <String>]
:[PreventsDownload <Boolean?>]
: 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.[Scope <String>]
: 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.[Type <String>]
: The type of the link created.[WebHtml <String>]
: For embed links, this property contains the HTML code for an[WebUrl <String>]
: A URL that opens the item in the browser on the OneDrive website.
[Roles <String-
[]>]
: The type of permission, for example, read. See the Roles property values section for the full list of roles. Read-only.[ShareId <String>]
: A unique token that can be used to access this shared item via the shares API. Read-only.
[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Versions <IMicrosoftGraphListItemVersion-
[]>]
: The list of previous versions of the list item.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified. Read-only.[Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet[Id <String>]
: The unique identifier for an entity. Read-only.[Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
[Location <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Altitude <Double?>]
: Optional. The altitude (height), in feet, above sea level for the item. Read-only.[Latitude <Double?>]
: Optional. The latitude, in decimal, for the item. Writable on OneDrive Personal.[Longitude <Double?>]
: Optional. The longitude, in decimal, for the item. Writable on OneDrive Personal.
[Malware <IMicrosoftGraphMalware>]
: malware[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: Contains the virus details for the malware facet.
[Media <IMicrosoftGraphMedia>]
: media[(Any) <Object>]
: This indicates any property can be added to this object.[IsTranscriptionShown <Boolean?>]
: 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.[MediaSource <IMicrosoftGraphMediaSource>]
: mediaSource[(Any) <Object>]
: This indicates any property can be added to this object.[ContentCategory <String>]
: mediaSourceContentCategory
[Package <IMicrosoftGraphPackage>]
: package[(Any) <Object>]
: This indicates any property can be added to this object.[Type <String>]
: An string indicating the type of package. While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.
[PendingOperations <IMicrosoftGraphPendingOperations>]
: pendingOperations[(Any) <Object>]
: This indicates any property can be added to this object.[PendingContentUpdate <IMicrosoftGraphPendingContentUpdate>]
: pendingContentUpdate[(Any) <Object>]
: This indicates any property can be added to this object.[QueuedDateTime <DateTime?>]
: Date and time the pending binary operation was queued in UTC time. Read-only.
[Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item. Read-only. Nullable.[Photo <IMicrosoftGraphPhoto>]
: photo[(Any) <Object>]
: This indicates any property can be added to this object.[CameraMake <String>]
: Camera manufacturer. Read-only.[CameraModel <String>]
: Camera model. Read-only.[ExposureDenominator <Double?>]
: The denominator for the exposure time fraction from the camera. Read-only.[ExposureNumerator <Double?>]
: The numerator for the exposure time fraction from the camera. Read-only.[FNumber <Double?>]
: The F-stop value from the camera. Read-only.[FocalLength <Double?>]
: The focal length from the camera. Read-only.[Iso <Int32?>]
: The ISO value from the camera. Read-only.[Orientation <Int32?>]
: The orientation value from the camera. Writable on OneDrive Personal.[TakenDateTime <DateTime?>]
: The date and time the photo was taken in UTC time. Read-only.
[Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet[RemoteItem <IMicrosoftGraphRemoteItem>]
: remoteItem[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[File <IMicrosoftGraphFile>]
: file[FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo[Folder <IMicrosoftGraphFolder>]
: folder[Id <String>]
: Unique identifier for the remote item in its drive. Read-only.[Image <IMicrosoftGraphImage>]
: image[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: Optional. Filename of the remote item. Read-only.[Package <IMicrosoftGraphPackage>]
: package[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[Shared <IMicrosoftGraphShared>]
: shared[(Any) <Object>]
: This indicates any property can be added to this object.[Owner <IMicrosoftGraphIdentitySet>]
: identitySet[Scope <String>]
: Indicates the scope of how the item is shared. The possible values are: anonymous, organization, or users. Read-only.[SharedBy <IMicrosoftGraphIdentitySet>]
: identitySet[SharedDateTime <DateTime?>]
: The UTC date and time when the item was shared. Read-only.
[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Size <Int64?>]
: Size of the remote item. Read-only.[SpecialFolder <IMicrosoftGraphSpecialFolder>]
: specialFolder[(Any) <Object>]
: This indicates any property can be added to this object.[Name <String>]
: The unique identifier for this item in the /drive/special collection
[Video <IMicrosoftGraphVideo>]
: video[(Any) <Object>]
: This indicates any property can be added to this object.[AudioBitsPerSample <Int32?>]
: Number of audio bits per sample.[AudioChannels <Int32?>]
: Number of audio channels.[AudioFormat <String>]
: Name of the audio format (AAC, MP3, etc.).[AudioSamplesPerSecond <Int32?>]
: Number of audio samples per second.[Bitrate <Int32?>]
: Bit rate of the video in bits per second.[Duration <Int64?>]
: Duration of the file in milliseconds.[FourCc <String>]
: 'Four character code' name of the video format.[FrameRate <Double?>]
:[Height <Int32?>]
: Height of the video, in pixels.[Width <Int32?>]
: Width of the video, in pixels.
[WebDavUrl <String>]
: DAV compatible URL for the item.[WebUrl <String>]
: URL that displays the resource in the browser. Read-only.
[RetentionLabel <IMicrosoftGraphItemRetentionLabel>]
: itemRetentionLabel[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsLabelAppliedExplicitly <Boolean?>]
: 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.[LabelAppliedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LabelAppliedDateTime <DateTime?>]
: The date and time when the label was applied on the item. 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.[Name <String>]
: The retention label on the document. Read-write.[RetentionSettings <IMicrosoftGraphRetentionLabelSettings>]
: retentionLabelSettings[(Any) <Object>]
: This indicates any property can be added to this object.[BehaviorDuringRetentionPeriod <String>]
: behaviorDuringRetentionPeriod[IsContentUpdateAllowed <Boolean?>]
: Specifies whether updates to document content are allowed. Read-only.[IsDeleteAllowed <Boolean?>]
: Specifies whether the document deletion is allowed. Read-only.[IsLabelUpdateAllowed <Boolean?>]
: Specifies whether you're allowed to change the retention label on the document. Read-only.[IsMetadataUpdateAllowed <Boolean?>]
: Specifies whether updates to the item metadata (for example, the Title field) are blocked. Read-only.[IsRecordLocked <Boolean?>]
: Specifies whether the item is locked. Read-write.
[Root <IMicrosoftGraphRoot>]
: root[(Any) <Object>]
: This indicates any property can be added to this object.
[SearchResult <IMicrosoftGraphSearchResult>]
: searchResult[(Any) <Object>]
: This indicates any property can be added to this object.[OnClickTelemetryUrl <String>]
: 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.
[Shared <IMicrosoftGraphShared>]
: shared[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Size <Int64?>]
: Size of the item in bytes. Read-only.[Source <IMicrosoftGraphDriveItemSource>]
: driveItemSource[(Any) <Object>]
: This indicates any property can be added to this object.[Application <String>]
: driveItemSourceApplication[ExternalId <String>]
: The external identifier for the drive item from the source.
[SpecialFolder <IMicrosoftGraphSpecialFolder>]
: specialFolder[Subscriptions <IMicrosoftGraphSubscription-
[]>]
: The set of subscriptions on the item. Only supported on the root of a drive.[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicationId <String>]
: Optional. Identifier of the application used to create the subscription. Read-only.[ChangeType <String>]
: Required. Indicates the type of change in the subscribed resource that raises 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 <String>]
: 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.[CreatorId <String>]
: 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.[EncryptionCertificate <String>]
: 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.[EncryptionCertificateId <String>]
: Optional. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when includeResourceData is true.[ExpirationDateTime <DateTime?>]
: 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 Subscription lifetime.[IncludeResourceData <Boolean?>]
: Optional. When set to true, change notifications include resource data (such as content of a chat message).[LatestSupportedTlsVersion <String>]
: 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.[LifecycleNotificationUrl <String>]
: 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.[NotificationContentType <String>]
: Optional. Desired content-type for Microsoft Graph change notifications for supported resource types. The default content-type is application/json.[NotificationQueryOptions <String>]
: 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 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.[NotificationUrl <String>]
: 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 is included in the HTTP POST request when Microsoft Graph sends the change notifications.[NotificationUrlAppId <String>]
: Optional. The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.[Resource <String>]
: Required. Specifies the resource that is monitored for changes. Don't include the base URL (https://graph.microsoft.com/beta/). See the possible resource path values for each supported resource.
[Thumbnails <IMicrosoftGraphThumbnailSet-
[]>]
: Collection of thumbnailSet objects associated with the item. For more information, see getting thumbnails. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Large <IMicrosoftGraphThumbnail>]
: thumbnail[(Any) <Object>]
: This indicates any property can be added to this object.[Content <Byte-
[]>]
: The content stream for the thumbnail.[Height <Int32?>]
: The height of the thumbnail, in pixels.[SourceItemId <String>]
: The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested.[Url <String>]
: The URL used to fetch the thumbnail content.[Width <Int32?>]
: The width of the thumbnail, in pixels.
[Medium <IMicrosoftGraphThumbnail>]
: thumbnail[Small <IMicrosoftGraphThumbnail>]
: thumbnail[Source <IMicrosoftGraphThumbnail>]
: thumbnail
[Versions <IMicrosoftGraphDriveItemVersion-
[]>]
: The list of previous versions of the item. For more info, see getting previous versions. Read-only. Nullable.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified. Read-only.[Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
:[Size <Int64?>]
: Indicates the size of the content stream for this version of the item.
[Video <IMicrosoftGraphVideo>]
: video[Viewpoint <IMicrosoftGraphDriveItemViewpoint>]
: driveItemViewpoint[(Any) <Object>]
: This indicates any property can be added to this object.[AccessOperations <IMicrosoftGraphDriveItemAccessOperationsViewpoint>]
: driveItemAccessOperationsViewpoint[(Any) <Object>]
: This indicates any property can be added to this object.[CanComment <Boolean?>]
: Indicates whether the user can comment on this item.[CanCreateFile <Boolean?>]
: Indicates whether the user can create files within this object. Returned only on folders.[CanCreateFolder <Boolean?>]
: Indicates whether the user can create folders within this object. Returned only on folders.[CanDelete <Boolean?>]
: Indicates whether the user can delete this item.[CanDownload <Boolean?>]
: Indicates whether the user can download this item.[CanRead <Boolean?>]
: Indicates whether the user can read this item.[CanUpdate <Boolean?>]
: Indicates whether the user can update this item.
[Sharing <IMicrosoftGraphSharingViewpoint>]
: sharingViewpoint[(Any) <Object>]
: This indicates any property can be added to this object.[DefaultSharingLink <IMicrosoftGraphDefaultSharingLink>]
: defaultSharingLink[(Any) <Object>]
: This indicates any property can be added to this object.[DefaultToExistingAccess <Boolean?>]
: Indicates whether the default link setting for this object is a direct URL rather than a sharing link.[Role <String>]
: sharingRole[Scope <String>]
: sharingScope
[SharingAbilities <IMicrosoftGraphSharePointSharingAbilities>]
: sharePointSharingAbilities[(Any) <Object>]
: This indicates any property can be added to this object.[AnyoneLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities[(Any) <Object>]
: This indicates any property can be added to this object.[BlockDownloadLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities[(Any) <Object>]
: This indicates any property can be added to this object.[AddExistingExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[(Any) <Object>]
: This indicates any property can be added to this object.[DisabledReason <String>]
: Provides a description of why this operation is not enabled. Only returned if this operation is not enabled.[Enabled <Boolean?>]
: Indicates whether this operation is enabled.
[AddNewExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[ApplyVariants <IMicrosoftGraphSharingLinkVariants>]
: sharingLinkVariants[(Any) <Object>]
: This indicates any property can be added to this object.[AddressBarLinkPermission <String>]
: sharingRole[AllowEmbed <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[PasswordProtected <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[RequiresAuthentication <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
[CreateLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[DeleteLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[LinkAllowsExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[LinkExpiration <IMicrosoftGraphSharingLinkExpirationStatus>]
: sharingLinkExpirationStatus[(Any) <Object>]
: This indicates any property can be added to this object.[DefaultExpirationInDays <Int32?>]
: Default link expiration in days. Returns -1 if there is no required expiration time.[DisabledReason <String>]
: Provides a description of why this operation is not enabled. Only returned if this operation is not enabled.[Enabled <Boolean?>]
: Indicates whether this operation is enabled.
[RetrieveLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[UpdateLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
[EditLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities[ManageListLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities[ReadLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities[ReviewLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities[SubmitOnlyLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
[DirectSharingAbilities <IMicrosoftGraphDirectSharingAbilities>]
: directSharingAbilities[(Any) <Object>]
: This indicates any property can be added to this object.[AddExistingExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[AddInternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[AddNewExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus[RequestGrantAccess <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
[OrganizationLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities[SpecificPeopleLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
[WebDavUrl <String>]
: WebDAV compatible URL for the item.[Workbook <IMicrosoftGraphWorkbook>]
: workbook[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Application <IMicrosoftGraphWorkbookApplication>]
: workbookApplication[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CalculationMode <String>]
: Returns the calculation mode used in the workbook. Possible values are: Automatic, AutomaticExceptTables, Manual.
[Comments <IMicrosoftGraphWorkbookComment-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <String>]
: The content of the comment.[ContentType <String>]
: The content type of the comment.[Replies <IMicrosoftGraphWorkbookCommentReply-
[]>]
: The list of replies to the comment. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Content <String>]
: The content of the reply.[ContentType <String>]
: The content type for the reply.[Task <IMicrosoftGraphWorkbookDocumentTask>]
: workbookDocumentTask[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Assignees <IMicrosoftGraphWorkbookEmailIdentity-
[]>]
: A collection of user identities the task is assigned to.[DisplayName <String>]
: Display name of the user.[Email <String>]
: Email address of the user.[Id <String>]
: The unique identifier of the user.
[Changes <IMicrosoftGraphWorkbookDocumentTaskChange-
[]>]
: A collection of task change histories.[Id <String>]
: The unique identifier for an entity. Read-only.[Assignee <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity[ChangedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity[CommentId <String>]
: The identifier of the associated comment.[CreatedDateTime <DateTime?>]
: Date and time when the task was changed. Nullable. 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.[DueDateTime <DateTime?>]
: The due date and time for the task. Only present when the type property is setSchedule. Nullable. 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.[PercentComplete <Int32?>]
: An integer value from 0 to 100 that represents the percentage of the completion of the task and associated comment. 100 means that the task and associated comment are completed. If you change the completion from 100 to a lower value, the associated task and comment are reactivated. Only present when the type property is setPercentComplete. Nullable.[Priority <Int32?>]
: An integer value from 0 to 10 that represents the priority of the task. A lower value indicates a higher priority. 5 indicates the default priority if not set. Only present when the type property is setPriority. Nullable.[StartDateTime <DateTime?>]
: The start date and time for the task. Only present when the type property is setSchedule. Nullable. 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.[Title <String>]
: The title of the task. Only present when the type property is setTitle. Nullable.[Type <String>]
: The type of the change history. Possible values are: create, assign, unassign, unassignAll, setPriority, setTitle, setPercentComplete, setSchedule, remove, restore, undo.[UndoChangeId <String>]
: The ID of the workbookDocumentTaskChange that was undone for the undo change action. Only exists on an undo change history. Nullable.
[Comment <IMicrosoftGraphWorkbookComment>]
: workbookComment[CompletedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity[CompletedDateTime <DateTime?>]
: Date and time when the task was completed. Nullable. 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.[CreatedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity[CreatedDateTime <DateTime?>]
: Date and time when the task was created. Nullable. 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.[PercentComplete <Int32?>]
: An integer value from 0 to 100 that represents the percentage of the completion of the task. 100 means that the task is completed. Nullable.[Priority <Int32?>]
: An integer value from 0 to 10 that represents the priority of the task. A lower value indicates a higher priority. Nullable.[StartAndDueDateTime <IMicrosoftGraphWorkbookDocumentTaskSchedule>]
: workbookDocumentTaskSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[DueDateTime <DateTime?>]
: The due date and time for the task. Nullable. 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.[StartDateTime <DateTime?>]
: The start date and time for the task. Nullable. 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.
[Title <String>]
: The title of the task.
[Task <IMicrosoftGraphWorkbookDocumentTask>]
: workbookDocumentTask
[Functions <IMicrosoftGraphWorkbookFunctions>]
: workbookFunctions[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Names <IMicrosoftGraphWorkbookNamedItem-
[]>]
: Represents a collection of workbooks scoped named items (named ranges and constants). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Comment <String>]
: The comment associated with this name.[Name <String>]
: The name of the object. Read-only.[Scope <String>]
: Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only.[Type <String>]
: The type of reference is associated with the name. Possible values are: String, Integer, Double, Boolean, Range. Read-only.[Value <IMicrosoftGraphJson>]
: Json[Visible <Boolean?>]
: Indicates whether the object is visible.[Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Charts <IMicrosoftGraphWorkbookChart-
[]>]
: The list of charts that are part of the worksheet. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Axes <IMicrosoftGraphWorkbookChartAxes>]
: workbookChartAxes[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CategoryAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartAxisFormat>]
: workbookChartAxisFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Bold <Boolean?>]
: Indicates whether the fond is bold.[Color <String>]
: The HTML color code representation of the text color. For example #FF0000 represents Red.[Italic <Boolean?>]
: Indicates whether the fond is italic.[Name <String>]
: The font name. For example 'Calibri'.[Size <Double?>]
: The size of the font. For example, 11.[Underline <String>]
: The type of underlining applied to the font. The possible values are: None, Single.
[Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: The HTML color code that represents the color of lines in the chart.
[MajorGridlines <IMicrosoftGraphWorkbookChartGridlines>]
: workbookChartGridlines[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartGridlinesFormat>]
: workbookChartGridlinesFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
[Visible <Boolean?>]
: Indicates whether the axis gridlines are visible.
[MajorUnit <IMicrosoftGraphJson>]
: Json[Maximum <IMicrosoftGraphJson>]
: Json[Minimum <IMicrosoftGraphJson>]
: Json[MinorGridlines <IMicrosoftGraphWorkbookChartGridlines>]
: workbookChartGridlines[MinorUnit <IMicrosoftGraphJson>]
: Json[Title <IMicrosoftGraphWorkbookChartAxisTitle>]
: workbookChartAxisTitle[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartAxisTitleFormat>]
: workbookChartAxisTitleFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
[Text <String>]
: Represents the axis title.[Visible <Boolean?>]
: A Boolean that specifies the visibility of an axis title.
[SeriesAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis[ValueAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
[DataLabels <IMicrosoftGraphWorkbookChartDataLabels>]
: workbookChartDataLabels[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartDataLabelFormat>]
: workbookChartDataLabelFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
[Position <String>]
: DataLabelPosition value that represents the position of the data label. The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.[Separator <String>]
: String that represents the separator used for the data labels on a chart.[ShowBubbleSize <Boolean?>]
: Boolean value that represents whether the data label bubble size is visible.[ShowCategoryName <Boolean?>]
: Boolean value that represents whether the data label category name is visible.[ShowLegendKey <Boolean?>]
: Boolean value that represents whether the data label legend key is visible.[ShowPercentage <Boolean?>]
: Boolean value that represents whether the data label percentage is visible.[ShowSeriesName <Boolean?>]
: Boolean value that represents whether the data label series name is visible.[ShowValue <Boolean?>]
: Boolean value that represents whether the data label value is visible.
[Format <IMicrosoftGraphWorkbookChartAreaFormat>]
: workbookChartAreaFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill[Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
[Height <Double?>]
: Represents the height, in points, of the chart object.[Left <Double?>]
: The distance, in points, from the left side of the chart to the worksheet origin.[Legend <IMicrosoftGraphWorkbookChartLegend>]
: workbookChartLegend[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartLegendFormat>]
: workbookChartLegendFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill[Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
[Overlay <Boolean?>]
: Indicates whether the chart legend should overlap with the main body of the chart.[Position <String>]
: Represents the position of the legend on the chart. The possible values are: Top, Bottom, Left, Right, Corner, Custom.[Visible <Boolean?>]
: Indicates whether the chart legend is visible.
[Name <String>]
: Represents the name of a chart object.[Series <IMicrosoftGraphWorkbookChartSeries-
[]>]
: Represents either a single series or collection of series in the chart. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartSeriesFormat>]
: workbookChartSeriesFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill[Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
[Name <String>]
: The name of a series in a chart.[Points <IMicrosoftGraphWorkbookChartPoint-
[]>]
: A collection of all points in the series. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartPointFormat>]
: workbookChartPointFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
[Value <IMicrosoftGraphJson>]
: Json
[Title <IMicrosoftGraphWorkbookChartTitle>]
: workbookChartTitle[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Format <IMicrosoftGraphWorkbookChartTitleFormat>]
: workbookChartTitleFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill[Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
[Overlay <Boolean?>]
: Indicates whether the chart title will overlay the chart or not.[Text <String>]
: The title text of the chart.[Visible <Boolean?>]
: Indicates whether the chart title is visible.
[Top <Double?>]
: Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).[Width <Double?>]
: Represents the width, in points, of the chart object.[Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
[Name <String>]
: The display name of the worksheet.[Names <IMicrosoftGraphWorkbookNamedItem-
[]>]
: The list of names that are associated with the worksheet. Read-only.[PivotTables <IMicrosoftGraphWorkbookPivotTable-
[]>]
: The list of piot tables that are part of the worksheet.[Id <String>]
: The unique identifier for an entity. Read-only.[Name <String>]
: The name of the pivot table.[Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
[Position <Int32?>]
: The zero-based position of the worksheet within the workbook.[Protection <IMicrosoftGraphWorkbookWorksheetProtection>]
: workbookWorksheetProtection[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Options <IMicrosoftGraphWorkbookWorksheetProtectionOptions>]
: workbookWorksheetProtectionOptions[(Any) <Object>]
: This indicates any property can be added to this object.[AllowAutoFilter <Boolean?>]
: Represents the worksheet protection option of allowing using auto filter feature.[AllowDeleteColumns <Boolean?>]
: Represents the worksheet protection option of allowing deleting columns.[AllowDeleteRows <Boolean?>]
: Represents the worksheet protection option of allowing deleting rows.[AllowFormatCells <Boolean?>]
: Represents the worksheet protection option of allowing formatting cells.[AllowFormatColumns <Boolean?>]
: Represents the worksheet protection option of allowing formatting columns.[AllowFormatRows <Boolean?>]
: Represents the worksheet protection option of allowing formatting rows.[AllowInsertColumns <Boolean?>]
: Represents the worksheet protection option of allowing inserting columns.[AllowInsertHyperlinks <Boolean?>]
: Represents the worksheet protection option of allowing inserting hyperlinks.[AllowInsertRows <Boolean?>]
: Represents the worksheet protection option of allowing inserting rows.[AllowPivotTables <Boolean?>]
: Represents the worksheet protection option of allowing using pivot table feature.[AllowSort <Boolean?>]
: Represents the worksheet protection option of allowing using sort feature.
[Protected <Boolean?>]
: Indicates whether the worksheet is protected. Read-only.
[Tables <IMicrosoftGraphWorkbookTable-
[]>]
: The list of tables that are part of the worksheet. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Columns <IMicrosoftGraphWorkbookTableColumn-
[]>]
: The list of all the columns in the table. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Filter <IMicrosoftGraphWorkbookFilter>]
: workbookFilter[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Criteria <IMicrosoftGraphWorkbookFilterCriteria>]
: workbookFilterCriteria[(Any) <Object>]
: This indicates any property can be added to this object.[Color <String>]
: The color applied to the cell.[Criterion1 <String>]
: A custom criterion.[Criterion2 <String>]
: A custom criterion.[DynamicCriteria <String>]
: A dynamic formula specified in a custom filter.[FilterOn <String>]
: Indicates whether a filter is applied to a column.[Icon <IMicrosoftGraphWorkbookIcon>]
: workbookIcon[(Any) <Object>]
: This indicates any property can be added to this object.[Index <Int32?>]
: The index of the icon in the given set.[Set <String>]
: The set that the icon is part of. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.
[Operator <String>]
: An operator in a cell; for example, =, >, <, <=, or <>.[Values <IMicrosoftGraphJson>]
: Json
[Index <Int32?>]
: The index of the column within the columns collection of the table. Zero-indexed. Read-only.[Name <String>]
: The name of the table column.[Values <IMicrosoftGraphJson>]
: Json
[HighlightFirstColumn <Boolean?>]
: Indicates whether the first column contains special formatting.[HighlightLastColumn <Boolean?>]
: Indicates whether the last column contains special formatting.[LegacyId <String>]
: A legacy identifier used in older Excel clients. The value of the identifier remains the same even when the table is renamed. This property should be interpreted as an opaque string value and shouldn't be parsed to any other type. Read-only.[Name <String>]
: The name of the table.[Rows <IMicrosoftGraphWorkbookTableRow-
[]>]
: The list of all the rows in the table. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Index <Int32?>]
: The index of the row within the rows collection of the table. Zero-based. Read-only.[Values <IMicrosoftGraphJson>]
: Json
[ShowBandedColumns <Boolean?>]
: Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.[ShowBandedRows <Boolean?>]
: Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.[ShowFilterButton <Boolean?>]
: Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.[ShowHeaders <Boolean?>]
: Indicates whether the header row is visible or not. This value can be set to show or remove the header row.[ShowTotals <Boolean?>]
: Indicates whether the total row is visible or not. This value can be set to show or remove the total row.[Sort <IMicrosoftGraphWorkbookTableSort>]
: workbookTableSort[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Fields <IMicrosoftGraphWorkbookSortField-
[]>]
: The list of the current conditions last used to sort the table. Read-only.[Ascending <Boolean?>]
: Represents whether the sorting is done in an ascending fashion.[Color <String>]
: Represents the color that is the target of the condition if the sorting is on font or cell color.[DataOption <String>]
: Represents additional sorting options for this field. Possible values are: Normal, TextAsNumber.[Icon <IMicrosoftGraphWorkbookIcon>]
: workbookIcon[Key <Int32?>]
: Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row).[SortOn <String>]
: Represents the type of sorting of this condition. Possible values are: Value, CellColor, FontColor, Icon.
[MatchCase <Boolean?>]
: Indicates whether the casing impacted the last sort of the table. Read-only.[Method <String>]
: The Chinese character ordering method last used to sort the table. The possible values are: PinYin, StrokeCount. Read-only.
[Style <String>]
: A constant value that represents the Table style. Possible values are: TableStyleLight1 through TableStyleLight21, TableStyleMedium1 through TableStyleMedium28, TableStyleStyleDark1 through TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.[Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
[Tasks <IMicrosoftGraphWorkbookDocumentTask-
[]>]
: Collection of document tasks on this worksheet. Read-only.[Visibility <String>]
: The visibility of the worksheet. The possible values are: Visible, Hidden, VeryHidden.
[Operations <IMicrosoftGraphWorkbookOperation-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Error <IMicrosoftGraphWorkbookOperationError>]
: workbookOperationError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The error code.[InnerError <IMicrosoftGraphWorkbookOperationError>]
: workbookOperationError[Message <String>]
: The error message.
[ResourceLocation <String>]
: The resource URI for the result.[Status <String>]
: workbookOperationStatus
[Tables <IMicrosoftGraphWorkbookTable-
[]>]
: Represents a collection of tables associated with the workbook. Read-only.[Worksheets <IMicrosoftGraphWorkbookWorksheet-
[]>]
: Represents a collection of worksheets associated with the workbook. Read-only.
[ListItem <IMicrosoftGraphListItem>]
: listItem[Times <IMicrosoftGraphItemActivityTimeSet>]
: itemActivityTimeSet[(Any) <Object>]
: This indicates any property can be added to this object.[LastRecordedDateTime <DateTime?>]
:[ObservedDateTime <DateTime?>]
: When the activity was observed to take place.[RecordedDateTime <DateTime?>]
: When the observation was recorded on the service.
[Bundles <IMicrosoftGraphDriveItem-
[]>]
: Collection of bundles (albums and multi-select-shared sets of items). Only in personal OneDrive.[DriveType <String>]
: Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only.[Following <IMicrosoftGraphDriveItem-
[]>]
: The list of items the user is following. Only in OneDrive for Business.[Items <IMicrosoftGraphDriveItem-
[]>]
: All items contained in the drive. Read-only. Nullable.[List <IMicrosoftGraphList>]
: list[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The recent activities that took place within this list.[Columns <IMicrosoftGraphColumnDefinition-
[]>]
: The collection of field definitions for this list.[Id <String>]
: The unique identifier for an entity. Read-only.[Boolean <IMicrosoftGraphBooleanColumn>]
: booleanColumn[(Any) <Object>]
: This indicates any property can be added to this object.
[Calculated <IMicrosoftGraphCalculatedColumn>]
: calculatedColumn[(Any) <Object>]
: This indicates any property can be added to this object.[Format <String>]
: For dateTime output types, the format of the value. Possible values are: dateOnly or dateTime.[Formula <String>]
: The formula used to compute the value for this column.[OutputType <String>]
: The output type used to format values in this column. Possible values are: boolean, currency, dateTime, number, or text.
[Choice <IMicrosoftGraphChoiceColumn>]
: choiceColumn[(Any) <Object>]
: This indicates any property can be added to this object.[AllowTextEntry <Boolean?>]
: If true, allows custom values that aren't in the configured choices.[Choices <String-
[]>]
: The list of values available for this column.[DisplayAs <String>]
: How the choices are to be presented in the UX. Must be one of checkBoxes, dropDownMenu, or radioButtons
[ColumnGroup <String>]
: For site columns, the name of the group this column belongs to. Helps organize related columns.[ContentApprovalStatus <IMicrosoftGraphContentApprovalStatusColumn>]
: contentApprovalStatusColumn[(Any) <Object>]
: This indicates any property can be added to this object.
[Currency <IMicrosoftGraphCurrencyColumn>]
: currencyColumn[(Any) <Object>]
: This indicates any property can be added to this object.[Locale <String>]
: Specifies the locale from which to infer the currency symbol.
[DateTime <IMicrosoftGraphDateTimeColumn>]
: dateTimeColumn[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayAs <String>]
: 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.[Format <String>]
: Indicates whether the value should be presented as a date only or a date and time. Must be one of dateOnly or dateTime
[DefaultValue <IMicrosoftGraphDefaultColumnValue>]
: defaultColumnValue[(Any) <Object>]
: This indicates any property can be added to this object.[Formula <String>]
: The formula used to compute the default value for the column.[Value <String>]
: The direct value to use as the default value for the column.
[Description <String>]
: The user-facing description of the column.[DisplayName <String>]
: The user-facing name of the column.[EnforceUniqueValues <Boolean?>]
: If true, no two list items may have the same value for this column.[Geolocation <IMicrosoftGraphGeolocationColumn>]
: geolocationColumn[(Any) <Object>]
: This indicates any property can be added to this object.
[Hidden <Boolean?>]
: Specifies whether the column is displayed in the user interface.[HyperlinkOrPicture <IMicrosoftGraphHyperlinkOrPictureColumn>]
: hyperlinkOrPictureColumn[(Any) <Object>]
: This indicates any property can be added to this object.[IsPicture <Boolean?>]
: Specifies whether the display format used for URL columns is an image or a hyperlink.
[Indexed <Boolean?>]
: Specifies whether the column values can used for sorting and searching.[IsDeletable <Boolean?>]
: Indicates whether this column can be deleted.[IsReorderable <Boolean?>]
: Indicates whether values in the column can be reordered. Read-only.[IsSealed <Boolean?>]
: Specifies whether the column can be changed.[Lookup <IMicrosoftGraphLookupColumn>]
: lookupColumn[(Any) <Object>]
: This indicates any property can be added to this object.[AllowMultipleValues <Boolean?>]
: Indicates whether multiple values can be selected from the source.[AllowUnlimitedLength <Boolean?>]
: Indicates whether values in the column should be able to exceed the standard limit of 255 characters.[ColumnName <String>]
: The name of the lookup source column.[ListId <String>]
: The unique identifier of the lookup source list.[PrimaryLookupColumnId <String>]
: 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.
[Name <String>]
: The API-facing name of the column as it appears in the fields on a listItem. For the user-facing name, see displayName.[Number <IMicrosoftGraphNumberColumn>]
: numberColumn[(Any) <Object>]
: This indicates any property can be added to this object.[DecimalPlaces <String>]
: How many decimal places to display. See below for information about the possible values.[DisplayAs <String>]
: How the value should be presented in the UX. Must be one of number or percentage. If unspecified, treated as number.[Maximum <Double?>]
: The maximum permitted value.[Minimum <Double?>]
: The minimum permitted value.
[PersonOrGroup <IMicrosoftGraphPersonOrGroupColumn>]
: personOrGroupColumn[(Any) <Object>]
: This indicates any property can be added to this object.[AllowMultipleSelection <Boolean?>]
: Indicates whether multiple values can be selected from the source.[ChooseFromType <String>]
: Whether to allow selection of people only, or people and groups. Must be one of peopleAndGroups or peopleOnly.[DisplayAs <String>]
: How to display the information about the person or group chosen. See below.
[PropagateChanges <Boolean?>]
: If true, changes to this column will be propagated to lists that implement the column.[ReadOnly <Boolean?>]
: Specifies whether the column values can be modified.[Required <Boolean?>]
: Specifies whether the column value isn't optional.[SourceColumn <IMicrosoftGraphColumnDefinition>]
: columnDefinition[SourceContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo[Term <IMicrosoftGraphTermColumn>]
: termColumn[(Any) <Object>]
: This indicates any property can be added to this object.[AllowMultipleValues <Boolean?>]
: Specifies whether the column allows more than one value[ParentTerm <IMicrosoftGraphTermStoreTerm>]
: term[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Children <IMicrosoftGraphTermStoreTerm-
[]>]
: Children of current term.[CreatedDateTime <DateTime?>]
: Date and time of term creation. Read-only.[Descriptions <IMicrosoftGraphTermStoreLocalizedDescription-
[]>]
: Description about term that is dependent on the languageTag.[Description <String>]
: The description in the localized language.[LanguageTag <String>]
: The language tag for the label.
[Labels <IMicrosoftGraphTermStoreLocalizedLabel-
[]>]
: Label metadata for a term.[IsDefault <Boolean?>]
: Indicates whether the label is the default label.[LanguageTag <String>]
: The language tag for the label.[Name <String>]
: The name of the label.
[LastModifiedDateTime <DateTime?>]
: Last date and time of term modification. Read-only.[Properties <IMicrosoftGraphKeyValue-
[]>]
: Collection of properties on the term.[Relations <IMicrosoftGraphTermStoreRelation-
[]>]
: To indicate which terms are related to the current term as either pinned or reused.[Id <String>]
: The unique identifier for an entity. Read-only.[FromTerm <IMicrosoftGraphTermStoreTerm>]
: term[Relationship <String>]
: relationType[Set <IMicrosoftGraphTermStoreSet>]
: set[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Children <IMicrosoftGraphTermStoreTerm-
[]>]
: Children terms of set in term -[store]
.[CreatedDateTime <DateTime?>]
: Date and time of set creation. Read-only.[Description <String>]
: Description giving details on the term usage.[LocalizedNames <IMicrosoftGraphTermStoreLocalizedName-
[]>]
: Name of the set for each languageTag.[LanguageTag <String>]
: The language tag for the label.[Name <String>]
: The name in the localized language.
[ParentGroup <IMicrosoftGraphTermStoreGroup>]
: group[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Date and time of the group creation. Read-only.[Description <String>]
: Description that gives details on the term usage.[DisplayName <String>]
: Name of the group.[ParentSiteId <String>]
: ID of the parent site of this group.[Scope <String>]
: termGroupScope[Sets <IMicrosoftGraphTermStoreSet-
[]>]
: All sets under the group in a term -[store]
.
[Properties <IMicrosoftGraphKeyValue-
[]>]
: Custom properties for the set.[Relations <IMicrosoftGraphTermStoreRelation-
[]>]
: Indicates which terms have been pinned or reused directly under the set.[Terms <IMicrosoftGraphTermStoreTerm-
[]>]
: All the terms under the set.
[ToTerm <IMicrosoftGraphTermStoreTerm>]
: term
[Set <IMicrosoftGraphTermStoreSet>]
: set
[ShowFullyQualifiedName <Boolean?>]
: Specifies whether to display the entire term path or only the term label.[TermSet <IMicrosoftGraphTermStoreSet>]
: set
[Text <IMicrosoftGraphTextColumn>]
: textColumn[(Any) <Object>]
: This indicates any property can be added to this object.[AllowMultipleLines <Boolean?>]
: Whether to allow multiple lines of text.[AppendChangesToExistingText <Boolean?>]
: Whether updates to this column should replace existing text, or append to it.[LinesForEditing <Int32?>]
: The size of the text box.[MaxLength <Int32?>]
: The maximum number of characters for the value.[TextType <String>]
: The type of text being stored. Must be one of plain or richText
[Thumbnail <IMicrosoftGraphThumbnailColumn>]
: thumbnailColumn[(Any) <Object>]
: This indicates any property can be added to this object.
[Type <String>]
: columnTypes[Validation <IMicrosoftGraphColumnValidation>]
: columnValidation[(Any) <Object>]
: This indicates any property can be added to this object.[DefaultLanguage <String>]
: Default BCP 47 language tag for the description.[Descriptions <IMicrosoftGraphDisplayNameLocalization-
[]>]
: 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.[DisplayName <String>]
: If present, the value of this field contains the displayName string that has been set for the language present in the languageTag field.[LanguageTag <String>]
: Provides the language culture-code and friendly name of the language that the displayName field has been provided in.
[Formula <String>]
: The formula to validate column value. For examples, see Examples of common formulas in lists
[ContentTypes <IMicrosoftGraphContentType-
[]>]
: The collection of content types present in this list.[Id <String>]
: The unique identifier for an entity. Read-only.[AssociatedHubsUrls <String-
[]>]
: List of canonical URLs for hub sites with which this content type is associated to. This contains all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type is applied to the lists in the enforced sites.[Base <IMicrosoftGraphContentType>]
: contentType[BaseTypes <IMicrosoftGraphContentType-
[]>]
: The collection of content types that are ancestors of this content type.[ColumnLinks <IMicrosoftGraphColumnLink-
[]>]
: The collection of columns that are required by this content type.[Id <String>]
: The unique identifier for an entity. Read-only.[Name <String>]
: The name of the column in this content type.
[ColumnPositions <IMicrosoftGraphColumnDefinition-
[]>]
: Column order information in a content type.[Columns <IMicrosoftGraphColumnDefinition-
[]>]
: The collection of column definitions for this content type.[Description <String>]
: The descriptive text for the item.[DocumentSet <IMicrosoftGraphDocumentSet>]
: documentSet[(Any) <Object>]
: This indicates any property can be added to this object.[AllowedContentTypes <IMicrosoftGraphContentTypeInfo-
[]>]
: Content types allowed in document set.[DefaultContents <IMicrosoftGraphDocumentSetContent-
[]>]
: Default contents of document set.[ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo[FileName <String>]
: Name of the file in resource folder that should be added as a default content or a template in the document set[FolderName <String>]
: Folder name in which the file will be placed when a new document set is created in the library.
[PropagateWelcomePageChanges <Boolean?>]
: Indicates whether to add the name of the document set to each file name.[SharedColumns <IMicrosoftGraphColumnDefinition-
[]>]
:[ShouldPrefixNameToFile <Boolean?>]
: Add the name of the Document Set to each file name.[WelcomePageColumns <IMicrosoftGraphColumnDefinition-
[]>]
:[WelcomePageUrl <String>]
: Welcome page absolute URL.
[DocumentTemplate <IMicrosoftGraphDocumentSetContent>]
: documentSetContent[Group <String>]
: The name of the group this content type belongs to. Helps organize related content types.[Hidden <Boolean?>]
: Indicates whether the content type is hidden in the list's 'New' menu.[InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference[IsBuiltIn <Boolean?>]
: Specifies if a content type is a built-in content type.[Name <String>]
: The name of the content type.[Order <IMicrosoftGraphContentTypeOrder>]
: contentTypeOrder[(Any) <Object>]
: This indicates any property can be added to this object.[Default <Boolean?>]
: Indicates whether this is the default content type.[Position <Int32?>]
: Specifies the position in which the content type appears in the selection UI.
[ParentId <String>]
: The unique identifier of the content type.[PropagateChanges <Boolean?>]
: If true, any changes made to the content type are pushed to inherited content types and lists that implement the content type.[ReadOnly <Boolean?>]
: If true, the content type can't be modified unless this value is first set to false.[Sealed <Boolean?>]
: If true, the content type can't be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types.
[DisplayName <String>]
: The displayable title of the list.[Drive <IMicrosoftGraphDrive>]
: drive[Items <IMicrosoftGraphListItem-
[]>]
: All items contained in the list.[List <IMicrosoftGraphListInfo>]
: listInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ContentTypesEnabled <Boolean?>]
: If true, indicates that content types are enabled for this list.[Hidden <Boolean?>]
: If true, indicates that the list isn't normally visible in the SharePoint user experience.[Template <String>]
: 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.
[Operations <IMicrosoftGraphRichLongRunningOperation-
[]>]
: The collection of long-running operations on the list.[CreatedDateTime <DateTime?>]
: The start time of the operation. 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.[LastActionDateTime <DateTime?>]
: 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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.[ResourceLocation <String>]
: URI of the resource that the operation is performed on.[Status <String>]
: longRunningOperationStatus[StatusDetail <String>]
: Details about the status of the operation.[Id <String>]
: The unique identifier for an entity. Read-only.[Error <IMicrosoftGraphPublicError>]
: publicError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: Represents the error code.[Details <IMicrosoftGraphPublicErrorDetail-
[]>]
: Details of the error.[Code <String>]
: The error code.[Message <String>]
: The error message.[Target <String>]
: The target of the error.
[InnerError <IMicrosoftGraphPublicInnerError>]
: publicInnerError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The error code.[Details <IMicrosoftGraphPublicErrorDetail-
[]>]
: A collection of error details.[Message <String>]
: The error message.[Target <String>]
: The target of the error.
[Message <String>]
: A non-localized message for the developer.[Target <String>]
: The target of the error.
[PercentageComplete <Int32?>]
: A value between 0 and 100 that indicates the progress of the operation.[ResourceId <String>]
: A unique identifier for the result.[Type <String>]
: Type of the operation.
[Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item. Read-only. Nullable.[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Subscriptions <IMicrosoftGraphSubscription-
[]>]
: The set of subscriptions on the list.[System <IMicrosoftGraphSystemFacet>]
: systemFacet[(Any) <Object>]
: This indicates any property can be added to this object.
[Owner <IMicrosoftGraphIdentitySet>]
: identitySet[Quota <IMicrosoftGraphQuota>]
: quota[(Any) <Object>]
: This indicates any property can be added to this object.[Deleted <Int64?>]
: Total space consumed by files in the recycle bin, in bytes. Read-only.[Remaining <Int64?>]
: Total space remaining before reaching the quota limit, in bytes. Read-only.[State <String>]
: Enumeration value that indicates the state of the storage space. Read-only.[StoragePlanInformation <IMicrosoftGraphStoragePlanInformation>]
: storagePlanInformation[(Any) <Object>]
: This indicates any property can be added to this object.[UpgradeAvailable <Boolean?>]
: Indicates if there are higher storage quota plans available. Read-only.
[Total <Int64?>]
: Total allowed storage space, in bytes. Read-only.[Used <Int64?>]
: Total space used, in bytes. Read-only.
[Root <IMicrosoftGraphDriveItem>]
: driveItem[SharePointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Special <IMicrosoftGraphDriveItem-
[]>]
: Collection of common folders available in OneDrive. Read-only. Nullable.[System <IMicrosoftGraphSystemFacet>]
: systemFacet
[Drives <IMicrosoftGraphDrive-
[]>]
: A collection of drives available for this user. Read-only.[EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
: employeeExperienceUser[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[LearningCourseActivities <IMicrosoftGraphLearningCourseActivity-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: Date and time when the assignment was completed. Optional.[CompletionPercentage <Int32?>]
: The percentage completion value of the course activity. Optional.[ExternalcourseActivityId <String>]
:[LearnerUserId <String>]
: The user ID of the learner to whom the activity is assigned. Required.[LearningContentId <String>]
: The ID of the learning content created in Viva Learning. Required.[LearningProviderId <String>]
: The registration ID of the provider. Required.[Status <String>]
: courseStatus
[EmployeeHireDate <DateTime?>]
: 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).[EmployeeId <String>]
: The employee identifier assigned to the user by the organization. The maximum length is 16 characters.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).[EmployeeLeaveDateTime <DateTime?>]
: The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user.[EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
: employeeOrgData[(Any) <Object>]
: This indicates any property can be added to this object.[CostCenter <String>]
: The cost center associated with the user. Returned only on $select. Supports $filter.[Division <String>]
: The name of the division in which the user works. Returned only on $select. Supports $filter.
[EmployeeType <String>]
: Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Supports $filter (eq, ne, not , ge, le, in, startsWith).[Events <IMicrosoftGraphEvent-
[]>]
: The user's events. The default is to show events under the Default Calendar. Read-only. Nullable.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the user. Supports $expand. Nullable.[ExternalUserState <String>]
: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Supports $filter (eq, ne, not , in).[ExternalUserStateChangeDateTime <String>]
: Shows the timestamp for the latest change to the externalUserState property. Supports $filter (eq, ne, not , in).[FaxNumber <String>]
: The fax number of the user. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).[FollowedSites <IMicrosoftGraphSite-
[]>]
:[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics[Columns <IMicrosoftGraphColumnDefinition-
[]>]
: The collection of column definitions reusable across lists under this site.[ContentModels <IMicrosoftGraphContentModel-
[]>]
: The collection of content models applied to this site.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Date and time of item last modification. Read-only.[ModelType <String>]
: contentModelType[Name <String>]
: The name of the contentModel.
[ContentTypes <IMicrosoftGraphContentType-
[]>]
: The collection of content types defined for this site.[Deleted <IMicrosoftGraphDeleted>]
: deleted[DisplayName <String>]
: The full title for the site. Read-only.[DocumentProcessingJobs <IMicrosoftGraphDocumentProcessingJob-
[]>]
: The document processing jobs running on this site.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[JobType <String>]
: documentProcessingJobType[ListItemUniqueId <String>]
: The listItemUniqueId of the file, or folder to process. Use GET driveItem resource operation and read sharepointIds property to get listItemUniqueId.[Status <String>]
: documentProcessingJobStatus
[Drive <IMicrosoftGraphDrive>]
: drive[Drives <IMicrosoftGraphDrive-
[]>]
: The collection of drives (document libraries) under this site.[ExternalColumns <IMicrosoftGraphColumnDefinition-
[]>]
: The collection of column definitions available in the site that is referenced from the sites in the parent hierarchy of the current site.[InformationProtection <IMicrosoftGraphInformationProtection>]
: informationProtection[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Bitlocker <IMicrosoftGraphBitlocker>]
: bitlocker[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[RecoveryKeys <IMicrosoftGraphBitlockerRecoveryKey-
[]>]
: The recovery keys associated with the bitlocker entity.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The date and time when the key was originally backed up to Microsoft Entra ID.[DeviceId <String>]
: ID of the device the BitLocker key is originally backed up from.[Key <String>]
: The BitLocker recovery key.[VolumeType <String>]
: volumeType
[DataLossPreventionPolicies <IMicrosoftGraphDataLossPreventionPolicy-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Name <String>]
:
[Policy <IMicrosoftGraphInformationProtectionPolicy>]
: informationProtectionPolicy[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Labels <IMicrosoftGraphInformationProtectionLabel-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: The color that the UI should display for the label, if configured.[Description <String>]
: The admin-defined description for the label.[IsActive <Boolean?>]
: Indicates whether the label is active or not. Active labels should be hidden or disabled in UI.[Name <String>]
: The plaintext name of the label.[Parent <IMicrosoftGraphParentLabelDetails>]
: parentLabelDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Color <String>]
: The color that the user interface should display for the label, if configured.[Description <String>]
: The admin-defined description for the label.[Id <String>]
: The label ID is a globally unique identifier (GUID).[IsActive <Boolean?>]
: Indicates whether the label is active or not. Active labels should be hidden or disabled in user interfaces.[Name <String>]
: The plaintext name of the label.[Parent <IMicrosoftGraphParentLabelDetails>]
: parentLabelDetails[Sensitivity <Int32?>]
: The sensitivity value of the label, where lower is less sensitive.[Tooltip <String>]
: The tooltip that should be displayed for the label in a user interface.
[Sensitivity <Int32?>]
: The sensitivity value of the label, where lower is less sensitive.[Tooltip <String>]
: The tooltip that should be displayed for the label in a UI.
[SensitivityLabels <IMicrosoftGraphSensitivityLabel-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicableTo <String>]
: sensitivityLabelTarget[ApplicationMode <String>]
: applicationMode[AssignedPolicies <IMicrosoftGraphLabelPolicy-
[]>]
:[Id <String>]
:[Name <String>]
:
[AutoLabeling <IMicrosoftGraphAutoLabeling>]
: autoLabeling[(Any) <Object>]
: This indicates any property can be added to this object.[Message <String>]
:[SensitiveTypeIds <String-
[]>]
:
[Description <String>]
:[DisplayName <String>]
:[IsDefault <Boolean?>]
:[IsEndpointProtectionEnabled <Boolean?>]
:[LabelActions <IMicrosoftGraphLabelActionBase-
[]>]
:[Name <String>]
:
[Name <String>]
:[Priority <Int32?>]
:[Sublabels <IMicrosoftGraphSensitivityLabel-
[]>]
:[ToolTip <String>]
:
[SensitivityPolicySettings <IMicrosoftGraphSensitivityPolicySettings>]
: sensitivityPolicySettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicableTo <String>]
: sensitivityLabelTarget[DowngradeSensitivityRequiresJustification <Boolean?>]
:[HelpWebUrl <String>]
:[IsMandatory <Boolean?>]
:
[ThreatAssessmentRequests <IMicrosoftGraphThreatAssessmentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Category <String>]
: threatCategory[ContentType <String>]
: threatAssessmentContentType[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: 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.[ExpectedAssessment <String>]
: threatExpectedAssessment[RequestSource <String>]
: threatAssessmentRequestSource[Results <IMicrosoftGraphThreatAssessmentResult-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: 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.[Message <String>]
: The result message for each threat assessment.[ResultType <String>]
: threatAssessmentResultType
[Status <String>]
: threatAssessmentStatus
[IsPersonalSite <Boolean?>]
:[Items <IMicrosoftGraphBaseItem-
[]>]
: Used to address any item contained in this site. This collection can't be enumerated.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.
[Lists <IMicrosoftGraphList-
[]>]
: The collection of lists under this site.[Onenote <IMicrosoftGraphOnenote>]
: onenote[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Notebooks <IMicrosoftGraphNotebook-
[]>]
: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DisplayName <String>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[IsDefault <Boolean?>]
: Indicates whether this is the user's default notebook. Read-only.[IsShared <Boolean?>]
: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.[Links <IMicrosoftGraphNotebookLinks>]
: notebookLinks[(Any) <Object>]
: This indicates any property can be added to this object.[OneNoteClientUrl <IMicrosoftGraphExternalLink>]
: externalLink[(Any) <Object>]
: This indicates any property can be added to this object.[Href <String>]
: The URL of the link.
[OneNoteWebUrl <IMicrosoftGraphExternalLink>]
: externalLink
[SectionGroups <IMicrosoftGraphSectionGroup-
[]>]
: The section groups in the notebook. Read-only. Nullable.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DisplayName <String>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ParentNotebook <IMicrosoftGraphNotebook>]
: notebook[ParentSectionGroup <IMicrosoftGraphSectionGroup>]
: sectionGroup[SectionGroups <IMicrosoftGraphSectionGroup-
[]>]
: The section groups in the section. Read-only. Nullable.[SectionGroupsUrl <String>]
: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.[Sections <IMicrosoftGraphOnenoteSection-
[]>]
: The sections in the section group. Read-only. Nullable.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DisplayName <String>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[IsDefault <Boolean?>]
: Indicates whether this is the user's default section. Read-only.[Links <IMicrosoftGraphSectionLinks>]
: sectionLinks[(Any) <Object>]
: This indicates any property can be added to this object.[OneNoteClientUrl <IMicrosoftGraphExternalLink>]
: externalLink[OneNoteWebUrl <IMicrosoftGraphExternalLink>]
: externalLink
[Pages <IMicrosoftGraphOnenotePage-
[]>]
: The collection of pages in the section. Read-only. Nullable.[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
: The page's HTML content.[ContentUrl <String>]
: The URL for the page's HTML content. Read-only.[CreatedByAppId <String>]
: The unique identifier of the application that created the page. Read-only.[LastModifiedDateTime <DateTime?>]
: 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.[Level <Int32?>]
: The indentation level of the page. Read-only.[Links <IMicrosoftGraphPageLinks>]
: pageLinks[(Any) <Object>]
: This indicates any property can be added to this object.[OneNoteClientUrl <IMicrosoftGraphExternalLink>]
: externalLink[OneNoteWebUrl <IMicrosoftGraphExternalLink>]
: externalLink
[Order <Int32?>]
: The order of the page within its parent section. Read-only.[ParentNotebook <IMicrosoftGraphNotebook>]
: notebook[ParentSection <IMicrosoftGraphOnenoteSection>]
: onenoteSection[Title <String>]
: The title of the page.[UserTags <String-
[]>]
:
[PagesUrl <String>]
: The pages endpoint where you can get details for all the pages in the section. Read-only.[ParentNotebook <IMicrosoftGraphNotebook>]
: notebook[ParentSectionGroup <IMicrosoftGraphSectionGroup>]
: sectionGroup
[SectionsUrl <String>]
: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
[SectionGroupsUrl <String>]
: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.[Sections <IMicrosoftGraphOnenoteSection-
[]>]
: The sections in the notebook. Read-only. Nullable.[SectionsUrl <String>]
: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.[UserRole <String>]
: onenoteUserRole
[Operations <IMicrosoftGraphOnenoteOperation-
[]>]
: 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.[CreatedDateTime <DateTime?>]
: The start time of the operation.[LastActionDateTime <DateTime?>]
: The time of the last action of the operation.[Status <String>]
: operationStatus[Id <String>]
: The unique identifier for an entity. Read-only.[Error <IMicrosoftGraphOnenoteOperationError>]
: onenoteOperationError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The error code.[Message <String>]
: The error message.
[PercentComplete <String>]
: The operation percent complete if the operation is still in running status.[ResourceId <String>]
: The resource id.[ResourceLocation <String>]
: The resource URI for the object. For example, the resource URI for a copied page or section.
[Pages <IMicrosoftGraphOnenotePage-
[]>]
: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.[Resources <IMicrosoftGraphOnenoteResource-
[]>]
: 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.[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
: The content of the resource.[ContentUrl <String>]
: The URL for the content stream.
[SectionGroups <IMicrosoftGraphSectionGroup-
[]>]
: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.[Sections <IMicrosoftGraphOnenoteSection-
[]>]
: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
[Operations <IMicrosoftGraphRichLongRunningOperation-
[]>]
: The collection of long running operations for the site.[PageTemplates <IMicrosoftGraphPageTemplate-
[]>]
: The collection of page templates on this site.[PageLayout <String>]
: pageLayoutType[PublishingState <IMicrosoftGraphPublicationFacet>]
: publicationFacet[Title <String>]
: Title of the sitePage.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[CanvasLayout <IMicrosoftGraphCanvasLayout>]
: canvasLayout[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[HorizontalSections <IMicrosoftGraphHorizontalSection-
[]>]
: Collection of horizontal sections on the SharePoint page.[Id <String>]
: The unique identifier for an entity. Read-only.[Columns <IMicrosoftGraphHorizontalSectionColumn-
[]>]
: The set of vertical columns in this section.[Id <String>]
: The unique identifier for an entity. Read-only.[Webparts <IMicrosoftGraphWebPart-
[]>]
: The collection of WebParts in this column.[Id <String>]
: The unique identifier for an entity. Read-only.
[Width <Int32?>]
: Width of the column. A horizontal section is divided into 12 grids. A column should have a value of 1-12 to represent its range spans. For example, there can be two columns both have a width of 6 in a section.
[Emphasis <String>]
: sectionEmphasisType[Layout <String>]
: horizontalSectionLayoutType
[VerticalSection <IMicrosoftGraphVerticalSection>]
: verticalSection[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Emphasis <String>]
: sectionEmphasisType[Webparts <IMicrosoftGraphWebPart-
[]>]
: The set of web parts in this section.
[TitleArea <IMicrosoftGraphTitleArea>]
: titleArea[(Any) <Object>]
: This indicates any property can be added to this object.[AlternativeText <String>]
: Alternative text on the title area.[EnableGradientEffect <Boolean?>]
: Indicates whether the title area has a gradient effect enabled.[ImageWebUrl <String>]
: URL of the image in the title area.[Layout <String>]
: titleAreaLayoutType[ServerProcessedContent <IMicrosoftGraphServerProcessedContent>]
: serverProcessedContent[(Any) <Object>]
: This indicates any property can be added to this object.[ComponentDependencies <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are component ids. SharePoint servers might decide to use this hint to preload the script for corresponding components for performance boost.[Key <String>]
: Key of the meta data.[Value <String>]
: Value of the meta data.
[CustomMetadata <IMicrosoftGraphMetaDataKeyValuePair-
[]>]
: A key-value map where keys are string identifier and values are object of custom key-value pair.[Key <String>]
: Key of the metadata.[Value <IMicrosoftGraphJson>]
: Json
[HtmlStrings <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are rich text with HTML format. SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them.[ImageSources <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are image sources. SharePoint servers treat the values as image sources and run services like search index and link fixup on them.[Links <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are links. SharePoint servers treat the values as links and run services like link fixup on them.[SearchablePlainTexts <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are strings that should be search indexed.
[ShowAuthor <Boolean?>]
: Indicates whether the author should be shown in title area.[ShowPublishedDate <Boolean?>]
: Indicates whether the published date should be shown in title area.[ShowTextBlockAboveTitle <Boolean?>]
: Indicates whether the text block above title should be shown in title area.[TextAboveTitle <String>]
: The text above title line.[TextAlignment <String>]
: titleAreaTextAlignmentType
[WebParts <IMicrosoftGraphWebPart-
[]>]
: The collection of web parts on the SharePoint page.
[Pages <IMicrosoftGraphBaseSitePage-
[]>]
: The collection of pages in the baseSitePages list on this site.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[PageLayout <String>]
: pageLayoutType[PublishingState <IMicrosoftGraphPublicationFacet>]
: publicationFacet[Title <String>]
: Title of the sitePage.
[Permissions <IMicrosoftGraphPermission-
[]>]
: The permissions associated with the site. Nullable.[RecycleBin <IMicrosoftGraphRecycleBin>]
: recycleBin[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Items <IMicrosoftGraphRecycleBinItem-
[]>]
: List of the recycleBinItems deleted by a user.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when the item was deleted. 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.[DeletedFromLocation <String>]
: Relative URL of the list or folder that originally contained the item.[Size <Int64?>]
: Size of the item in bytes.
[Root <IMicrosoftGraphRoot>]
: root[Settings <IMicrosoftGraphSiteSettings>]
: siteSettings[(Any) <Object>]
: This indicates any property can be added to this object.[LanguageTag <String>]
: The language tag for the language used on this site.[TimeZone <String>]
: Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC).
[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[SiteCollection <IMicrosoftGraphSiteCollection>]
: siteCollection[(Any) <Object>]
: This indicates any property can be added to this object.[ArchivalDetails <IMicrosoftGraphSiteArchivalDetails>]
: siteArchivalDetails[(Any) <Object>]
: This indicates any property can be added to this object.[ArchiveStatus <String>]
: siteArchiveStatus
[DataLocationCode <String>]
: The geographic region code for where this site collection resides. Only present for multi-geo tenants. Read-only.[Hostname <String>]
: The hostname for the site collection. Read-only.[Root <IMicrosoftGraphRoot>]
: root
[Sites <IMicrosoftGraphSite-
[]>]
: The collection of the sub-sites under this site.[TermStore <IMicrosoftGraphTermStore>]
: store[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DefaultLanguageTag <String>]
: Default language of the term store.[Groups <IMicrosoftGraphTermStoreGroup-
[]>]
: Collection of all groups available in the term store.[LanguageTags <String-
[]>]
: List of languages for the term store.[Sets <IMicrosoftGraphTermStoreSet-
[]>]
: Collection of all sets available in the term store.
[GivenName <String>]
: 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).[HireDate <DateTime?>]
: 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.[Identities <IMicrosoftGraphObjectIdentity-
[]>]
: 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) with limitations.[Issuer <String>]
: Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn't federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.[IssuerAssignedId <String>]
: Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress (or a custom string that starts with emailAddress like emailAddress1), issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _ For more information about filtering behavior for this property, see Filtering on the identities property of a user.[SignInType <String>]
: Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity updates the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, are performed when setting or updating a userPrincipalName identity. Extra validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
[ImAddresses <String-
[]>]
: The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Supports $filter (eq, not, ge, le, startsWith).[InferenceClassification <IMicrosoftGraphInferenceClassification>]
: inferenceClassification[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Overrides <IMicrosoftGraphInferenceClassificationOverride-
[]>]
: A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ClassifyAs <String>]
: inferenceClassificationType[SenderEmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[InfoCatalogs <String-
[]>]
: Identifies the info segments assigned to the user. Supports $filter (eq, not, ge, le, startsWith).[InformationProtection <IMicrosoftGraphInformationProtection>]
: informationProtection[Insights <IMicrosoftGraphItemInsights>]
: itemInsights[(Any) <Object>]
: This indicates any property can be added to this object.[Shared <IMicrosoftGraphSharedInsight-
[]>]
: Access this property from the derived type itemInsights.[Id <String>]
: The unique identifier for an entity. Read-only.[LastShared <IMicrosoftGraphSharingDetail>]
: sharingDetail[(Any) <Object>]
: This indicates any property can be added to this object.[SharedBy <IMicrosoftGraphInsightIdentity>]
: insightIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of the user who shared the item.[DisplayName <String>]
: The display name of the user who shared the item.[Id <String>]
: The ID of the user who shared the item.
[SharedDateTime <DateTime?>]
: The date and time the file was last shared. 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.[SharingReference <IMicrosoftGraphResourceReference>]
: resourceReference[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The item's unique identifier.[Type <String>]
: A string value that can be used to classify the item, such as 'microsoft.graph.driveItem'[WebUrl <String>]
: A URL leading to the referenced item.
[SharingSubject <String>]
: The subject with which the document was shared.[SharingType <String>]
: Determines the way the document was shared, can be by a 'Link', 'Attachment', 'Group', 'Site'.
[LastSharedMethod <IMicrosoftGraphEntity>]
: entity[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Resource <IMicrosoftGraphEntity>]
: entity[ResourceReference <IMicrosoftGraphResourceReference>]
: resourceReference[ResourceVisualization <IMicrosoftGraphResourceVisualization>]
: resourceVisualization[(Any) <Object>]
: This indicates any property can be added to this object.[ContainerDisplayName <String>]
: A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item.[ContainerType <String>]
: Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness.[ContainerWebUrl <String>]
: A path leading to the folder in which the item is stored.[MediaType <String>]
: The item's media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Not all Media Mime Types are supported.[PreviewImageUrl <String>]
: A URL leading to the preview image for the item.[PreviewText <String>]
: A preview text for the item.[Title <String>]
: The item's title text.[Type <String>]
: The item's media type. Can be used for filtering for a specific file based on a specific type. See the Type property values section, for supported types.
[SharingHistory <IMicrosoftGraphSharingDetail-
[]>]
:
[Trending <IMicrosoftGraphTrending-
[]>]
: Access this property from the derived type itemInsights.[Id <String>]
: The unique identifier for an entity. Read-only.[LastModifiedDateTime <DateTime?>]
: 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[Resource <IMicrosoftGraphEntity>]
: entity[ResourceReference <IMicrosoftGraphResourceReference>]
: resourceReference[ResourceVisualization <IMicrosoftGraphResourceVisualization>]
: resourceVisualization[Weight <Double?>]
: Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value.
[Used <IMicrosoftGraphUsedInsight-
[]>]
: Access this property from the derived type itemInsights.[Id <String>]
: The unique identifier for an entity. Read-only.[LastUsed <IMicrosoftGraphUsageDetails>]
: usageDetails[(Any) <Object>]
: This indicates any property can be added to this object.[LastAccessedDateTime <DateTime?>]
: The date and time the resource was last accessed by the user. 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.[LastModifiedDateTime <DateTime?>]
: The date and time the resource was last modified by the user. 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.
[Resource <IMicrosoftGraphEntity>]
: entity[ResourceReference <IMicrosoftGraphResourceReference>]
: resourceReference[ResourceVisualization <IMicrosoftGraphResourceVisualization>]
: resourceVisualization
[Id <String>]
: The unique identifier for an entity. Read-only.
[Interests <String-
[]>]
: A list for users to describe their interests. Returned only on $select.[InvitedBy <IMicrosoftGraphDirectoryObject>]
: directoryObject[IsLicenseReconciliationNeeded <Boolean?>]
: Indicates whether the user is pending an exchange mailbox license assignment. Read-only. Supports $filter (eq where true only).[IsManagementRestricted <Boolean?>]
: true if the user is a member of a restricted management administrative unit. Default value is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsResourceAccount <Boolean?>]
: Do not use - reserved for future use.[JobTitle <String>]
: The user's job title. Maximum length is 128 characters. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).[JoinedGroups <IMicrosoftGraphGroup-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AcceptedSenders <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[AccessType <String>]
: groupAccessType[AllowExternalSenders <Boolean?>]
: 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}).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a group has been granted for an application. Supports $expand.[AssignedLabels <IMicrosoftGraphAssignedLabel-
[]>]
: The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role.[DisplayName <String>]
: The display name of the label. Read-only.[LabelId <String>]
: The unique identifier of the label.
[AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq). Read-only.[AutoSubscribeNewMembers <Boolean?>]
: 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}).[Calendar <IMicrosoftGraphCalendar>]
: calendar[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Read-only.[Classification <String>]
: 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).[Conversations <IMicrosoftGraphConversation-
[]>]
: The group's conversations.[Id <String>]
: The unique identifier for an entity. Read-only.[HasAttachments <Boolean?>]
: Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.[LastDeliveredDateTime <DateTime?>]
: 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).[Preview <String>]
: A short summary from the body of the latest post in this conversation.[Threads <IMicrosoftGraphConversationThread-
[]>]
: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[CcRecipients <IMicrosoftGraphRecipient-
[]>]
: The Cc: recipients for the thread. Returned only on $select.[HasAttachments <Boolean?>]
: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.[IsLocked <Boolean?>]
: Indicates if the thread is locked. Returned by default.[LastDeliveredDateTime <DateTime?>]
: 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.[Posts <IMicrosoftGraphPost-
[]>]
:[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the post. Read-only. Nullable. Supports $expand.[Body <IMicrosoftGraphItemBody>]
: itemBody[ConversationId <String>]
: Unique ID of the conversation. Read-only.[ConversationThreadId <String>]
: Unique ID of the conversation thread. Read-only.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand.[From <IMicrosoftGraphRecipient>]
: recipient[HasAttachments <Boolean?>]
: Indicates whether the post has at least one attachment. This is a default property.[Importance <String>]
: importance[InReplyTo <IMicrosoftGraphPost>]
: post[Mentions <IMicrosoftGraphMention-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Application <String>]
: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.[ClientReference <String>]
: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.[CreatedBy <IMicrosoftGraphEmailAddress>]
: emailAddress[CreatedDateTime <DateTime?>]
: The date and time that the mention is created on the client.[DeepLink <String>]
: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.[MentionText <String>]
: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.[Mentioned <IMicrosoftGraphEmailAddress>]
: emailAddress[ServerCreatedDateTime <DateTime?>]
: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the post. Read-only. Nullable.[NewParticipants <IMicrosoftGraphRecipient-
[]>]
: Conversation participants that were added to the thread as part of this post.[ReceivedDateTime <DateTime?>]
: Specifies when the post was received. 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[Sender <IMicrosoftGraphRecipient>]
: recipient[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the post. Read-only. Nullable.
[Preview <String>]
: A short summary from the body of the latest post in this conversation. Returned by default.[ToRecipients <IMicrosoftGraphRecipient-
[]>]
: The To: recipients for the thread. Returned only on $select.[Topic <String>]
: The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.[UniqueSenders <String-
[]>]
: All the users that sent a message to this thread. Returned by default.
[Topic <String>]
: The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.[UniqueSenders <String-
[]>]
: All the users that sent a message to this Conversation.
[CreatedByAppId <String>]
: App ID of the app used to create the group. Can be null for some groups. Returned by default. Read-only. Supports $filter (eq, ne, not, in, startsWith).[CreatedDateTime <DateTime?>]
: 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.[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]
: directoryObject[Description <String>]
: An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.[DisplayName <String>]
: The display name for the group. Required. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[Drive <IMicrosoftGraphDrive>]
: drive[Drives <IMicrosoftGraphDrive-
[]>]
: The group's drives. Read-only.[Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints for the group. Read-only. Nullable.[Events <IMicrosoftGraphEvent-
[]>]
: The group's events.[ExpirationDateTime <DateTime?>]
: 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.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the group. Read-only. Nullable.[GroupLifecyclePolicies <IMicrosoftGraphGroupLifecyclePolicy-
[]>]
: The collection of lifecycle policies for this group. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AlternateNotificationEmails <String>]
: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.[GroupLifetimeInDays <Int32?>]
: 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.[ManagedGroupTypes <String>]
: The group type for which the expiration policy applies. Possible values are All, Selected or None.
[GroupTypes <String-
[]>]
: 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 <Boolean?>]
: 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).[HideFromAddressLists <Boolean?>]
: 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}).[HideFromOutlookClients <Boolean?>]
: 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}).[InfoCatalogs <String-
[]>]
: Identifies the info segments assigned to the group. Returned by default. Supports $filter (eq, not, ge, le, startsWith).[IsArchived <Boolean?>]
: 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.[IsAssignableToRole <Boolean?>]
: 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 with at least the Privileged Role Administrator role 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).[IsFavorite <Boolean?>]
: Indicates whether the user marked the group as favorite.[IsManagementRestricted <Boolean?>]
: Indicates whether the group is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsSubscribedByMail <Boolean?>]
: 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}).[LicenseProcessingState <IMicrosoftGraphLicenseProcessingState>]
: licenseProcessingState[(Any) <Object>]
: This indicates any property can be added to this object.[State <String>]
:
[Mail <String>]
: The SMTP address for the group, for example, 'serviceadmins@contoso.com'. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[MailEnabled <Boolean?>]
: Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not, and eq on null values).[MailNickname <String>]
: The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / -[]
' ; : <> , SPACE. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith).[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.[Members <IMicrosoftGraphDirectoryObject-
[]>]
: 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).[MembersWithLicenseErrors <IMicrosoftGraphDirectoryObject-
[]>]
: A list of group members with license errors from this group-based license assignment. Read-only.[MembershipRule <String>]
: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).[MembershipRuleProcessingState <String>]
: 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).[MembershipRuleProcessingStatus <IMicrosoftGraphMembershipRuleProcessingStatus>]
: membershipRuleProcessingStatus[(Any) <Object>]
: This indicates any property can be added to this object.[ErrorMessage <String>]
: Detailed error message if dynamic group processing ran into an error. Optional. Read-only.[LastMembershipUpdated <DateTime?>]
: Most recent date and time when membership of a dynamic group was updated. Optional. Read-only.[Status <String>]
: MembershipRuleProcessingStatusDetails
[OnPremisesDomainName <String>]
: 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.[OnPremisesLastSyncDateTime <DateTime?>]
: 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).[OnPremisesNetBiosName <String>]
: 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.[OnPremisesProvisioningErrors <IMicrosoftGraphOnPremisesProvisioningError-
[]>]
: Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).[Category <String>]
: Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.[OccurredDateTime <DateTime?>]
: The date and time at which the error occurred.[PropertyCausingError <String>]
: Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress[Value <String>]
: Value of the property causing the error.
[OnPremisesSamAccountName <String>]
: 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.[OnPremisesSecurityIdentifier <String>]
: Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values).[OnPremisesSyncEnabled <Boolean?>]
: true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).[Onenote <IMicrosoftGraphOnenote>]
: onenote[OrganizationId <String>]
:[Owners <IMicrosoftGraphDirectoryObject-
[]>]
: The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. A non-admin user can't explicitly add themselves to this collection when they're creating the group. For more information, see the related known issue. For security groups, the admin user isn't automatically added to this collection. For more information, see the related known issue. 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).[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: The permissions granted for a group to a specific application. Supports $expand.[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[Photos <IMicrosoftGraphProfilePhoto-
[]>]
: The profile photos owned by the group. Read-only. Nullable.[Planner <IMicrosoftGraphPlannerGroup>]
: plannerGroup[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Plans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans owned by the group.[Id <String>]
: The unique identifier for an entity. Read-only.[ArchivalInfo <IMicrosoftGraphPlannerArchivalInfo>]
: plannerArchivalInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Justification <String>]
: Read-only. Reason why the entity was archived or unarchived.[StatusChangedBy <IMicrosoftGraphIdentitySet>]
: identitySet[StatusChangedDateTime <DateTime?>]
: Read-only. Date and time at which the entity's archive status changed.
[Buckets <IMicrosoftGraphPlannerBucket-
[]>]
: Collection of buckets in the plan. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ArchivalInfo <IMicrosoftGraphPlannerArchivalInfo>]
: plannerArchivalInfo[CreationSource <IMicrosoftGraphPlannerBucketCreation>]
: plannerBucketCreation[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind
[IsArchived <Boolean?>]
: Read-only. If set totrue, the bucket is archived. An archived bucket is read-only.[Name <String>]
: Name of the bucket.[OrderHint <String>]
: Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.[PlanId <String>]
: Plan ID to which the bucket belongs.[Tasks <IMicrosoftGraphPlannerTask-
[]>]
: Read-only. Nullable. The collection of tasks in the bucket.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveChecklistItemCount <Int32?>]
: The number of checklist items with value set to false, representing incomplete items.[AppliedCategories <IMicrosoftGraphPlannerAppliedCategories>]
: plannerAppliedCategories[(Any) <Object>]
: This indicates any property can be added to this object.
[ArchivalInfo <IMicrosoftGraphPlannerArchivalInfo>]
: plannerArchivalInfo[AssignedToTaskBoardFormat <IMicrosoftGraphPlannerAssignedToTaskBoardTaskFormat>]
: plannerAssignedToTaskBoardTaskFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[OrderHintsByAssignee <IMicrosoftGraphPlannerOrderHintsByAssignee>]
: plannerOrderHintsByAssignee[(Any) <Object>]
: This indicates any property can be added to this object.
[UnassignedOrderHint <String>]
: Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.
[AssigneePriority <String>]
: A hint that is used to order items of this type in a list view. For more information, see Using order hints in planner.[Assignments <IMicrosoftGraphPlannerAssignments>]
: plannerAssignments[(Any) <Object>]
: This indicates any property can be added to this object.
[BucketId <String>]
: Bucket ID to which the task belongs. The bucket needs to be in the same plan as the task. The value of the bucketId property is 28 characters long and case-sensitive. Format validation is done on the service.[BucketTaskBoardFormat <IMicrosoftGraphPlannerBucketTaskBoardTaskFormat>]
: plannerBucketTaskBoardTaskFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[OrderHint <String>]
: Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.
[ChecklistItemCount <Int32?>]
: The number of checklist items that are present on the task.[CompletedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CompletedDateTime <DateTime?>]
: Read-only. The 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[ConversationThreadId <String>]
: The thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Read-only. The 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[CreationSource <IMicrosoftGraphPlannerTaskCreation>]
: plannerTaskCreation[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind[TeamsPublicationInfo <IMicrosoftGraphPlannerTeamsPublicationInfo>]
: plannerTeamsPublicationInfo[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind[TeamsPublicationInfo <IMicrosoftGraphPlannerTeamsPublicationInfo>]
: plannerTeamsPublicationInfo[LastModifiedDateTime <DateTime?>]
: The date and time when this task was last modified by the publication process. Read-only.[PublicationId <String>]
: The identifier of the publication. Read-only.[PublishedToPlanId <String>]
: The identifier of the plannerPlan this task was originally placed in. Read-only.[PublishingTeamId <String>]
: The identifier of the team that initiated the publication process. Read-only.[PublishingTeamName <String>]
: The display name of the team that initiated the publication process. This display name is for reference only, and might not represent the most up-to-date name of the team. Read-only.
[Details <IMicrosoftGraphPlannerTaskDetails>]
: plannerTaskDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ApprovalAttachment <IMicrosoftGraphPlannerBaseApprovalAttachment>]
: plannerBaseApprovalAttachment[(Any) <Object>]
: This indicates any property can be added to this object.[Status <String>]
: plannerApprovalStatus
[Checklist <IMicrosoftGraphPlannerChecklistItems>]
: plannerChecklistItems[(Any) <Object>]
: This indicates any property can be added to this object.
[CompletionRequirements <IMicrosoftGraphPlannerTaskCompletionRequirementDetails>]
: plannerTaskCompletionRequirementDetails[(Any) <Object>]
: This indicates any property can be added to this object.[ApprovalRequirement <IMicrosoftGraphPlannerApprovalRequirement>]
: plannerApprovalRequirement[(Any) <Object>]
: This indicates any property can be added to this object.[IsApprovalRequired <Boolean?>]
: Specifies whether approval is required to complete the plannerTask. When this property is set to true, the task can only be marked complete if an approval is created for the task and approved.
[ChecklistRequirement <IMicrosoftGraphPlannerChecklistRequirement>]
: plannerChecklistRequirement[(Any) <Object>]
: This indicates any property can be added to this object.[RequiredChecklistItemIds <String-
[]>]
: A collection of required plannerChecklistItems identifiers to complete the plannerTask.
[FormsRequirement <IMicrosoftGraphPlannerFormsRequirement>]
: plannerFormsRequirement[(Any) <Object>]
: This indicates any property can be added to this object.[RequiredForms <String-
[]>]
: Read-only. A collection of keys from the plannerFormsDictionary that identify the plannerFormReference objects that specify the requirements to complete the plannerTask.
[Description <String>]
: Description of the task.[Forms <IMicrosoftGraphPlannerFormsDictionary>]
: plannerFormsDictionary[(Any) <Object>]
: This indicates any property can be added to this object.
[Notes <IMicrosoftGraphItemBody>]
: itemBody[PreviewType <String>]
: plannerPreviewType[References <IMicrosoftGraphPlannerExternalReferences>]
: plannerExternalReferences[(Any) <Object>]
: This indicates any property can be added to this object.
[DueDateTime <DateTime?>]
: The 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[HasDescription <Boolean?>]
: Read-only. This value is true if the details object of the task has a nonempty description. Otherwise,false.[IsArchived <Boolean?>]
: Read-only. If set to true, the task is archived. An archived task is read-only.[IsOnMyDay <Boolean?>]
: Indicates whether to show this task in the MyDay view. If true, it shows the task.[IsOnMyDayLastModifiedDate <DateTime?>]
: Read-only. The date on which task is added to or removed from MyDay.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[OrderHint <String>]
: The hint used to order items of this type in a list view. For more information, see Using order hints in plannern.[PercentComplete <Int32?>]
: The percentage of task completion. When set to 100, the task is completed.[PlanId <String>]
: Plan ID to which the task belongs.[PreviewType <String>]
: plannerPreviewType[Priority <Int32?>]
: The priority of the task. Valid values are between 0 and 10, inclusive. Larger values indicate lower priority. For example, 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'.[ProgressTaskBoardFormat <IMicrosoftGraphPlannerProgressTaskBoardTaskFormat>]
: plannerProgressTaskBoardTaskFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[OrderHint <String>]
: Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.
[Recurrence <IMicrosoftGraphPlannerTaskRecurrence>]
: plannerTaskRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[NextInSeriesTaskId <String>]
: The taskId of the next task in this series. This value is assigned at the time the next task in the series is created, and is null prior to that time.[OccurrenceId <Int32?>]
: The 1-based index of this task within the recurrence series. The first task in a series has the value 1, the next task in the series has the value 2, and so on.[PreviousInSeriesTaskId <String>]
: The taskId of the previous task in this series. null for the first task in a series since it has no predecessor. All subsequent tasks in the series have a value that corresponds to their predecessors.[RecurrenceStartDateTime <DateTime?>]
: The date and time when this recurrence series begin. For the first task in a series (occurrenceId = 1) this value is copied from schedule.patternStartDateTime. For subsequent tasks in the series (occurrenceId >= 2) this value is copied from the previous task and never changes; it preserves the start date of the recurring series. 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.[Schedule <IMicrosoftGraphPlannerRecurrenceSchedule>]
: plannerRecurrenceSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[NextOccurrenceDateTime <DateTime?>]
: The next date for this schedule. When a new task is instantiated to continue the recurrence series, this date is used for the dueDateTime of the new plannerTask. Auto-generated by the service. 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.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[PatternStartDateTime <DateTime?>]
: The start date for the recurrence pattern. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.
[SeriesId <String>]
: The recurrence series this task belongs to. A GUID-based value that serves as the unique identifier for a series.
[ReferenceCount <Int32?>]
: Number of external references that exist on the task.[SpecifiedCompletionRequirements <String>]
: plannerTaskCompletionRequirements[StartDateTime <DateTime?>]
: 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[Title <String>]
: Title of the task.
[Container <IMicrosoftGraphPlannerPlanContainer>]
: plannerPlanContainer[(Any) <Object>]
: This indicates any property can be added to this object.[ContainerId <String>]
: The identifier of the resource that contains the plan. Optional.[Type <String>]
: plannerContainerType[Url <String>]
: The full canonical URL of the container. Optional.
[Contexts <IMicrosoftGraphPlannerPlanContextCollection>]
: plannerPlanContextCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: 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[CreationSource <IMicrosoftGraphPlannerPlanCreation>]
: plannerPlanCreation[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind
[Details <IMicrosoftGraphPlannerPlanDetails>]
: plannerPlanDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CategoryDescriptions <IMicrosoftGraphPlannerCategoryDescriptions>]
: plannerCategoryDescriptions[(Any) <Object>]
: This indicates any property can be added to this object.[Category1 <String>]
: The label associated with Category 1[Category10 <String>]
: The label associated with Category 10[Category11 <String>]
: The label associated with Category 11[Category12 <String>]
: The label associated with Category 12[Category13 <String>]
: The label associated with Category 13[Category14 <String>]
: The label associated with Category 14[Category15 <String>]
: The label associated with Category 15[Category16 <String>]
: The label associated with Category 16[Category17 <String>]
: The label associated with Category 17[Category18 <String>]
: The label associated with Category 18[Category19 <String>]
: The label associated with Category 19[Category2 <String>]
: The label associated with Category 2[Category20 <String>]
: The label associated with Category 20[Category21 <String>]
: The label associated with Category 21[Category22 <String>]
: The label associated with Category 22[Category23 <String>]
: The label associated with Category 23[Category24 <String>]
: The label associated with Category 24[Category25 <String>]
: The label associated with Category 25[Category3 <String>]
: The label associated with Category 3[Category4 <String>]
: The label associated with Category 4[Category5 <String>]
: The label associated with Category 5[Category6 <String>]
: The label associated with Category 6[Category7 <String>]
: The label associated with Category 7[Category8 <String>]
: The label associated with Category 8[Category9 <String>]
: The label associated with Category 9
[ContextDetails <IMicrosoftGraphPlannerPlanContextDetailsCollection>]
: plannerPlanContextDetailsCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[SharedWith <IMicrosoftGraphPlannerUserIds>]
: plannerUserIds[(Any) <Object>]
: This indicates any property can be added to this object.
[IsArchived <Boolean?>]
: Read-only. If set to true, the plan is archived. An archived plan is read-only.[Owner <String>]
: Use the container property instead. ID of the group that owns the plan. After it's set, this property can't be updated. This property doesn't return a valid group ID if the container of the plan isn't a group.[SharedWithContainers <IMicrosoftGraphPlannerSharedWithContainer-
[]>]
: List of containers the plan is shared with.[ContainerId <String>]
: The identifier of the resource that contains the plan. Optional.[Type <String>]
: plannerContainerType[Url <String>]
: The full canonical URL of the container. Optional.[AccessLevel <String>]
: plannerPlanAccessLevel
[Tasks <IMicrosoftGraphPlannerTask-
[]>]
: Collection of tasks in the plan. Read-only. Nullable.[Title <String>]
: Required. Title of the plan.
[PreferredDataLocation <String>]
: 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 at least one of the following Microsoft Entra roles: 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.[PreferredLanguage <String>]
: 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).[ProxyAddresses <String-
[]>]
: Email addresses for the group that direct to the same group mailbox. For example: -['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']
. The any operator is required for filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).[RejectedSenders <IMicrosoftGraphDirectoryObject-
[]>]
: The list of users or groups not allowed to create posts or calendar events in this group. Nullable[RenewedDateTime <DateTime?>]
: 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.[ResourceBehaviorOptions <String-
[]>]
: Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This property can be set only as part of creation (POST). For the list of possible values, see Microsoft 365 group behaviors and provisioning options.[ResourceProvisioningOptions <String-
[]>]
: Specifies the group resources that are associated with the Microsoft 365 group. The possible value is Team. For more information, see Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith.[SecurityEnabled <Boolean?>]
: Specifies whether the group is a security group. Required.Returned by default. Supports $filter (eq, ne, not, in).[SecurityIdentifier <String>]
: Security identifier of the group, used in Windows scenarios. Read-only. Returned by default.[ServiceProvisioningErrors <IMicrosoftGraphServiceProvisioningError-
[]>]
: Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object.[CreatedDateTime <DateTime?>]
: The date and time at which the error occurred.[IsResolved <Boolean?>]
: Indicates whether the Error has been attended to.[ServiceInstance <String>]
: Qualified service instance (for example, 'SharePoint/Dublin') that published the service error information.
[Settings <IMicrosoftGraphDirectorySetting-
[]>]
: Settings that can govern this group's behavior, like whether members can invite guest users to the group. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Display name of this group of settings, which comes from the associated template. Read-only.[TemplateId <String>]
: Unique identifier for the template used to create this group of settings. Read-only.[Values <IMicrosoftGraphSettingValue-
[]>]
: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.[Name <String>]
: Name of the setting (as defined by the directorySettingTemplate).[Value <String>]
: Value of the setting.
[Sites <IMicrosoftGraphSite-
[]>]
: The list of SharePoint sites in this group. Access the default site with /sites/root.[Team <IMicrosoftGraphTeam>]
: team[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllChannels <IMicrosoftGraphChannel-
[]>]
: List of channels either hosted in or shared with the team (incoming channels).[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Read only. Timestamp at which the channel was created.[Description <String>]
: Optional textual description for the channel.[DisplayName <String>]
: Channel name as it appears to the user in Microsoft Teams. The maximum length is 50 characters.[Email <String>]
: The email address for sending messages to the channel. Read-only.[FilesFolder <IMicrosoftGraphDriveItem>]
: driveItem[IsArchived <Boolean?>]
: Indicates whether the channel is archived. Read-only.[IsFavoriteByDefault <Boolean?>]
: Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false.[Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of membership records associated with the channel.[MembershipType <String>]
: channelMembershipType[Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the channel. A navigation property. Nullable.[ModerationSettings <IMicrosoftGraphChannelModerationSettings>]
: channelModerationSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowNewMessageFromBots <Boolean?>]
: Indicates whether bots are allowed to post messages.[AllowNewMessageFromConnectors <Boolean?>]
: Indicates whether connectors are allowed to post messages.[ReplyRestriction <String>]
: replyRestriction[UserNewMessageRestriction <String>]
: userNewMessageRestriction
[SharedWithTeams <IMicrosoftGraphSharedWithChannelTeamInfo-
[]>]
: A collection of teams with which a channel is shared.[DisplayName <String>]
: The name of the team.[Team <IMicrosoftGraphTeam>]
: team[TenantId <String>]
: The ID of the Microsoft Entra tenant.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedMembers <IMicrosoftGraphConversationMember-
[]>]
: A collection of team members who have access to the shared channel.[IsHostTeam <Boolean?>]
: Indicates whether the team is the host of the channel.
[Summary <IMicrosoftGraphChannelSummary>]
: channelSummary[(Any) <Object>]
: This indicates any property can be added to this object.[GuestsCount <Int32?>]
: Count of guests in a channel.[HasMembersFromOtherTenants <Boolean?>]
: Indicates whether external members are included on the channel.[MembersCount <Int32?>]
: Count of members in a channel.[OwnersCount <Int32?>]
: Count of owners in a channel.
[Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the channel. A navigation property.[TenantId <String>]
: The ID of the Microsoft Entra tenant.[WebUrl <String>]
: A hyperlink to the channel in Microsoft Teams. This URL is supplied 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.
[Channels <IMicrosoftGraphChannel-
[]>]
: The collection of channels and messages associated with the team.[Classification <String>]
: 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.[CreatedDateTime <DateTime?>]
: Timestamp at which the team was created.[Description <String>]
: An optional description for the team. Maximum length: 1024 characters.[DiscoverySettings <IMicrosoftGraphTeamDiscoverySettings>]
: teamDiscoverySettings[(Any) <Object>]
: This indicates any property can be added to this object.[ShowInTeamsSearchAndSuggestions <Boolean?>]
: If set to true, the team is visible via search and suggestions from the Teams client.
[DisplayName <String>]
: The name of the team.[FunSettings <IMicrosoftGraphTeamFunSettings>]
: teamFunSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowCustomMemes <Boolean?>]
: If set to true, enables users to include custom memes.[AllowGiphy <Boolean?>]
: If set to true, enables Giphy use.[AllowStickersAndMemes <Boolean?>]
: If set to true, enables users to include stickers and memes.[GiphyContentRating <String>]
: giphyRatingType
[Group <IMicrosoftGraphGroup>]
: group[GuestSettings <IMicrosoftGraphTeamGuestSettings>]
: teamGuestSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowCreateUpdateChannels <Boolean?>]
: If set to true, guests can add and update channels.[AllowDeleteChannels <Boolean?>]
: If set to true, guests can delete channels.
[IncomingChannels <IMicrosoftGraphChannel-
[]>]
: List of channels shared with the team.[InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: The apps installed in this team.[InternalId <String>]
: A unique ID for the team used in a few places such as the audit log/Office 365 Management Activity API.[IsArchived <Boolean?>]
: Whether this team is in read-only mode.[IsMembershipLimitedToOwners <Boolean?>]
: If set to true, the team is currently in the owner-only team membership state and inaccessible by other team members, such as students.[MemberSettings <IMicrosoftGraphTeamMemberSettings>]
: teamMemberSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowAddRemoveApps <Boolean?>]
: If set to true, members can add and remove apps.[AllowCreatePrivateChannels <Boolean?>]
: If set to true, members can add and update private channels.[AllowCreateUpdateChannels <Boolean?>]
: If set to true, members can add and update any channels.[AllowCreateUpdateRemoveConnectors <Boolean?>]
: If set to true, members can add, update, and remove connectors.[AllowCreateUpdateRemoveTabs <Boolean?>]
: If set to true, members can add, update, and remove tabs.[AllowDeleteChannels <Boolean?>]
: If set to true, members can delete channels.
[Members <IMicrosoftGraphConversationMember-
[]>]
: Members and owners of the team.[MessagingSettings <IMicrosoftGraphTeamMessagingSettings>]
: teamMessagingSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowChannelMentions <Boolean?>]
: If set to true, @channel mentions are allowed.[AllowOwnerDeleteMessages <Boolean?>]
: If set to true, owners can delete any message.[AllowTeamMentions <Boolean?>]
: If set to true, @team mentions are allowed.[AllowUserDeleteMessages <Boolean?>]
: If set to true, users can delete their messages.[AllowUserEditMessages <Boolean?>]
: If set to true, users can edit their messages.
[Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: The async operations that ran or are running on this team.[Owners <IMicrosoftGraphUser-
[]>]
: 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). The owner must be specified as an object ID (GUID), not a UPN.[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps to access the team.[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[PrimaryChannel <IMicrosoftGraphChannel>]
: channel[Schedule <IMicrosoftGraphSchedule>]
: schedule[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivitiesIncludedWhenCopyingShiftsEnabled <Boolean?>]
: Indicates whether copied shifts should include the activities.[DayNotes <IMicrosoftGraphDayNote-
[]>]
: The day notes in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DayNoteDate <DateTime?>]
: The date of the day note.[DraftDayNote <IMicrosoftGraphItemBody>]
: itemBody[SharedDayNote <IMicrosoftGraphItemBody>]
: itemBody
[Enabled <Boolean?>]
: Indicates whether the schedule is enabled for the team. Required.[IsCrossLocationShiftRequestApprovalRequired <Boolean?>]
: Indicates whether approval is required by a manager of this schedule for cross location shift requests.[IsCrossLocationShiftsEnabled <Boolean?>]
: Indicates whether the cross-location marketplace feature is enabled for this schedule.[OfferShiftRequests <IMicrosoftGraphOfferShiftRequest-
[]>]
: The offer requests for shifts in the schedule.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[RecipientActionMessage <String>]
: Custom message sent by recipient of the offer shift request.[RecipientUserId <String>]
: User id of the recipient of the offer shift request.[SenderShiftId <String>]
: User id of the sender of the offer shift request.
[OfferShiftRequestsEnabled <Boolean?>]
: Indicates whether offer shift requests are enabled for the schedule.[OpenShiftChangeRequests <IMicrosoftGraphOpenShiftChangeRequest-
[]>]
: The open shift requests in the schedule.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[OpenShiftId <String>]
: ID for the open shift.
[OpenShifts <IMicrosoftGraphOpenShift-
[]>]
: The set of open shifts in a scheduling group in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftOpenShift <IMicrosoftGraphOpenShiftItem>]
: openShiftItem[(Any) <Object>]
: This indicates any property can be added to this object.[Activities <IMicrosoftGraphShiftActivity-
[]>]
: An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. Required.[Code <String>]
: Customer defined code for the shiftActivity. Required.[DisplayName <String>]
: The name of the shiftActivity. Required.[EndDateTime <DateTime?>]
: The end date and time for the shiftActivity. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.[IsPaid <Boolean?>]
: Indicates whether the microsoft.graph.user should be paid for the activity during their shift. Required.[StartDateTime <DateTime?>]
: The start date and time for the shiftActivity. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.[Theme <String>]
: scheduleEntityTheme
[DisplayName <String>]
: The shift label of the shiftItem.[Notes <String>]
: The shift notes for the shiftItem.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[OpenSlotCount <Int32?>]
: Count of the number of slots for the given open shift.
[IsStagedForDeletion <Boolean?>]
: The openShift is marked for deletion, a process that is finalized when the schedule is shared.[SchedulingGroupId <String>]
: The ID of the schedulingGroup that contains the openShift.[SchedulingGroupInfo <IMicrosoftGraphSchedulingGroupInfo>]
: schedulingGroupInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The code for the schedulingGroup.[DisplayName <String>]
: The display name for the schedulingGroup. Required.[SchedulingGroupId <String>]
: ID of the schedulingGroup.
[SharedOpenShift <IMicrosoftGraphOpenShiftItem>]
: openShiftItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the team. Required.[TeamId <String>]
: ID of the team.
[OpenShiftsEnabled <Boolean?>]
: Indicates whether open shifts are enabled for the schedule.[ProvisionStatus <String>]
: operationStatus[SchedulingGroups <IMicrosoftGraphSchedulingGroup-
[]>]
: The logical grouping of users in the schedule (usually by role).[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Code <String>]
: The code for the schedulingGroup to represent an external identifier. This field must be unique within the team in Microsoft Teams and uses an alphanumeric format, with a maximum of 100 characters.[DisplayName <String>]
: The display name for the schedulingGroup. Required.[UserIds <String-
[]>]
: The list of user IDs that are a member of the schedulingGroup. Required.
[Shifts <IMicrosoftGraphShift-
[]>]
: The shifts in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftShift <IMicrosoftGraphShiftItem>]
: shiftItem[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[Activities <IMicrosoftGraphShiftActivity-
[]>]
: An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. Required.[DisplayName <String>]
: The shift label of the shiftItem.[Notes <String>]
: The shift notes for the shiftItem.
[IsStagedForDeletion <Boolean?>]
: The shift is marked for deletion, a process that is finalized when the schedule is shared.[SchedulingGroupId <String>]
: ID of the scheduling group the shift is part of. Required.[SchedulingGroupInfo <IMicrosoftGraphSchedulingGroupInfo>]
: schedulingGroupInfo[SharedShift <IMicrosoftGraphShiftItem>]
: shiftItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[UserId <String>]
: ID of the user assigned to the shift. Required.[UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the user. Required.[UserId <String>]
: ID of the user.
[ShiftsRoleDefinitions <IMicrosoftGraphShiftsRoleDefinition-
[]>]
: The definitions of the roles in the schedule.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: The description of the role.[DisplayName <String>]
: The display name of the role.[ShiftsRolePermissions <IMicrosoftGraphShiftsRolePermission-
[]>]
: The collection of role permissions within the role.[AllowedResourceActions <String-
[]>]
: The permissions that are allowed for a role. Permissions that aren't in this collection are disabled.
[StartDayOfWeek <String>]
: dayOfWeek[SwapShiftsChangeRequests <IMicrosoftGraphSwapShiftsChangeRequest-
[]>]
: The swap requests for shifts in the schedule.[RecipientActionMessage <String>]
: Custom message sent by recipient of the offer shift request.[RecipientUserId <String>]
: User id of the recipient of the offer shift request.[SenderShiftId <String>]
: User id of the sender of the offer shift request.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[RecipientShiftId <String>]
: Shift ID for the recipient user with whom the request is to swap.
[SwapShiftsRequestsEnabled <Boolean?>]
: Indicates whether swap shifts requests are enabled for the schedule.[TimeCards <IMicrosoftGraphTimeCard-
[]>]
: The time cards in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Breaks <IMicrosoftGraphTimeCardBreak-
[]>]
: The list of breaks associated with the timeCard.[BreakId <String>]
: ID of the timeCardBreak.[End <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[(Any) <Object>]
: This indicates any property can be added to this object.[AtApprovedLocation <Boolean?>]
: Indicates whether the entry was recorded at the approved location.[DateTime <DateTime?>]
: The time the entry is recorded.[Notes <IMicrosoftGraphItemBody>]
: itemBody
[Notes <IMicrosoftGraphItemBody>]
: itemBody[Start <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
[ClockInEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[ClockOutEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[ConfirmedBy <String>]
: confirmedBy[Notes <IMicrosoftGraphItemBody>]
: itemBody[OriginalEntry <IMicrosoftGraphTimeCardEntry>]
: timeCardEntry[(Any) <Object>]
: This indicates any property can be added to this object.[Breaks <IMicrosoftGraphTimeCardBreak-
[]>]
: The list of breaks associated with the timeCard.[ClockInEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[ClockOutEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
[State <String>]
: timeCardState[UserId <String>]
: User ID to which the timeCard belongs.
[TimeClockEnabled <Boolean?>]
: Indicates whether time clock is enabled for the schedule.[TimeClockSettings <IMicrosoftGraphTimeClockSettings>]
: timeClockSettings[(Any) <Object>]
: This indicates any property can be added to this object.[ApprovedLocation <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates
[TimeOffReasons <IMicrosoftGraphTimeOffReason-
[]>]
: The set of reasons for a time off in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Code <String>]
: The code of the timeOffReason to represent an external identifier. This field must be unique within the team in Microsoft Teams and uses an alphanumeric format, with a maximum of 100 characters.[DisplayName <String>]
: The name of the timeOffReason. Required.[IconType <String>]
: timeOffReasonIconType[IsActive <Boolean?>]
: Indicates whether the timeOffReason can be used when creating new entities or updating existing ones. Required.
[TimeOffRequests <IMicrosoftGraphTimeOffRequest-
[]>]
: The time off requests in the schedule.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[EndDateTime <DateTime?>]
: 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[StartDateTime <DateTime?>]
: 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[TimeOffReasonId <String>]
: The reason for the time off.
[TimeOffRequestsEnabled <Boolean?>]
: Indicates whether time off requests are enabled for the schedule.[TimeZone <String>]
: Indicates the time zone of the schedule team using tz database format. Required.[TimesOff <IMicrosoftGraphTimeOff-
[]>]
: The instances of times off in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[TimeOffReasonId <String>]
: ID of the timeOffReason for this timeOffItem. Required.
[IsStagedForDeletion <Boolean?>]
: The timeOff is marked for deletion, a process that is finalized when the schedule is shared.[SharedTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[UserId <String>]
: ID of the user assigned to the timeOff. Required.[UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo
[WorkforceIntegrationIds <String-
[]>]
: The IDs for the workforce integrations associated with this schedule.
[Specialization <String>]
: teamSpecialization[Summary <IMicrosoftGraphTeamSummary>]
: teamSummary[(Any) <Object>]
: This indicates any property can be added to this object.[GuestsCount <Int32?>]
: Count of guests in a team.[MembersCount <Int32?>]
: Count of members in a team.[OwnersCount <Int32?>]
: Count of owners in a team.
[Tags <IMicrosoftGraphTeamworkTag-
[]>]
: The tags associated with the team.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Tag description as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.[DisplayName <String>]
: Tag name as it appears to the user in Microsoft Teams.[MemberCount <Int32?>]
: The number of users assigned to the tag.[Members <IMicrosoftGraphTeamworkTagMember-
[]>]
: Users assigned to the tag.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The member's display name.[TenantId <String>]
: The ID of the tenant that the tag member is a part of.[UserId <String>]
: The user ID of the member.
[TagType <String>]
: teamworkTagType[TeamId <String>]
: ID of the team in which the tag is defined.
[Template <IMicrosoftGraphTeamsTemplate>]
: teamsTemplate[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[TemplateDefinition <IMicrosoftGraphTeamTemplateDefinition>]
: teamTemplateDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Audience <String>]
: teamTemplateAudience[Categories <String-
[]>]
: The assigned categories for the team template.[Description <String>]
: A brief description of the team template as it will appear to the users in Microsoft Teams.[DisplayName <String>]
: The user defined name of the team template.[IconUrl <String>]
: The icon url for the team template.[LanguageTag <String>]
: Language the template is available in.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: The date time of when the team template was last modified.[ParentTemplateId <String>]
: The templateId for the team template[PublisherName <String>]
: The organization which published the team template.[ShortDescription <String>]
: A short-description of the team template as it will appear to the users in Microsoft Teams.[TeamDefinition <IMicrosoftGraphTeam>]
: team
[TenantId <String>]
: The ID of the Microsoft Entra tenant.[Visibility <String>]
: teamVisibilityType[WebUrl <String>]
: A hyperlink that goes to the team in the Microsoft Teams client. It is the URL 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.
[Theme <String>]
: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.[Threads <IMicrosoftGraphConversationThread-
[]>]
: The group's conversation threads. Nullable.[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: The groups a group is a member of, either directly or through nested membership. Nullable.[TransitiveMembers <IMicrosoftGraphDirectoryObject-
[]>]
: The direct and transitive members of a group. Nullable.[UniqueName <String>]
: The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only.[UnseenConversationsCount <Int32?>]
: 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.[UnseenCount <Int32?>]
: Count of conversations that have received new posts since the signed-in user last visited the group. This property is the same as unseenConversationsCount.Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).[UnseenMessagesCount <Int32?>]
: 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.[Visibility <String>]
: 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.[WritebackConfiguration <IMicrosoftGraphGroupWritebackConfiguration>]
: groupWritebackConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[IsEnabled <Boolean?>]
: Indicates whether writeback of cloud groups to on-premise Active Directory is enabled. Default value is true for Microsoft 365 groups and false for security groups.[OnPremisesGroupType <String>]
: 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
[JoinedTeams <IMicrosoftGraphTeam-
[]>]
: The Microsoft Teams teams the user is a member of. Read-only. Nullable.[LastPasswordChangeDateTime <DateTime?>]
: 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.[LegalAgeGroupClassification <String>]
: 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.[LicenseAssignmentStates <IMicrosoftGraphLicenseAssignmentState-
[]>]
: 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.[AssignedByGroup <String>]
: Indicates whether the license is directly-assigned or inherited from a group. If directly-assigned, this field is null; if inherited through a group membership, this field contains the ID of the group. Read-Only.[DisabledPlans <String-
[]>]
: The service plans that are disabled in this assignment. Read-Only.[Error <String>]
: License assignment failure error. If the license is assigned successfully, this field will be Null. Read-Only. The possible values are CountViolation, MutuallyExclusiveViolation, DependencyViolation, ProhibitedInUsageLocationViolation, UniquenessViolation, and Other. For more information on how to identify and resolve license assignment errors, see here.[LastUpdatedDateTime <DateTime?>]
: The timestamp when the state of the license assignment was last updated.[SkuId <String>]
: The unique identifier for the SKU. Read-Only.[State <String>]
: Indicate the current state of this assignment. Read-Only. The possible values are Active, ActiveWithError, Disabled, and Error.
[LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:[Mail <String>]
: 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).[MailFolders <IMicrosoftGraphMailFolder-
[]>]
: The user's mail folders. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ChildFolderCount <Int32?>]
: The number of immediate child mailFolders in the current mailFolder.[ChildFolders <IMicrosoftGraphMailFolder-
[]>]
: The collection of child folders in the mailFolder.[DisplayName <String>]
: The mailFolder's display name.[IsHidden <Boolean?>]
: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.[MessageRules <IMicrosoftGraphMessageRule-
[]>]
: The collection of rules that apply to the user's Inbox folder.[Id <String>]
: The unique identifier for an entity. Read-only.[Actions <IMicrosoftGraphMessageRuleActions>]
: messageRuleActions[(Any) <Object>]
: This indicates any property can be added to this object.[AssignCategories <String-
[]>]
: A list of categories to be assigned to a message.[CopyToFolder <String>]
: The ID of a folder that a message is to be copied to.[Delete <Boolean?>]
: Indicates whether a message should be moved to the Deleted Items folder.[ForwardAsAttachmentTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses of the recipients to which a message should be forwarded as an attachment.[ForwardTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses of the recipients to which a message should be forwarded.[MarkAsRead <Boolean?>]
: Indicates whether a message should be marked as read.[MarkImportance <String>]
: importance[MoveToFolder <String>]
: The ID of the folder that a message will be moved to.[PermanentDelete <Boolean?>]
: Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder.[RedirectTo <IMicrosoftGraphRecipient-
[]>]
: The email address to which a message should be redirected.[StopProcessingRules <Boolean?>]
: Indicates whether subsequent rules should be evaluated.
[Conditions <IMicrosoftGraphMessageRulePredicates>]
: messageRulePredicates[(Any) <Object>]
: This indicates any property can be added to this object.[BodyContains <String-
[]>]
: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.[BodyOrSubjectContains <String-
[]>]
: 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 <String-
[]>]
: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.[FromAddresses <IMicrosoftGraphRecipient-
[]>]
: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.[HasAttachments <Boolean?>]
: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.[HeaderContains <String-
[]>]
: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.[Importance <String>]
: importance[IsApprovalRequest <Boolean?>]
: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.[IsAutomaticForward <Boolean?>]
: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.[IsAutomaticReply <Boolean?>]
: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.[IsEncrypted <Boolean?>]
: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.[IsMeetingRequest <Boolean?>]
: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.[IsMeetingResponse <Boolean?>]
: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.[IsNonDeliveryReport <Boolean?>]
: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.[IsPermissionControlled <Boolean?>]
: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.[IsReadReceipt <Boolean?>]
: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.[IsSigned <Boolean?>]
: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.[IsVoicemail <Boolean?>]
: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.[MessageActionFlag <String>]
: messageActionFlag[NotSentToMe <Boolean?>]
: 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.[RecipientContains <String-
[]>]
: 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 <String-
[]>]
: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.[Sensitivity <String>]
: sensitivity[SentCcMe <Boolean?>]
: 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.[SentOnlyToMe <Boolean?>]
: 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.[SentToAddresses <IMicrosoftGraphRecipient-
[]>]
: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.[SentToMe <Boolean?>]
: 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.[SentToOrCcMe <Boolean?>]
: 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.[SubjectContains <String-
[]>]
: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.[WithinSizeRange <IMicrosoftGraphSizeRange>]
: sizeRange[(Any) <Object>]
: This indicates any property can be added to this object.[MaximumSize <Int32?>]
: The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.[MinimumSize <Int32?>]
: The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
[DisplayName <String>]
: The display name of the rule.[Exceptions <IMicrosoftGraphMessageRulePredicates>]
: messageRulePredicates[HasError <Boolean?>]
: Indicates whether the rule is in an error condition. Read-only.[IsEnabled <Boolean?>]
: Indicates whether the rule is enabled to be applied to messages.[IsReadOnly <Boolean?>]
: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.[Sequence <Int32?>]
: Indicates the order in which the rule is executed, among other rules.
[Messages <IMicrosoftGraphMessage-
[]>]
: The collection of messages in the mailFolder.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The fileAttachment and itemAttachment attachments for the message.[BccRecipients <IMicrosoftGraphRecipient-
[]>]
: The Bcc: recipients for the message.[Body <IMicrosoftGraphItemBody>]
: itemBody[BodyPreview <String>]
: 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.[CcRecipients <IMicrosoftGraphRecipient-
[]>]
: The Cc: recipients for the message.[ConversationId <String>]
: The ID of the conversation the email belongs to.[ConversationIndex <Byte-
[]>]
: Indicates the position of the message within the conversation.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the message. Nullable.[Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag[From <IMicrosoftGraphRecipient>]
: recipient[HasAttachments <Boolean?>]
: 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 .[Importance <String>]
: importance[InferenceClassification <String>]
: inferenceClassificationType[InternetMessageHeaders <IMicrosoftGraphInternetMessageHeader-
[]>]
: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.[Name <String>]
: Represents the key in a key-value pair.[Value <String>]
: The value in a key-value pair.
[InternetMessageId <String>]
: The message ID in the format specified by RFC5322. Updatable only if isDraft is true.[IsDeliveryReceiptRequested <Boolean?>]
: Indicates whether a read receipt is requested for the message.[IsDraft <Boolean?>]
: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.[IsRead <Boolean?>]
: Indicates whether the message has been read.[IsReadReceiptRequested <Boolean?>]
: Indicates whether a read receipt is requested for the message.[Mentions <IMicrosoftGraphMention-
[]>]
: 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.[MentionsPreview <IMicrosoftGraphMentionsPreview>]
: mentionsPreview[(Any) <Object>]
: This indicates any property can be added to this object.[IsMentioned <Boolean?>]
: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the message. Nullable.[ParentFolderId <String>]
: The unique identifier for the message's parent mailFolder.[ReceivedDateTime <DateTime?>]
: The date and time the message was received. 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.[ReplyTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses to use when replying.[Sender <IMicrosoftGraphRecipient>]
: recipient[SentDateTime <DateTime?>]
: The date and time the message was sent. 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.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the message. Nullable.[Subject <String>]
: The subject of the message.[ToRecipients <IMicrosoftGraphRecipient-
[]>]
: The To: recipients for the message.[UniqueBody <IMicrosoftGraphItemBody>]
: itemBody[UnsubscribeData <String-
[]>]
: The valid entries parsed from the List-Unsubscribe header. This is the data for the mail command in the List-Unsubscribe header if UnsubscribeEnabled property is true.[UnsubscribeEnabled <Boolean?>]
: Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369.[WebLink <String>]
: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.[ParentFolderId <String>]
: The unique identifier for the mailFolder's parent mailFolder.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.[TotalItemCount <Int32?>]
: The number of items in the mailFolder.[UnreadItemCount <Int32?>]
: The number of items in the mailFolder marked as unread.[UserConfigurations <IMicrosoftGraphUserConfiguration-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[BinaryData <Byte-
[]>]
:
[WellKnownName <String>]
: 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.
[MailNickname <String>]
: 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).[MailboxSettings <IMicrosoftGraphMailboxSettings>]
: mailboxSettings[(Any) <Object>]
: This indicates any property can be added to this object.[ArchiveFolder <String>]
: Folder ID of an archive folder for the user. Read-only.[AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]
: automaticRepliesSetting[(Any) <Object>]
: This indicates any property can be added to this object.[ExternalAudience <String>]
: externalAudienceScope[ExternalReplyMessage <String>]
: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.[InternalReplyMessage <String>]
: The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.[ScheduledEndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ScheduledStartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: automaticRepliesStatus
[DateFormat <String>]
: The date format for the user's mailbox.[DelegateMeetingMessageDeliveryOptions <String>]
: delegateMeetingMessageDeliveryOptions[Language <IMicrosoftGraphLocaleInfo>]
: localeInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: A name representing the user's locale in natural language, for example, 'English (United States)'.[Locale <String>]
: 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.
[TimeFormat <String>]
: The time format for the user's mailbox.[TimeZone <String>]
: The default time zone for the user's mailbox.[UserPurpose <String>]
: userPurpose[UserPurposeV2 <String>]
: mailboxRecipientType[WorkingHours <IMicrosoftGraphWorkingHours>]
: workingHours[(Any) <Object>]
: This indicates any property can be added to this object.[DaysOfWeek <String-
[]>]
: The days of the week on which the user works.[EndTime <String>]
: The time of the day that the user stops working.[StartTime <String>]
: The time of the day that the user starts working.[TimeZone <IMicrosoftGraphTimeZoneBase>]
: timeZoneBase[(Any) <Object>]
: This indicates any property can be added to this object.[Name <String>]
: The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.
[ManagedAppLogCollectionRequests <IMicrosoftGraphManagedAppLogCollectionRequest-
[]>]
: Zero or more log collection requests triggered for the user.[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: DateTime of when the log upload request was completed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.[ManagedAppRegistrationId <String>]
: The unique identifier of the app instance for which diagnostic logs were collected. Read-only.[RequestedBy <String>]
: The user principal name associated with the request for the managed application log collection. Read-only.[RequestedByUserPrincipalName <String>]
: The user principal name associated with the request for the managed application log collection. Read-only.[RequestedDateTime <DateTime?>]
: DateTime of when the log upload request was received. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.[Status <String>]
: Indicates the status for the app log collection request - pending, completed or failed. Default is pending.[UploadedLogs <IMicrosoftGraphManagedAppLogUpload-
[]>]
: The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs. Read-only.[ManagedAppComponent <String>]
: The Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. Read-only.[ManagedAppComponentDescription <String>]
: The Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. Read-only.[ReferenceId <String>]
: A provider-specific reference id for the uploaded logs. Read-only.[Status <ManagedAppLogUploadState?>]
: Represents the current status of the associated `managedAppLogCollectionRequest`.
[UserLogUploadConsent <ManagedAppLogUploadConsent?>]
: Represents the current consent status of the associated `managedAppLogCollectionRequest`.[Version <String>]
: Version of the entity.
[ManagedAppRegistrations <IMicrosoftGraphManagedAppRegistration-
[]>]
: Zero or more managed app registrations that belong to the user.[Id <String>]
: The unique identifier for an entity. Read-only.[AppIdentifier <IMicrosoftGraphMobileAppIdentifier>]
: The identifier for a mobile app.[(Any) <Object>]
: This indicates any property can be added to this object.
[ApplicationVersion <String>]
: App version[AppliedPolicies <IMicrosoftGraphManagedAppPolicy-
[]>]
: Zero or more policys already applied on the registered app when it last synchronized with managment service.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The date and time the policy was created.[Description <String>]
: The policy's description.[DisplayName <String>]
: Policy display name.[LastModifiedDateTime <DateTime?>]
: Last time the policy was modified.[RoleScopeTagIds <String-
[]>]
: List of Scope Tags for this Entity instance.[Version <String>]
: Version of the entity.
[AzureAdDeviceId <String>]
: The Azure Active Directory Device identifier of the host device. Value could be empty even when the host device is Azure Active Directory registered.[CreatedDateTime <DateTime?>]
: Date and time of creation[DeviceManufacturer <String>]
: The device manufacturer for the current app registration[DeviceModel <String>]
: The device model for the current app registration[DeviceName <String>]
: Host device name[DeviceTag <String>]
: App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.[DeviceType <String>]
: Host device type[FlaggedReasons <ManagedAppFlaggedReason-
[]>]
: Zero or more reasons an app registration is flagged. E.g. app running on rooted device[IntendedPolicies <IMicrosoftGraphManagedAppPolicy-
[]>]
: Zero or more policies admin intended for the app as of now.[LastSyncDateTime <DateTime?>]
: Date and time of last the app synced with management service.[ManagedAppLogCollectionRequests <IMicrosoftGraphManagedAppLogCollectionRequest-
[]>]
: Zero or more log collection requests triggered for the app.[ManagedDeviceId <String>]
: The Managed Device identifier of the host device. Value could be empty even when the host device is managed.[ManagementSdkVersion <String>]
: App management SDK version[Operations <IMicrosoftGraphManagedAppOperation-
[]>]
: Zero or more long running operations triggered on the app registration.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The operation name.[LastModifiedDateTime <DateTime?>]
: The last time the app operation was modified.[State <String>]
: The current state of the operation[Version <String>]
: Version of the entity.
[PlatformVersion <String>]
: Operating System version[UserId <String>]
: The user Id to who this app registration belongs.[Version <String>]
: Version of the entity.
[ManagedDevices <IMicrosoftGraphManagedDevice-
[]>]
: The managed devices associated with the user.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentFilterEvaluationStatusDetails <IMicrosoftGraphAssignmentFilterEvaluationStatusDetails-
[]>]
: Managed device mobile app configuration states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[PayloadId <String>]
: PayloadId on which filter has been applied.
[ChassisType <ChassisType?>]
: Chassis type.[ChromeOSDeviceInfo <IMicrosoftGraphChromeOSDeviceProperty-
[]>]
: 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.[Name <String>]
: Name of the property[Updatable <Boolean?>]
: Whether this property is updatable[Value <String>]
: Value of the property[ValueType <String>]
: Type of the value
[CloudPcRemoteActionResults <IMicrosoftGraphCloudPcRemoteActionResult-
[]>]
:[ComplianceState <ComplianceState?>]
: Compliance state.[ConfigurationManagerClientEnabledFeatures <IMicrosoftGraphConfigurationManagerClientEnabledFeatures>]
: configuration Manager client enabled features[(Any) <Object>]
: This indicates any property can be added to this object.[CompliancePolicy <Boolean?>]
: Whether compliance policy is managed by Intune[DeviceConfiguration <Boolean?>]
: Whether device configuration is managed by Intune[EndpointProtection <Boolean?>]
: Whether Endpoint Protection is managed by Intune[Inventory <Boolean?>]
: Whether inventory is managed by Intune[ModernApps <Boolean?>]
: Whether modern application is managed by Intune[OfficeApps <Boolean?>]
: Whether Office application is managed by Intune[ResourceAccess <Boolean?>]
: Whether resource access is managed by Intune[WindowsUpdateForBusiness <Boolean?>]
: Whether Windows Update for Business is managed by Intune
[ConfigurationManagerClientHealthState <IMicrosoftGraphConfigurationManagerClientHealthState>]
: Configuration manager client health state[(Any) <Object>]
: This indicates any property can be added to this object.[ErrorCode <Int32?>]
: Error code for failed state.[LastSyncDateTime <DateTime?>]
: Datetime for last sync with configuration manager management point.[State <ConfigurationManagerClientState?>]
: Configuration manager client state
[ConfigurationManagerClientInformation <IMicrosoftGraphConfigurationManagerClientInformation>]
: Configuration Manager client information synced from SCCM[(Any) <Object>]
: This indicates any property can be added to this object.[ClientIdentifier <String>]
: Configuration Manager Client Id from SCCM[ClientVersion <String>]
: Configuration Manager Client version from SCCM[IsBlocked <Boolean?>]
: Configuration Manager Client blocked status from SCCM
[DetectedApps <IMicrosoftGraphDetectedApp-
[]>]
: All applications currently installed on the device[Id <String>]
: The unique identifier for an entity. Read-only.[DeviceCount <Int32?>]
: The number of devices that have installed this application[DisplayName <String>]
: Name of the discovered application. Read-only[ManagedDevices <IMicrosoftGraphManagedDevice-
[]>]
: The devices that have the discovered application installed[Platform <DetectedAppPlatformType?>]
: Indicates the operating system / platform of the discovered application. Some possible values are Windows, iOS, macOS. The default value is unknown (0).[Publisher <String>]
: Indicates the publisher of the discovered application. For example: 'Microsoft'. The default value is an empty string.[SizeInByte <Int64?>]
: Discovered application size in bytes. Read-only[Version <String>]
: Version of the discovered application. Read-only
[DeviceCategory <IMicrosoftGraphDeviceCategory>]
: 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.[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Optional description for the device category.[DisplayName <String>]
: Display name for the device category.[RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the device category.
[DeviceCompliancePolicyStates <IMicrosoftGraphDeviceCompliancePolicyState-
[]>]
: Device compliance policy states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the policy for this policyBase[PlatformType <PolicyPlatformType?>]
: Supported platform types for policies.[SettingCount <Int32?>]
: Count of how many setting a policy holds[SettingStates <IMicrosoftGraphDeviceCompliancePolicySettingState-
[]>]
:[CurrentValue <String>]
: Current value of setting on device[ErrorCode <Int64?>]
: Error code for the setting[ErrorDescription <String>]
: Error description[InstanceDisplayName <String>]
: Name of setting instance that is being reported.[Setting <String>]
: The setting that is being reported[SettingInstanceId <String>]
: SettingInstanceId[SettingName <String>]
: Localized/user friendly setting name that is being reported[Sources <IMicrosoftGraphSettingSource-
[]>]
: Contributing policies[DisplayName <String>]
:[Id <String>]
:[SourceType <String>]
: settingSourceType
[State <String>]
: complianceStatus[UserEmail <String>]
: UserEmail[UserId <String>]
: UserId[UserName <String>]
: UserName[UserPrincipalName <String>]
: UserPrincipalName.
[State <String>]
: complianceStatus[UserId <String>]
: User unique identifier, must be Guid[UserPrincipalName <String>]
: User Principal Name[Version <Int32?>]
: The version of the policy
[DeviceConfigurationStates <IMicrosoftGraphDeviceConfigurationState-
[]>]
: Device configuration states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the policy for this policyBase[PlatformType <PolicyPlatformType?>]
: Supported platform types for policies.[SettingCount <Int32?>]
: Count of how many setting a policy holds[SettingStates <IMicrosoftGraphDeviceConfigurationSettingState-
[]>]
:[CurrentValue <String>]
: Current value of setting on device[ErrorCode <Int64?>]
: Error code for the setting[ErrorDescription <String>]
: Error description[InstanceDisplayName <String>]
: Name of setting instance that is being reported.[Setting <String>]
: The setting that is being reported[SettingInstanceId <String>]
: SettingInstanceId[SettingName <String>]
: Localized/user friendly setting name that is being reported[Sources <IMicrosoftGraphSettingSource-
[]>]
: Contributing policies[State <String>]
: complianceStatus[UserEmail <String>]
: UserEmail[UserId <String>]
: UserId[UserName <String>]
: UserName[UserPrincipalName <String>]
: UserPrincipalName.
[State <String>]
: complianceStatus[UserId <String>]
: User unique identifier, must be Guid[UserPrincipalName <String>]
: User Principal Name[Version <Int32?>]
: The version of the policy
[DeviceEnrollmentType <DeviceEnrollmentType?>]
: Possible ways of adding a mobile device to management.[DeviceFirmwareConfigurationInterfaceManaged <Boolean?>]
: 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 <IMicrosoftGraphDeviceHealthAttestationState>]
: deviceHealthAttestationState[(Any) <Object>]
: This indicates any property can be added to this object.[AttestationIdentityKey <String>]
: TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.[BitLockerStatus <String>]
: On or Off of BitLocker Drive Encryption[BootAppSecurityVersion <String>]
: The security version number of the Boot Application[BootDebugging <String>]
: When bootDebugging is enabled, the device is used in development and testing[BootManagerSecurityVersion <String>]
: The security version number of the Boot Application[BootManagerVersion <String>]
: The version of the Boot Manager[BootRevisionListInfo <String>]
: The Boot Revision List that was loaded during initial boot on the attested device[CodeIntegrity <String>]
: When code integrity is enabled, code execution is restricted to integrity verified code[CodeIntegrityCheckVersion <String>]
: The version of the Boot Manager[CodeIntegrityPolicy <String>]
: The Code Integrity policy that is controlling the security of the boot environment[ContentNamespaceUrl <String>]
: The DHA report version. (Namespace version)[ContentVersion <String>]
: The HealthAttestation state schema version[DataExcutionPolicy <String>]
: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory[DeviceHealthAttestationStatus <String>]
: The DHA report version. (Namespace version)[EarlyLaunchAntiMalwareDriverProtection <String>]
: ELAM provides protection for the computers in your network when they start up[FirmwareProtection <FirmwareProtectionType?>]
: A list of possible Firmware protection type for a device. Firmware protection is a set of features that helps to ensure attackers can't get your device to start with untrusted or malicious firmware. Firmware protection type is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "systemGuardSecureLaunch" or "firmwareAttackSurfaceReduction" or "disabled". Windows 10 devices will have value "notApplicable".[HealthAttestationSupportedStatus <String>]
: This attribute indicates if DHA is supported for the device[HealthStatusMismatchInfo <String>]
: This attribute appears if DHA-Service detects an integrity issue[IssuedDateTime <DateTime?>]
: The DateTime when device was evaluated or issued to MDM[LastUpdateDateTime <String>]
: The Timestamp of the last update.[MemoryAccessProtection <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[MemoryIntegrityProtection <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[OperatingSystemKernelDebugging <String>]
: When operatingSystemKernelDebugging is enabled, the device is used in development and testing[OperatingSystemRevListInfo <String>]
: The Operating System Revision List that was loaded during initial boot on the attested device[Pcr0 <String>]
: The measurement that is captured in PCR-[0]
[PcrHashAlgorithm <String>]
: Informational attribute that identifies the HASH algorithm that was used by TPM[ResetCount <Int64?>]
: The number of times a PC device has hibernated or resumed[RestartCount <Int64?>]
: The number of times a PC device has rebooted[SafeMode <String>]
: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state[SecureBoot <String>]
: When Secure Boot is enabled, the core components must have the correct cryptographic signatures[SecureBootConfigurationPolicyFingerPrint <String>]
: Fingerprint of the Custom Secure Boot Configuration Policy[SecuredCorePc <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[SystemManagementMode <SystemManagementModeLevel?>]
: A list of possible System Management Mode levels for a device. System Management Mode levels is determined by report sent from Microsoft Azure Attestation service. Only specific hardwares support System Management Mode. Windows 11 devices will have values "notApplicable", "level1", "level2" or "level3". Windows 10 devices will have value "notApplicable".[TestSigning <String>]
: When test signing is allowed, the device does not enforce signature validation during boot[TpmVersion <String>]
: The security version number of the Boot Application[VirtualSecureMode <String>]
: Indicates whether the device has Virtual Secure Mode (VSM) enabled. Virtual Secure Mode (VSM) is a container that protects high value assets from a compromised kernel. This property will be deprecated in beta from August 2023. Support for this property will end in August 2025 for v1.0 API. A new property virtualizationBasedSecurity is added and used instead. The value used for virtualSecureMode will be passed by virtualizationBasedSecurity during the deprecation process. Possible values are 'enabled', 'disabled' and 'notApplicable'. 'enabled' indicates Virtual Secure Mode (VSM) is enabled. 'disabled' indicates Virtual Secure Mode (VSM) is disabled. 'notApplicable' indicates the device is not a Windows 11 device. Default value is 'notApplicable'.[VirtualizationBasedSecurity <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[WindowsPe <String>]
: Operating system running with limited services that is used to prepare a computer for Windows
[DeviceHealthScriptStates <IMicrosoftGraphDeviceHealthScriptPolicyState-
[]>]
: Results of device health scripts that ran for this device. Default is empty list. This property is read-only.[AssignmentFilterIds <String-
[]>]
: A list of the assignment filter ids used for health script applicability evaluation[DetectionState <RunState?>]
: Indicates the type of execution status of the device management script.[DeviceId <String>]
: The Intune device Id[DeviceName <String>]
: Display name of the device[ExpectedStateUpdateDateTime <DateTime?>]
: The next timestamp of when the device health script is expected to execute[Id <String>]
: Key of the device health script policy state is a concatenation of the MT sideCar policy Id and Intune device Id[LastStateUpdateDateTime <DateTime?>]
: The last timestamp of when the device health script executed[LastSyncDateTime <DateTime?>]
: The last time that Intune Managment Extension synced with Intune[OSVersion <String>]
: Value of the OS Version in string[PolicyId <String>]
: The MT sideCar policy Id[PolicyName <String>]
: Display name of the device health script[PostRemediationDetectionScriptError <String>]
: Error from the detection script after remediation[PostRemediationDetectionScriptOutput <String>]
: Detection script output after remediation[PreRemediationDetectionScriptError <String>]
: Error from the detection script before remediation[PreRemediationDetectionScriptOutput <String>]
: Output of the detection script before remediation[RemediationScriptError <String>]
: Error output of the remediation script[RemediationState <RemediationState?>]
: Indicates the type of execution status of the device management script.[UserName <String>]
: Name of the user whom ran the device health script
[DeviceRegistrationState <DeviceRegistrationState?>]
: Device registration status.[DeviceType <DeviceType?>]
: Device type.[ExchangeAccessState <DeviceManagementExchangeAccessState?>]
: Device Exchange Access State.[ExchangeAccessStateReason <DeviceManagementExchangeAccessStateReason?>]
: Device Exchange Access State Reason.[HardwareInformation <IMicrosoftGraphHardwareInformation>]
: Hardware information of a given device.[(Any) <Object>]
: This indicates any property can be added to this object.[BatteryChargeCycles <Int32?>]
: The number of charge cycles the device's current battery has gone through. Valid values 0 to 2147483647[BatteryHealthPercentage <Int32?>]
: The device's current battery's health percentage. Valid values 0 to 100[BatteryLevelPercentage <Double?>]
: 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[BatterySerialNumber <String>]
: The serial number of the device's current battery[CellularTechnology <String>]
: Cellular technology of the device[DeviceFullQualifiedDomainName <String>]
: Returns the fully qualified domain name of the device (if any). If the device is not domain-joined, it returns an empty string.[DeviceGuardLocalSystemAuthorityCredentialGuardState <DeviceGuardLocalSystemAuthorityCredentialGuardState?>]
: deviceGuardLocalSystemAuthorityCredentialGuardState[DeviceGuardVirtualizationBasedSecurityHardwareRequirementState <DeviceGuardVirtualizationBasedSecurityHardwareRequirementState?>]
: deviceGuardVirtualizationBasedSecurityHardwareRequirementState[DeviceGuardVirtualizationBasedSecurityState <DeviceGuardVirtualizationBasedSecurityState?>]
: deviceGuardVirtualizationBasedSecurityState[DeviceLicensingLastErrorCode <Int32?>]
: 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[DeviceLicensingLastErrorDescription <String>]
: 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.[DeviceLicensingStatus <DeviceLicensingStatus?>]
: Indicates the device licensing status after Windows device based subscription has been enabled.[EsimIdentifier <String>]
: eSIM identifier[FreeStorageSpace <Int64?>]
: Free storage space of the device.[IPAddressV4 <String>]
: IPAddressV4[Imei <String>]
: IMEI[IsEncrypted <Boolean?>]
: Encryption status of the device[IsSharedDevice <Boolean?>]
: Shared iPad[IsSupervised <Boolean?>]
: Supervised mode of the device[Manufacturer <String>]
: Manufacturer of the device[Meid <String>]
: MEID[Model <String>]
: Model of the device[OSBuildNumber <String>]
: Operating System Build Number on Android device[OperatingSystemEdition <String>]
: String that specifies the OS edition.[OperatingSystemLanguage <String>]
: Operating system language of the device[OperatingSystemProductType <Int32?>]
: Int that specifies the Windows Operating System ProductType. More details here https://go.microsoft.com/fwlink/?linkid=2126950. Valid values 0 to 2147483647[PhoneNumber <String>]
: Phone number of the device[ProductName <String>]
: 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.[ResidentUsersCount <Int32?>]
: 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[SerialNumber <String>]
: Serial number.[SharedDeviceCachedUsers <IMicrosoftGraphSharedAppleDeviceUser-
[]>]
: All users on the shared Apple device[DataQuota <Int64?>]
: Data quota[DataToSync <Boolean?>]
: Data to sync[DataUsed <Int64?>]
: Data quota[UserPrincipalName <String>]
: User name
[SubnetAddress <String>]
: SubnetAddress[SubscriberCarrier <String>]
: Subscriber carrier of the device[SystemManagementBiosVersion <String>]
: BIOS version as reported by SMBIOS[TotalStorageSpace <Int64?>]
: Total storage space of the device.[TpmManufacturer <String>]
: The identifying information that uniquely names the TPM manufacturer[TpmSpecificationVersion <String>]
: String that specifies the specification version.[TpmVersion <String>]
: The version of the TPM, as specified by the manufacturer[WifiMac <String>]
: WiFi MAC address of the device[WiredIPv4Addresses <String-
[]>]
: 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.
[JoinType <JoinType?>]
: Device enrollment join type.[LogCollectionRequests <IMicrosoftGraphDeviceLogCollectionResponse-
[]>]
: List of log collection requests[Id <String>]
: The unique identifier for an entity. Read-only.[EnrolledByUser <String>]
: The User Principal Name (UPN) of the user that enrolled the device.[ErrorCode <Int64?>]
: The error code, if any. Valid values -9.22337203685478E+18 to 9.22337203685478E+18[ExpirationDateTimeUtc <DateTime?>]
: The DateTime of the expiration of the logs.[InitiatedByUserPrincipalName <String>]
: The UPN for who initiated the request.[ManagedDeviceId <String>]
: Indicates Intune device unique identifier.[ReceivedDateTimeUtc <DateTime?>]
: The DateTime the request was received.[RequestedDateTimeUtc <DateTime?>]
: The DateTime of the request.[Size <Double?>]
: The size of the logs. Valid values -1.79769313486232E+308 to 1.79769313486232E+308[SizeInKb <Double?>]
: The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308[Status <AppLogUploadState?>]
: AppLogUploadStatus
[LostModeState <LostModeState?>]
: State of lost mode, indicating if lost mode is enabled or disabled[ManagedDeviceMobileAppConfigurationStates <IMicrosoftGraphManagedDeviceMobileAppConfigurationState-
[]>]
: Managed device mobile app configuration states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the policy for this policyBase[PlatformType <PolicyPlatformType?>]
: Supported platform types for policies.[SettingCount <Int32?>]
: Count of how many setting a policy holds[SettingStates <IMicrosoftGraphManagedDeviceMobileAppConfigurationSettingState-
[]>]
:[CurrentValue <String>]
: Current value of setting on device[ErrorCode <Int64?>]
: Error code for the setting[ErrorDescription <String>]
: Error description[InstanceDisplayName <String>]
: Name of setting instance that is being reported.[Setting <String>]
: The setting that is being reported[SettingInstanceId <String>]
: SettingInstanceId[SettingName <String>]
: Localized/user friendly setting name that is being reported[Sources <IMicrosoftGraphSettingSource-
[]>]
: Contributing policies[State <String>]
: complianceStatus[UserEmail <String>]
: UserEmail[UserId <String>]
: UserId[UserName <String>]
: UserName[UserPrincipalName <String>]
: UserPrincipalName.
[State <String>]
: complianceStatus[UserId <String>]
: User unique identifier, must be Guid[UserPrincipalName <String>]
: User Principal Name[Version <Int32?>]
: The version of the policy
[ManagedDeviceName <String>]
: Automatically generated name to identify a device. Can be overwritten to a user friendly name.[ManagedDeviceOwnerType <ManagedDeviceOwnerType?>]
: Owner type of device.[ManagementAgent <ManagementAgentType?>]
: Management agent type.[ManagementFeatures <ManagedDeviceManagementFeatures?>]
: Device management features.[ManagementState <ManagementState?>]
: Management state of device in Microsoft Intune.[Notes <String>]
: Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.[OwnerType <OwnerType?>]
: Owner type of device.[PartnerReportedThreatState <ManagedDevicePartnerReportedHealthState?>]
: Available health states for the Device Health API[ProcessorArchitecture <ManagedDeviceArchitecture?>]
: Processor architecture[RoleScopeTagIds <String-
[]>]
: List of Scope Tag IDs for this Device instance.[SecurityBaselineStates <IMicrosoftGraphSecurityBaselineState-
[]>]
: Security baseline states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the security baseline[SecurityBaselineTemplateId <String>]
: The security baseline template id[SettingStates <IMicrosoftGraphSecurityBaselineSettingState-
[]>]
: The security baseline state for different settings for a device[Id <String>]
: The unique identifier for an entity. Read-only.[ContributingPolicies <IMicrosoftGraphSecurityBaselineContributingPolicy-
[]>]
: The policies that contribute to this setting instance[DisplayName <String>]
: Name of the policy[SourceId <String>]
: Unique identifier of the policy[SourceType <String>]
: Authoring source of a policy
[ErrorCode <String>]
: The error code if the setting is in error state[SettingCategoryId <String>]
: The setting category id which this setting belongs to[SettingCategoryName <String>]
: The setting category name which this setting belongs to[SettingId <String>]
: The setting id guid[SettingName <String>]
: The setting name that is being reported[SourcePolicies <IMicrosoftGraphSettingSource-
[]>]
: The policies that contribute to this setting instance[State <SecurityBaselineComplianceState?>]
: Security Baseline Compliance State
[State <SecurityBaselineComplianceState?>]
: Security Baseline Compliance State[UserPrincipalName <String>]
: User Principal Name
[SkuFamily <String>]
: Device sku family[Users <IMicrosoftGraphUser-
[]>]
: The primary users associated with the managed device.[WindowsProtectionState <IMicrosoftGraphWindowsProtectionState>]
: Device protection status entity.[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AntiMalwareVersion <String>]
: Current anti malware version[DetectedMalwareState <IMicrosoftGraphWindowsDeviceMalwareState-
[]>]
: Device malware list[Id <String>]
: The unique identifier for an entity. Read-only.[AdditionalInformationUrl <String>]
: Information URL to learn more about the malware[Category <WindowsMalwareCategory?>]
: Malware category id[DetectionCount <Int32?>]
: Number of times the malware is detected[DisplayName <String>]
: Malware name[ExecutionState <WindowsMalwareExecutionState?>]
: Malware execution status[InitialDetectionDateTime <DateTime?>]
: Initial detection datetime of the malware[LastStateChangeDateTime <DateTime?>]
: The last time this particular threat was changed[Severity <WindowsMalwareSeverity?>]
: Malware severity[State <WindowsMalwareState?>]
: Malware current status[ThreatState <WindowsMalwareThreatState?>]
: Malware threat status
[DeviceState <WindowsDeviceHealthState?>]
: Computer endpoint protection state[EngineVersion <String>]
: Current endpoint protection engine's version[FullScanOverdue <Boolean?>]
: When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.[FullScanRequired <Boolean?>]
: When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.[IsVirtualMachine <Boolean?>]
: 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.[LastFullScanDateTime <DateTime?>]
: Last quick scan datetime[LastFullScanSignatureVersion <String>]
: Last full scan signature version[LastQuickScanDateTime <DateTime?>]
: Last quick scan datetime[LastQuickScanSignatureVersion <String>]
: Last quick scan signature version[LastReportedDateTime <DateTime?>]
: Last device health status reported time[MalwareProtectionEnabled <Boolean?>]
: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.[NetworkInspectionSystemEnabled <Boolean?>]
: When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.[ProductStatus <WindowsDefenderProductStatus?>]
: Product Status of Windows Defender[QuickScanOverdue <Boolean?>]
: When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.[RealTimeProtectionEnabled <Boolean?>]
: When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.[RebootRequired <Boolean?>]
: When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.[SignatureUpdateOverdue <Boolean?>]
: When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.[SignatureVersion <String>]
: Current malware definitions version[TamperProtectionEnabled <Boolean?>]
: 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.
[Manager <IMicrosoftGraphDirectoryObject>]
: directoryObject[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: The groups, directory roles, and administrative units that the user is a member of. Read-only. Nullable. Supports $expand.[Messages <IMicrosoftGraphMessage-
[]>]
: The messages in a mailbox or folder. Read-only. Nullable.[MobileAppIntentAndStates <IMicrosoftGraphMobileAppIntentAndState-
[]>]
: The list of troubleshooting events for this user.[Id <String>]
: The unique identifier for an entity. Read-only.[ManagedDeviceIdentifier <String>]
: Device identifier created or collected by Intune.[MobileAppList <IMicrosoftGraphMobileAppIntentAndStateDetail-
[]>]
: The list of payload intents and states for the tenant.[ApplicationId <String>]
: MobieApp identifier.[DisplayName <String>]
: The admin provided or imported title of the app.[DisplayVersion <String>]
: Human readable version of the application[InstallState <ResultantAppState?>]
: A list of possible states for application status on an individual device. When devices contact the Intune service and find targeted application enforcement intent, the status of the enforcement is recorded and becomes accessible in the Graph API. Since the application status is identified during device interaction with the Intune service, status records do not immediately appear upon application group assignment; it is created only after the assignment is evaluated in the service and devices start receiving the policy during check-ins.[MobileAppIntent <MobileAppIntent?>]
: Indicates the status of the mobile app on the device.[SupportedDeviceTypes <IMicrosoftGraphMobileAppSupportedDeviceType-
[]>]
: The supported platforms for the app.[MaximumOperatingSystemVersion <String>]
: Maximum OS version[MinimumOperatingSystemVersion <String>]
: Minimum OS version[Type <DeviceType?>]
: Device type.
[UserId <String>]
: Identifier for the user that tried to enroll the device.
[MobileAppTroubleshootingEvents <IMicrosoftGraphMobileAppTroubleshootingEvent-
[]>]
: The list of mobile app troubleshooting events for this user.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event[CorrelationId <String>]
: Id used for tracing the failure in the service.[EventDateTime <DateTime?>]
: Time when the event occurred .[EventName <String>]
: Event Name corresponding to the Troubleshooting Event. It is an Optional field[TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.[Id <String>]
: The unique identifier for an entity. Read-only.[AppLogCollectionRequests <IMicrosoftGraphAppLogCollectionRequest-
[]>]
: The collection property of AppLogUploadRequest.[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: Time at which the upload log request reached a completed state if not completed yet NULL will be returned.[CustomLogFolders <String-
[]>]
: List of log folders.[ErrorMessage <String>]
: Indicates error message if any during the upload process.[Status <AppLogUploadState?>]
: AppLogUploadStatus
[ApplicationId <String>]
: Intune application identifier.[DeviceId <String>]
: Device identifier created or collected by Intune.[History <IMicrosoftGraphMobileAppTroubleshootingHistoryItem-
[]>]
: Intune Mobile Application Troubleshooting History Item[OccurrenceDateTime <DateTime?>]
: Time when the history item occurred.[TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
[ManagedDeviceIdentifier <String>]
: Device identifier created or collected by Intune.[UserId <String>]
: Identifier for the user that tried to enroll the device.
[MobilePhone <String>]
: 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.[MySite <String>]
: The URL for the user's site. Returned only on $select.[Notifications <IMicrosoftGraphNotification-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayTimeToLive <Int32?>]
: Sets how long (in seconds) this notification content stays in each platform's notification viewer. For example, when the notification is delivered to a Windows device, the value of this property is passed on to ToastNotification.ExpirationTime, which determines how long the toast notification stays in the user's Windows Action Center.[ExpirationDateTime <DateTime?>]
: Sets a UTC expiration date and time on a user notification using ISO 8601 format (for example, midnight UTC on Jan 1, 2019 would look like this: '2019-01-01T00:00:00Z'). When time is up, the notification is removed from the Microsoft Graph notification feed store completely and is no longer part of notification history. Max value is 30 days.[GroupName <String>]
: The name of the group that this notification belongs to. It is set by the developer for grouping notifications together.[Payload <IMicrosoftGraphPayloadTypes>]
: payloadTypes[(Any) <Object>]
: This indicates any property can be added to this object.[RawContent <String>]
: 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.[VisualContent <IMicrosoftGraphVisualProperties>]
: visualProperties[(Any) <Object>]
: This indicates any property can be added to this object.[Body <String>]
: The body of a visual user notification. Body is optional.[Title <String>]
: The title of a visual user notification. This field is required for visual notification payloads.
[Priority <String>]
: priority[TargetHostName <String>]
: Represents the host name of the app to which the calling service wants to post the notification, for the given user. If targeting web endpoints (see targetPolicy.platformTypes), ensure that targetHostName is the same as the name used when creating a subscription on the client side within the application JSON property.[TargetPolicy <IMicrosoftGraphTargetPolicyEndpoints>]
: targetPolicyEndpoints[(Any) <Object>]
: This indicates any property can be added to this object.[PlatformTypes <String-
[]>]
: 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.
[Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
:[OfficeLocation <String>]
: The office location in the user's place of business. Maximum length is 128 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[OnPremisesDistinguishedName <String>]
: 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.[OnPremisesDomainName <String>]
: 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.[OnPremisesExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes[OnPremisesImmutableId <String>]
: 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).[OnPremisesLastSyncDateTime <DateTime?>]
: 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).[OnPremisesProvisioningErrors <IMicrosoftGraphOnPremisesProvisioningError-
[]>]
: Errors when using Microsoft synchronization product during provisioning. Supports $filter (eq, not, ge, le).[OnPremisesSamAccountName <String>]
: 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).[OnPremisesSecurityIdentifier <String>]
: 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).[OnPremisesSipInfo <IMicrosoftGraphOnPremisesSipInfo>]
: onPremisesSipInfo[(Any) <Object>]
: This indicates any property can be added to this object.[IsSipEnabled <Boolean?>]
: Indicates whether the user is currently enabled for on-premises Skype for Business.[SipDeploymentLocation <String>]
: Indicates a fully qualified DNS name of the Microsoft Online Communications Server deployment.[SipPrimaryAddress <String>]
: Serves as a unique identifier for each user on the on-premises Skype for Business.
[OnPremisesSyncEnabled <Boolean?>]
: 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).[OnPremisesUserPrincipalName <String>]
: 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).[Onenote <IMicrosoftGraphOnenote>]
: onenote[OnlineMeetings <IMicrosoftGraphOnlineMeeting-
[]>]
: Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.[AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.[AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.[AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.[AllowLiveShare <String>]
: meetingLiveShareOptions[AllowMeetingChat <String>]
: meetingChatMode[AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.[AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.[AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.[AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.[AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.[AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.[AllowedPresenters <String>]
: onlineMeetingPresenters[AnonymizeIdentityForRoles <String-
[]>]
: 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.[AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[AttendanceRecords <IMicrosoftGraphAttendanceRecord-
[]>]
: List of attendance records of an attendance report. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[AttendanceIntervals <IMicrosoftGraphAttendanceInterval-
[]>]
: List of time periods between joining and leaving a meeting.[DurationInSeconds <Int32?>]
: Duration of the meeting interval in seconds; that is, the difference between joinDateTime and leaveDateTime.[JoinDateTime <DateTime?>]
: The time the attendee joined in UTC.[LeaveDateTime <DateTime?>]
: The time the attendee left in UTC.
[EmailAddress <String>]
: Email address of the user associated with this attendance record.[Identity <IMicrosoftGraphIdentity>]
: identity[RegistrantId <String>]
: Unique identifier of a meetingRegistrant. Presents when the participant has registered for the meeting. (deprecated)[Role <String>]
: Role of the attendee. Possible values are: None, Attendee, Presenter, and Organizer.[TotalAttendanceInSeconds <Int32?>]
: Total duration of the attendances in seconds.
[MeetingEndDateTime <DateTime?>]
: UTC time when the meeting ended. Read-only.[MeetingStartDateTime <DateTime?>]
: UTC time when the meeting started. Read-only.[TotalParticipantCount <Int32?>]
: Total number of participants. Read-only.
[AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The conference id of the online meeting.[DialinUrl <String>]
: A URL to the externally-accessible web page that contains dial-in information.[TollFreeNumber <String>]
: The toll-free number that connects to the Audio Conference Provider.[TollFreeNumbers <String-
[]>]
: List of toll-free numbers that are displayed in the meeting invite.[TollNumber <String>]
: The toll number that connects to the Audio Conference Provider.[TollNumbers <String-
[]>]
: List of toll numbers that are displayed in the meeting invite.
[ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo[(Any) <Object>]
: This indicates any property can be added to this object.[MessageId <String>]
: The unique identifier for a message in a Microsoft Teams channel.[ReplyChainMessageId <String>]
: The ID of the reply message.[ThreadId <String>]
: The unique identifier for a thread in Microsoft Teams.
[ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions[(Any) <Object>]
: This indicates any property can be added to this object.[AllowTextOnly <Boolean?>]
: Indicates whether only text is allowed in the meeting chat. Optional.
[IsEndToEndEncryptionEnabled <Boolean?>]
:[IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.[JoinInformation <IMicrosoftGraphItemBody>]
: itemBody[JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsPasscodeRequired <Boolean?>]
: Indicates whether a passcode is required to join a meeting when using joinMeetingId. Optional.[JoinMeetingId <String>]
: The meeting ID to be used to join a meeting. Optional. Read-only.[Passcode <String>]
: The passcode to join a meeting. Optional. Read-only.
[JoinWebUrl <String>]
: The join URL of the online meeting. Read-only.[LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsDialInBypassEnabled <Boolean?>]
: Specifies whether or not to always let dial-in callers bypass the lobby. Optional.[Scope <String>]
: lobbyBypassScope
[RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.[ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode[Subject <String>]
: The subject of the online meeting.[VideoTeleconferenceId <String>]
: The video teleconferencing ID. Read-only.[WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues[(Any) <Object>]
: This indicates any property can be added to this object.[IsEnabledForContentSharing <Boolean?>]
: Indicates whether to apply a watermark to any shared content.[IsEnabledForVideo <Boolean?>]
: Indicates whether to apply a watermark to everyone's video feed.
[Id <String>]
: The unique identifier for an entity. Read-only.[AiInsights <IMicrosoftGraphCallAiInsight-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ActionItems <IMicrosoftGraphActionItem-
[]>]
:[OwnerDisplayName <String>]
:[Text <String>]
:[Title <String>]
:
[CallId <String>]
:[ContentCorrelationId <String>]
:[CreatedDateTime <DateTime?>]
:[EndDateTime <DateTime?>]
:[MeetingNotes <IMicrosoftGraphMeetingNote-
[]>]
:[Subpoints <IMicrosoftGraphMeetingNoteSubpoint-
[]>]
:[Text <String>]
:[Title <String>]
:
[Text <String>]
:[Title <String>]
:
[Viewpoint <IMicrosoftGraphCallAiInsightViewPoint>]
: callAiInsightViewPoint[(Any) <Object>]
: This indicates any property can be added to this object.[MentionEvents <IMicrosoftGraphMentionEvent-
[]>]
:[EventDateTime <DateTime?>]
:[Speaker <IMicrosoftGraphIdentitySet>]
: identitySet[TranscriptUtterance <String>]
:
[AlternativeRecording <Byte-
[]>]
: The content stream of the alternative recording of a Microsoft Teams live event. Read-only.[AttendeeReport <Byte-
[]>]
: The content stream of the attendee report of a Teams live event. Read-only.[BroadcastRecording <Byte-
[]>]
:[BroadcastSettings <IMicrosoftGraphBroadcastMeetingSettings>]
: broadcastMeetingSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowedAudience <String>]
: broadcastMeetingAudience[Captions <IMicrosoftGraphBroadcastMeetingCaptionSettings>]
: broadcastMeetingCaptionSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsCaptionEnabled <Boolean?>]
: Indicates whether captions are enabled for this Teams live event.[SpokenLanguage <String>]
: The spoken language.[TranslationLanguages <String-
[]>]
: The translation languages (choose up to 6).
[IsAttendeeReportEnabled <Boolean?>]
: Indicates whether attendee report is enabled for this Teams live event. Default value is false.[IsQuestionAndAnswerEnabled <Boolean?>]
: Indicates whether Q&A is enabled for this Teams live event. Default value is false.[IsRecordingEnabled <Boolean?>]
: Indicates whether recording is enabled for this Teams live event. Default value is false.[IsVideoOnDemandEnabled <Boolean?>]
: Indicates whether video on demand is enabled for this Teams live event. Default value is false.
[Capabilities <String-
[]>]
: The list of meeting capabilities. Possible values are: questionAndAnswer,unknownFutureValue.[CreationDateTime <DateTime?>]
: The meeting creation time in UTC. Read-only.[EndDateTime <DateTime?>]
: The meeting end time in UTC. Required when you create an online meeting.[ExternalId <String>]
: The external ID. A custom ID. Optional.[IsBroadcast <Boolean?>]
: Indicates whether this event is a Teams live event.[JoinUrl <String>]
:[MeetingAttendanceReport <IMicrosoftGraphMeetingAttendanceReport>]
: meetingAttendanceReport[MeetingTemplateId <String>]
: The ID of the meeting template.[Participants <IMicrosoftGraphMeetingParticipants>]
: meetingParticipants[(Any) <Object>]
: This indicates any property can be added to this object.[Attendees <IMicrosoftGraphMeetingParticipantInfo-
[]>]
: Information of the meeting attendees.[Identity <IMicrosoftGraphIdentitySet>]
: identitySet[Role <String>]
: onlineMeetingRole[Upn <String>]
: User principal name of the participant.
[Contributors <IMicrosoftGraphMeetingParticipantInfo-
[]>]
: For broadcast meeting only.[Organizer <IMicrosoftGraphMeetingParticipantInfo>]
: meetingParticipantInfo[Producers <IMicrosoftGraphMeetingParticipantInfo-
[]>]
: For broadcast meeting only.
[Recording <Byte-
[]>]
: The content stream of the recording of a Teams live event. Read-only.[Recordings <IMicrosoftGraphCallRecording-
[]>]
: The recordings of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[CallId <String>]
: The unique identifier for the call that is related to this recording. Read-only.[Content <Byte-
[]>]
: The content of the recording. Read-only.[ContentCorrelationId <String>]
: The unique identifier that links the transcript with its corresponding recording. Read-only.[CreatedDateTime <DateTime?>]
: 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.[EndDateTime <DateTime?>]
: Date and time at which the recording ends. 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.[MeetingId <String>]
: The unique identifier of the onlineMeeting related to this recording. Read-only.[MeetingOrganizer <IMicrosoftGraphIdentitySet>]
: identitySet[RecordingContentUrl <String>]
: The URL that can be used to access the content of the recording. Read-only.
[Registration <IMicrosoftGraphMeetingRegistration>]
: meetingRegistration[(Any) <Object>]
: This indicates any property can be added to this object.[AllowedRegistrant <String>]
: meetingAudience[Registrants <IMicrosoftGraphMeetingRegistrantBase-
[]>]
: Registrants of the online meeting.[Id <String>]
: The unique identifier for an entity. Read-only.[JoinWebUrl <String>]
: A unique web URL for the registrant to join the meeting. Read-only.
[Id <String>]
: The unique identifier for an entity. Read-only.[CustomQuestions <IMicrosoftGraphMeetingRegistrationQuestion-
[]>]
: Custom registration questions.[Id <String>]
: The unique identifier for an entity. Read-only.[AnswerInputType <String>]
: answerInputType[AnswerOptions <String-
[]>]
: Answer options when answerInputType is radioButton.[DisplayName <String>]
: Display name of the custom registration question.[IsRequired <Boolean?>]
: Indicates whether the question is required. Default value is false.
[Description <String>]
: The description of the meeting.[EndDateTime <DateTime?>]
: The meeting end time in UTC.[RegistrationPageViewCount <Int32?>]
: The number of times the registration page has been visited. Read-only.[RegistrationPageWebUrl <String>]
: The URL of the registration page. Read-only.[Speakers <IMicrosoftGraphMeetingSpeaker-
[]>]
: The meeting speaker's information.[Bio <String>]
: Bio of the speaker.[DisplayName <String>]
: Display name of the speaker.
[StartDateTime <DateTime?>]
: The meeting start time in UTC.[Subject <String>]
: The subject of the meeting.
[StartDateTime <DateTime?>]
: The meeting start time in UTC. Required when you create an online meeting.[Transcripts <IMicrosoftGraphCallTranscript-
[]>]
: The transcripts of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[CallId <String>]
: The unique identifier for the call that is related to this transcript. Read-only.[Content <Byte-
[]>]
: The content of the transcript. Read-only.[ContentCorrelationId <String>]
: The unique identifier that links the transcript with its corresponding recording. Read-only.[CreatedDateTime <DateTime?>]
: Date and time at which the transcript 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.[EndDateTime <DateTime?>]
: Date and time at which the transcription ends. 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.[MeetingId <String>]
: The unique identifier of the online meeting related to this transcript. Read-only.[MeetingOrganizer <IMicrosoftGraphIdentitySet>]
: identitySet[MetadataContent <Byte-
[]>]
: The time-aligned metadata of the utterances in the transcript. Read-only.[TranscriptContentUrl <String>]
: The URL that can be used to access the content of the transcript. Read-only.
[OtherMails <String-
[]>]
: A list of additional email addresses for the user; for example: -['bob@contoso.com', 'Robert@fabrikam.com']
.NOTE: This property can't contain accent characters.Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).[Outlook <IMicrosoftGraphOutlookUser>]
: outlookUser[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[MasterCategories <IMicrosoftGraphOutlookCategory-
[]>]
: A list of categories defined for the user.[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: categoryColor[DisplayName <String>]
: A unique name that identifies a category in the user's mailbox. After a category is created, the name can't be changed. Read-only.
[TaskFolders <IMicrosoftGraphOutlookTaskFolder-
[]>]
: The user's Outlook task folders. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ChangeKey <String>]
: The version of the task folder.[IsDefaultFolder <Boolean?>]
: True if the folder is the default task folder.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the task folder. Read-only. Nullable.[Name <String>]
: The name of the task folder.[ParentGroupKey <String>]
: The unique GUID identifier for the task folder's parent group.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the task folder. Read-only. Nullable.[Tasks <IMicrosoftGraphOutlookTask-
[]>]
: The tasks in this task folder. Read-only. Nullable.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedTo <String>]
: The name of the person who has been assigned the task in Outlook. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the task. Read-only. Nullable.[Body <IMicrosoftGraphItemBody>]
: itemBody[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[HasAttachments <Boolean?>]
: Set to true if the task has attachments.[Importance <String>]
: importance[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the task.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the task. Read-only. Nullable.[Owner <String>]
: The name of the person who created the task.[ParentFolderId <String>]
: The unique identifier for the task's parent folder.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[ReminderDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Sensitivity <String>]
: sensitivity[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the task. Read-only. Nullable.[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: taskStatus[Subject <String>]
: A brief description or title of the task.
[TaskGroups <IMicrosoftGraphOutlookTaskGroup-
[]>]
: The user's Outlook task groups. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ChangeKey <String>]
: The version of the task group.[GroupKey <String>]
: The unique GUID identifier for the task group.[IsDefaultGroup <Boolean?>]
: True if the task group is the default task group.[Name <String>]
: The name of the task group.[TaskFolders <IMicrosoftGraphOutlookTaskFolder-
[]>]
: The collection of task folders in the task group. Read-only. Nullable.
[Tasks <IMicrosoftGraphOutlookTask-
[]>]
: The user's Outlook tasks. Read-only. Nullable.
[OwnedDevices <IMicrosoftGraphDirectoryObject-
[]>]
: Devices owned by the user. Read-only. Nullable. Supports $expand.[OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: 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).[PasswordPolicies <String>]
: Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values).[PasswordProfile <IMicrosoftGraphPasswordProfile>]
: passwordProfile[(Any) <Object>]
: This indicates any property can be added to this object.[ForceChangePasswordNextSignIn <Boolean?>]
: true if the user must change their password on the next sign-in; otherwise false. If not set, default is false.[ForceChangePasswordNextSignInWithMfa <Boolean?>]
: If true, at next sign-in, the user must perform a multifactor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multifactor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.[Password <String>]
: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next sign-in. The password must satisfy minimum requirements as specified by the user's passwordPolicies property. By default, a strong password is required.
[PastProjects <String-
[]>]
: A list for users to enumerate their past projects. Returned only on $select.[PendingAccessReviewInstances <IMicrosoftGraphAccessReviewInstance-
[]>]
: Navigation property to get a list of access reviews pending approval by the reviewer.[Id <String>]
: The unique identifier for an entity. Read-only.[ContactedReviewers <IMicrosoftGraphAccessReviewReviewer-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The date when the reviewer was added for the access review.[DisplayName <String>]
: Name of reviewer.[UserPrincipalName <String>]
: User principal name of the user.
[Decisions <IMicrosoftGraphAccessReviewInstanceDecisionItem-
[]>]
: Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.[Id <String>]
: The unique identifier for an entity. Read-only.[AccessReviewId <String>]
: The identifier of the accessReviewInstance parent. Supports $select. Read-only.[AppliedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[IPAddress <String>]
: Indicates the client IP address associated with the user performing the activity (audit log only).[UserPrincipalName <String>]
: The userPrincipalName attribute of the user.
[AppliedDateTime <DateTime?>]
: 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.[ApplyResult <String>]
: The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound, and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.[Decision <String>]
: Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).[Insights <IMicrosoftGraphGovernanceInsight-
[]>]
: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.[Id <String>]
: The unique identifier for an entity. Read-only.[InsightCreatedDateTime <DateTime?>]
: Indicates when the insight was created.
[Instance <IMicrosoftGraphAccessReviewInstance>]
: accessReviewInstance[Justification <String>]
: Justification left by the reviewer when they made the decision.[Principal <IMicrosoftGraphIdentity>]
: identity[PrincipalLink <String>]
: Link to the principal object. For example: https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.[PrincipalResourceMembership <IMicrosoftGraphDecisionItemPrincipalResourceMembership>]
: decisionItemPrincipalResourceMembership[(Any) <Object>]
: This indicates any property can be added to this object.[MembershipType <String>]
: decisionItemPrincipalResourceMembershipType
[Recommendation <String>]
: A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within 30 days of start of review. Recommend deny if sign-in is greater than 30 days of start of review. Recommendation not available otherwise. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.[Resource <IMicrosoftGraphAccessReviewInstanceDecisionItemResource>]
: accessReviewInstanceDecisionItemResource[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: Display name of the resource[Id <String>]
: Resource ID[Type <String>]
: Type of resource. Types include: Group, ServicePrincipal, DirectoryRole, AzureRole, AccessPackageAssignmentPolicy.
[ResourceLink <String>]
: A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.[ReviewedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[ReviewedDateTime <DateTime?>]
: The timestamp when the review decision occurred. Supports $select. Read-only.[Target <IMicrosoftGraphAccessReviewInstanceDecisionItemTarget>]
: accessReviewInstanceDecisionItemTarget[(Any) <Object>]
: This indicates any property can be added to this object.
[Definition <IMicrosoftGraphAccessReviewScheduleDefinition>]
: accessReviewScheduleDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AdditionalNotificationRecipients <IMicrosoftGraphAccessReviewNotificationRecipientItem-
[]>]
: Defines the list of additional users or group members to be notified of the access review progress.[NotificationRecipientScope <IMicrosoftGraphAccessReviewNotificationRecipientScope>]
: accessReviewNotificationRecipientScope[(Any) <Object>]
: This indicates any property can be added to this object.
[NotificationTemplateType <String>]
: Indicates the type of access review email to be sent. Supported template type is CompletedAdditionalRecipients which sends review completion notifications to the recipients.
[BackupReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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. Note: This property has been replaced by fallbackReviewers. However, specifying either backupReviewers or fallbackReviewers automatically populates the same values to the other property.[Query <String>]
: The query specifying who will be the reviewer.[QueryRoot <String>]
: 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.[QueryType <String>]
: The type of query. Examples include MicrosoftGraph and ARM.
[CreatedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[CreatedDateTime <DateTime?>]
: Timestamp when the access review series was created. Supports $select. Read-only.[DescriptionForAdmins <String>]
: Description provided by review creators to provide more context of the review to admins. Supports $select.[DescriptionForReviewers <String>]
: 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.[DisplayName <String>]
: Name of the access review series. Supports $select and $orderby. Required on create.[FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewScope>]
: accessReviewScope[(Any) <Object>]
: This indicates any property can be added to this object.
[Instances <IMicrosoftGraphAccessReviewInstance-
[]>]
: 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.[LastModifiedDateTime <DateTime?>]
: Timestamp when the access review series was last modified. Supports $select. Read-only.[Reviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewScope>]
: accessReviewScope[Settings <IMicrosoftGraphAccessReviewScheduleSettings>]
: accessReviewScheduleSettings[(Any) <Object>]
: This indicates any property can be added to this object.[ApplyActions <IMicrosoftGraphAccessReviewApplyAction-
[]>]
: Optional field. Describes the actions to take once a review is complete. There are two types that are currently supported: removeAccessApplyAction (default) and disableAndDeleteUserApplyAction. Field only needs to be specified in the case of disableAndDeleteUserApplyAction.[AutoApplyDecisionsEnabled <Boolean?>]
: Indicates whether decisions are automatically applied. When set to false, an admin must apply the decisions manually once the reviewer completes the access review. When set to true, decisions are applied automatically after the access review instance duration ends, whether or not the reviewers have responded. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.[DecisionHistoriesForReviewersEnabled <Boolean?>]
: Indicates whether decisions on previous access review stages are available for reviewers on an accessReviewInstance with multiple subsequent stages. If not provided, the default is disabled (false).[DefaultDecision <String>]
: Decision chosen if defaultDecisionEnabled is enabled. Can be one of Approve, Deny, or Recommendation.[DefaultDecisionEnabled <Boolean?>]
: Indicates whether the default decision is enabled or disabled when reviewers do not respond. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.[InstanceDurationInDays <Int32?>]
: Duration of each recurrence of review (accessReviewInstance) in number of days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its durationInDays setting will be used instead of the value of this property.[JustificationRequiredOnApproval <Boolean?>]
: Indicates whether reviewers are required to provide justification with their decision. Default value is false.[MailNotificationsEnabled <Boolean?>]
: Indicates whether emails are enabled or disabled. Default value is false.[RecommendationInsightSettings <IMicrosoftGraphAccessReviewRecommendationInsightSetting-
[]>]
: Optional. Describes the types of insights that aid reviewers to make access review decisions. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationInsightSettings setting will be used instead of the value of this property.[RecommendationLookBackDuration <TimeSpan?>]
: Optional field. Indicates the period of inactivity (with respect to the start date of the review instance) that recommendations will be configured from. The recommendation will be to deny if the user is inactive during the look-back duration. For reviews of groups and Microsoft Entra roles, any duration is accepted. For reviews of applications, 30 days is the maximum duration. If not specified, the duration is 30 days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationLookBackDuration setting will be used instead of the value of this property.[RecommendationsEnabled <Boolean?>]
: Indicates whether decision recommendations are enabled or disabled. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationsEnabled setting will be used instead of the value of this property.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[ReminderNotificationsEnabled <Boolean?>]
: Indicates whether reminders are enabled or disabled. Default value is false.
[StageSettings <IMicrosoftGraphAccessReviewStageSettings-
[]>]
: 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.[DecisionsThatWillMoveToNextStage <String-
[]>]
: Indicate which decisions will go to the next stage. Can be a subset of Approve, Deny, Recommendation, or NotReviewed. If not provided, all decisions will go to the next stage. Optional.[DependsOn <String-
[]>]
: Defines the sequential or parallel order of the stages and depends on the stageId. Only sequential stages are currently supported. For example, if stageId is 2, then dependsOn must be 1. If stageId is 1, don't specify dependsOn. Required if stageId isn't 1.[DurationInDays <Int32?>]
: The duration of the stage. Required. NOTE: The cumulative value of this property across all stages 1. Will override the instanceDurationInDays setting on the accessReviewScheduleDefinition object.
Can't exceed the length of one recurrence.
That is, if the review recurs weekly, the cumulative durationInDays can't exceed 7.
- [FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: If provided, the fallback reviewers are asked to complete a review if the primary reviewers don't exist.
For example, if managers are selected as reviewers and a principal under review doesn't have a manager in Microsoft Entra ID, the fallback reviewers are asked to review that principal.
NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.
- [RecommendationInsightSettings <IMicrosoftGraphAccessReviewRecommendationInsightSetting-
[]>]
:
- [RecommendationLookBackDuration <TimeSpan?>]
: Optional field.
Indicates the time period of inactivity (with respect to the start date of the review instance) from which that recommendations will be configured.
The recommendation is to deny if the user is inactive during the look back duration.
For reviews of groups and Microsoft Entra roles, any duration is accepted.
For reviews of applications, 30 days is the maximum duration.
If not specified, the duration is 30 days.
NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.
- [RecommendationsEnabled <Boolean?>]
: Indicates whether showing recommendations to reviewers is enabled.
Required.
NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.
- [Reviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: Defines who the reviewers are.
If none is specified, the review is a self-review (users review their own access).
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 overrides the corresponding setting on the accessReviewScheduleDefinition.
- [StageId <String>]
: Unique identifier of the accessReviewStageSettings.
The stageId is used in dependsOn property to indicate the stage relationship.
Required.
- [Status <String>]
: 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.
- [EndDateTime <DateTime?>]
: 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.
- [Errors <IMicrosoftGraphAccessReviewError-
[]>]
: Collection of errors in an access review instance lifecycle.
Read-only.
- [Code <String>]
: The error code.
- [Message <String>]
: The error message.
- [FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewScope>]
: accessReviewScope
- [Stages <IMicrosoftGraphAccessReviewStage-
[]>]
: 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.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Decisions <IMicrosoftGraphAccessReviewInstanceDecisionItem-
[]>]
: Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.
- [EndDateTime <DateTime?>]
: 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.
- [FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <DateTime?>]
: 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.
- [Status <String>]
: 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.
- [StartDateTime <DateTime?>]
: 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.
- [Status <String>]
: 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.
[People <IMicrosoftGraphPerson-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Birthday <String>]
: The person's birthday.[CompanyName <String>]
: The name of the person's company.[Department <String>]
: The person's department.[DisplayName <String>]
: The person's display name.[EmailAddresses <IMicrosoftGraphRankedEmailAddress-
[]>]
: The person's email addresses.[Address <String>]
: The email address.[Rank <Double?>]
: 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.
[GivenName <String>]
: The person's given name.[IsFavorite <Boolean?>]
: True if the user has flagged this person as a favorite.[MailboxType <String>]
: The type of mailbox that is represented by the person's email address.[OfficeLocation <String>]
: The location of the person's office.[PersonNotes <String>]
: Free-form notes that the user has taken about this person.[PersonType <String>]
: The type of person, for example distribution list.[Phones <IMicrosoftGraphPhone-
[]>]
: The person's phone numbers.[PostalAddresses <IMicrosoftGraphLocation-
[]>]
: The person's addresses.[Profession <String>]
: The person's profession.[Sources <IMicrosoftGraphPersonDataSource-
[]>]
: The sources the user data comes from, for example Directory or Outlook Contacts.[Type <String>]
: The type of data source.
[Surname <String>]
: The person's surname.[Title <String>]
: The person's title.[UserPrincipalName <String>]
: 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.[Websites <IMicrosoftGraphWebsite-
[]>]
: The person's websites.[YomiCompany <String>]
: The phonetic Japanese name of the person's company.
[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: List all resource-specific permission grants of a user.[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[Photos <IMicrosoftGraphProfilePhoto-
[]>]
: The collection of the user's profile photos in different sizes. Read-only.[Planner <IMicrosoftGraphPlannerUser>]
: plannerUser[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[All <IMicrosoftGraphPlannerDelta-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.
[FavoritePlanReferences <IMicrosoftGraphPlannerFavoritePlanReferenceCollection>]
: plannerFavoritePlanReferenceCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[FavoritePlans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans that the user marked as favorites.[MyDayTasks <IMicrosoftGraphPlannerTask-
[]>]
: Read-only. Nullable. Returns the plannerTasks to be shown in the My Day view of the user.[Plans <IMicrosoftGraphPlannerPlan-
[]>]
:[RecentPlanReferences <IMicrosoftGraphPlannerRecentPlanReferenceCollection>]
: plannerRecentPlanReferenceCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[RecentPlans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans that the user recently viewed in apps that support recent plans.[RosterPlans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans contained by the plannerRosters the user is a member.[Tasks <IMicrosoftGraphPlannerTask-
[]>]
: Read-only. Nullable. Returns the plannerTasks assigned to the user.
[PostalCode <String>]
: 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).[PreferredDataLocation <String>]
: The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.[PreferredLanguage <String>]
: 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).[PreferredName <String>]
: The preferred name for the user. Not Supported. This attribute returns an empty string.Returned only on $select.[Presence <IMicrosoftGraphPresence>]
: presence[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: 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.[Availability <String>]
: The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.[OutOfOfficeSettings <IMicrosoftGraphOutOfOfficeSettings>]
: outOfOfficeSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsOutOfOffice <Boolean?>]
: 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.[Message <String>]
: 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).
[StatusMessage <IMicrosoftGraphPresenceStatusMessage>]
: presenceStatusMessage[(Any) <Object>]
: This indicates any property can be added to this object.[ExpiryDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Message <IMicrosoftGraphItemBody>]
: itemBody[PublishedDateTime <DateTime?>]
: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
[Print <IMicrosoftGraphUserPrint>]
: userPrint[(Any) <Object>]
: This indicates any property can be added to this object.[RecentPrinterShares <IMicrosoftGraphPrinterShare-
[]>]
:[Capabilities <IMicrosoftGraphPrinterCapabilities>]
: printerCapabilities[(Any) <Object>]
: This indicates any property can be added to this object.[BottomMargins <Int32-
[]>]
: A list of supported bottom margins(in microns) for the printer.[Collation <Boolean?>]
: True if the printer supports collating when printing multiple copies of a multi-page document; false otherwise.[ColorModes <String-
[]>]
: The color modes supported by the printer. Valid values are described in the following table.[ContentTypes <String-
[]>]
: A list of supported content (MIME) types that the printer supports. It isn't guaranteed that the Universal Print service supports printing all of these MIME types.[CopiesPerJob <IMicrosoftGraphIntegerRange>]
: integerRange[(Any) <Object>]
: This indicates any property can be added to this object.[End <Int64?>]
: The inclusive upper bound of the integer range.[Maximum <Int64?>]
:[Minimum <Int64?>]
:[Start <Int64?>]
: The inclusive lower bound of the integer range.
[Dpis <Int32-
[]>]
: The list of print resolutions in DPI that are supported by the printer.[DuplexModes <String-
[]>]
: The list of duplex modes that are supported by the printer. Valid values are described in the following table.[FeedDirections <String-
[]>]
:[FeedOrientations <String-
[]>]
: The list of feed orientations that are supported by the printer.[Finishings <String-
[]>]
: Finishing processes the printer supports for a printed document.[InputBins <String-
[]>]
: Supported input bins for the printer.[IsColorPrintingSupported <Boolean?>]
: True if color printing is supported by the printer; false otherwise. Read-only.[IsPageRangeSupported <Boolean?>]
: True if the printer supports printing by page ranges; false otherwise.[LeftMargins <Int32-
[]>]
: A list of supported left margins(in microns) for the printer.[MediaColors <String-
[]>]
: The media (that is, paper) colors supported by the printer.[MediaSizes <String-
[]>]
: The media sizes supported by the printer. Supports standard size names for ISO and ANSI media sizes. Valid values are in the following table.[MediaTypes <String-
[]>]
: The media types supported by the printer.[MultipageLayouts <String-
[]>]
: The presentation directions supported by the printer. Supported values are described in the following table.[Orientations <String-
[]>]
: The print orientations supported by the printer. Valid values are described in the following table.[OutputBins <String-
[]>]
: The printer's supported output bins (trays).[PagesPerSheet <Int32-
[]>]
: Supported number of Input Pages to impose upon a single Impression.[Qualities <String-
[]>]
: The print qualities supported by the printer.[RightMargins <Int32-
[]>]
: A list of supported right margins(in microns) for the printer.[Scalings <String-
[]>]
: Supported print scalings.[SupportedColorConfigurations <String-
[]>]
:[SupportedCopiesPerJob <IMicrosoftGraphIntegerRange>]
: integerRange[SupportedDocumentMimeTypes <String-
[]>]
:[SupportedDuplexConfigurations <String-
[]>]
:[SupportedFinishings <String-
[]>]
:[SupportedMediaColors <String-
[]>]
:[SupportedMediaSizes <String-
[]>]
:[SupportedMediaTypes <String-
[]>]
:[SupportedOrientations <String-
[]>]
:[SupportedOutputBins <String-
[]>]
:[SupportedPagesPerSheet <IMicrosoftGraphIntegerRange>]
: integerRange[SupportedPresentationDirections <String-
[]>]
:[SupportedPrintQualities <String-
[]>]
:[SupportsFitPdfToPage <Boolean?>]
: True if the printer supports scaling PDF pages to match the print media size; false otherwise.[TopMargins <Int32-
[]>]
: A list of supported top margins(in microns) for the printer.
[Defaults <IMicrosoftGraphPrinterDefaults>]
: printerDefaults[(Any) <Object>]
: This indicates any property can be added to this object.[ColorMode <String>]
: printColorMode[ContentType <String>]
: The default content (MIME) type to use when processing documents.[CopiesPerJob <Int32?>]
: The default number of copies printed per job.[DocumentMimeType <String>]
:[Dpi <Int32?>]
: The default resolution in DPI to use when printing the job.[DuplexConfiguration <String>]
: printDuplexConfiguration[DuplexMode <String>]
: printDuplexMode[Finishings <String-
[]>]
: The default set of finishings to apply to print jobs. Valid values are described in the following table.[FitPdfToPage <Boolean?>]
: The default fitPdfToPage setting. True to fit each page of a PDF document to a physical sheet of media; false to let the printer decide how to lay out impressions.[InputBin <String>]
: The default input bin that serves as the paper source.[MediaColor <String>]
: The default media (such as paper) color to print the document on.[MediaSize <String>]
: The default media size to use. Supports standard size names for ISO and ANSI media sizes. Valid values are listed in the printerCapabilities topic.[MediaType <String>]
: The default media (such as paper) type to print the document on.[MultipageLayout <String>]
: printMultipageLayout[Orientation <String>]
: printOrientation[OutputBin <String>]
: The default output bin to place completed prints into. See the printer's capabilities for a list of supported output bins.[PagesPerSheet <Int32?>]
: The default number of document pages to print on each sheet.[PdfFitToPage <Boolean?>]
:[PresentationDirection <String>]
: printPresentationDirection[PrintColorConfiguration <String>]
: printColorConfiguration[PrintQuality <String>]
: printQuality[Quality <String>]
: printQuality[Scaling <String>]
: printScaling
[DisplayName <String>]
:[IsAcceptingJobs <Boolean?>]
:[Jobs <IMicrosoftGraphPrintJob-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AcknowledgedDateTime <DateTime?>]
:[CompletedDateTime <DateTime?>]
:[Configuration <IMicrosoftGraphPrintJobConfiguration>]
: printJobConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Collate <Boolean?>]
: Whether the printer should collate pages when printing multiple copies of a multi-page document.[ColorMode <String>]
: printColorMode[Copies <Int32?>]
: The number of copies that should be printed. Read-only.[Dpi <Int32?>]
: The resolution to use when printing the job, expressed in dots per inch (DPI). Read-only.[DuplexMode <String>]
: printDuplexMode[FeedOrientation <String>]
: printerFeedOrientation[Finishings <String-
[]>]
: Finishing processes to use when printing.[FitPdfToPage <Boolean?>]
:[InputBin <String>]
: The input bin (tray) to use when printing. See the printer's capabilities for a list of supported input bins.[Margin <IMicrosoftGraphPrintMargin>]
: printMargin[(Any) <Object>]
: This indicates any property can be added to this object.[Bottom <Int32?>]
: The margin in microns from the bottom edge.[Left <Int32?>]
: The margin in microns from the left edge.[Right <Int32?>]
: The margin in microns from the right edge.[Top <Int32?>]
: The margin in microns from the top edge.
[MediaSize <String>]
: The media sizeto use when printing. Supports standard size names for ISO and ANSI media sizes. Valid values are listed in the printerCapabilities topic.[MediaType <String>]
: The default media (such as paper) type to print the document on.[MultipageLayout <String>]
: printMultipageLayout[Orientation <String>]
: printOrientation[OutputBin <String>]
: The output bin to place completed prints into. See the printer's capabilities for a list of supported output bins.[PageRanges <IMicrosoftGraphIntegerRange-
[]>]
: The page ranges to print. Read-only.[PagesPerSheet <Int32?>]
: The number of document pages to print on each sheet.[Quality <String>]
: printQuality[Scaling <String>]
: printScaling
[CreatedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[CreatedDateTime <DateTime?>]
: The DateTimeOffset when the job was created. Read-only.[DisplayName <String>]
: The name of the print job.[Documents <IMicrosoftGraphPrintDocument-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Configuration <IMicrosoftGraphPrinterDocumentConfiguration>]
: printerDocumentConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Collate <Boolean?>]
:[ColorMode <String>]
: printColorMode[Copies <Int32?>]
:[Dpi <Int32?>]
:[DuplexMode <String>]
: printDuplexMode[FeedDirection <String>]
: printerFeedDirection[FeedOrientation <String>]
: printerFeedOrientation[Finishings <String-
[]>]
:[FitPdfToPage <Boolean?>]
:[InputBin <String>]
:[Margin <IMicrosoftGraphPrintMargin>]
: printMargin[MediaSize <String>]
:[MediaType <String>]
:[MultipageLayout <String>]
: printMultipageLayout[Orientation <String>]
: printOrientation[OutputBin <String>]
:[PageRanges <IMicrosoftGraphIntegerRange-
[]>]
:[PagesPerSheet <Int32?>]
:[Quality <String>]
: printQuality[Scaling <String>]
: printScaling
[ContentType <String>]
: The document's content (MIME) type. Read-only.[DisplayName <String>]
: The document's name. Read-only.[DownloadedDateTime <DateTime?>]
:[Size <Int64?>]
: The document's size in bytes. Read-only.[UploadedDateTime <DateTime?>]
:
[ErrorCode <Int32?>]
:[IsFetchable <Boolean?>]
: If true, document can be fetched by printer.[RedirectedFrom <String>]
: Contains the source job URL, if the job has been redirected from another printer.[RedirectedTo <String>]
: Contains the destination job URL, if the job has been redirected to another printer.[Status <IMicrosoftGraphPrintJobStatus>]
: printJobStatus[(Any) <Object>]
: This indicates any property can be added to this object.[AcquiredByPrinter <Boolean?>]
:[Description <String>]
: A human-readable description of the print job's current processing state. Read-only.[Details <String-
[]>]
: Additional details for print job state. Valid values are described in the following table. Read-only.[IsAcquiredByPrinter <Boolean?>]
: True if the job was acknowledged by a printer; false otherwise. Read-only.[ProcessingState <String>]
: printJobProcessingState[ProcessingStateDescription <String>]
:[State <String>]
: printJobProcessingState
[Tasks <IMicrosoftGraphPrintTask-
[]>]
: A list of printTasks that were triggered by this print job.[Id <String>]
: The unique identifier for an entity. Read-only.[Definition <IMicrosoftGraphPrintTaskDefinition>]
: printTaskDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedBy <IMicrosoftGraphAppIdentity>]
: appIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[AppId <String>]
: Refers to the unique identifier representing application ID in the Microsoft Entra ID.[DisplayName <String>]
: Refers to the application name displayed in the Microsoft Entra admin center.[ServicePrincipalId <String>]
: Refers to the unique identifier indicating service principal ID in Microsoft Entra ID for the corresponding App.[ServicePrincipalName <String>]
: Refers to the Service Principal Name is the Application name in the tenant.
[DisplayName <String>]
: The name of the printTaskDefinition.[Tasks <IMicrosoftGraphPrintTask-
[]>]
: A list of tasks that have been created based on this definition. The list includes currently running tasks and recently completed tasks. Read-only.
[ParentUrl <String>]
: The URL for the print entity that triggered this task. For example, https://graph.microsoft.com/beta/print/printers/{printerId}/jobs/{jobId}. Read-only.[Status <IMicrosoftGraphPrintTaskStatus>]
: printTaskStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: A human-readable description of the current processing state of the printTask.[State <String>]
: printTaskProcessingState
[Trigger <IMicrosoftGraphPrintTaskTrigger>]
: printTaskTrigger[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Definition <IMicrosoftGraphPrintTaskDefinition>]
: printTaskDefinition[Event <String>]
: printEvent
[Location <IMicrosoftGraphPrinterLocation>]
: printerLocation[(Any) <Object>]
: This indicates any property can be added to this object.[AltitudeInMeters <Int32?>]
: The altitude, in meters, that the printer is located at.[Building <String>]
: The building that the printer is located in.[City <String>]
: The city that the printer is located in.[CountryOrRegion <String>]
: The country or region that the printer is located in.[Floor <String>]
: The floor that the printer is located on. Only numerical values are supported right now.[FloorDescription <String>]
: The description of the floor that the printer is located on.[FloorNumber <Int32?>]
:[Latitude <Double?>]
: The latitude that the printer is located at.[Longitude <Double?>]
: The longitude that the printer is located at.[Organization <String-
[]>]
: The organizational hierarchy that the printer belongs to. The elements should be in hierarchical order.[PostalCode <String>]
: The postal code that the printer is located in.[RoomDescription <String>]
: The description of the room that the printer is located in.[RoomName <String>]
: The room that the printer is located in. Only numerical values are supported right now.[RoomNumber <Int32?>]
:[Site <String>]
: The site that the printer is located in.[StateOrProvince <String>]
: The state or province that the printer is located in.[StreetAddress <String>]
: The street address where the printer is located.[Subdivision <String-
[]>]
: The subdivision that the printer is located in. The elements should be in hierarchical order.[Subunit <String-
[]>]
:
[Manufacturer <String>]
:[Model <String>]
:[Name <String>]
:[Status <IMicrosoftGraphPrinterStatus>]
: printerStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: A human-readable description of the printer's current processing state. Read-only.[Details <String-
[]>]
: The list of details describing why the printer is in the current state. Valid values are described in the following table. Read-only.[ProcessingState <String>]
: printerProcessingState[ProcessingStateDescription <String>]
:[ProcessingStateReasons <String-
[]>]
:[State <String>]
: printerProcessingState
[Id <String>]
: The unique identifier for an entity. Read-only.[AllowAllUsers <Boolean?>]
: If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties.[AllowedGroups <IMicrosoftGraphGroup-
[]>]
: The groups whose users have access to print using the printer.[AllowedUsers <IMicrosoftGraphUser-
[]>]
: The users who have access to print using the printer.[CreatedDateTime <DateTime?>]
: The DateTimeOffset when the printer share was created. Read-only.[Printer <IMicrosoftGraphPrinter>]
: printer[(Any) <Object>]
: This indicates any property can be added to this object.[Capabilities <IMicrosoftGraphPrinterCapabilities>]
: printerCapabilities[Defaults <IMicrosoftGraphPrinterDefaults>]
: printerDefaults[DisplayName <String>]
:[IsAcceptingJobs <Boolean?>]
:[Jobs <IMicrosoftGraphPrintJob-
[]>]
:[Location <IMicrosoftGraphPrinterLocation>]
: printerLocation[Manufacturer <String>]
:[Model <String>]
:[Name <String>]
:[Status <IMicrosoftGraphPrinterStatus>]
: printerStatus[Id <String>]
: The unique identifier for an entity. Read-only.[AcceptingJobs <Boolean?>]
:[Connectors <IMicrosoftGraphPrintConnector-
[]>]
: The connectors that are associated with the printer.[Id <String>]
: The unique identifier for an entity. Read-only.[AppVersion <String>]
: The connector's version.[DeviceHealth <IMicrosoftGraphDeviceHealth>]
: deviceHealth[(Any) <Object>]
: This indicates any property can be added to this object.[LastConnectionTime <DateTime?>]
: The last time the device was connected.
[DisplayName <String>]
: The name of the connector.[FullyQualifiedDomainName <String>]
: The connector machine's hostname.[Location <IMicrosoftGraphPrinterLocation>]
: printerLocation[Name <String>]
:[OperatingSystem <String>]
: The connector machine's operating system version.[RegisteredDateTime <DateTime?>]
: The DateTimeOffset when the connector was registered.
[HasPhysicalDevice <Boolean?>]
: True if the printer has a physical device for printing. Read-only.[IsShared <Boolean?>]
: True if the printer is shared; false otherwise. Read-only.[LastSeenDateTime <DateTime?>]
: The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.[RegisteredDateTime <DateTime?>]
: The DateTimeOffset when the printer was registered. Read-only.[Share <IMicrosoftGraphPrinterShare>]
: printerShare[Shares <IMicrosoftGraphPrinterShare-
[]>]
: The list of printerShares that are associated with the printer. Currently, only one printerShare can be associated with the printer. Read-only. Nullable.[TaskTriggers <IMicrosoftGraphPrintTaskTrigger-
[]>]
: A list of task triggers that are associated with the printer.
[ViewPoint <IMicrosoftGraphPrinterShareViewpoint>]
: printerShareViewpoint[(Any) <Object>]
: This indicates any property can be added to this object.[LastUsedDateTime <DateTime?>]
: Date and time when the printer was last used by the signed-in 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.
[Profile <IMicrosoftGraphProfile>]
: profile[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Account <IMicrosoftGraphUserAccountInformation-
[]>]
:[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[(Any) <Object>]
: This indicates any property can be added to this object.[ConfidenceScore <Double?>]
: Confidence score reflecting the accuracy of the data inferred about the user.[UserHasVerifiedAccuracy <Boolean?>]
: Records if the user has confirmed this inference as being True or False.
[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[(Any) <Object>]
: This indicates any property can be added to this object.[Type <String-
[]>]
:
[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[IsDefaultSource <Boolean?>]
: Indicates whether the source is the default one.[Properties <String-
[]>]
: Names of properties that have data from this source.[SourceId <String>]
:
[Id <String>]
: The unique identifier for an entity. Read-only.[AgeGroup <String>]
: Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and can't be changed.[CountryCode <String>]
: Contains the two-character country code associated with the users' account.[PreferredLanguageTag <IMicrosoftGraphLocaleInfo>]
: localeInfo[UserPrincipalName <String>]
: The user principal name (UPN) of the user associated with the account.
[Addresses <IMicrosoftGraphItemAddress-
[]>]
: Represents details of addresses associated with the user.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Detail <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[DisplayName <String>]
: Friendly name the user has assigned to this address.[GeoCoordinates <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates
[Anniversaries <IMicrosoftGraphPersonAnnualEvent-
[]>]
: Represents the details of meaningful dates associated with a person.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Date <DateTime?>]
:[DisplayName <String>]
:[Type <String>]
: personAnnualEventType
[Awards <IMicrosoftGraphPersonAward-
[]>]
: Represents the details of awards or honors associated with a person.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Descpription of the award or honor.[DisplayName <String>]
: Name of the award or honor.[IssuedDate <DateTime?>]
: The date that the award or honor was granted.[IssuingAuthority <String>]
: Authority which granted the award or honor.[ThumbnailUrl <String>]
: URL referencing a thumbnail of the award or honor.[WebUrl <String>]
: URL referencing the award or honor.
[Certifications <IMicrosoftGraphPersonCertification-
[]>]
: Represents the details of certifications associated with a person.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[CertificationId <String>]
: The referenceable identifier for the certification.[Description <String>]
: Description of the certification.[DisplayName <String>]
: Title of the certification.[EndDate <DateTime?>]
: The date that the certification expires.[IssuedDate <DateTime?>]
: The date that the certification was issued.[IssuingAuthority <String>]
: Authority which granted the certification.[IssuingCompany <String>]
: Company which granted the certification.[StartDate <DateTime?>]
: The date that the certification became valid.[ThumbnailUrl <String>]
: URL referencing a thumbnail of the certification.[WebUrl <String>]
: URL referencing the certification.
[EducationalActivities <IMicrosoftGraphEducationalActivity-
[]>]
: Represents data that a user has supplied related to undergraduate, graduate, postgraduate or other educational activities.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[CompletionMonthYear <DateTime?>]
: The month and year the user graduated or completed the activity.[EndMonthYear <DateTime?>]
: The month and year the user completed the educational activity referenced.[Institution <IMicrosoftGraphInstitutionData>]
: institutionData[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: Short description of the institution the user studied at.[DisplayName <String>]
: Name of the institution the user studied at.[Location <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[WebUrl <String>]
: Link to the institution or department homepage.
[Program <IMicrosoftGraphEducationalActivityDetail>]
: educationalActivityDetail[(Any) <Object>]
: This indicates any property can be added to this object.[Abbreviation <String>]
: Shortened name of the degree or program (example: PhD, MBA)[Activities <String-
[]>]
: Extracurricular activities undertaken alongside the program.[Awards <String-
[]>]
: Any awards or honors associated with the program.[Description <String>]
: Short description of the program provided by the user.[DisplayName <String>]
: Long-form name of the program that the user has provided.[FieldsOfStudy <String-
[]>]
: Majors and minors associated with the program. (if applicable)[Grade <String>]
: The final grade, class, GPA or score.[Notes <String>]
: Additional notes the user has provided.[WebUrl <String>]
: Link to the degree or program page.
[StartMonthYear <DateTime?>]
: The month and year the user commenced the activity referenced.
[Emails <IMicrosoftGraphItemEmail-
[]>]
: Represents detailed information about email addresses associated with the user.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Address <String>]
: The email address itself.[DisplayName <String>]
: The name or label a user has associated with a particular email address.[Type <String>]
: emailType
[Interests <IMicrosoftGraphPersonInterest-
[]>]
: Provides detailed information about interests the user has associated with themselves in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the interest (for example, personal, recipies).[CollaborationTags <String-
[]>]
: Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.[Description <String>]
: Contains a description of the interest.[DisplayName <String>]
: Contains a friendly name for the interest.[ThumbnailUrl <String>]
:[WebUrl <String>]
: Contains a link to a web page or resource about the interest.
[Languages <IMicrosoftGraphLanguageProficiency-
[]>]
: Represents detailed information about languages that a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Contains the long-form name for the language.[Proficiency <String>]
: languageProficiencyLevel[Reading <String>]
: languageProficiencyLevel[Spoken <String>]
: languageProficiencyLevel[Tag <String>]
: Contains the four-character BCP47 name for the language (en-US, no-NB, en-AU).[ThumbnailUrl <String>]
:[Written <String>]
: languageProficiencyLevel
[Names <IMicrosoftGraphPersonName-
[]>]
: Represents the names a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.[First <String>]
: First name of the user.[Initials <String>]
: Initials of the user.[LanguageTag <String>]
: Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.[Last <String>]
: Last name of the user.[Maiden <String>]
: Maiden name of the user.[Middle <String>]
: Middle name of the user.[Nickname <String>]
: Nickname of the user.[Pronunciation <IMicrosoftGraphPersonNamePronounciation>]
: personNamePronounciation[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
:[First <String>]
:[Last <String>]
:[Maiden <String>]
:[Middle <String>]
:
[Suffix <String>]
: Designators used after the users name (eg: PhD.)[Title <String>]
: Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)
[Notes <IMicrosoftGraphPersonAnnotation-
[]>]
: Represents notes that a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Detail <IMicrosoftGraphItemBody>]
: itemBody[DisplayName <String>]
: Contains a friendly name for the note.[ThumbnailUrl <String>]
:
[Patents <IMicrosoftGraphItemPatent-
[]>]
: Represents patents that a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Descpription of the patent or filing.[DisplayName <String>]
: Title of the patent or filing.[IsPending <Boolean?>]
: Indicates the patent is pending.[IssuedDate <DateTime?>]
: The date that the patent was granted.[IssuingAuthority <String>]
: Authority which granted the patent.[Number <String>]
: The patent number.[WebUrl <String>]
: URL referencing the patent or filing.
[Phones <IMicrosoftGraphItemPhone-
[]>]
: Represents detailed information about phone numbers associated with a user in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Friendly name the user has assigned this phone number.[Number <String>]
: Phone number provided by the user.[Type <String>]
: phoneType
[Positions <IMicrosoftGraphWorkPosition-
[]>]
: Represents detailed information about work positions associated with a user's profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Categories that the user has associated with this position.[Colleagues <IMicrosoftGraphRelatedPerson-
[]>]
: Colleagues that are associated with this position.[DisplayName <String>]
: Name of the person.[Relationship <String>]
: personRelationship[UserId <String>]
: The user's directory object ID (Microsoft Entra ID or CID).[UserPrincipalName <String>]
: Email address or reference to person within the organization.
[Detail <IMicrosoftGraphPositionDetail>]
: positionDetail[(Any) <Object>]
: This indicates any property can be added to this object.[Company <IMicrosoftGraphCompanyDetail>]
: companyDetail[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[CompanyCode <String>]
: Legal entity number of the company or its subdivision. For information on how to set the value for the companyCode, see profileSourceAnnotation.[Department <String>]
: Department Name within a company.[DisplayName <String>]
: Company name.[OfficeLocation <String>]
: Office Location of the person referred to.[Pronunciation <String>]
: Pronunciation guide for the company name.[SecondaryDepartment <String>]
: Secondary Department Name within a company.[WebUrl <String>]
: Link to the company home page.
[Description <String>]
: A description for the position in question.[EndMonthYear <DateTime?>]
: The date when the position ended.[JobTitle <String>]
: The title of the position.[Layer <Int32?>]
: The place where the employee is within the organizational hierarchy.[Level <String>]
: The employee's experience or management level.[Role <String>]
: The role the position entailed.[SecondaryJobTitle <String>]
: An optional job title for the position.[SecondaryRole <String>]
: An optional role for the position entailed.[StartMonthYear <DateTime?>]
: The start date of the position.[Summary <String>]
: The summary of the position.
[IsCurrent <Boolean?>]
: Denotes whether or not the position is current.[Manager <IMicrosoftGraphRelatedPerson>]
: relatedPerson
[Projects <IMicrosoftGraphProjectParticipation-
[]>]
: Represents detailed information about projects associated with a user.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the project (for example, digital transformation, oil rig).[Client <IMicrosoftGraphCompanyDetail>]
: companyDetail[CollaborationTags <String-
[]>]
: Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.[Colleagues <IMicrosoftGraphRelatedPerson-
[]>]
: Lists people that also worked on the project.[Detail <IMicrosoftGraphPositionDetail>]
: positionDetail[DisplayName <String>]
: Contains a friendly name for the project.[Sponsors <IMicrosoftGraphRelatedPerson-
[]>]
: The Person or people who sponsored the project.[ThumbnailUrl <String>]
:
[Publications <IMicrosoftGraphItemPublication-
[]>]
: Represents details of any publications a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Description of the publication.[DisplayName <String>]
: Title of the publication.[PublishedDate <DateTime?>]
: The date that the publication was published.[Publisher <String>]
: Publication or publisher for the publication.[ThumbnailUrl <String>]
: URL referencing a thumbnail of the publication.[WebUrl <String>]
: URL referencing the publication.
[Skills <IMicrosoftGraphSkillProficiency-
[]>]
: Represents detailed information about skills associated with a user in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the skill (for example, personal, professional, hobby).[CollaborationTags <String-
[]>]
: Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.[DisplayName <String>]
: Contains a friendly name for the skill.[Proficiency <String>]
: skillProficiencyLevel[ThumbnailUrl <String>]
:[WebUrl <String>]
: Contains a link to an information source about the skill.
[WebAccounts <IMicrosoftGraphWebAccount-
[]>]
: Represents web accounts the user has indicated they use or has added to their user profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Contains the description the user has provided for the account on the service being referenced.[Service <IMicrosoftGraphServiceInformation>]
: serviceInformation[(Any) <Object>]
: This indicates any property can be added to this object.[Name <String>]
: The name of the cloud service (for example, Twitter, Instagram).[WebUrl <String>]
: Contains the URL for the service being referenced.
[StatusMessage <String>]
: Contains a status message from the cloud service if provided or synchronized.[ThumbnailUrl <String>]
:[UserId <String>]
: The user name displayed for the webaccount.[WebUrl <String>]
: Contains a link to the user's profile on the cloud service if one exists.
[Websites <IMicrosoftGraphPersonWebsite-
[]>]
: Represents detailed information about websites associated with a user in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the website (for example, personal, recipes).[Description <String>]
: Contains a description of the website.[DisplayName <String>]
: Contains a friendly name for the website.[ThumbnailUrl <String>]
:[WebUrl <String>]
: Contains a link to the website itself.
[ProvisionedPlans <IMicrosoftGraphProvisionedPlan-
[]>]
: The plans that are provisioned for the user. Read-only. Not nullable. Supports $filter (eq, not, ge, le).[CapabilityStatus <String>]
: For example, 'Enabled'.[ProvisioningStatus <String>]
: For example, 'Success'.[Service <String>]
: The name of the service; for example, 'AccessControlS2S'
[ProxyAddresses <String-
[]>]
: 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 <DateTime?>]
: 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.[RegisteredDevices <IMicrosoftGraphDirectoryObject-
[]>]
: Devices that are registered for the user. Read-only. Nullable. Supports $expand and returns up to 100 objects.[Responsibilities <String-
[]>]
: A list for the user to enumerate their responsibilities. Returned only on $select.[Schools <String-
[]>]
: A list for the user to enumerate the schools they have attended. Returned only on $select.[ScopedRoleMemberOf <IMicrosoftGraphScopedRoleMembership-
[]>]
: The scoped-role administrative unit memberships for this user. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AdministrativeUnitId <String>]
: Unique identifier for the administrative unit that the directory role is scoped to[RoleId <String>]
: Unique identifier for the directory role that the member is in.[RoleMemberInfo <IMicrosoftGraphIdentity>]
: identity
[Security <IMicrosoftGraphSecurity>]
: security[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[InformationProtection <IMicrosoftGraphSecurityInformationProtection>]
: informationProtection[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[LabelPolicySettings <IMicrosoftGraphSecurityInformationProtectionPolicySetting>]
: informationProtectionPolicySetting[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DefaultLabelId <String>]
:[IsDowngradeJustificationRequired <Boolean?>]
: Exposes whether justification input is required on label downgrade.[IsMandatory <Boolean?>]
: Exposes whether mandatory labeling is enabled.[MoreInfoUrl <String>]
: Exposes the more information URL that can be configured by the administrator.
[SensitivityLabels <IMicrosoftGraphSecuritySensitivityLabel-
[]>]
: Read the Microsoft Purview Information Protection labels for the user or organization.[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: The color that the UI should display for the label, if configured.[ContentFormats <String-
[]>]
: Returns the supported content formats for the label.[Description <String>]
: The admin-defined description for the label.[HasProtection <Boolean?>]
: Indicates whether the label has protection actions configured.[IsActive <Boolean?>]
: Indicates whether the label is active or not. Active labels should be hidden or disabled in the UI.[IsAppliable <Boolean?>]
: Indicates whether the label can be applied to content. False if the label is a parent with child labels.[Name <String>]
: The plaintext name of the label.[Parent <IMicrosoftGraphSecuritySensitivityLabel>]
: sensitivityLabel[Sensitivity <Int32?>]
: The sensitivity value of the label, where lower is less sensitive.[Tooltip <String>]
: The tooltip that should be displayed for the label in a UI.
[SecurityIdentifier <String>]
: Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith).[ServiceProvisioningErrors <IMicrosoftGraphServiceProvisioningError-
[]>]
: Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object.[Settings <IMicrosoftGraphUserSettings>]
: userSettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ContactMergeSuggestions <IMicrosoftGraphContactMergeSuggestions>]
: contactMergeSuggestions[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsEnabled <Boolean?>]
: true if the duplicate contact merge suggestions feature is enabled for the user; false if the feature is disabled. Default value is true.
[ContributionToContentDiscoveryAsOrganizationDisabled <Boolean?>]
: 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 <Boolean?>]
: When set to true, documents in the user's Office Delve are disabled. Users can control this setting in Office Delve.[ItemInsights <IMicrosoftGraphUserInsightsSettings>]
: userInsightsSettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsEnabled <Boolean?>]
: True if the user's itemInsights and meeting hours insights are enabled; false if the user's itemInsights and meeting hours insights are disabled. The default value is true. Optional.
[RegionalAndLanguageSettings <IMicrosoftGraphRegionalAndLanguageSettings>]
: regionalAndLanguageSettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AuthoringLanguages <IMicrosoftGraphLocaleInfo-
[]>]
: Prioritized list of languages the user reads and authors in.Returned by default. Not nullable.[DefaultDisplayLanguage <IMicrosoftGraphLocaleInfo>]
: localeInfo[DefaultRegionalFormat <IMicrosoftGraphLocaleInfo>]
: localeInfo[DefaultSpeechInputLanguage <IMicrosoftGraphLocaleInfo>]
: localeInfo[DefaultTranslationLanguage <IMicrosoftGraphLocaleInfo>]
: localeInfo[RegionalFormatOverrides <IMicrosoftGraphRegionalFormatOverrides>]
: regionalFormatOverrides[(Any) <Object>]
: This indicates any property can be added to this object.[Calendar <String>]
: The calendar to use, e.g., Gregorian Calendar.Returned by default.[FirstDayOfWeek <String>]
: The first day of the week to use, e.g., Sunday.Returned by default.[LongDateFormat <String>]
: The long date time format to be used for displaying dates.Returned by default.[LongTimeFormat <String>]
: The long time format to be used for displaying time.Returned by default.[ShortDateFormat <String>]
: The short date time format to be used for displaying dates.Returned by default.[ShortTimeFormat <String>]
: The short time format to be used for displaying time.Returned by default.[TimeZone <String>]
: The timezone to be used for displaying time.Returned by default.
[TranslationPreferences <IMicrosoftGraphTranslationPreferences>]
: translationPreferences[(Any) <Object>]
: This indicates any property can be added to this object.[LanguageOverrides <IMicrosoftGraphTranslationLanguageOverride-
[]>]
: Translation override behavior for languages, if any.Returned by default.[LanguageTag <String>]
: The language to apply the override.Returned by default. Not nullable.[TranslationBehavior <String>]
: translationBehavior
[TranslationBehavior <String>]
: translationBehavior[UntranslatedLanguages <String-
[]>]
: The list of languages the user does not need translated. This is computed from the authoringLanguages collection in regionalAndLanguageSettings, and the languageOverrides collection in translationPreferences. The list specifies neutral culture values that include the language code without any country or region association. For example, it would specify 'fr' for the neutral French culture, but not 'fr-FR' for the French culture in France. Returned by default. Read only.
[ShiftPreferences <IMicrosoftGraphShiftPreferences>]
: shiftPreferences[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Availability <IMicrosoftGraphShiftAvailability-
[]>]
: Availability of the user to be scheduled for work and its recurrence pattern.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[TimeSlots <IMicrosoftGraphTimeRange-
[]>]
: The time slot(s) preferred by the user.[EndTime <String>]
: End time for the time range.[StartTime <String>]
: Start time for the time range.
[TimeZone <String>]
: Specifies the time zone for the indicated time.
[Storage <IMicrosoftGraphUserStorage>]
: userStorage[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Quota <IMicrosoftGraphUnifiedStorageQuota>]
: unifiedStorageQuota[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Deleted <Int64?>]
:[ManageWebUrl <String>]
: A URL that can be used in a browser to manage the breakdown. Read-only.[Remaining <Int64?>]
: Total space remaining before reaching the quota limit in bytes.[Services <IMicrosoftGraphServiceStorageQuotaBreakdown-
[]>]
: The breakdown of services contributing to the user's quota usage.[DisplayName <String>]
:[ManageWebUrl <String>]
:[Used <Int64?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.
[State <String>]
: Indicates the state of the storage space. The possible values are: normal, nearing, critical, full, and overLimit.[Total <Int64?>]
: Total allowed storage space in bytes.[Used <Int64?>]
: Total space used in bytes.
[Windows <IMicrosoftGraphWindowsSetting-
[]>]
: The Windows settings of the user stored in the cloud.[Id <String>]
: The unique identifier for an entity. Read-only.[Instances <IMicrosoftGraphWindowsSettingInstance-
[]>]
: A collection of setting values for a given windowsSetting.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Set by the server. Represents the dateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. The object expires at the specified dateTime in UTC, making it unavailable after that time.[LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the request from the Windows client device. Refers to the user's Windows device that modified the object at the specified dateTime in UTC.[Payload <String>]
: Base64-encoded JSON setting value.
[PayloadType <String>]
: The type of setting payloads contained in the instances navigation property.[SettingType <String>]
: windowsSettingType[WindowsDeviceId <String>]
: A unique identifier for the device the setting might belong to if it is of the settingType backup.
[ShowInAddressList <Boolean?>]
: 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.[SignInActivity <IMicrosoftGraphSignInActivity>]
: signInActivity[(Any) <Object>]
: This indicates any property can be added to this object.[LastNonInteractiveSignInDateTime <DateTime?>]
: The last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted (either successfully or unsuccessfully) to sign in to 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 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. 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.[LastNonInteractiveSignInRequestId <String>]
: Request identifier of the last non-interactive sign-in performed by this user.[LastSignInDateTime <DateTime?>]
: 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 (either successfully or unsuccessfully) to sign in to the directory the directory with an interactive authentication method. This field can be used to build reports, such as inactive users. 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. 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.[LastSignInRequestId <String>]
: Request identifier of the last interactive sign-in performed by this user.[LastSuccessfulSignInDateTime <DateTime?>]
: The date and time of the user's most recent successful sign-in activity. 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.[LastSuccessfulSignInRequestId <String>]
: The request ID of the last successful sign-in.
[SignInSessionsValidFromDateTime <DateTime?>]
: 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.[Skills <String-
[]>]
: A list for the user to enumerate their skills. Returned only on $select.[Solutions <IMicrosoftGraphUserSolutionRoot>]
: userSolutionRoot[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[WorkingTimeSchedule <IMicrosoftGraphWorkingTimeSchedule>]
: workingTimeSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Sponsors <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[State <String>]
: 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).[StreetAddress <String>]
: The street address of the user's place of business. Maximum length is 1024 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[Surname <String>]
: The user's surname (family name or last name). Maximum length is 64 characters. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[Teamwork <IMicrosoftGraphUserTeamwork>]
: userTeamwork[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AssociatedTeams <IMicrosoftGraphAssociatedTeamInfo-
[]>]
: The list of associatedTeamInfo objects that a user is associated with.[DisplayName <String>]
: The name of the team.[Team <IMicrosoftGraphTeam>]
: team[TenantId <String>]
: The ID of the Microsoft Entra tenant.[Id <String>]
: The unique identifier for an entity. Read-only.
[InstalledApps <IMicrosoftGraphUserScopeTeamsAppInstallation-
[]>]
: The apps installed in the personal scope of this user.[ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet[ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo[TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp[TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition[Id <String>]
: The unique identifier for an entity. Read-only.[Chat <IMicrosoftGraphChat>]
: chat
[Locale <String>]
: Represents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale setting. A user's locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.[Region <String>]
: Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.
[Todo <IMicrosoftGraphTodo>]
: todo[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Lists <IMicrosoftGraphTodoTaskList-
[]>]
: The task lists in the users mailbox.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the task list.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the task list. Nullable.[IsOwner <Boolean?>]
: True if the user is owner of the given task list.[IsShared <Boolean?>]
: True if the task list is shared with other users[Tasks <IMicrosoftGraphTodoTask-
[]>]
: The tasks in this task list. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AttachmentSessions <IMicrosoftGraphAttachmentSession-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
: The content streams that are uploaded.[ExpirationDateTime <DateTime?>]
: The date and time in UTC when the upload session will expire. The complete file must be uploaded before this expiration time is reached.[NextExpectedRanges <String-
[]>]
: Indicates a single value {start} that represents the location in the file where the next upload should begin.
[Attachments <IMicrosoftGraphAttachmentBase-
[]>]
: A collection of file attachments for the task.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[LastModifiedDateTime <DateTime?>]
: 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.[Name <String>]
: The display name of the attachment. This doesn't need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Body <IMicrosoftGraphItemBody>]
: itemBody[BodyLastModifiedDateTime <DateTime?>]
: The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[Categories <String-
[]>]
: The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.[ChecklistItems <IMicrosoftGraphChecklistItem-
[]>]
: A collection of smaller subtasks linked to the more complex parent task.[Id <String>]
: The unique identifier for an entity. Read-only.[CheckedDateTime <DateTime?>]
: The date and time when the checklistItem was finished.[CreatedDateTime <DateTime?>]
: The date and time when the checklistItem was created.[DisplayName <String>]
: Indicates the title of the checklistItem.[IsChecked <Boolean?>]
: State that indicates whether the item is checked off or not.
[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[CreatedDateTime <DateTime?>]
: The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the task. Nullable.[HasAttachments <Boolean?>]
: Indicates whether the task has attachments.[Importance <String>]
: importance[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the task.[LastModifiedDateTime <DateTime?>]
: The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[LinkedResources <IMicrosoftGraphLinkedResource-
[]>]
: A collection of resources linked to the task.[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicationName <String>]
: The app name of the source that sends the linkedResource.[DisplayName <String>]
: The title of the linkedResource.[ExternalId <String>]
: ID of the object that is associated with this task on the third-party/partner system.[WebUrl <String>]
: Deep link to the linkedResource.
[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[ReminderDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: taskStatus[Title <String>]
: A brief description of the task.
[WellknownListName <String>]
: wellknownListName
[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: The groups, including nested groups and directory roles that a user is a member of. Nullable.[TransitiveReports <IMicrosoftGraphDirectoryObject-
[]>]
: The transitive reports for a user. Read-only.[UsageLocation <String>]
: 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).[UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a user has been granted.[UserPrincipalName <String>]
: 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.
[UserType <String>]
: A String value that can be used to classify user types in your directory. The possible values are 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?[VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:[CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity[ApplicationInstance <IMicrosoftGraphIdentity>]
: identity[AssertedIdentity <IMicrosoftGraphIdentity>]
: identity[AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity[Encrypted <IMicrosoftGraphIdentity>]
: identity[EndpointType <String>]
: endpointType[Guest <IMicrosoftGraphIdentity>]
: identity[OnPremises <IMicrosoftGraphIdentity>]
: identity[Phone <IMicrosoftGraphIdentity>]
: identity
[Description <IMicrosoftGraphItemBody>]
: itemBody[DisplayName <String>]
: The display name of the virtual event.[EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.[Id <String>]
: The unique identifier for an entity. Read-only.[Email <String>]
: Email address of the presenter.[Identity <IMicrosoftGraphIdentity>]
: identity[PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Bio <IMicrosoftGraphItemBody>]
: itemBody[Company <String>]
: The presenter's company name.[JobTitle <String>]
: The presenter's job title.[LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.[PersonalSiteWebUrl <String>]
: The presenter's personal website URL.[Photo <Byte-
[]>]
: The content stream of the presenter's photo.[TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
[Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:[AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.[AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.[AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.[AllowLiveShare <String>]
: meetingLiveShareOptions[AllowMeetingChat <String>]
: meetingChatMode[AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.[AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.[AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.[AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.[AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.[AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.[AllowedPresenters <String>]
: onlineMeetingPresenters[AnonymizeIdentityForRoles <String-
[]>]
: 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.[AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting. Read-only.[AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing[ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo[ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions[IsEndToEndEncryptionEnabled <Boolean?>]
:[IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.[JoinInformation <IMicrosoftGraphItemBody>]
: itemBody[JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings[JoinWebUrl <String>]
: The join URL of the online meeting. Read-only.[LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings[RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.[ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode[Subject <String>]
: The subject of the online meeting.[VideoTeleconferenceId <String>]
: The video teleconferencing ID. Read-only.[WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues[Id <String>]
: The unique identifier for an entity. Read-only.[EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:[Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event. Only appears when applicable. 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.[Email <String>]
: Email address of the registrant.[FirstName <String>]
: First name of the registrant.[LastName <String>]
: Last name of the registrant.[PreferredLanguage <String>]
: The registrant's preferred language.[PreferredTimezone <String>]
: The registrant's time zone details.[RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event. 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.[RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.[BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion. Only appears when answerInputType is boolean.[DisplayName <String>]
: Display name of the registration question.[MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion. Only appears when answerInputType is multiChoice.[QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.[Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion. Appears when answerInputType is text, multilineText or singleChoice.
[Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:[Status <String>]
: virtualEventAttendeeRegistrationStatus[UserId <String>]
: The registrant's ID in Microsoft Entra ID. Only appears when the registrant is registered in Microsoft Entra ID.
[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.[Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: virtualEventStatus[Id <String>]
: The unique identifier for an entity. Read-only.[Audience <String>]
: meetingAudience[CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[TenantId <String>]
: The user's tenant ID.
[RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Capacity <Int32?>]
: Total capacity of the virtual event.[Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Display name of the registration question.[IsRequired <Boolean?>]
: Indicates whether an answer to the question is required. The default value is false.
[RegistrationWebUrl <String>]
: Registration URL of the virtual event.[Id <String>]
: The unique identifier for an entity. Read-only.[IsManualApprovalEnabled <Boolean?>]
:[IsWaitlistEnabled <Boolean?>]
:
[Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
[WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.[Id <String>]
: The unique identifier for an entity. Read-only.[DeviceMacAddress <String>]
: Device Mac address.[DeviceName <String>]
: Device name.[DeviceRegistrationId <String>]
: Device identifier for this device registration record.[DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.[LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.[UserId <String>]
: UserId associated with this device registration record.
CALENDAR <IMicrosoftGraphCalendar>
: calendar
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
CALENDARGROUPS <IMicrosoftGraphCalendarGroup- []
>: The user's calendar groups.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
[ChangeKey <String>]
: Identifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[ClassId <String>]
: The class identifier. Read-only.[Name <String>]
: The group name.
CALENDARS <IMicrosoftGraphCalendar- []
>: The user's calendars.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
CALENDARVIEW <IMicrosoftGraphEvent- []
>: The calendar view for the calendar.
Read-only.
Nullable.
[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
CHATS <IMicrosoftGraphChat- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[ChatType <String>]
: chatType[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedDateTime <DateTime?>]
: Date and time at which the chat was created. Read-only.[InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet[(Any) <Object>]
: This indicates any property can be added to this object.[ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.[PermissionType <String>]
: teamsAppResourceSpecificPermissionType[PermissionValue <String>]
: The name of the resource-specific permission.
[ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Scope <String>]
: teamsAppInstallationScopes
[TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedInstallationScopes <String>]
: teamsAppInstallationScopes[Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization[(Any) <Object>]
: This indicates any property can be added to this object.[ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.[RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
[AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.[Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentBytes <Byte-
[]>]
: Write only. Bytes for the hosted content (such as images).[ContentType <String>]
: Write only. Content type, such as image/png, image/jpg.
[WebUrl <String>]
: The web URL that can be used for downloading the image.
[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource[(Any) <Object>]
: This indicates any property can be added to this object.[BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition. This is a unique app ID for the bot as registered with the Bot Framework.
[SourceType <String>]
: teamsAppDashboardCardSourceType
[DefaultSize <String>]
: teamsAppDashboardCardSize[Description <String>]
: The description for the card. Required.[DisplayName <String>]
: The name of the card. Required.[Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon[(Any) <Object>]
: This indicates any property can be added to this object.[IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL. The preferred size for raster images is 28x28 pixels. If this property has a value, the officeFabricIconFontName property is ignored.[OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified. For example, 'officeUIFabricIconName': 'Search'.
[PickerGroupId <String>]
: ID for the group in the card picker. Required.
[Description <String>]
:[DisplayName <String>]
: The name of the app provided by the app developer.[LastModifiedDateTime <DateTime?>]
:[OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon[PublishingState <String>]
: teamsAppPublishingState[Shortdescription <String>]
:[TeamsAppId <String>]
: The ID from the Teams app manifest.[Version <String>]
: The version number of the application.
[DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.[DistributionMethod <String>]
: teamsAppDistributionMethod[ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
[TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
[IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members. Read-only.[LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.[EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail[(Any) <Object>]
: This indicates any property can be added to this object.
[From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.[MessageType <String>]
: chatMessageType
[LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed. Read-only.[Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the user.[Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
[Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.[Content <String>]
: 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.[ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet. application/vnd.microsoft.card.announcement: An announcement header.[ContentUrl <String>]
: The URL for the content of the attachment.[Id <String>]
: Read-only. The unique id of the attachment.[Name <String>]
: Name of the attachment.[TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.[ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
[Body <IMicrosoftGraphItemBody>]
: itemBody[ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[ChannelId <String>]
: The identity of the channel in which the message was posted.[TeamId <String>]
: The identity of the team in which the message was posted.
[ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.[CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.[DeletedDateTime <DateTime?>]
: Read only. Timestamp at which the chat message was deleted, or null if not deleted.[Etag <String>]
: Read-only. Version number of the chat message.[EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail[From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet[HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.[ContentBytes <Byte-
[]>]
: Write only. Bytes for the hosted content (such as images).[ContentType <String>]
: Write only. Content type, such as image/png, image/jpg.[Id <String>]
: The unique identifier for an entity. Read-only.
[Importance <String>]
: chatMessageImportance[LastEditedDateTime <DateTime?>]
: 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.[LastModifiedDateTime <DateTime?>]
: Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.[Locale <String>]
: Locale of the chat message set by the client. Always set to en-us.[Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.[Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage. Matches the {index} value in the corresponding<at id='{index}'>
tag in the message body.[MentionText <String>]
: String used to represent the mention. For example, a user's display name, a team name.[Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity[Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[ConversationIdentityType <String>]
: teamworkConversationIdentityType
[Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.[Actions <String>]
: chatMessageActions[ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.[Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedDateTime <DateTime?>]
: 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.[DisplayName <String>]
: The name of the reaction.[ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.[ReactionType <String>]
: The reaction type. Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.[User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[MessageType <String>]
: chatMessageType[OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet[PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation[(Any) <Object>]
: This indicates any property can be added to this object.[DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes[JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.[PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip[(Any) <Object>]
: This indicates any property can be added to this object.[ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization. (ie, policies about what users shouldn't say in chats)[GeneralText <String>]
: Explanatory text shown to the sender of the message.[MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app. Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
[UserAction <String>]
: chatMessagePolicyViolationUserActionTypes[VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
[Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).[Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message. Supports $expand for channel messages.[ReplyToId <String>]
: Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)[Subject <String>]
: The subject of the chat message, in plaintext.[Summary <String>]
: 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.[WebUrl <String>]
: Read-only. Link to the message in Microsoft Teams.
[OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.[JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.[Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[UserIdentityType <String>]
: teamworkUserIdentityType
[Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.[CreatedDateTime <DateTime?>]
: Time when the operation was created.[Error <IMicrosoftGraphOperationError>]
: operationError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: Operation error code.[Message <String>]
: Operation error message.
[LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.[OperationType <String>]
: teamsAsyncOperationType[Status <String>]
: teamsAsyncOperationStatus[TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.[TargetResourceLocation <String>]
: 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.
[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.[ClientId <String>]
: ID of the Microsoft Entra app that has been granted access. Read-only.[Permission <String>]
: The name of the resource-specific permission. Read-only.[PermissionType <String>]
: The type of permission. Possible values are: Application, Delegated. Read-only.[ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource. Read-only.
[PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Message <IMicrosoftGraphChatMessage>]
: chatMessage
[Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[ContentUrl <String>]
: Url used for rendering tab contents in Teams. Required.[EntityId <String>]
: Identifier for the entity hosted by the tab provider.[RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.[WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
[DisplayName <String>]
: Name of the tab.[MessageId <String>]
:[SortOrderIndex <String>]
: Index of the order used for sorting tabs.[TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp[TeamsAppId <String>]
: App definition identifier of the tab. This value can't be changed after tab creation. Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.[WebUrl <String>]
: Deep link URL of the tab instance. Read only.
[TenantId <String>]
: The identifier of the tenant in which the chat was created. Read-only.[Topic <String>]
: (Optional) Subject or topic for the chat. Only available for group chats.[Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint[(Any) <Object>]
: This indicates any property can be added to this object.[IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.[LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
[WebUrl <String>]
: The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.
CLOUDCLIPBOARD <IMicrosoftGraphCloudClipboardRoot>
: cloudClipboardRoot
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expires and after that the object is no longer available. The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.[LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request. DateTime in UTC when the object was modified by the client.[Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads. A window can place more than one clipboard object on the clipboard. Each one represents the same information in a different clipboard format.[Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.[FormatName <String>]
: For a list of possible values see formatName values.
CLOUDPCS <IMicrosoftGraphCloudPc- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.[AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment. When the provisioningType is dedicated, the allotment name is null. Read-only.[ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting[(Any) <Object>]
: This indicates any property can be added to this object.[EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled. The default value is false.
[ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings[(Any) <Object>]
: This indicates any property can be added to this object.[EnableSingleSignOn <Boolean?>]
:
[ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult[(Any) <Object>]
: This indicates any property can be added to this object.[FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items. If the status property is available, this property is empty.[AdditionalDetails <String>]
: Additional message for this health check.[DisplayName <String>]
: The connectivity health check item name.[LastHealthCheckDateTime <DateTime?>]
: 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.[Result <String>]
: cloudPcConnectivityEventResult
[LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.[Status <String>]
: cloudPcConnectivityStatus[UpdatedDateTime <DateTime?>]
: Datetime when the status was updated. This property is deprecated and will no longer be supported effective August 31, 2024. Use lastModifiedDateTime instead. Read-Only.
[DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned. For example, westus3, eastus2, and southeastasia. Read-only.[DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability[(Any) <Object>]
: This indicates any property can be added to this object.[CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType[PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.[SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
[DiskEncryptionState <String>]
: cloudPcDiskEncryptionState[DisplayName <String>]
: The display name of the Cloud PC.[GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens. 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.[ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.[LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult[(Any) <Object>]
: This indicates any property can be added to this object.[Time <DateTime?>]
: 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.
[LastModifiedDateTime <DateTime?>]
: 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.[LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult[(Any) <Object>]
: This indicates any property can be added to this object.[ActionName <String>]
: 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.[ActionState <String>]
: actionState[CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed. Read-only.[LastUpdatedDateTime <DateTime?>]
: 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'.[ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed. Read-only.[StartDateTime <DateTime?>]
: 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'.[StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail[(Any) <Object>]
: This indicates any property can be added to this object.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status. For example, 'additionalInformation': -['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'[Name <String>]
: Name for this key-value pair[Value <String>]
: Value for this key-value pair
[Code <String>]
: The error/warning code associated with the Cloud PC status. Example: 'code': 'internalServerError'.[Message <String>]
: The status message associated with error code. Example: 'message': 'There was an internal server error. Please contact support xxx.'.
[StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails[(Any) <Object>]
: This indicates any property can be added to this object.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.[Code <String>]
: The code associated with the Cloud PC status.[Message <String>]
: The status message.
[ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.[ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.[OSVersion <String>]
: cloudPcOperatingSystem[OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.[PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.[ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.[InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus[IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.[PartnerAgentName <String>]
: cloudPcPartnerAgentName[Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried. The default value is false.
[PowerState <String>]
: cloudPcPowerState[ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.[ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.[ProvisioningType <String>]
: cloudPcProvisioningType[ScopeIds <String-
[]>]
:[ServicePlanId <String>]
: The service plan ID of the Cloud PC.[ServicePlanName <String>]
: The service plan name of the Cloud PC.[ServicePlanType <String>]
: cloudPcServicePlanType[Status <String>]
: cloudPcStatus[StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail[StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails[UserAccountType <String>]
: cloudPcUserAccountType[UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
CLOUDREALTIMECOMMUNICATIONINFO <IMicrosoftGraphCloudRealtimeCommunicationInfo>
: cloudRealtimeCommunicationInfo
[(Any) <Object>]
: This indicates any property can be added to this object.[IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them. Read-only.
CONTACTFOLDERS <IMicrosoftGraphContactFolder- []
>: The user's contacts folders.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder. Navigation property. Read-only. Nullable.[Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder. Navigation property. Read-only. Nullable.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AssistantName <String>]
: The name of the contact's assistant.[Birthday <DateTime?>]
: The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Children <String-
[]>]
: The names of the contact's children.[CompanyName <String>]
: The name of the contact's company.[Department <String>]
: The contact's department.[DisplayName <String>]
: The contact's display name. You can specify the display name in a create or update operation. Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified. To preserve a pre-existing value, always include it as displayName in an update operation.[EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.[OtherLabel <String>]
: 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.[Type <String>]
: emailType
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[FileAs <String>]
: The name the contact is filed under.[Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag[(Any) <Object>]
: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[FlagStatus <String>]
: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Gender <String>]
: The contact's gender.[Generation <String>]
: The contact's suffix.[GivenName <String>]
: The contact's given name.[ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.[Initials <String>]
: The contact's initials.[IsFavorite <Boolean?>]
:[JobTitle <String>]
: The contact's job title.[Manager <String>]
: The name of the contact's manager.[MiddleName <String>]
: The contact's middle name.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[NickName <String>]
: The contact's nickname.[OfficeLocation <String>]
: The location of the contact's office.[ParentFolderId <String>]
: The ID of the contact's parent folder.[PersonalNotes <String>]
: The user's notes about the contact.[Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Height <Int32?>]
: The height of the photo. Read-only.[Width <Int32?>]
: The width of the photo. Read-only.
[PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Profession <String>]
: The contact's profession.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[SpouseName <String>]
: The name of the contact's spouse/partner.[Surname <String>]
: The contact's surname.[Title <String>]
: The contact's title.[Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.[Address <String>]
: The URL of the website.[DisplayName <String>]
: The display name of the web site.[Type <String>]
: websiteType
[WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.[YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.[YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.[YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
[DisplayName <String>]
: The folder's display name.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.[ParentFolderId <String>]
: The ID of the folder's parent folder.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.[WellKnownName <String>]
: The name of the folder if the folder is a recognized folder. Currently contacts is the only recognized contacts folder.
CONTACTS <IMicrosoftGraphContact- []
>: The user's contacts.
Read-only.
Nullable.
[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AssistantName <String>]
: The name of the contact's assistant.[Birthday <DateTime?>]
: The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Children <String-
[]>]
: The names of the contact's children.[CompanyName <String>]
: The name of the contact's company.[Department <String>]
: The contact's department.[DisplayName <String>]
: The contact's display name. You can specify the display name in a create or update operation. Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified. To preserve a pre-existing value, always include it as displayName in an update operation.[EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.[OtherLabel <String>]
: 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.[Type <String>]
: emailType
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[FileAs <String>]
: The name the contact is filed under.[Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag[(Any) <Object>]
: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[FlagStatus <String>]
: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Gender <String>]
: The contact's gender.[Generation <String>]
: The contact's suffix.[GivenName <String>]
: The contact's given name.[ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.[Initials <String>]
: The contact's initials.[IsFavorite <Boolean?>]
:[JobTitle <String>]
: The contact's job title.[Manager <String>]
: The name of the contact's manager.[MiddleName <String>]
: The contact's middle name.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[NickName <String>]
: The contact's nickname.[OfficeLocation <String>]
: The location of the contact's office.[ParentFolderId <String>]
: The ID of the contact's parent folder.[PersonalNotes <String>]
: The user's notes about the contact.[Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Height <Int32?>]
: The height of the photo. Read-only.[Width <Int32?>]
: The width of the photo. Read-only.
[PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Profession <String>]
: The contact's profession.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[SpouseName <String>]
: The name of the contact's spouse/partner.[Surname <String>]
: The contact's surname.[Title <String>]
: The contact's title.[Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.[Address <String>]
: The URL of the website.[DisplayName <String>]
: The display name of the web site.[Type <String>]
: websiteType
[WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.[YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.[YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.[YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
CREATEDOBJECTS <IMicrosoftGraphDirectoryObject- []
>: Directory objects that the user created.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
DEVICEENROLLMENTCONFIGURATIONS <IMicrosoftGraphDeviceEnrollmentConfiguration- []
>: Get enrollment configurations targeted to the user
[Id <String>]
: The unique identifier for an entity. Read-only.[Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile[Id <String>]
: The unique identifier for an entity. Read-only.[Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.[SourceId <String>]
: Identifier for resource used for deployment to a group[Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.[(Any) <Object>]
: This indicates any property can be added to this object.[DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.[DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
[CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration[Description <String>]
: The description of the device enrollment configuration[DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity[DisplayName <String>]
: The display name of the device enrollment configuration[LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration[Priority <Int32?>]
: 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.[RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.[Version <Int32?>]
: The version of the device enrollment configuration
DEVICEKEYS <IMicrosoftGraphDeviceKey- []
>: .
[DeviceId <String>]
:[KeyMaterial <Byte-
[]>]
:[KeyType <String>]
:
DEVICEMANAGEMENTTROUBLESHOOTINGEVENTS <IMicrosoftGraphDeviceManagementTroubleshootingEvent- []
>: The list of troubleshooting events for this user.
[Id <String>]
: The unique identifier for an entity. Read-only.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event[Name <String>]
: Name for this key-value pair[Value <String>]
: Value for this key-value pair
[CorrelationId <String>]
: Id used for tracing the failure in the service.[EventDateTime <DateTime?>]
: Time when the event occurred .[EventName <String>]
: Event Name corresponding to the Troubleshooting Event. It is an Optional field[TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.[(Any) <Object>]
: This indicates any property can be added to this object.[Context <String>]
:[Failure <String>]
:[FailureDetails <String>]
: The detailed description of what went wrong.[Remediation <String>]
: The detailed description of how to remediate this issue.[Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.[Link <String>]
: The link to the web resource. Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}[Text <String>]
:
DEVICES <IMicrosoftGraphDevice- []
>: .
[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. Default is true. Supports $filter (eq, ne, not, in). Only callers with at least the Cloud Device Administrator role can set this property.[AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le).[IdentityProvider <String>]
: For internal use only.[Key <Byte-
[]>]
: For internal use only.[Type <Int32?>]
: For internal use only.
[ApproximateLastSignInDateTime <DateTime?>]
: 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.[Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.[Id <String>]
: The unique identifier for an entity. Read-only.[AppServiceName <String>]
:[Error <String>]
:[PackageFamilyName <String>]
:[Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest[(Any) <Object>]
: This indicates any property can be added to this object.
[PermissionTicket <String>]
:[PostBackUri <String>]
:[Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[Status <String>]
:[Type <String>]
:
[ComplianceExpirationDateTime <DateTime?>]
: 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.[DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.[DeviceId <String>]
: 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).[DeviceMetadata <String>]
: For internal use only. Set to null.[DeviceOwnership <String>]
: Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal.[DeviceVersion <Int32?>]
: For internal use only.[DisplayName <String>]
: The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices. This property is set by Intune.[EnrollmentProfileName <String>]
: 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.[EnrollmentType <String>]
: Enrollment type of the device. This property is set by Intune. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed.[ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes[(Any) <Object>]
: This indicates any property can be added to this object.[ExtensionAttribute1 <String>]
: First customizable extension attribute.[ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.[ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.[ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.[ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.[ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.[ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.[ExtensionAttribute2 <String>]
: Second customizable extension attribute.[ExtensionAttribute3 <String>]
: Third customizable extension attribute.[ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.[ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.[ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.[ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.[ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.[ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[Hostnames <String-
[]>]
: List of host names for the device.[IsCompliant <Boolean?>]
: 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).[IsManaged <Boolean?>]
: 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).[IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsRooted <Boolean?>]
: true if the device is rooted or jail-broken. This property can only be updated by Intune.[Kind <String>]
: Form factor of the device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ManagementType <String>]
: 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.[Manufacturer <String>]
: Manufacturer of the device. Read-only.[MdmAppId <String>]
: Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. Read-only. Nullable. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[Model <String>]
: Model of the device. Read-only.[Name <String>]
: Friendly name of the device. Only returned if user signs in with a Microsoft account as part of Project Rome.[OnPremisesLastSyncDateTime <DateTime?>]
: 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).[OnPremisesSecurityIdentifier <String>]
: 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).[OnPremisesSyncEnabled <Boolean?>]
: 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).[OperatingSystem <String>]
: The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[OperatingSystemVersion <String>]
: Operating system version of the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).[PhysicalIds <String-
[]>]
: For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.[Platform <String>]
: Platform of device. Only returned if the user signs in with a Microsoft account as part of Project Rome.[ProfileType <String>]
: The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.[RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[RegistrationDateTime <DateTime?>]
: 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.[Status <String>]
: Device is online or offline. Only returned if user signs in with a Microsoft account as part of Project Rome.[SystemLabels <String-
[]>]
: List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of. This operation is transitive. Supports $expand.[TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.[UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.[Id <String>]
: The unique identifier for an entity. Read-only.[CatalogId <String>]
: Product id corresponding to the usage right.[ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.[State <String>]
: usageRightState
DIRECTREPORTS <IMicrosoftGraphDirectoryObject- []
>: 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.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
DRIVE <IMicrosoftGraphDrive>
: drive
[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).
- [DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled.
IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]
: The unique identifier for the SKU.
Corresponds to the skuId from subscribedSkus or companySubscription.
- [AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar.
If the user has never explicitly set a group for the calendar, this property is null.
- [CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar.
Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.
- [IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise.
The 'My organization' user determines the permissions other people within your organization have to the given calendar.
You can't remove 'My organization' as a recipient to a calendar.
- [Role <String>]
: calendarRoleType
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Navigation property.
Read-only.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false.
Optional.
Default is true.
- [Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event.
Navigation property.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentType <String>]
: The MIME type.
- [IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.
- [LastModifiedDateTime <DateTime?>]
: 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
- [Name <String>]
: The display name of the attachment.
This does not need to be the actual file name.
- [Size <Int32?>]
: The length of the attachment in bytes.
- [Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.
- [Type <String>]
: attendeeType
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
- [TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <IMicrosoftGraphResponseStatus>]
: responseStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Response <String>]
: responseType
- [Time <DateTime?>]
: The date and time that the response was returned.
It uses ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <String>]
: The content of the item.
- [ContentType <String>]
: bodyType
- [BodyPreview <String>]
: The preview of the message associated with the event.
It is in text format.
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master.
Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event.
Nullable.
- [HasAttachments <Boolean?>]
: Set to true if the event has attachments.
- [HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
Default is false.
- [ICalUId <String>]
: A unique identifier for an event across calendars.
This ID is different for each occurrence in a recurring series.
Read-only.
- [Importance <String>]
: importance
- [Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master.
This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified.
It doesn't include occurrences that have been canceled from the series.
Navigation property.
Read-only.
Nullable.
- [IsAllDay <Boolean?>]
: Set to true if the event lasts all day.
If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
- [IsCancelled <Boolean?>]
: Set to true if the event has been canceled.
- [IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
Set to false if all changes have been sent, or if the event is an appointment without any attendees.
- [IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
Default is false (onlineMeeting is null).
Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.
- [IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event).
This also applies if a delegate organized the event on behalf of the owner.
- [IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.
- [Location <IMicrosoftGraphLocation>]
: location
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [City <String>]
: The city.
- [CountryOrRegion <String>]
: The country or region.
It's a free-format string value, for example, 'United States'.
- [PostOfficeBox <String>]
: The post office box number.
- [PostalCode <String>]
: The postal code.
- [State <String>]
: The state.
- [Street <String>]
: The street.
- [Type <String>]
: physicalAddressType
- [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Accuracy <Double?>]
: The accuracy of the latitude and longitude.
As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
- [Altitude <Double?>]
: The altitude of the location.
- [AltitudeAccuracy <Double?>]
: The accuracy of the altitude.
- [Latitude <Double?>]
: The latitude of the location.
- [Longitude <Double?>]
: The longitude of the location.
- [DisplayName <String>]
: The name associated with the location.
- [LocationEmailAddress <String>]
: Optional email address of the location.
- [LocationType <String>]
: locationType
- [LocationUri <String>]
: Optional URI representing the location.
- [UniqueId <String>]
: For internal use only.
- [UniqueIdType <String>]
: locationUniqueIdType
- [Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from.
The location and locations properties always correspond with each other.
If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String-
[]>]
: A collection of property values.
- [OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series.
Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}.
The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled.
You can use this property to perform all operations supported by occurrences in the recurring series.
- [OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ConferenceId <String>]
: The ID of the conference.
- [JoinUrl <String>]
: The external link that launches the online meeting.
This is a URL that clients launch into a browser and will redirect the user to join the meeting.
- [Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.
- [Number <String>]
: The phone number.
- [Type <String>]
: phoneType
- [QuickDial <String>]
: The preformatted quick dial for this call.
- [TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.
- [TollNumber <String>]
: The toll number that can be used to join the conference.
- [OnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [OnlineMeetingUrl <String>]
: A URL for an online meeting.
The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype.
Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event.
The onlineMeetingUrl property will be deprecated in the future.
- [Organizer <IMicrosoftGraphRecipient>]
: recipient
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series.
This property isn't returned for events that are single instances.
Its date and time information is expressed in ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DayOfMonth <Int32?>]
: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
- [DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
- [FirstDayOfWeek <String>]
: dayOfWeek
- [Index <String>]
: weekIndex
- [Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
- [Month <Int32?>]
: The month in which the event occurs.
This is a number from 1 to 12.
- [Type <String>]
: recurrencePatternType
- [Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDate <DateTime?>]
: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
- [NumberOfOccurrences <Int32?>]
: The number of times to repeat the event.
Required and must be positive if type is numbered.
- [RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
- [StartDate <DateTime?>]
: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
- [Type <String>]
: recurrenceRangeType
- [ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.
- [ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.
- [ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus
- [Sensitivity <String>]
: sensitivity
- [SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.
- [ShowAs <String>]
: freeBusyStatus
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String>]
: A property value.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Subject <String>]
: The text of the event's subject line.
- [TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event.
This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request.
After you set transactionId when creating an event, you can't change transactionId in a subsequent update.
This property is only returned in a response payload if an app has set it.
Optional.
- [Type <String>]
: eventType
- [Uid <String>]
: A unique identifier for calendar events.
For recurring events, the value is the same for the series master and all of its occurrences including exceptions.
- [WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox.
Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
- [CanEdit <Boolean?>]
: 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.
- [CanShare <Boolean?>]
: 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.
- [CanViewPrivateItems <Boolean?>]
: 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.
- [ChangeKey <String>]
: 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.
- [Color <String>]
: calendarColor
- [DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar.
Navigation property.
Read-only.
- [HexColor <String>]
: 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.
- [IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.
- [IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.
- [IsShared <Boolean?>]
: 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.
- [IsSharedWithMe <Boolean?>]
: 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.
- [IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses.
Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar.
Read-only.
Nullable.
- [Name <String>]
: The calendar name.
- [Owner <IMicrosoftGraphEmailAddress>]
: emailAddress
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar.
Read-only.
Nullable.
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [Drives <IMicrosoftGraphDrive-
[]>]
: A collection of drives available for this user.
Read-only.
- [EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
: employeeExperienceUser
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LearningCourseActivities <IMicrosoftGraphLearningCourseActivity-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CompletedDateTime <DateTime?>]
: Date and time when the assignment was completed.
Optional.
- [CompletionPercentage <Int32?>]
: The percentage completion value of the course activity.
Optional.
- [ExternalcourseActivityId <String>]
:
- [LearnerUserId <String>]
: The user ID of the learner to whom the activity is assigned.
Required.
- [LearningContentId <String>]
: The ID of the learning content created in Viva Learning.
Required.
- [LearningProviderId <String>]
: The registration ID of the provider.
Required.
- [Status <String>]
: courseStatus
- [EmployeeHireDate <DateTime?>]
: 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).
- [EmployeeId <String>]
: The employee identifier assigned to the user by the organization.
The maximum length is 16 characters.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [EmployeeLeaveDateTime <DateTime?>]
: The date and time when the user left or will leave the organization.
To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission.
To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions.
To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader.
To write this property in delegated scenarios, the admin needs the Global Administrator role.
Supports $filter (eq, ne, not , ge, le, in).
For more information, see Configure the employeeLeaveDateTime property for a user.
- [EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
: employeeOrgData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CostCenter <String>]
: The cost center associated with the user.
Returned only on $select.
Supports $filter.
- [Division <String>]
: The name of the division in which the user works.
Returned only on $select.
Supports $filter.
- [EmployeeType <String>]
: Captures enterprise worker type.
For example, Employee, Contractor, Consultant, or Vendor.
Supports $filter (eq, ne, not , ge, le, in, startsWith).
- [Events <IMicrosoftGraphEvent-
[]>]
: The user's events.
The default is to show events under the Default Calendar.
Read-only.
Nullable.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the user.
Supports $expand.
Nullable.
- [ExternalUserState <String>]
: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status.
For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.
Supports $filter (eq, ne, not , in).
- [ExternalUserStateChangeDateTime <String>]
: Shows the timestamp for the latest change to the externalUserState property.
Supports $filter (eq, ne, not , in).
- [FaxNumber <String>]
: The fax number of the user.
Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [FollowedSites <IMicrosoftGraphSite-
[]>]
:
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.[Bundles <IMicrosoftGraphDriveItem-
[]>]
: Collection of bundles (albums and multi-select-shared sets of items). Only in personal OneDrive.[DriveType <String>]
: Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only.[Following <IMicrosoftGraphDriveItem-
[]>]
: The list of items the user is following. Only in OneDrive for Business.[Items <IMicrosoftGraphDriveItem-
[]>]
: All items contained in the drive. Read-only. Nullable.[List <IMicrosoftGraphList>]
: list[Owner <IMicrosoftGraphIdentitySet>]
: identitySet[Quota <IMicrosoftGraphQuota>]
: quota[(Any) <Object>]
: This indicates any property can be added to this object.[Deleted <Int64?>]
: Total space consumed by files in the recycle bin, in bytes. Read-only.[Remaining <Int64?>]
: Total space remaining before reaching the quota limit, in bytes. Read-only.[State <String>]
: Enumeration value that indicates the state of the storage space. Read-only.[StoragePlanInformation <IMicrosoftGraphStoragePlanInformation>]
: storagePlanInformation[(Any) <Object>]
: This indicates any property can be added to this object.[UpgradeAvailable <Boolean?>]
: Indicates if there are higher storage quota plans available. Read-only.
[Total <Int64?>]
: Total allowed storage space, in bytes. Read-only.[Used <Int64?>]
: Total space used, in bytes. Read-only.
[Root <IMicrosoftGraphDriveItem>]
: driveItem[SharePointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Special <IMicrosoftGraphDriveItem-
[]>]
: Collection of common folders available in OneDrive. Read-only. Nullable.[System <IMicrosoftGraphSystemFacet>]
: systemFacet
DRIVES <IMicrosoftGraphDrive- []
>: A collection of drives available for this user.
Read-only.
[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).
- [DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled.
IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]
: The unique identifier for the SKU.
Corresponds to the skuId from subscribedSkus or companySubscription.
- [AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar.
If the user has never explicitly set a group for the calendar, this property is null.
- [CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar.
Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.
- [IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise.
The 'My organization' user determines the permissions other people within your organization have to the given calendar.
You can't remove 'My organization' as a recipient to a calendar.
- [Role <String>]
: calendarRoleType
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Navigation property.
Read-only.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false.
Optional.
Default is true.
- [Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event.
Navigation property.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentType <String>]
: The MIME type.
- [IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.
- [LastModifiedDateTime <DateTime?>]
: 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
- [Name <String>]
: The display name of the attachment.
This does not need to be the actual file name.
- [Size <Int32?>]
: The length of the attachment in bytes.
- [Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.
- [Type <String>]
: attendeeType
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
- [TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <IMicrosoftGraphResponseStatus>]
: responseStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Response <String>]
: responseType
- [Time <DateTime?>]
: The date and time that the response was returned.
It uses ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <String>]
: The content of the item.
- [ContentType <String>]
: bodyType
- [BodyPreview <String>]
: The preview of the message associated with the event.
It is in text format.
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master.
Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event.
Nullable.
- [HasAttachments <Boolean?>]
: Set to true if the event has attachments.
- [HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
Default is false.
- [ICalUId <String>]
: A unique identifier for an event across calendars.
This ID is different for each occurrence in a recurring series.
Read-only.
- [Importance <String>]
: importance
- [Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master.
This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified.
It doesn't include occurrences that have been canceled from the series.
Navigation property.
Read-only.
Nullable.
- [IsAllDay <Boolean?>]
: Set to true if the event lasts all day.
If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
- [IsCancelled <Boolean?>]
: Set to true if the event has been canceled.
- [IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
Set to false if all changes have been sent, or if the event is an appointment without any attendees.
- [IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
Default is false (onlineMeeting is null).
Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.
- [IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event).
This also applies if a delegate organized the event on behalf of the owner.
- [IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.
- [Location <IMicrosoftGraphLocation>]
: location
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [City <String>]
: The city.
- [CountryOrRegion <String>]
: The country or region.
It's a free-format string value, for example, 'United States'.
- [PostOfficeBox <String>]
: The post office box number.
- [PostalCode <String>]
: The postal code.
- [State <String>]
: The state.
- [Street <String>]
: The street.
- [Type <String>]
: physicalAddressType
- [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Accuracy <Double?>]
: The accuracy of the latitude and longitude.
As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
- [Altitude <Double?>]
: The altitude of the location.
- [AltitudeAccuracy <Double?>]
: The accuracy of the altitude.
- [Latitude <Double?>]
: The latitude of the location.
- [Longitude <Double?>]
: The longitude of the location.
- [DisplayName <String>]
: The name associated with the location.
- [LocationEmailAddress <String>]
: Optional email address of the location.
- [LocationType <String>]
: locationType
- [LocationUri <String>]
: Optional URI representing the location.
- [UniqueId <String>]
: For internal use only.
- [UniqueIdType <String>]
: locationUniqueIdType
- [Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from.
The location and locations properties always correspond with each other.
If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String-
[]>]
: A collection of property values.
- [OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series.
Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}.
The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled.
You can use this property to perform all operations supported by occurrences in the recurring series.
- [OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ConferenceId <String>]
: The ID of the conference.
- [JoinUrl <String>]
: The external link that launches the online meeting.
This is a URL that clients launch into a browser and will redirect the user to join the meeting.
- [Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.
- [Number <String>]
: The phone number.
- [Type <String>]
: phoneType
- [QuickDial <String>]
: The preformatted quick dial for this call.
- [TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.
- [TollNumber <String>]
: The toll number that can be used to join the conference.
- [OnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [OnlineMeetingUrl <String>]
: A URL for an online meeting.
The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype.
Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event.
The onlineMeetingUrl property will be deprecated in the future.
- [Organizer <IMicrosoftGraphRecipient>]
: recipient
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series.
This property isn't returned for events that are single instances.
Its date and time information is expressed in ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DayOfMonth <Int32?>]
: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
- [DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
- [FirstDayOfWeek <String>]
: dayOfWeek
- [Index <String>]
: weekIndex
- [Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
- [Month <Int32?>]
: The month in which the event occurs.
This is a number from 1 to 12.
- [Type <String>]
: recurrencePatternType
- [Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDate <DateTime?>]
: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
- [NumberOfOccurrences <Int32?>]
: The number of times to repeat the event.
Required and must be positive if type is numbered.
- [RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
- [StartDate <DateTime?>]
: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
- [Type <String>]
: recurrenceRangeType
- [ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.
- [ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.
- [ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus
- [Sensitivity <String>]
: sensitivity
- [SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.
- [ShowAs <String>]
: freeBusyStatus
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String>]
: A property value.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Subject <String>]
: The text of the event's subject line.
- [TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event.
This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request.
After you set transactionId when creating an event, you can't change transactionId in a subsequent update.
This property is only returned in a response payload if an app has set it.
Optional.
- [Type <String>]
: eventType
- [Uid <String>]
: A unique identifier for calendar events.
For recurring events, the value is the same for the series master and all of its occurrences including exceptions.
- [WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox.
Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
- [CanEdit <Boolean?>]
: 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.
- [CanShare <Boolean?>]
: 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.
- [CanViewPrivateItems <Boolean?>]
: 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.
- [ChangeKey <String>]
: 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.
- [Color <String>]
: calendarColor
- [DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar.
Navigation property.
Read-only.
- [HexColor <String>]
: 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.
- [IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.
- [IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.
- [IsShared <Boolean?>]
: 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.
- [IsSharedWithMe <Boolean?>]
: 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.
- [IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses.
Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar.
Read-only.
Nullable.
- [Name <String>]
: The calendar name.
- [Owner <IMicrosoftGraphEmailAddress>]
: emailAddress
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar.
Read-only.
Nullable.
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [Drives <IMicrosoftGraphDrive-
[]>]
: A collection of drives available for this user.
Read-only.
- [EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
: employeeExperienceUser
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LearningCourseActivities <IMicrosoftGraphLearningCourseActivity-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CompletedDateTime <DateTime?>]
: Date and time when the assignment was completed.
Optional.
- [CompletionPercentage <Int32?>]
: The percentage completion value of the course activity.
Optional.
- [ExternalcourseActivityId <String>]
:
- [LearnerUserId <String>]
: The user ID of the learner to whom the activity is assigned.
Required.
- [LearningContentId <String>]
: The ID of the learning content created in Viva Learning.
Required.
- [LearningProviderId <String>]
: The registration ID of the provider.
Required.
- [Status <String>]
: courseStatus
- [EmployeeHireDate <DateTime?>]
: 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).
- [EmployeeId <String>]
: The employee identifier assigned to the user by the organization.
The maximum length is 16 characters.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [EmployeeLeaveDateTime <DateTime?>]
: The date and time when the user left or will leave the organization.
To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission.
To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions.
To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader.
To write this property in delegated scenarios, the admin needs the Global Administrator role.
Supports $filter (eq, ne, not , ge, le, in).
For more information, see Configure the employeeLeaveDateTime property for a user.
- [EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
: employeeOrgData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CostCenter <String>]
: The cost center associated with the user.
Returned only on $select.
Supports $filter.
- [Division <String>]
: The name of the division in which the user works.
Returned only on $select.
Supports $filter.
- [EmployeeType <String>]
: Captures enterprise worker type.
For example, Employee, Contractor, Consultant, or Vendor.
Supports $filter (eq, ne, not , ge, le, in, startsWith).
- [Events <IMicrosoftGraphEvent-
[]>]
: The user's events.
The default is to show events under the Default Calendar.
Read-only.
Nullable.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the user.
Supports $expand.
Nullable.
- [ExternalUserState <String>]
: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status.
For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.
Supports $filter (eq, ne, not , in).
- [ExternalUserStateChangeDateTime <String>]
: Shows the timestamp for the latest change to the externalUserState property.
Supports $filter (eq, ne, not , in).
- [FaxNumber <String>]
: The fax number of the user.
Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [FollowedSites <IMicrosoftGraphSite-
[]>]
:
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.[Bundles <IMicrosoftGraphDriveItem-
[]>]
: Collection of bundles (albums and multi-select-shared sets of items). Only in personal OneDrive.[DriveType <String>]
: Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only.[Following <IMicrosoftGraphDriveItem-
[]>]
: The list of items the user is following. Only in OneDrive for Business.[Items <IMicrosoftGraphDriveItem-
[]>]
: All items contained in the drive. Read-only. Nullable.[List <IMicrosoftGraphList>]
: list[Owner <IMicrosoftGraphIdentitySet>]
: identitySet[Quota <IMicrosoftGraphQuota>]
: quota[(Any) <Object>]
: This indicates any property can be added to this object.[Deleted <Int64?>]
: Total space consumed by files in the recycle bin, in bytes. Read-only.[Remaining <Int64?>]
: Total space remaining before reaching the quota limit, in bytes. Read-only.[State <String>]
: Enumeration value that indicates the state of the storage space. Read-only.[StoragePlanInformation <IMicrosoftGraphStoragePlanInformation>]
: storagePlanInformation[(Any) <Object>]
: This indicates any property can be added to this object.[UpgradeAvailable <Boolean?>]
: Indicates if there are higher storage quota plans available. Read-only.
[Total <Int64?>]
: Total allowed storage space, in bytes. Read-only.[Used <Int64?>]
: Total space used, in bytes. Read-only.
[Root <IMicrosoftGraphDriveItem>]
: driveItem[SharePointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[Special <IMicrosoftGraphDriveItem-
[]>]
: Collection of common folders available in OneDrive. Read-only. Nullable.[System <IMicrosoftGraphSystemFacet>]
: systemFacet
EMPLOYEEEXPERIENCE <IMicrosoftGraphEmployeeExperienceUser>
: employeeExperienceUser
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[LearningCourseActivities <IMicrosoftGraphLearningCourseActivity-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: Date and time when the assignment was completed. Optional.[CompletionPercentage <Int32?>]
: The percentage completion value of the course activity. Optional.[ExternalcourseActivityId <String>]
:[LearnerUserId <String>]
: The user ID of the learner to whom the activity is assigned. Required.[LearningContentId <String>]
: The ID of the learning content created in Viva Learning. Required.[LearningProviderId <String>]
: The registration ID of the provider. Required.[Status <String>]
: courseStatus
EMPLOYEEORGDATA <IMicrosoftGraphEmployeeOrgData>
: employeeOrgData
[(Any) <Object>]
: This indicates any property can be added to this object.[CostCenter <String>]
: The cost center associated with the user. Returned only on $select. Supports $filter.[Division <String>]
: The name of the division in which the user works. Returned only on $select. Supports $filter.
EVENTS <IMicrosoftGraphEvent- []
>: The user's events.
The default is to show events under the Default Calendar.
Read-only.
Nullable.
[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
EXTENSIONS <IMicrosoftGraphExtension- []
>: The collection of open extensions defined for the user.
Supports $expand.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.
FOLLOWEDSITES <IMicrosoftGraphSite- []
>: .
[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).
- [DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled.
IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]
: The unique identifier for the SKU.
Corresponds to the skuId from subscribedSkus or companySubscription.
- [AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar.
If the user has never explicitly set a group for the calendar, this property is null.
- [CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar.
Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.
- [IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise.
The 'My organization' user determines the permissions other people within your organization have to the given calendar.
You can't remove 'My organization' as a recipient to a calendar.
- [Role <String>]
: calendarRoleType
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Navigation property.
Read-only.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false.
Optional.
Default is true.
- [Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event.
Navigation property.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentType <String>]
: The MIME type.
- [IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.
- [LastModifiedDateTime <DateTime?>]
: 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
- [Name <String>]
: The display name of the attachment.
This does not need to be the actual file name.
- [Size <Int32?>]
: The length of the attachment in bytes.
- [Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.
- [Type <String>]
: attendeeType
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
- [TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <IMicrosoftGraphResponseStatus>]
: responseStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Response <String>]
: responseType
- [Time <DateTime?>]
: The date and time that the response was returned.
It uses ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <String>]
: The content of the item.
- [ContentType <String>]
: bodyType
- [BodyPreview <String>]
: The preview of the message associated with the event.
It is in text format.
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master.
Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event.
Nullable.
- [HasAttachments <Boolean?>]
: Set to true if the event has attachments.
- [HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
Default is false.
- [ICalUId <String>]
: A unique identifier for an event across calendars.
This ID is different for each occurrence in a recurring series.
Read-only.
- [Importance <String>]
: importance
- [Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master.
This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified.
It doesn't include occurrences that have been canceled from the series.
Navigation property.
Read-only.
Nullable.
- [IsAllDay <Boolean?>]
: Set to true if the event lasts all day.
If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
- [IsCancelled <Boolean?>]
: Set to true if the event has been canceled.
- [IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
Set to false if all changes have been sent, or if the event is an appointment without any attendees.
- [IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
Default is false (onlineMeeting is null).
Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.
- [IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event).
This also applies if a delegate organized the event on behalf of the owner.
- [IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.
- [Location <IMicrosoftGraphLocation>]
: location
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [City <String>]
: The city.
- [CountryOrRegion <String>]
: The country or region.
It's a free-format string value, for example, 'United States'.
- [PostOfficeBox <String>]
: The post office box number.
- [PostalCode <String>]
: The postal code.
- [State <String>]
: The state.
- [Street <String>]
: The street.
- [Type <String>]
: physicalAddressType
- [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Accuracy <Double?>]
: The accuracy of the latitude and longitude.
As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
- [Altitude <Double?>]
: The altitude of the location.
- [AltitudeAccuracy <Double?>]
: The accuracy of the altitude.
- [Latitude <Double?>]
: The latitude of the location.
- [Longitude <Double?>]
: The longitude of the location.
- [DisplayName <String>]
: The name associated with the location.
- [LocationEmailAddress <String>]
: Optional email address of the location.
- [LocationType <String>]
: locationType
- [LocationUri <String>]
: Optional URI representing the location.
- [UniqueId <String>]
: For internal use only.
- [UniqueIdType <String>]
: locationUniqueIdType
- [Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from.
The location and locations properties always correspond with each other.
If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String-
[]>]
: A collection of property values.
- [OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series.
Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}.
The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled.
You can use this property to perform all operations supported by occurrences in the recurring series.
- [OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ConferenceId <String>]
: The ID of the conference.
- [JoinUrl <String>]
: The external link that launches the online meeting.
This is a URL that clients launch into a browser and will redirect the user to join the meeting.
- [Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.
- [Number <String>]
: The phone number.
- [Type <String>]
: phoneType
- [QuickDial <String>]
: The preformatted quick dial for this call.
- [TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.
- [TollNumber <String>]
: The toll number that can be used to join the conference.
- [OnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [OnlineMeetingUrl <String>]
: A URL for an online meeting.
The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype.
Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event.
The onlineMeetingUrl property will be deprecated in the future.
- [Organizer <IMicrosoftGraphRecipient>]
: recipient
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series.
This property isn't returned for events that are single instances.
Its date and time information is expressed in ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DayOfMonth <Int32?>]
: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
- [DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
- [FirstDayOfWeek <String>]
: dayOfWeek
- [Index <String>]
: weekIndex
- [Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
- [Month <Int32?>]
: The month in which the event occurs.
This is a number from 1 to 12.
- [Type <String>]
: recurrencePatternType
- [Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDate <DateTime?>]
: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
- [NumberOfOccurrences <Int32?>]
: The number of times to repeat the event.
Required and must be positive if type is numbered.
- [RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
- [StartDate <DateTime?>]
: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
- [Type <String>]
: recurrenceRangeType
- [ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.
- [ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.
- [ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus
- [Sensitivity <String>]
: sensitivity
- [SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.
- [ShowAs <String>]
: freeBusyStatus
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String>]
: A property value.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Subject <String>]
: The text of the event's subject line.
- [TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event.
This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request.
After you set transactionId when creating an event, you can't change transactionId in a subsequent update.
This property is only returned in a response payload if an app has set it.
Optional.
- [Type <String>]
: eventType
- [Uid <String>]
: A unique identifier for calendar events.
For recurring events, the value is the same for the series master and all of its occurrences including exceptions.
- [WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox.
Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
- [CanEdit <Boolean?>]
: 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.
- [CanShare <Boolean?>]
: 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.
- [CanViewPrivateItems <Boolean?>]
: 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.
- [ChangeKey <String>]
: 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.
- [Color <String>]
: calendarColor
- [DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar.
Navigation property.
Read-only.
- [HexColor <String>]
: 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.
- [IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.
- [IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.
- [IsShared <Boolean?>]
: 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.
- [IsSharedWithMe <Boolean?>]
: 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.
- [IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses.
Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar.
Read-only.
Nullable.
- [Name <String>]
: The calendar name.
- [Owner <IMicrosoftGraphEmailAddress>]
: emailAddress
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar.
Read-only.
Nullable.
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Create <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Delete <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Edit <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [EndDateTime <DateTime?>]
: When the interval ends.
Read-only.
- [IncompleteData <IMicrosoftGraphIncompleteData>]
: incompleteData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [MissingDataBeforeDateTime <DateTime?>]
: The service doesn't have source data before the specified time.
- [WasThrottled <Boolean?>]
: Some data wasn't recorded due to excessive activity.
- [IsTrending <Boolean?>]
: Indicates whether the item is 'trending.' Read-only.
- [Move <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [StartDateTime <DateTime?>]
: When the interval starts.
Read-only.
- [ItemActivityStats <IMicrosoftGraphItemActivityStat-
[]>]
:
- [LastSevenDays <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [Audio <IMicrosoftGraphAudio>]
: audio
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <String>]
: The title of the album for this audio file.
- [AlbumArtist <String>]
: The artist named on the album for the audio file.
- [Artist <String>]
: The performing artist for the audio file.
- [Bitrate <Int64?>]
: Bitrate expressed in kbps.
- [Composers <String>]
: The name of the composer of the audio file.
- [Copyright <String>]
: Copyright information for the audio file.
- [Disc <Int32?>]
: The number of the disc this audio file came from.
- [DiscCount <Int32?>]
: The total number of discs in this album.
- [Duration <Int64?>]
: Duration of the audio file, expressed in milliseconds
- [Genre <String>]
: The genre of this audio file.
- [HasDrm <Boolean?>]
: Indicates if the file is protected with digital rights management.
- [IsVariableBitrate <Boolean?>]
: Indicates if the file is encoded with a variable bitrate.
- [Title <String>]
: The title of the audio file.
- [Track <Int32?>]
: The number of the track on the original disc for this audio file.
- [TrackCount <Int32?>]
: The total number of tracks on the original disc for this audio file.
- [Year <Int32?>]
: The year the audio file was recorded.
- [Bundle <IMicrosoftGraphBundle>]
: bundle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <IMicrosoftGraphAlbum>]
: album
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CoverImageItemId <String>]
: Unique identifier of the driveItem that is the cover of the album.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [CTag <String>]
: An eTag for the content of the item.
This eTag isn't changed if only the metadata is changed.
Note This property isn't returned if the item is a folder.
Read-only.
- [Children <IMicrosoftGraphDriveItem-
[]>]
: Collection containing Item objects for the immediate children of Item.
Only items representing folders have children.
Read-only.
Nullable.
- [Content <Byte-
[]>]
: The content stream, if the item represents a file.
The content property will have a potentially breaking change in behavior in the future.
It will stream content directly instead of redirecting.
To proactively opt in to the new behavior ahead of time, use the contentStream property instead.
- [ContentStream <Byte-
[]>]
: The content stream, if the item represents a file.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [File <IMicrosoftGraphFile>]
: file
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Hashes <IMicrosoftGraphHashes>]
: hashes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Crc32Hash <String>]
: The CRC32 value of the file (if available).
Read-only.
- [QuickXorHash <String>]
: A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available).
Read-only.
- [Sha1Hash <String>]
: SHA1 hash for the contents of the file (if available).
Read-only.
- [Sha256Hash <String>]
: SHA256 hash for the contents of the file (if available).
Read-only.
- [MimeType <String>]
: 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.
- [ProcessingMetadata <Boolean?>]
:
- [FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: The UTC date and time the file was created on a client.
- [LastAccessedDateTime <DateTime?>]
: The UTC date and time the file was last accessed.
Available for the recent file list only.
- [LastModifiedDateTime <DateTime?>]
: The UTC date and time the file was last modified on a client.
- [Folder <IMicrosoftGraphFolder>]
: folder
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [View <IMicrosoftGraphFolderView>]
: folderView
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [SortBy <String>]
: The method by which the folder should be sorted.
- [SortOrder <String>]
: If true, indicates that items should be sorted in descending order.
Otherwise, items should be sorted ascending.
- [ViewType <String>]
: The type of view that should be used to represent the folder.
- [Image <IMicrosoftGraphImage>]
: image
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Height <Int32?>]
: Optional.
Height of the image, in pixels.
Read-only.
- [Width <Int32?>]
: Optional.
Width of the image, in pixels.
Read-only.
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics[Columns <IMicrosoftGraphColumnDefinition-
[]>]
: The collection of column definitions reusable across lists under this site.[ContentModels <IMicrosoftGraphContentModel-
[]>]
: The collection of content models applied to this site.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Date and time of item last modification. Read-only.[ModelType <String>]
: contentModelType[Name <String>]
: The name of the contentModel.
[ContentTypes <IMicrosoftGraphContentType-
[]>]
: The collection of content types defined for this site.[Deleted <IMicrosoftGraphDeleted>]
: deleted[DisplayName <String>]
: The full title for the site. Read-only.[DocumentProcessingJobs <IMicrosoftGraphDocumentProcessingJob-
[]>]
: The document processing jobs running on this site.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[JobType <String>]
: documentProcessingJobType[ListItemUniqueId <String>]
: The listItemUniqueId of the file, or folder to process. Use GET driveItem resource operation and read sharepointIds property to get listItemUniqueId.[Status <String>]
: documentProcessingJobStatus
[Drive <IMicrosoftGraphDrive>]
: drive[Drives <IMicrosoftGraphDrive-
[]>]
: The collection of drives (document libraries) under this site.[ExternalColumns <IMicrosoftGraphColumnDefinition-
[]>]
: The collection of column definitions available in the site that is referenced from the sites in the parent hierarchy of the current site.[InformationProtection <IMicrosoftGraphInformationProtection>]
: informationProtection[IsPersonalSite <Boolean?>]
:[Items <IMicrosoftGraphBaseItem-
[]>]
: Used to address any item contained in this site. This collection can't be enumerated.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.
[Lists <IMicrosoftGraphList-
[]>]
: The collection of lists under this site.[Onenote <IMicrosoftGraphOnenote>]
: onenote[Operations <IMicrosoftGraphRichLongRunningOperation-
[]>]
: The collection of long running operations for the site.[PageTemplates <IMicrosoftGraphPageTemplate-
[]>]
: The collection of page templates on this site.[PageLayout <String>]
: pageLayoutType[PublishingState <IMicrosoftGraphPublicationFacet>]
: publicationFacet[Title <String>]
: Title of the sitePage.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[CanvasLayout <IMicrosoftGraphCanvasLayout>]
: canvasLayout[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[HorizontalSections <IMicrosoftGraphHorizontalSection-
[]>]
: Collection of horizontal sections on the SharePoint page.[Id <String>]
: The unique identifier for an entity. Read-only.[Columns <IMicrosoftGraphHorizontalSectionColumn-
[]>]
: The set of vertical columns in this section.[Id <String>]
: The unique identifier for an entity. Read-only.[Webparts <IMicrosoftGraphWebPart-
[]>]
: The collection of WebParts in this column.[Id <String>]
: The unique identifier for an entity. Read-only.
[Width <Int32?>]
: Width of the column. A horizontal section is divided into 12 grids. A column should have a value of 1-12 to represent its range spans. For example, there can be two columns both have a width of 6 in a section.
[Emphasis <String>]
: sectionEmphasisType[Layout <String>]
: horizontalSectionLayoutType
[VerticalSection <IMicrosoftGraphVerticalSection>]
: verticalSection[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Emphasis <String>]
: sectionEmphasisType[Webparts <IMicrosoftGraphWebPart-
[]>]
: The set of web parts in this section.
[TitleArea <IMicrosoftGraphTitleArea>]
: titleArea[(Any) <Object>]
: This indicates any property can be added to this object.[AlternativeText <String>]
: Alternative text on the title area.[EnableGradientEffect <Boolean?>]
: Indicates whether the title area has a gradient effect enabled.[ImageWebUrl <String>]
: URL of the image in the title area.[Layout <String>]
: titleAreaLayoutType[ServerProcessedContent <IMicrosoftGraphServerProcessedContent>]
: serverProcessedContent[(Any) <Object>]
: This indicates any property can be added to this object.[ComponentDependencies <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are component ids. SharePoint servers might decide to use this hint to preload the script for corresponding components for performance boost.[Key <String>]
: Key of the meta data.[Value <String>]
: Value of the meta data.
[CustomMetadata <IMicrosoftGraphMetaDataKeyValuePair-
[]>]
: A key-value map where keys are string identifier and values are object of custom key-value pair.[Key <String>]
: Key of the metadata.[Value <IMicrosoftGraphJson>]
: Json
[HtmlStrings <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are rich text with HTML format. SharePoint servers treat the values as HTML content and run services like safety checks, search index and link fixup on them.[ImageSources <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are image sources. SharePoint servers treat the values as image sources and run services like search index and link fixup on them.[Links <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are links. SharePoint servers treat the values as links and run services like link fixup on them.[SearchablePlainTexts <IMicrosoftGraphMetaDataKeyStringPair-
[]>]
: A key-value map where keys are string identifiers and values are strings that should be search indexed.
[ShowAuthor <Boolean?>]
: Indicates whether the author should be shown in title area.[ShowPublishedDate <Boolean?>]
: Indicates whether the published date should be shown in title area.[ShowTextBlockAboveTitle <Boolean?>]
: Indicates whether the text block above title should be shown in title area.[TextAboveTitle <String>]
: The text above title line.[TextAlignment <String>]
: titleAreaTextAlignmentType
[WebParts <IMicrosoftGraphWebPart-
[]>]
: The collection of web parts on the SharePoint page.
[Pages <IMicrosoftGraphBaseSitePage-
[]>]
: The collection of pages in the baseSitePages list on this site.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[PageLayout <String>]
: pageLayoutType[PublishingState <IMicrosoftGraphPublicationFacet>]
: publicationFacet[Title <String>]
: Title of the sitePage.
[Permissions <IMicrosoftGraphPermission-
[]>]
: The permissions associated with the site. Nullable.[RecycleBin <IMicrosoftGraphRecycleBin>]
: recycleBin[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[Items <IMicrosoftGraphRecycleBinItem-
[]>]
: List of the recycleBinItems deleted by a user.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedByUser <IMicrosoftGraphUser>]
: user[CreatedDateTime <DateTime?>]
: Date and time of item creation. Read-only.[Description <String>]
: The description of the item.[ETag <String>]
: ETag for the item. Read-only.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedByUser <IMicrosoftGraphUser>]
: user[LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified. Read-only.[Name <String>]
: The name of the item. Read-write.[ParentReference <IMicrosoftGraphItemReference>]
: itemReference[WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when the item was deleted. 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.[DeletedFromLocation <String>]
: Relative URL of the list or folder that originally contained the item.[Size <Int64?>]
: Size of the item in bytes.
[Root <IMicrosoftGraphRoot>]
: root[Settings <IMicrosoftGraphSiteSettings>]
: siteSettings[(Any) <Object>]
: This indicates any property can be added to this object.[LanguageTag <String>]
: The language tag for the language used on this site.[TimeZone <String>]
: Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC).
[SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds[SiteCollection <IMicrosoftGraphSiteCollection>]
: siteCollection[(Any) <Object>]
: This indicates any property can be added to this object.[ArchivalDetails <IMicrosoftGraphSiteArchivalDetails>]
: siteArchivalDetails[(Any) <Object>]
: This indicates any property can be added to this object.[ArchiveStatus <String>]
: siteArchiveStatus
[DataLocationCode <String>]
: The geographic region code for where this site collection resides. Only present for multi-geo tenants. Read-only.[Hostname <String>]
: The hostname for the site collection. Read-only.[Root <IMicrosoftGraphRoot>]
: root
[Sites <IMicrosoftGraphSite-
[]>]
: The collection of the sub-sites under this site.[TermStore <IMicrosoftGraphTermStore>]
: store[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DefaultLanguageTag <String>]
: Default language of the term store.[Groups <IMicrosoftGraphTermStoreGroup-
[]>]
: Collection of all groups available in the term store.[LanguageTags <String-
[]>]
: List of languages for the term store.[Sets <IMicrosoftGraphTermStoreSet-
[]>]
: Collection of all sets available in the term store.
IDENTITIES <IMicrosoftGraphObjectIdentity- []
>: 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) with limitations.
[Issuer <String>]
: Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn't federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.[IssuerAssignedId <String>]
: Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).When signInType is set to: emailAddress (or a custom string that starts with emailAddress like emailAddress1), issuerAssignedId must be a valid email addressuserName, issuerAssignedId must begin with an alphabetical character or number, and can only contain alphanumeric characters and the following symbols: - or _ For more information about filtering behavior for this property, see Filtering on the identities property of a user.[SignInType <String>]
: Specifies the user sign-in types in your directory, such as emailAddress, userName, federated, or userPrincipalName. federated represents a unique identifier for a user from an issuer that can be in any format chosen by the issuer. Setting or updating a userPrincipalName identity updates the value of the userPrincipalName property on the user object. The validations performed on the userPrincipalName property on the user object, for example, verified domains and acceptable characters, are performed when setting or updating a userPrincipalName identity. Extra validation is enforced on issuerAssignedId when the sign-in type is set to emailAddress or userName. This property can also be set to any custom string. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
INFERENCECLASSIFICATION <IMicrosoftGraphInferenceClassification>
: inferenceClassification
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Overrides <IMicrosoftGraphInferenceClassificationOverride-
[]>]
: A set of overrides for a user to always classify messages from specific senders in certain ways: focused, or other. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ClassifyAs <String>]
: inferenceClassificationType[SenderEmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
INFORMATIONPROTECTION <IMicrosoftGraphInformationProtection>
: informationProtection
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Bitlocker <IMicrosoftGraphBitlocker>]
: bitlocker[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[RecoveryKeys <IMicrosoftGraphBitlockerRecoveryKey-
[]>]
: The recovery keys associated with the bitlocker entity.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The date and time when the key was originally backed up to Microsoft Entra ID.[DeviceId <String>]
: ID of the device the BitLocker key is originally backed up from.[Key <String>]
: The BitLocker recovery key.[VolumeType <String>]
: volumeType
[DataLossPreventionPolicies <IMicrosoftGraphDataLossPreventionPolicy-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Name <String>]
:
[Policy <IMicrosoftGraphInformationProtectionPolicy>]
: informationProtectionPolicy[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Labels <IMicrosoftGraphInformationProtectionLabel-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: The color that the UI should display for the label, if configured.[Description <String>]
: The admin-defined description for the label.[IsActive <Boolean?>]
: Indicates whether the label is active or not. Active labels should be hidden or disabled in UI.[Name <String>]
: The plaintext name of the label.[Parent <IMicrosoftGraphParentLabelDetails>]
: parentLabelDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Color <String>]
: The color that the user interface should display for the label, if configured.[Description <String>]
: The admin-defined description for the label.[Id <String>]
: The label ID is a globally unique identifier (GUID).[IsActive <Boolean?>]
: Indicates whether the label is active or not. Active labels should be hidden or disabled in user interfaces.[Name <String>]
: The plaintext name of the label.[Parent <IMicrosoftGraphParentLabelDetails>]
: parentLabelDetails[Sensitivity <Int32?>]
: The sensitivity value of the label, where lower is less sensitive.[Tooltip <String>]
: The tooltip that should be displayed for the label in a user interface.
[Sensitivity <Int32?>]
: The sensitivity value of the label, where lower is less sensitive.[Tooltip <String>]
: The tooltip that should be displayed for the label in a UI.
[SensitivityLabels <IMicrosoftGraphSensitivityLabel-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicableTo <String>]
: sensitivityLabelTarget[ApplicationMode <String>]
: applicationMode[AssignedPolicies <IMicrosoftGraphLabelPolicy-
[]>]
:[Id <String>]
:[Name <String>]
:
[AutoLabeling <IMicrosoftGraphAutoLabeling>]
: autoLabeling[(Any) <Object>]
: This indicates any property can be added to this object.[Message <String>]
:[SensitiveTypeIds <String-
[]>]
:
[Description <String>]
:[DisplayName <String>]
:[IsDefault <Boolean?>]
:[IsEndpointProtectionEnabled <Boolean?>]
:[LabelActions <IMicrosoftGraphLabelActionBase-
[]>]
:[Name <String>]
:
[Name <String>]
:[Priority <Int32?>]
:[Sublabels <IMicrosoftGraphSensitivityLabel-
[]>]
:[ToolTip <String>]
:
[SensitivityPolicySettings <IMicrosoftGraphSensitivityPolicySettings>]
: sensitivityPolicySettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicableTo <String>]
: sensitivityLabelTarget[DowngradeSensitivityRequiresJustification <Boolean?>]
:[HelpWebUrl <String>]
:[IsMandatory <Boolean?>]
:
[ThreatAssessmentRequests <IMicrosoftGraphThreatAssessmentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Category <String>]
: threatCategory[ContentType <String>]
: threatAssessmentContentType[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedDateTime <DateTime?>]
: 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.[ExpectedAssessment <String>]
: threatExpectedAssessment[RequestSource <String>]
: threatAssessmentRequestSource[Results <IMicrosoftGraphThreatAssessmentResult-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: 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.[Message <String>]
: The result message for each threat assessment.[ResultType <String>]
: threatAssessmentResultType
[Status <String>]
: threatAssessmentStatus
INPUTOBJECT <IUsersIdentity>
: Identity Parameter
[AppId <String>]
: Alternate key of servicePrincipal[AttachmentBaseId <String>]
: The unique identifier of attachmentBase[AttachmentId <String>]
: The unique identifier of attachment[AttachmentSessionId <String>]
: The unique identifier of attachmentSession[ChecklistItemId <String>]
: The unique identifier of checklistItem[DirectoryObjectId <String>]
: The unique identifier of directoryObject[ExtensionId <String>]
: The unique identifier of extension[LicenseDetailsId <String>]
: The unique identifier of licenseDetails[LinkedResourceId <String>]
: The unique identifier of linkedResource[NotificationId <String>]
: The unique identifier of notification[OAuth2PermissionGrantId <String>]
: The unique identifier of oAuth2PermissionGrant[OutlookCategoryId <String>]
: The unique identifier of outlookCategory[OutlookTaskFolderId <String>]
: The unique identifier of outlookTaskFolder[OutlookTaskGroupId <String>]
: The unique identifier of outlookTaskGroup[OutlookTaskId <String>]
: The unique identifier of outlookTask[ProfilePhotoId <String>]
: The unique identifier of profilePhoto[ServicePrincipalId <String>]
: The unique identifier of servicePrincipal[ServiceStorageQuotaBreakdownId <String>]
: The unique identifier of serviceStorageQuotaBreakdown[SharedInsightId <String>]
: The unique identifier of sharedInsight[TodoTaskId <String>]
: The unique identifier of todoTask[TodoTaskListId <String>]
: The unique identifier of todoTaskList[TrendingId <String>]
: The unique identifier of trending[UsedInsightId <String>]
: The unique identifier of usedInsight[UserId <String>]
: The unique identifier of user[WindowsSettingId <String>]
: The unique identifier of windowsSetting[WindowsSettingInstanceId <String>]
: The unique identifier of windowsSettingInstance
INVITEDBY <IMicrosoftGraphDirectoryObject>
: directoryObject
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
JOINEDGROUPS <IMicrosoftGraphGroup- []
>: .
[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AcceptedSenders <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[AccessType <String>]
: groupAccessType[AllowExternalSenders <Boolean?>]
: 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}).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a group has been granted for an application. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AssignedLabels <IMicrosoftGraphAssignedLabel-
[]>]
: The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role.[DisplayName <String>]
: The display name of the label. Read-only.[LabelId <String>]
: The unique identifier of the label.
[AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq). Read-only.[DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.[SkuId <String>]
: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
[AutoSubscribeNewMembers <Boolean?>]
: 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}).[Calendar <IMicrosoftGraphCalendar>]
: calendar[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Read-only.[Classification <String>]
: 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).[Conversations <IMicrosoftGraphConversation-
[]>]
: The group's conversations.[Id <String>]
: The unique identifier for an entity. Read-only.[HasAttachments <Boolean?>]
: Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.[LastDeliveredDateTime <DateTime?>]
: 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).[Preview <String>]
: A short summary from the body of the latest post in this conversation.[Threads <IMicrosoftGraphConversationThread-
[]>]
: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[CcRecipients <IMicrosoftGraphRecipient-
[]>]
: The Cc: recipients for the thread. Returned only on $select.[HasAttachments <Boolean?>]
: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.[IsLocked <Boolean?>]
: Indicates if the thread is locked. Returned by default.[LastDeliveredDateTime <DateTime?>]
: 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.[Posts <IMicrosoftGraphPost-
[]>]
:[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the post. Read-only. Nullable. Supports $expand.[Body <IMicrosoftGraphItemBody>]
: itemBody[ConversationId <String>]
: Unique ID of the conversation. Read-only.[ConversationThreadId <String>]
: Unique ID of the conversation thread. Read-only.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand.[From <IMicrosoftGraphRecipient>]
: recipient[HasAttachments <Boolean?>]
: Indicates whether the post has at least one attachment. This is a default property.[Importance <String>]
: importance[InReplyTo <IMicrosoftGraphPost>]
: post[Mentions <IMicrosoftGraphMention-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Application <String>]
: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.[ClientReference <String>]
: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.[CreatedBy <IMicrosoftGraphEmailAddress>]
: emailAddress[CreatedDateTime <DateTime?>]
: The date and time that the mention is created on the client.[DeepLink <String>]
: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.[MentionText <String>]
: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.[Mentioned <IMicrosoftGraphEmailAddress>]
: emailAddress[ServerCreatedDateTime <DateTime?>]
: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the post. Read-only. Nullable.[NewParticipants <IMicrosoftGraphRecipient-
[]>]
: Conversation participants that were added to the thread as part of this post.[ReceivedDateTime <DateTime?>]
: Specifies when the post was received. 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[Sender <IMicrosoftGraphRecipient>]
: recipient[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the post. Read-only. Nullable.
[Preview <String>]
: A short summary from the body of the latest post in this conversation. Returned by default.[ToRecipients <IMicrosoftGraphRecipient-
[]>]
: The To: recipients for the thread. Returned only on $select.[Topic <String>]
: The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.[UniqueSenders <String-
[]>]
: All the users that sent a message to this thread. Returned by default.
[Topic <String>]
: The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.[UniqueSenders <String-
[]>]
: All the users that sent a message to this Conversation.
[CreatedByAppId <String>]
: App ID of the app used to create the group. Can be null for some groups. Returned by default. Read-only. Supports $filter (eq, ne, not, in, startsWith).[CreatedDateTime <DateTime?>]
: 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.[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]
: directoryObject[Description <String>]
: An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.[DisplayName <String>]
: The display name for the group. Required. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[Drive <IMicrosoftGraphDrive>]
: drive[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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 <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [Drives <IMicrosoftGraphDrive-
[]>]
: A collection of drives available for this user.
Read-only.
- [EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
: employeeExperienceUser
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LearningCourseActivities <IMicrosoftGraphLearningCourseActivity-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CompletedDateTime <DateTime?>]
: Date and time when the assignment was completed.
Optional.
- [CompletionPercentage <Int32?>]
: The percentage completion value of the course activity.
Optional.
- [ExternalcourseActivityId <String>]
:
- [LearnerUserId <String>]
: The user ID of the learner to whom the activity is assigned.
Required.
- [LearningContentId <String>]
: The ID of the learning content created in Viva Learning.
Required.
- [LearningProviderId <String>]
: The registration ID of the provider.
Required.
- [Status <String>]
: courseStatus
- [EmployeeHireDate <DateTime?>]
: 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).
- [EmployeeId <String>]
: The employee identifier assigned to the user by the organization.
The maximum length is 16 characters.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [EmployeeLeaveDateTime <DateTime?>]
: The date and time when the user left or will leave the organization.
To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission.
To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions.
To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader.
To write this property in delegated scenarios, the admin needs the Global Administrator role.
Supports $filter (eq, ne, not , ge, le, in).
For more information, see Configure the employeeLeaveDateTime property for a user.
- [EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
: employeeOrgData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CostCenter <String>]
: The cost center associated with the user.
Returned only on $select.
Supports $filter.
- [Division <String>]
: The name of the division in which the user works.
Returned only on $select.
Supports $filter.
- [EmployeeType <String>]
: Captures enterprise worker type.
For example, Employee, Contractor, Consultant, or Vendor.
Supports $filter (eq, ne, not , ge, le, in, startsWith).
- [Events <IMicrosoftGraphEvent-
[]>]
: The user's events.
The default is to show events under the Default Calendar.
Read-only.
Nullable.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the user.
Supports $expand.
Nullable.
- [ExternalUserState <String>]
: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status.
For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.
Supports $filter (eq, ne, not , in).
- [ExternalUserStateChangeDateTime <String>]
: Shows the timestamp for the latest change to the externalUserState property.
Supports $filter (eq, ne, not , in).
- [FaxNumber <String>]
: The fax number of the user.
Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [FollowedSites <IMicrosoftGraphSite-
[]>]
:
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.
- [Bundles <IMicrosoftGraphDriveItem-
[]>]
: Collection of bundles (albums and multi-select-shared sets of items).
Only in personal OneDrive.
- [DriveType <String>]
: Describes the type of drive represented by this resource.
OneDrive personal drives return personal.
OneDrive for Business returns business.
SharePoint document libraries return documentLibrary.
Read-only.
- [Following <IMicrosoftGraphDriveItem-
[]>]
: The list of items the user is following.
Only in OneDrive for Business.
- [Items <IMicrosoftGraphDriveItem-
[]>]
: All items contained in the drive.
Read-only.
Nullable.
- [List <IMicrosoftGraphList>]
: list
- [Owner <IMicrosoftGraphIdentitySet>]
: identitySet
- [Quota <IMicrosoftGraphQuota>]
: quota
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Deleted <Int64?>]
: Total space consumed by files in the recycle bin, in bytes.
Read-only.
- [Remaining <Int64?>]
: Total space remaining before reaching the quota limit, in bytes.
Read-only.
- [State <String>]
: Enumeration value that indicates the state of the storage space.
Read-only.
- [StoragePlanInformation <IMicrosoftGraphStoragePlanInformation>]
: storagePlanInformation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [UpgradeAvailable <Boolean?>]
: Indicates if there are higher storage quota plans available.
Read-only.
- [Total <Int64?>]
: Total allowed storage space, in bytes.
Read-only.
- [Used <Int64?>]
: Total space used, in bytes.
Read-only.
- [Root <IMicrosoftGraphDriveItem>]
: driveItem
- [SharePointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [Special <IMicrosoftGraphDriveItem-
[]>]
: Collection of common folders available in OneDrive.
Read-only.
Nullable.
- [System <IMicrosoftGraphSystemFacet>]
: systemFacet
[Drives <IMicrosoftGraphDrive-
[]>]
: The group's drives. Read-only.[Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints for the group. Read-only. Nullable.[Events <IMicrosoftGraphEvent-
[]>]
: The group's events.[ExpirationDateTime <DateTime?>]
: 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.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the group. Read-only. Nullable.[GroupLifecyclePolicies <IMicrosoftGraphGroupLifecyclePolicy-
[]>]
: The collection of lifecycle policies for this group. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AlternateNotificationEmails <String>]
: List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon.[GroupLifetimeInDays <Int32?>]
: 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.[ManagedGroupTypes <String>]
: The group type for which the expiration policy applies. Possible values are All, Selected or None.
[GroupTypes <String-
[]>]
: 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 <Boolean?>]
: 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).[HideFromAddressLists <Boolean?>]
: 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}).[HideFromOutlookClients <Boolean?>]
: 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}).[InfoCatalogs <String-
[]>]
: Identifies the info segments assigned to the group. Returned by default. Supports $filter (eq, not, ge, le, startsWith).[IsArchived <Boolean?>]
: 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.[IsAssignableToRole <Boolean?>]
: 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 with at least the Privileged Role Administrator role 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).[IsFavorite <Boolean?>]
: Indicates whether the user marked the group as favorite.[IsManagementRestricted <Boolean?>]
: Indicates whether the group is a member of a restricted management administrative unit. The default value is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.[IsSubscribedByMail <Boolean?>]
: 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}).[LicenseProcessingState <IMicrosoftGraphLicenseProcessingState>]
: licenseProcessingState[(Any) <Object>]
: This indicates any property can be added to this object.[State <String>]
:
[Mail <String>]
: The SMTP address for the group, for example, 'serviceadmins@contoso.com'. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).[MailEnabled <Boolean?>]
: Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not, and eq on null values).[MailNickname <String>]
: The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / -[]
' ; : <> , SPACE. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith).[MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.[Members <IMicrosoftGraphDirectoryObject-
[]>]
: 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).[MembersWithLicenseErrors <IMicrosoftGraphDirectoryObject-
[]>]
: A list of group members with license errors from this group-based license assignment. Read-only.[MembershipRule <String>]
: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).[MembershipRuleProcessingState <String>]
: 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).[MembershipRuleProcessingStatus <IMicrosoftGraphMembershipRuleProcessingStatus>]
: membershipRuleProcessingStatus[(Any) <Object>]
: This indicates any property can be added to this object.[ErrorMessage <String>]
: Detailed error message if dynamic group processing ran into an error. Optional. Read-only.[LastMembershipUpdated <DateTime?>]
: Most recent date and time when membership of a dynamic group was updated. Optional. Read-only.[Status <String>]
: MembershipRuleProcessingStatusDetails
[OnPremisesDomainName <String>]
: 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.[OnPremisesLastSyncDateTime <DateTime?>]
: 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).[OnPremisesNetBiosName <String>]
: 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.[OnPremisesProvisioningErrors <IMicrosoftGraphOnPremisesProvisioningError-
[]>]
: Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).[OnPremisesSamAccountName <String>]
: 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.[OnPremisesSecurityIdentifier <String>]
: Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values).[OnPremisesSyncEnabled <Boolean?>]
: true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).[Onenote <IMicrosoftGraphOnenote>]
: onenote[OrganizationId <String>]
:[Owners <IMicrosoftGraphDirectoryObject-
[]>]
: The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. A non-admin user can't explicitly add themselves to this collection when they're creating the group. For more information, see the related known issue. For security groups, the admin user isn't automatically added to this collection. For more information, see the related known issue. 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).[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: The permissions granted for a group to a specific application. Supports $expand.[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[Photos <IMicrosoftGraphProfilePhoto-
[]>]
: The profile photos owned by the group. Read-only. Nullable.[Planner <IMicrosoftGraphPlannerGroup>]
: plannerGroup[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Plans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans owned by the group.
[PreferredDataLocation <String>]
: 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 at least one of the following Microsoft Entra roles: 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.[PreferredLanguage <String>]
: 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).[ProxyAddresses <String-
[]>]
: Email addresses for the group that direct to the same group mailbox. For example: -['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']
. The any operator is required for filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).[RejectedSenders <IMicrosoftGraphDirectoryObject-
[]>]
: The list of users or groups not allowed to create posts or calendar events in this group. Nullable[RenewedDateTime <DateTime?>]
: 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.[ResourceBehaviorOptions <String-
[]>]
: Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This property can be set only as part of creation (POST). For the list of possible values, see Microsoft 365 group behaviors and provisioning options.[ResourceProvisioningOptions <String-
[]>]
: Specifies the group resources that are associated with the Microsoft 365 group. The possible value is Team. For more information, see Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith.[SecurityEnabled <Boolean?>]
: Specifies whether the group is a security group. Required.Returned by default. Supports $filter (eq, ne, not, in).[SecurityIdentifier <String>]
: Security identifier of the group, used in Windows scenarios. Read-only. Returned by default.[ServiceProvisioningErrors <IMicrosoftGraphServiceProvisioningError-
[]>]
: Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object.[Settings <IMicrosoftGraphDirectorySetting-
[]>]
: Settings that can govern this group's behavior, like whether members can invite guest users to the group. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Display name of this group of settings, which comes from the associated template. Read-only.[TemplateId <String>]
: Unique identifier for the template used to create this group of settings. Read-only.[Values <IMicrosoftGraphSettingValue-
[]>]
: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.[Name <String>]
: Name of the setting (as defined by the directorySettingTemplate).[Value <String>]
: Value of the setting.
[Sites <IMicrosoftGraphSite-
[]>]
: The list of SharePoint sites in this group. Access the default site with /sites/root.[Team <IMicrosoftGraphTeam>]
: team[Theme <String>]
: Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.[Threads <IMicrosoftGraphConversationThread-
[]>]
: The group's conversation threads. Nullable.[TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: The groups a group is a member of, either directly or through nested membership. Nullable.[TransitiveMembers <IMicrosoftGraphDirectoryObject-
[]>]
: The direct and transitive members of a group. Nullable.[UniqueName <String>]
: The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only.[UnseenConversationsCount <Int32?>]
: 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.[UnseenCount <Int32?>]
: Count of conversations that have received new posts since the signed-in user last visited the group. This property is the same as unseenConversationsCount.Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).[UnseenMessagesCount <Int32?>]
: 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.[Visibility <String>]
: 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.[WritebackConfiguration <IMicrosoftGraphGroupWritebackConfiguration>]
: groupWritebackConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[IsEnabled <Boolean?>]
: Indicates whether writeback of cloud groups to on-premise Active Directory is enabled. Default value is true for Microsoft 365 groups and false for security groups.[OnPremisesGroupType <String>]
: 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
JOINEDTEAMS <IMicrosoftGraphTeam- []
>: The Microsoft Teams teams the user is a member of.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[AllChannels <IMicrosoftGraphChannel-
[]>]
: List of channels either hosted in or shared with the team (incoming channels).[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Read only. Timestamp at which the channel was created.[Description <String>]
: Optional textual description for the channel.[DisplayName <String>]
: Channel name as it appears to the user in Microsoft Teams. The maximum length is 50 characters.[Email <String>]
: The email address for sending messages to the channel. Read-only.[FilesFolder <IMicrosoftGraphDriveItem>]
: driveItem[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).
- [DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled.
IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]
: The unique identifier for the SKU.
Corresponds to the skuId from subscribedSkus or companySubscription.
- [AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar.
If the user has never explicitly set a group for the calendar, this property is null.
- [CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar.
Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.
- [IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise.
The 'My organization' user determines the permissions other people within your organization have to the given calendar.
You can't remove 'My organization' as a recipient to a calendar.
- [Role <String>]
: calendarRoleType
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Navigation property.
Read-only.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false.
Optional.
Default is true.
- [Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event.
Navigation property.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentType <String>]
: The MIME type.
- [IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.
- [LastModifiedDateTime <DateTime?>]
: 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
- [Name <String>]
: The display name of the attachment.
This does not need to be the actual file name.
- [Size <Int32?>]
: The length of the attachment in bytes.
- [Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.
- [Type <String>]
: attendeeType
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
- [TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <IMicrosoftGraphResponseStatus>]
: responseStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Response <String>]
: responseType
- [Time <DateTime?>]
: The date and time that the response was returned.
It uses ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <String>]
: The content of the item.
- [ContentType <String>]
: bodyType
- [BodyPreview <String>]
: The preview of the message associated with the event.
It is in text format.
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master.
Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event.
Nullable.
- [HasAttachments <Boolean?>]
: Set to true if the event has attachments.
- [HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
Default is false.
- [ICalUId <String>]
: A unique identifier for an event across calendars.
This ID is different for each occurrence in a recurring series.
Read-only.
- [Importance <String>]
: importance
- [Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master.
This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified.
It doesn't include occurrences that have been canceled from the series.
Navigation property.
Read-only.
Nullable.
- [IsAllDay <Boolean?>]
: Set to true if the event lasts all day.
If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
- [IsCancelled <Boolean?>]
: Set to true if the event has been canceled.
- [IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
Set to false if all changes have been sent, or if the event is an appointment without any attendees.
- [IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
Default is false (onlineMeeting is null).
Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.
- [IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event).
This also applies if a delegate organized the event on behalf of the owner.
- [IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.
- [Location <IMicrosoftGraphLocation>]
: location
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [City <String>]
: The city.
- [CountryOrRegion <String>]
: The country or region.
It's a free-format string value, for example, 'United States'.
- [PostOfficeBox <String>]
: The post office box number.
- [PostalCode <String>]
: The postal code.
- [State <String>]
: The state.
- [Street <String>]
: The street.
- [Type <String>]
: physicalAddressType
- [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Accuracy <Double?>]
: The accuracy of the latitude and longitude.
As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
- [Altitude <Double?>]
: The altitude of the location.
- [AltitudeAccuracy <Double?>]
: The accuracy of the altitude.
- [Latitude <Double?>]
: The latitude of the location.
- [Longitude <Double?>]
: The longitude of the location.
- [DisplayName <String>]
: The name associated with the location.
- [LocationEmailAddress <String>]
: Optional email address of the location.
- [LocationType <String>]
: locationType
- [LocationUri <String>]
: Optional URI representing the location.
- [UniqueId <String>]
: For internal use only.
- [UniqueIdType <String>]
: locationUniqueIdType
- [Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from.
The location and locations properties always correspond with each other.
If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String-
[]>]
: A collection of property values.
- [OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series.
Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}.
The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled.
You can use this property to perform all operations supported by occurrences in the recurring series.
- [OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ConferenceId <String>]
: The ID of the conference.
- [JoinUrl <String>]
: The external link that launches the online meeting.
This is a URL that clients launch into a browser and will redirect the user to join the meeting.
- [Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.
- [Number <String>]
: The phone number.
- [Type <String>]
: phoneType
- [QuickDial <String>]
: The preformatted quick dial for this call.
- [TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.
- [TollNumber <String>]
: The toll number that can be used to join the conference.
- [OnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [OnlineMeetingUrl <String>]
: A URL for an online meeting.
The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype.
Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event.
The onlineMeetingUrl property will be deprecated in the future.
- [Organizer <IMicrosoftGraphRecipient>]
: recipient
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series.
This property isn't returned for events that are single instances.
Its date and time information is expressed in ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DayOfMonth <Int32?>]
: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
- [DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
- [FirstDayOfWeek <String>]
: dayOfWeek
- [Index <String>]
: weekIndex
- [Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
- [Month <Int32?>]
: The month in which the event occurs.
This is a number from 1 to 12.
- [Type <String>]
: recurrencePatternType
- [Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDate <DateTime?>]
: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
- [NumberOfOccurrences <Int32?>]
: The number of times to repeat the event.
Required and must be positive if type is numbered.
- [RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
- [StartDate <DateTime?>]
: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
- [Type <String>]
: recurrenceRangeType
- [ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.
- [ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.
- [ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus
- [Sensitivity <String>]
: sensitivity
- [SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.
- [ShowAs <String>]
: freeBusyStatus
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String>]
: A property value.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Subject <String>]
: The text of the event's subject line.
- [TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event.
This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request.
After you set transactionId when creating an event, you can't change transactionId in a subsequent update.
This property is only returned in a response payload if an app has set it.
Optional.
- [Type <String>]
: eventType
- [Uid <String>]
: A unique identifier for calendar events.
For recurring events, the value is the same for the series master and all of its occurrences including exceptions.
- [WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox.
Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
- [CanEdit <Boolean?>]
: 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.
- [CanShare <Boolean?>]
: 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.
- [CanViewPrivateItems <Boolean?>]
: 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.
- [ChangeKey <String>]
: 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.
- [Color <String>]
: calendarColor
- [DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar.
Navigation property.
Read-only.
- [HexColor <String>]
: 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.
- [IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.
- [IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.
- [IsShared <Boolean?>]
: 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.
- [IsSharedWithMe <Boolean?>]
: 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.
- [IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses.
Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar.
Read-only.
Nullable.
- [Name <String>]
: The calendar name.
- [Owner <IMicrosoftGraphEmailAddress>]
: emailAddress
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar.
Read-only.
Nullable.
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Create <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Delete <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Edit <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [EndDateTime <DateTime?>]
: When the interval ends.
Read-only.
- [IncompleteData <IMicrosoftGraphIncompleteData>]
: incompleteData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [MissingDataBeforeDateTime <DateTime?>]
: The service doesn't have source data before the specified time.
- [WasThrottled <Boolean?>]
: Some data wasn't recorded due to excessive activity.
- [IsTrending <Boolean?>]
: Indicates whether the item is 'trending.' Read-only.
- [Move <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [StartDateTime <DateTime?>]
: When the interval starts.
Read-only.
- [ItemActivityStats <IMicrosoftGraphItemActivityStat-
[]>]
:
- [LastSevenDays <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [Audio <IMicrosoftGraphAudio>]
: audio
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <String>]
: The title of the album for this audio file.
- [AlbumArtist <String>]
: The artist named on the album for the audio file.
- [Artist <String>]
: The performing artist for the audio file.
- [Bitrate <Int64?>]
: Bitrate expressed in kbps.
- [Composers <String>]
: The name of the composer of the audio file.
- [Copyright <String>]
: Copyright information for the audio file.
- [Disc <Int32?>]
: The number of the disc this audio file came from.
- [DiscCount <Int32?>]
: The total number of discs in this album.
- [Duration <Int64?>]
: Duration of the audio file, expressed in milliseconds
- [Genre <String>]
: The genre of this audio file.
- [HasDrm <Boolean?>]
: Indicates if the file is protected with digital rights management.
- [IsVariableBitrate <Boolean?>]
: Indicates if the file is encoded with a variable bitrate.
- [Title <String>]
: The title of the audio file.
- [Track <Int32?>]
: The number of the track on the original disc for this audio file.
- [TrackCount <Int32?>]
: The total number of tracks on the original disc for this audio file.
- [Year <Int32?>]
: The year the audio file was recorded.
- [Bundle <IMicrosoftGraphBundle>]
: bundle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <IMicrosoftGraphAlbum>]
: album
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CoverImageItemId <String>]
: Unique identifier of the driveItem that is the cover of the album.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [CTag <String>]
: An eTag for the content of the item.
This eTag isn't changed if only the metadata is changed.
Note This property isn't returned if the item is a folder.
Read-only.
- [Children <IMicrosoftGraphDriveItem-
[]>]
: Collection containing Item objects for the immediate children of Item.
Only items representing folders have children.
Read-only.
Nullable.
- [Content <Byte-
[]>]
: The content stream, if the item represents a file.
The content property will have a potentially breaking change in behavior in the future.
It will stream content directly instead of redirecting.
To proactively opt in to the new behavior ahead of time, use the contentStream property instead.
- [ContentStream <Byte-
[]>]
: The content stream, if the item represents a file.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [File <IMicrosoftGraphFile>]
: file
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Hashes <IMicrosoftGraphHashes>]
: hashes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Crc32Hash <String>]
: The CRC32 value of the file (if available).
Read-only.
- [QuickXorHash <String>]
: A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available).
Read-only.
- [Sha1Hash <String>]
: SHA1 hash for the contents of the file (if available).
Read-only.
- [Sha256Hash <String>]
: SHA256 hash for the contents of the file (if available).
Read-only.
- [MimeType <String>]
: 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.
- [ProcessingMetadata <Boolean?>]
:
- [FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: The UTC date and time the file was created on a client.
- [LastAccessedDateTime <DateTime?>]
: The UTC date and time the file was last accessed.
Available for the recent file list only.
- [LastModifiedDateTime <DateTime?>]
: The UTC date and time the file was last modified on a client.
- [Folder <IMicrosoftGraphFolder>]
: folder
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [View <IMicrosoftGraphFolderView>]
: folderView
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [SortBy <String>]
: The method by which the folder should be sorted.
- [SortOrder <String>]
: If true, indicates that items should be sorted in descending order.
Otherwise, items should be sorted ascending.
- [ViewType <String>]
: The type of view that should be used to represent the folder.
- [Image <IMicrosoftGraphImage>]
: image
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Height <Int32?>]
: Optional.
Height of the image, in pixels.
Read-only.
- [Width <Int32?>]
: Optional.
Width of the image, in pixels.
Read-only.
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [Location <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates
- [Malware <IMicrosoftGraphMalware>]
: malware
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Description <String>]
: Contains the virus details for the malware facet.
- [Media <IMicrosoftGraphMedia>]
: media
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsTranscriptionShown <Boolean?>]
: 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.
- [MediaSource <IMicrosoftGraphMediaSource>]
: mediaSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentCategory <String>]
: mediaSourceContentCategory
- [Package <IMicrosoftGraphPackage>]
: package
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Type <String>]
: An string indicating the type of package.
While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.
- [PendingOperations <IMicrosoftGraphPendingOperations>]
: pendingOperations
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PendingContentUpdate <IMicrosoftGraphPendingContentUpdate>]
: pendingContentUpdate
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [QueuedDateTime <DateTime?>]
: Date and time the pending binary operation was queued in UTC time.
Read-only.
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Photo <IMicrosoftGraphPhoto>]
: photo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CameraMake <String>]
: Camera manufacturer.
Read-only.
- [CameraModel <String>]
: Camera model.
Read-only.
- [ExposureDenominator <Double?>]
: The denominator for the exposure time fraction from the camera.
Read-only.
- [ExposureNumerator <Double?>]
: The numerator for the exposure time fraction from the camera.
Read-only.
- [FNumber <Double?>]
: The F-stop value from the camera.
Read-only.
- [FocalLength <Double?>]
: The focal length from the camera.
Read-only.
- [Iso <Int32?>]
: The ISO value from the camera.
Read-only.
- [Orientation <Int32?>]
: The orientation value from the camera.
Writable on OneDrive Personal.
- [TakenDateTime <DateTime?>]
: The date and time the photo was taken in UTC time.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [RemoteItem <IMicrosoftGraphRemoteItem>]
: remoteItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [File <IMicrosoftGraphFile>]
: file
- [FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo
- [Folder <IMicrosoftGraphFolder>]
: folder
- [Id <String>]
: Unique identifier for the remote item in its drive.
Read-only.
- [Image <IMicrosoftGraphImage>]
: image
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: Optional.
Filename of the remote item.
Read-only.
- [Package <IMicrosoftGraphPackage>]
: package
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [Shared <IMicrosoftGraphShared>]
: shared
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Owner <IMicrosoftGraphIdentitySet>]
: identitySet
- [Scope <String>]
: Indicates the scope of how the item is shared.
The possible values are: anonymous, organization, or users.
Read-only.
- [SharedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [SharedDateTime <DateTime?>]
: The UTC date and time when the item was shared.
Read-only.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [Size <Int64?>]
: Size of the remote item.
Read-only.
- [SpecialFolder <IMicrosoftGraphSpecialFolder>]
: specialFolder
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The unique identifier for this item in the /drive/special collection
- [Video <IMicrosoftGraphVideo>]
: video
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AudioBitsPerSample <Int32?>]
: Number of audio bits per sample.
- [AudioChannels <Int32?>]
: Number of audio channels.
- [AudioFormat <String>]
: Name of the audio format (AAC, MP3, etc.).
- [AudioSamplesPerSecond <Int32?>]
: Number of audio samples per second.
- [Bitrate <Int32?>]
: Bit rate of the video in bits per second.
- [Duration <Int64?>]
: Duration of the file in milliseconds.
- [FourCc <String>]
: 'Four character code' name of the video format.
- [FrameRate <Double?>]
:
- [Height <Int32?>]
: Height of the video, in pixels.
- [Width <Int32?>]
: Width of the video, in pixels.
- [WebDavUrl <String>]
: DAV compatible URL for the item.
- [WebUrl <String>]
: URL that displays the resource in the browser.
Read-only.
- [RetentionLabel <IMicrosoftGraphItemRetentionLabel>]
: itemRetentionLabel
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsLabelAppliedExplicitly <Boolean?>]
: 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.
- [LabelAppliedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LabelAppliedDateTime <DateTime?>]
: The date and time when the label was applied on the item.
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.
- [Name <String>]
: The retention label on the document.
Read-write.
- [RetentionSettings <IMicrosoftGraphRetentionLabelSettings>]
: retentionLabelSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BehaviorDuringRetentionPeriod <String>]
: behaviorDuringRetentionPeriod
- [IsContentUpdateAllowed <Boolean?>]
: Specifies whether updates to document content are allowed.
Read-only.
- [IsDeleteAllowed <Boolean?>]
: Specifies whether the document deletion is allowed.
Read-only.
- [IsLabelUpdateAllowed <Boolean?>]
: Specifies whether you're allowed to change the retention label on the document.
Read-only.
- [IsMetadataUpdateAllowed <Boolean?>]
: Specifies whether updates to the item metadata (for example, the Title field) are blocked.
Read-only.
- [IsRecordLocked <Boolean?>]
: Specifies whether the item is locked.
Read-write.
- [Root <IMicrosoftGraphRoot>]
: root
- [SearchResult <IMicrosoftGraphSearchResult>]
: searchResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [OnClickTelemetryUrl <String>]
: 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.
- [Shared <IMicrosoftGraphShared>]
: shared
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [Size <Int64?>]
: Size of the item in bytes.
Read-only.
- [Source <IMicrosoftGraphDriveItemSource>]
: driveItemSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <String>]
: driveItemSourceApplication
- [ExternalId <String>]
: The external identifier for the drive item from the source.
- [SpecialFolder <IMicrosoftGraphSpecialFolder>]
: specialFolder
- [Subscriptions <IMicrosoftGraphSubscription-
[]>]
: The set of subscriptions on the item.
Only supported on the root of a drive.
- [Thumbnails <IMicrosoftGraphThumbnailSet-
[]>]
: Collection of thumbnailSet objects associated with the item.
For more information, see getting thumbnails.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Large <IMicrosoftGraphThumbnail>]
: thumbnail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <Byte-
[]>]
: The content stream for the thumbnail.
- [Height <Int32?>]
: The height of the thumbnail, in pixels.
- [SourceItemId <String>]
: The unique identifier of the item that provided the thumbnail.
This is only available when a folder thumbnail is requested.
- [Url <String>]
: The URL used to fetch the thumbnail content.
- [Width <Int32?>]
: The width of the thumbnail, in pixels.
- [Medium <IMicrosoftGraphThumbnail>]
: thumbnail
- [Small <IMicrosoftGraphThumbnail>]
: thumbnail
- [Source <IMicrosoftGraphThumbnail>]
: thumbnail
- [Versions <IMicrosoftGraphDriveItemVersion-
[]>]
: The list of previous versions of the item.
For more info, see getting previous versions.
Read-only.
Nullable.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Content <Byte-
[]>]
:
- [Size <Int64?>]
: Indicates the size of the content stream for this version of the item.
- [Video <IMicrosoftGraphVideo>]
: video
- [Viewpoint <IMicrosoftGraphDriveItemViewpoint>]
: driveItemViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AccessOperations <IMicrosoftGraphDriveItemAccessOperationsViewpoint>]
: driveItemAccessOperationsViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CanComment <Boolean?>]
: Indicates whether the user can comment on this item.
- [CanCreateFile <Boolean?>]
: Indicates whether the user can create files within this object.
Returned only on folders.
- [CanCreateFolder <Boolean?>]
: Indicates whether the user can create folders within this object.
Returned only on folders.
- [CanDelete <Boolean?>]
: Indicates whether the user can delete this item.
- [CanDownload <Boolean?>]
: Indicates whether the user can download this item.
- [CanRead <Boolean?>]
: Indicates whether the user can read this item.
- [CanUpdate <Boolean?>]
: Indicates whether the user can update this item.
- [Sharing <IMicrosoftGraphSharingViewpoint>]
: sharingViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DefaultSharingLink <IMicrosoftGraphDefaultSharingLink>]
: defaultSharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DefaultToExistingAccess <Boolean?>]
: Indicates whether the default link setting for this object is a direct URL rather than a sharing link.
- [Role <String>]
: sharingRole
- [Scope <String>]
: sharingScope
- [SharingAbilities <IMicrosoftGraphSharePointSharingAbilities>]
: sharePointSharingAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AnyoneLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BlockDownloadLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddExistingExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisabledReason <String>]
: Provides a description of why this operation is not enabled.
Only returned if this operation is not enabled.
- [Enabled <Boolean?>]
: Indicates whether this operation is enabled.
- [AddNewExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [ApplyVariants <IMicrosoftGraphSharingLinkVariants>]
: sharingLinkVariants
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddressBarLinkPermission <String>]
: sharingRole
- [AllowEmbed <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [PasswordProtected <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [RequiresAuthentication <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [CreateLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [DeleteLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [LinkAllowsExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [LinkExpiration <IMicrosoftGraphSharingLinkExpirationStatus>]
: sharingLinkExpirationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DefaultExpirationInDays <Int32?>]
: Default link expiration in days.
Returns -1 if there is no required expiration time.
- [DisabledReason <String>]
: Provides a description of why this operation is not enabled.
Only returned if this operation is not enabled.
- [Enabled <Boolean?>]
: Indicates whether this operation is enabled.
- [RetrieveLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [UpdateLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [EditLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [ManageListLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [ReadLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [ReviewLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [SubmitOnlyLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [DirectSharingAbilities <IMicrosoftGraphDirectSharingAbilities>]
: directSharingAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddExistingExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [AddInternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [AddNewExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [RequestGrantAccess <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [OrganizationLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
- [SpecificPeopleLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
- [WebDavUrl <String>]
: WebDAV compatible URL for the item.
- [Workbook <IMicrosoftGraphWorkbook>]
: workbook
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Application <IMicrosoftGraphWorkbookApplication>]
: workbookApplication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CalculationMode <String>]
: Returns the calculation mode used in the workbook.
Possible values are: Automatic, AutomaticExceptTables, Manual.
- [Comments <IMicrosoftGraphWorkbookComment-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Content <String>]
: The content of the comment.
- [ContentType <String>]
: The content type of the comment.
- [Replies <IMicrosoftGraphWorkbookCommentReply-
[]>]
: The list of replies to the comment.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Content <String>]
: The content of the reply.
- [ContentType <String>]
: The content type for the reply.
- [Task <IMicrosoftGraphWorkbookDocumentTask>]
: workbookDocumentTask
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignees <IMicrosoftGraphWorkbookEmailIdentity-
[]>]
: A collection of user identities the task is assigned to.
- [DisplayName <String>]
: Display name of the user.
- [Email <String>]
: Email address of the user.
- [Id <String>]
: The unique identifier of the user.
- [Changes <IMicrosoftGraphWorkbookDocumentTaskChange-
[]>]
: A collection of task change histories.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignee <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [ChangedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [CommentId <String>]
: The identifier of the associated comment.
- [CreatedDateTime <DateTime?>]
: Date and time when the task was changed.
Nullable.
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.
- [DueDateTime <DateTime?>]
: The due date and time for the task.
Only present when the type property is setSchedule.
Nullable.
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.
- [PercentComplete <Int32?>]
: An integer value from 0 to 100 that represents the percentage of the completion of the task and associated comment.
100 means that the task and associated comment are completed.
If you change the completion from 100 to a lower value, the associated task and comment are reactivated.
Only present when the type property is setPercentComplete.
Nullable.
- [Priority <Int32?>]
: An integer value from 0 to 10 that represents the priority of the task.
A lower value indicates a higher priority.
5 indicates the default priority if not set.
Only present when the type property is setPriority.
Nullable.
- [StartDateTime <DateTime?>]
: The start date and time for the task.
Only present when the type property is setSchedule.
Nullable.
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.
- [Title <String>]
: The title of the task.
Only present when the type property is setTitle.
Nullable.
- [Type <String>]
: The type of the change history.
Possible values are: create, assign, unassign, unassignAll, setPriority, setTitle, setPercentComplete, setSchedule, remove, restore, undo.
- [UndoChangeId <String>]
: The ID of the workbookDocumentTaskChange that was undone for the undo change action.
Only exists on an undo change history.
Nullable.
- [Comment <IMicrosoftGraphWorkbookComment>]
: workbookComment
- [CompletedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [CompletedDateTime <DateTime?>]
: Date and time when the task was completed.
Nullable.
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.
- [CreatedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [CreatedDateTime <DateTime?>]
: Date and time when the task was created.
Nullable.
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.
- [PercentComplete <Int32?>]
: An integer value from 0 to 100 that represents the percentage of the completion of the task.
100 means that the task is completed.
Nullable.
- [Priority <Int32?>]
: An integer value from 0 to 10 that represents the priority of the task.
A lower value indicates a higher priority.
Nullable.
- [StartAndDueDateTime <IMicrosoftGraphWorkbookDocumentTaskSchedule>]
: workbookDocumentTaskSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DueDateTime <DateTime?>]
: The due date and time for the task.
Nullable.
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.
- [StartDateTime <DateTime?>]
: The start date and time for the task.
Nullable.
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.
- [Title <String>]
: The title of the task.
- [Task <IMicrosoftGraphWorkbookDocumentTask>]
: workbookDocumentTask
- [Functions <IMicrosoftGraphWorkbookFunctions>]
: workbookFunctions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Names <IMicrosoftGraphWorkbookNamedItem-
[]>]
: Represents a collection of workbooks scoped named items (named ranges and constants).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: The comment associated with this name.
- [Name <String>]
: The name of the object.
Read-only.
- [Scope <String>]
: Indicates whether the name is scoped to the workbook or to a specific worksheet.
Read-only.
- [Type <String>]
: The type of reference is associated with the name.
Possible values are: String, Integer, Double, Boolean, Range.
Read-only.
- [Value <IMicrosoftGraphJson>]
: Json
- [Visible <Boolean?>]
: Indicates whether the object is visible.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Charts <IMicrosoftGraphWorkbookChart-
[]>]
: The list of charts that are part of the worksheet.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Axes <IMicrosoftGraphWorkbookChartAxes>]
: workbookChartAxes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CategoryAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartAxisFormat>]
: workbookChartAxisFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Bold <Boolean?>]
: Indicates whether the fond is bold.
- [Color <String>]
: The HTML color code representation of the text color.
For example #FF0000 represents Red.
- [Italic <Boolean?>]
: Indicates whether the fond is italic.
- [Name <String>]
: The font name.
For example 'Calibri'.
- [Size <Double?>]
: The size of the font.
For example, 11.
- [Underline <String>]
: The type of underlining applied to the font.
The possible values are: None, Single.
- [Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Color <String>]
: The HTML color code that represents the color of lines in the chart.
- [MajorGridlines <IMicrosoftGraphWorkbookChartGridlines>]
: workbookChartGridlines
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartGridlinesFormat>]
: workbookChartGridlinesFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
- [Visible <Boolean?>]
: Indicates whether the axis gridlines are visible.
- [MajorUnit <IMicrosoftGraphJson>]
: Json
- [Maximum <IMicrosoftGraphJson>]
: Json
- [Minimum <IMicrosoftGraphJson>]
: Json
- [MinorGridlines <IMicrosoftGraphWorkbookChartGridlines>]
: workbookChartGridlines
- [MinorUnit <IMicrosoftGraphJson>]
: Json
- [Title <IMicrosoftGraphWorkbookChartAxisTitle>]
: workbookChartAxisTitle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartAxisTitleFormat>]
: workbookChartAxisTitleFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Text <String>]
: Represents the axis title.
- [Visible <Boolean?>]
: A Boolean that specifies the visibility of an axis title.
- [SeriesAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
- [ValueAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
- [DataLabels <IMicrosoftGraphWorkbookChartDataLabels>]
: workbookChartDataLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartDataLabelFormat>]
: workbookChartDataLabelFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Position <String>]
: DataLabelPosition value that represents the position of the data label.
The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.
- [Separator <String>]
: String that represents the separator used for the data labels on a chart.
- [ShowBubbleSize <Boolean?>]
: Boolean value that represents whether the data label bubble size is visible.
- [ShowCategoryName <Boolean?>]
: Boolean value that represents whether the data label category name is visible.
- [ShowLegendKey <Boolean?>]
: Boolean value that represents whether the data label legend key is visible.
- [ShowPercentage <Boolean?>]
: Boolean value that represents whether the data label percentage is visible.
- [ShowSeriesName <Boolean?>]
: Boolean value that represents whether the data label series name is visible.
- [ShowValue <Boolean?>]
: Boolean value that represents whether the data label value is visible.
- [Format <IMicrosoftGraphWorkbookChartAreaFormat>]
: workbookChartAreaFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Height <Double?>]
: Represents the height, in points, of the chart object.
- [Left <Double?>]
: The distance, in points, from the left side of the chart to the worksheet origin.
- [Legend <IMicrosoftGraphWorkbookChartLegend>]
: workbookChartLegend
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartLegendFormat>]
: workbookChartLegendFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Overlay <Boolean?>]
: Indicates whether the chart legend should overlap with the main body of the chart.
- [Position <String>]
: Represents the position of the legend on the chart.
The possible values are: Top, Bottom, Left, Right, Corner, Custom.
- [Visible <Boolean?>]
: Indicates whether the chart legend is visible.
- [Name <String>]
: Represents the name of a chart object.
- [Series <IMicrosoftGraphWorkbookChartSeries-
[]>]
: Represents either a single series or collection of series in the chart.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartSeriesFormat>]
: workbookChartSeriesFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
- [Name <String>]
: The name of a series in a chart.
- [Points <IMicrosoftGraphWorkbookChartPoint-
[]>]
: A collection of all points in the series.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartPointFormat>]
: workbookChartPointFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Value <IMicrosoftGraphJson>]
: Json
- [Title <IMicrosoftGraphWorkbookChartTitle>]
: workbookChartTitle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartTitleFormat>]
: workbookChartTitleFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Overlay <Boolean?>]
: Indicates whether the chart title will overlay the chart or not.
- [Text <String>]
: The title text of the chart.
- [Visible <Boolean?>]
: Indicates whether the chart title is visible.
- [Top <Double?>]
: Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
- [Width <Double?>]
: Represents the width, in points, of the chart object.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [Name <String>]
: The display name of the worksheet.
- [Names <IMicrosoftGraphWorkbookNamedItem-
[]>]
: The list of names that are associated with the worksheet.
Read-only.
- [PivotTables <IMicrosoftGraphWorkbookPivotTable-
[]>]
: The list of piot tables that are part of the worksheet.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Name <String>]
: The name of the pivot table.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [Position <Int32?>]
: The zero-based position of the worksheet within the workbook.
- [Protection <IMicrosoftGraphWorkbookWorksheetProtection>]
: workbookWorksheetProtection
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Options <IMicrosoftGraphWorkbookWorksheetProtectionOptions>]
: workbookWorksheetProtectionOptions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowAutoFilter <Boolean?>]
: Represents the worksheet protection option of allowing using auto filter feature.
- [AllowDeleteColumns <Boolean?>]
: Represents the worksheet protection option of allowing deleting columns.
- [AllowDeleteRows <Boolean?>]
: Represents the worksheet protection option of allowing deleting rows.
- [AllowFormatCells <Boolean?>]
: Represents the worksheet protection option of allowing formatting cells.
- [AllowFormatColumns <Boolean?>]
: Represents the worksheet protection option of allowing formatting columns.
- [AllowFormatRows <Boolean?>]
: Represents the worksheet protection option of allowing formatting rows.
- [AllowInsertColumns <Boolean?>]
: Represents the worksheet protection option of allowing inserting columns.
- [AllowInsertHyperlinks <Boolean?>]
: Represents the worksheet protection option of allowing inserting hyperlinks.
- [AllowInsertRows <Boolean?>]
: Represents the worksheet protection option of allowing inserting rows.
- [AllowPivotTables <Boolean?>]
: Represents the worksheet protection option of allowing using pivot table feature.
- [AllowSort <Boolean?>]
: Represents the worksheet protection option of allowing using sort feature.
- [Protected <Boolean?>]
: Indicates whether the worksheet is protected.
Read-only.
- [Tables <IMicrosoftGraphWorkbookTable-
[]>]
: The list of tables that are part of the worksheet.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Columns <IMicrosoftGraphWorkbookTableColumn-
[]>]
: The list of all the columns in the table.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Filter <IMicrosoftGraphWorkbookFilter>]
: workbookFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Criteria <IMicrosoftGraphWorkbookFilterCriteria>]
: workbookFilterCriteria
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Color <String>]
: The color applied to the cell.
- [Criterion1 <String>]
: A custom criterion.
- [Criterion2 <String>]
: A custom criterion.
- [DynamicCriteria <String>]
: A dynamic formula specified in a custom filter.
- [FilterOn <String>]
: Indicates whether a filter is applied to a column.
- [Icon <IMicrosoftGraphWorkbookIcon>]
: workbookIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Index <Int32?>]
: The index of the icon in the given set.
- [Set <String>]
: The set that the icon is part of.
Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.
- [Operator <String>]
: An operator in a cell; for example, =, >, <, <=, or <>.
- [Values <IMicrosoftGraphJson>]
: Json
- [Index <Int32?>]
: The index of the column within the columns collection of the table.
Zero-indexed.
Read-only.
- [Name <String>]
: The name of the table column.
- [Values <IMicrosoftGraphJson>]
: Json
- [HighlightFirstColumn <Boolean?>]
: Indicates whether the first column contains special formatting.
- [HighlightLastColumn <Boolean?>]
: Indicates whether the last column contains special formatting.
- [LegacyId <String>]
: A legacy identifier used in older Excel clients.
The value of the identifier remains the same even when the table is renamed.
This property should be interpreted as an opaque string value and shouldn't be parsed to any other type.
Read-only.
- [Name <String>]
: The name of the table.
- [Rows <IMicrosoftGraphWorkbookTableRow-
[]>]
: The list of all the rows in the table.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Index <Int32?>]
: The index of the row within the rows collection of the table.
Zero-based.
Read-only.
- [Values <IMicrosoftGraphJson>]
: Json
- [ShowBandedColumns <Boolean?>]
: Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.
- [ShowBandedRows <Boolean?>]
: Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.
- [ShowFilterButton <Boolean?>]
: Indicates whether the filter buttons are visible at the top of each column header.
Setting this is only allowed if the table contains a header row.
- [ShowHeaders <Boolean?>]
: Indicates whether the header row is visible or not.
This value can be set to show or remove the header row.
- [ShowTotals <Boolean?>]
: Indicates whether the total row is visible or not.
This value can be set to show or remove the total row.
- [Sort <IMicrosoftGraphWorkbookTableSort>]
: workbookTableSort
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fields <IMicrosoftGraphWorkbookSortField-
[]>]
: The list of the current conditions last used to sort the table.
Read-only.
- [Ascending <Boolean?>]
: Represents whether the sorting is done in an ascending fashion.
- [Color <String>]
: Represents the color that is the target of the condition if the sorting is on font or cell color.
- [DataOption <String>]
: Represents additional sorting options for this field.
Possible values are: Normal, TextAsNumber.
- [Icon <IMicrosoftGraphWorkbookIcon>]
: workbookIcon
- [Key <Int32?>]
: Represents the column (or row, depending on the sort orientation) that the condition is on.
Represented as an offset from the first column (or row).
- [SortOn <String>]
: Represents the type of sorting of this condition.
Possible values are: Value, CellColor, FontColor, Icon.
- [MatchCase <Boolean?>]
: Indicates whether the casing impacted the last sort of the table.
Read-only.
- [Method <String>]
: The Chinese character ordering method last used to sort the table.
The possible values are: PinYin, StrokeCount.
Read-only.
- [Style <String>]
: A constant value that represents the Table style.
Possible values are: TableStyleLight1 through TableStyleLight21, TableStyleMedium1 through TableStyleMedium28, TableStyleStyleDark1 through TableStyleStyleDark11.
A custom user-defined style present in the workbook can also be specified.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [Tasks <IMicrosoftGraphWorkbookDocumentTask-
[]>]
: Collection of document tasks on this worksheet.
Read-only.
- [Visibility <String>]
: The visibility of the worksheet.
The possible values are: Visible, Hidden, VeryHidden.
- [Operations <IMicrosoftGraphWorkbookOperation-
[]>]
: 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.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Error <IMicrosoftGraphWorkbookOperationError>]
: workbookOperationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
- [InnerError <IMicrosoftGraphWorkbookOperationError>]
: workbookOperationError
- [Message <String>]
: The error message.
- [ResourceLocation <String>]
: The resource URI for the result.
- [Status <String>]
: workbookOperationStatus
- [Tables <IMicrosoftGraphWorkbookTable-
[]>]
: Represents a collection of tables associated with the workbook.
Read-only.
- [Worksheets <IMicrosoftGraphWorkbookWorksheet-
[]>]
: Represents a collection of worksheets associated with the workbook.
Read-only.
- [IsArchived <Boolean?>]
: Indicates whether the channel is archived.
Read-only.
- [IsFavoriteByDefault <Boolean?>]
: Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list.
Note: All recommended channels automatically show in the channels list for education and frontline worker users.
The property can only be set programmatically via the Create team method.
The default value is false.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of membership records associated with the channel.
- [MembershipType <String>]
: channelMembershipType
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the channel.
A navigation property.
Nullable.
- [ModerationSettings <IMicrosoftGraphChannelModerationSettings>]
: channelModerationSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowNewMessageFromBots <Boolean?>]
: Indicates whether bots are allowed to post messages.
- [AllowNewMessageFromConnectors <Boolean?>]
: Indicates whether connectors are allowed to post messages.
- [ReplyRestriction <String>]
: replyRestriction
- [UserNewMessageRestriction <String>]
: userNewMessageRestriction
- [SharedWithTeams <IMicrosoftGraphSharedWithChannelTeamInfo-
[]>]
: A collection of teams with which a channel is shared.
- [DisplayName <String>]
: The name of the team.
- [Team <IMicrosoftGraphTeam>]
: team
- [TenantId <String>]
: The ID of the Microsoft Entra tenant.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedMembers <IMicrosoftGraphConversationMember-
[]>]
: A collection of team members who have access to the shared channel.
- [IsHostTeam <Boolean?>]
: Indicates whether the team is the host of the channel.
- [Summary <IMicrosoftGraphChannelSummary>]
: channelSummary
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [GuestsCount <Int32?>]
: Count of guests in a channel.
- [HasMembersFromOtherTenants <Boolean?>]
: Indicates whether external members are included on the channel.
- [MembersCount <Int32?>]
: Count of members in a channel.
- [OwnersCount <Int32?>]
: Count of owners in a channel.
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the channel.
A navigation property.
- [TenantId <String>]
: The ID of the Microsoft Entra tenant.
- [WebUrl <String>]
: A hyperlink to the channel in Microsoft Teams.
This URL is supplied 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.
[Channels <IMicrosoftGraphChannel-
[]>]
: The collection of channels and messages associated with the team.[Classification <String>]
: 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.[CreatedDateTime <DateTime?>]
: Timestamp at which the team was created.[Description <String>]
: An optional description for the team. Maximum length: 1024 characters.[DiscoverySettings <IMicrosoftGraphTeamDiscoverySettings>]
: teamDiscoverySettings[(Any) <Object>]
: This indicates any property can be added to this object.[ShowInTeamsSearchAndSuggestions <Boolean?>]
: If set to true, the team is visible via search and suggestions from the Teams client.
[DisplayName <String>]
: The name of the team.[FunSettings <IMicrosoftGraphTeamFunSettings>]
: teamFunSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowCustomMemes <Boolean?>]
: If set to true, enables users to include custom memes.[AllowGiphy <Boolean?>]
: If set to true, enables Giphy use.[AllowStickersAndMemes <Boolean?>]
: If set to true, enables users to include stickers and memes.[GiphyContentRating <String>]
: giphyRatingType
[Group <IMicrosoftGraphGroup>]
: group[GuestSettings <IMicrosoftGraphTeamGuestSettings>]
: teamGuestSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowCreateUpdateChannels <Boolean?>]
: If set to true, guests can add and update channels.[AllowDeleteChannels <Boolean?>]
: If set to true, guests can delete channels.
[IncomingChannels <IMicrosoftGraphChannel-
[]>]
: List of channels shared with the team.[InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: The apps installed in this team.[InternalId <String>]
: A unique ID for the team used in a few places such as the audit log/Office 365 Management Activity API.[IsArchived <Boolean?>]
: Whether this team is in read-only mode.[IsMembershipLimitedToOwners <Boolean?>]
: If set to true, the team is currently in the owner-only team membership state and inaccessible by other team members, such as students.[MemberSettings <IMicrosoftGraphTeamMemberSettings>]
: teamMemberSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowAddRemoveApps <Boolean?>]
: If set to true, members can add and remove apps.[AllowCreatePrivateChannels <Boolean?>]
: If set to true, members can add and update private channels.[AllowCreateUpdateChannels <Boolean?>]
: If set to true, members can add and update any channels.[AllowCreateUpdateRemoveConnectors <Boolean?>]
: If set to true, members can add, update, and remove connectors.[AllowCreateUpdateRemoveTabs <Boolean?>]
: If set to true, members can add, update, and remove tabs.[AllowDeleteChannels <Boolean?>]
: If set to true, members can delete channels.
[Members <IMicrosoftGraphConversationMember-
[]>]
: Members and owners of the team.[MessagingSettings <IMicrosoftGraphTeamMessagingSettings>]
: teamMessagingSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowChannelMentions <Boolean?>]
: If set to true, @channel mentions are allowed.[AllowOwnerDeleteMessages <Boolean?>]
: If set to true, owners can delete any message.[AllowTeamMentions <Boolean?>]
: If set to true, @team mentions are allowed.[AllowUserDeleteMessages <Boolean?>]
: If set to true, users can delete their messages.[AllowUserEditMessages <Boolean?>]
: If set to true, users can edit their messages.
[Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: The async operations that ran or are running on this team.[Owners <IMicrosoftGraphUser-
[]>]
: 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). The owner must be specified as an object ID (GUID), not a UPN.[PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps to access the team.[Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto[PrimaryChannel <IMicrosoftGraphChannel>]
: channel[Schedule <IMicrosoftGraphSchedule>]
: schedule[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivitiesIncludedWhenCopyingShiftsEnabled <Boolean?>]
: Indicates whether copied shifts should include the activities.[DayNotes <IMicrosoftGraphDayNote-
[]>]
: The day notes in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DayNoteDate <DateTime?>]
: The date of the day note.[DraftDayNote <IMicrosoftGraphItemBody>]
: itemBody[SharedDayNote <IMicrosoftGraphItemBody>]
: itemBody
[Enabled <Boolean?>]
: Indicates whether the schedule is enabled for the team. Required.[IsCrossLocationShiftRequestApprovalRequired <Boolean?>]
: Indicates whether approval is required by a manager of this schedule for cross location shift requests.[IsCrossLocationShiftsEnabled <Boolean?>]
: Indicates whether the cross-location marketplace feature is enabled for this schedule.[OfferShiftRequests <IMicrosoftGraphOfferShiftRequest-
[]>]
: The offer requests for shifts in the schedule.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[RecipientActionMessage <String>]
: Custom message sent by recipient of the offer shift request.[RecipientUserId <String>]
: User id of the recipient of the offer shift request.[SenderShiftId <String>]
: User id of the sender of the offer shift request.
[OfferShiftRequestsEnabled <Boolean?>]
: Indicates whether offer shift requests are enabled for the schedule.[OpenShiftChangeRequests <IMicrosoftGraphOpenShiftChangeRequest-
[]>]
: The open shift requests in the schedule.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[OpenShiftId <String>]
: ID for the open shift.
[OpenShifts <IMicrosoftGraphOpenShift-
[]>]
: The set of open shifts in a scheduling group in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftOpenShift <IMicrosoftGraphOpenShiftItem>]
: openShiftItem[(Any) <Object>]
: This indicates any property can be added to this object.[Activities <IMicrosoftGraphShiftActivity-
[]>]
: An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. Required.[Code <String>]
: Customer defined code for the shiftActivity. Required.[DisplayName <String>]
: The name of the shiftActivity. Required.[EndDateTime <DateTime?>]
: The end date and time for the shiftActivity. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.[IsPaid <Boolean?>]
: Indicates whether the microsoft.graph.user should be paid for the activity during their shift. Required.[StartDateTime <DateTime?>]
: The start date and time for the shiftActivity. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.[Theme <String>]
: scheduleEntityTheme
[DisplayName <String>]
: The shift label of the shiftItem.[Notes <String>]
: The shift notes for the shiftItem.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[OpenSlotCount <Int32?>]
: Count of the number of slots for the given open shift.
[IsStagedForDeletion <Boolean?>]
: The openShift is marked for deletion, a process that is finalized when the schedule is shared.[SchedulingGroupId <String>]
: The ID of the schedulingGroup that contains the openShift.[SchedulingGroupInfo <IMicrosoftGraphSchedulingGroupInfo>]
: schedulingGroupInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The code for the schedulingGroup.[DisplayName <String>]
: The display name for the schedulingGroup. Required.[SchedulingGroupId <String>]
: ID of the schedulingGroup.
[SharedOpenShift <IMicrosoftGraphOpenShiftItem>]
: openShiftItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the team. Required.[TeamId <String>]
: ID of the team.
[OpenShiftsEnabled <Boolean?>]
: Indicates whether open shifts are enabled for the schedule.[ProvisionStatus <String>]
: operationStatus[SchedulingGroups <IMicrosoftGraphSchedulingGroup-
[]>]
: The logical grouping of users in the schedule (usually by role).[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Code <String>]
: The code for the schedulingGroup to represent an external identifier. This field must be unique within the team in Microsoft Teams and uses an alphanumeric format, with a maximum of 100 characters.[DisplayName <String>]
: The display name for the schedulingGroup. Required.[UserIds <String-
[]>]
: The list of user IDs that are a member of the schedulingGroup. Required.
[Shifts <IMicrosoftGraphShift-
[]>]
: The shifts in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftShift <IMicrosoftGraphShiftItem>]
: shiftItem[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[Activities <IMicrosoftGraphShiftActivity-
[]>]
: An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch. Required.[DisplayName <String>]
: The shift label of the shiftItem.[Notes <String>]
: The shift notes for the shiftItem.
[IsStagedForDeletion <Boolean?>]
: The shift is marked for deletion, a process that is finalized when the schedule is shared.[SchedulingGroupId <String>]
: ID of the scheduling group the shift is part of. Required.[SchedulingGroupInfo <IMicrosoftGraphSchedulingGroupInfo>]
: schedulingGroupInfo[SharedShift <IMicrosoftGraphShiftItem>]
: shiftItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[UserId <String>]
: ID of the user assigned to the shift. Required.[UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name for the user. Required.[UserId <String>]
: ID of the user.
[ShiftsRoleDefinitions <IMicrosoftGraphShiftsRoleDefinition-
[]>]
: The definitions of the roles in the schedule.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: The description of the role.[DisplayName <String>]
: The display name of the role.[ShiftsRolePermissions <IMicrosoftGraphShiftsRolePermission-
[]>]
: The collection of role permissions within the role.[AllowedResourceActions <String-
[]>]
: The permissions that are allowed for a role. Permissions that aren't in this collection are disabled.
[StartDayOfWeek <String>]
: dayOfWeek[SwapShiftsChangeRequests <IMicrosoftGraphSwapShiftsChangeRequest-
[]>]
: The swap requests for shifts in the schedule.[RecipientActionMessage <String>]
: Custom message sent by recipient of the offer shift request.[RecipientUserId <String>]
: User id of the recipient of the offer shift request.[SenderShiftId <String>]
: User id of the sender of the offer shift request.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[RecipientShiftId <String>]
: Shift ID for the recipient user with whom the request is to swap.
[SwapShiftsRequestsEnabled <Boolean?>]
: Indicates whether swap shifts requests are enabled for the schedule.[TimeCards <IMicrosoftGraphTimeCard-
[]>]
: The time cards in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Breaks <IMicrosoftGraphTimeCardBreak-
[]>]
: The list of breaks associated with the timeCard.[BreakId <String>]
: ID of the timeCardBreak.[End <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[(Any) <Object>]
: This indicates any property can be added to this object.[AtApprovedLocation <Boolean?>]
: Indicates whether the entry was recorded at the approved location.[DateTime <DateTime?>]
: The time the entry is recorded.[Notes <IMicrosoftGraphItemBody>]
: itemBody
[Notes <IMicrosoftGraphItemBody>]
: itemBody[Start <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
[ClockInEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[ClockOutEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[ConfirmedBy <String>]
: confirmedBy[Notes <IMicrosoftGraphItemBody>]
: itemBody[OriginalEntry <IMicrosoftGraphTimeCardEntry>]
: timeCardEntry[(Any) <Object>]
: This indicates any property can be added to this object.[Breaks <IMicrosoftGraphTimeCardBreak-
[]>]
: The list of breaks associated with the timeCard.[ClockInEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent[ClockOutEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
[State <String>]
: timeCardState[UserId <String>]
: User ID to which the timeCard belongs.
[TimeClockEnabled <Boolean?>]
: Indicates whether time clock is enabled for the schedule.[TimeClockSettings <IMicrosoftGraphTimeClockSettings>]
: timeClockSettings[(Any) <Object>]
: This indicates any property can be added to this object.[ApprovedLocation <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates
[TimeOffReasons <IMicrosoftGraphTimeOffReason-
[]>]
: The set of reasons for a time off in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Code <String>]
: The code of the timeOffReason to represent an external identifier. This field must be unique within the team in Microsoft Teams and uses an alphanumeric format, with a maximum of 100 characters.[DisplayName <String>]
: The name of the timeOffReason. Required.[IconType <String>]
: timeOffReasonIconType[IsActive <Boolean?>]
: Indicates whether the timeOffReason can be used when creating new entities or updating existing ones. Required.
[TimeOffRequests <IMicrosoftGraphTimeOffRequest-
[]>]
: The time off requests in the schedule.[AssignedTo <String>]
: scheduleChangeRequestActor[ManagerActionMessage <String>]
:[SenderMessage <String>]
:[State <String>]
: scheduleChangeState[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[EndDateTime <DateTime?>]
: 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[StartDateTime <DateTime?>]
: 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[TimeOffReasonId <String>]
: The reason for the time off.
[TimeOffRequestsEnabled <Boolean?>]
: Indicates whether time off requests are enabled for the schedule.[TimeZone <String>]
: Indicates the time zone of the schedule team using tz database format. Required.[TimesOff <IMicrosoftGraphTimeOff-
[]>]
: The instances of times off in the schedule.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[DraftTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem[(Any) <Object>]
: This indicates any property can be added to this object.[EndDateTime <DateTime?>]
:[StartDateTime <DateTime?>]
:[Theme <String>]
: scheduleEntityTheme[TimeOffReasonId <String>]
: ID of the timeOffReason for this timeOffItem. Required.
[IsStagedForDeletion <Boolean?>]
: The timeOff is marked for deletion, a process that is finalized when the schedule is shared.[SharedTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem[TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo[UserId <String>]
: ID of the user assigned to the timeOff. Required.[UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo
[WorkforceIntegrationIds <String-
[]>]
: The IDs for the workforce integrations associated with this schedule.
[Specialization <String>]
: teamSpecialization[Summary <IMicrosoftGraphTeamSummary>]
: teamSummary[(Any) <Object>]
: This indicates any property can be added to this object.[GuestsCount <Int32?>]
: Count of guests in a team.[MembersCount <Int32?>]
: Count of members in a team.[OwnersCount <Int32?>]
: Count of owners in a team.
[Tags <IMicrosoftGraphTeamworkTag-
[]>]
: The tags associated with the team.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Tag description as it appears to the user in Microsoft Teams. A teamworkTag can't have more than 200 teamworkTagMembers.[DisplayName <String>]
: Tag name as it appears to the user in Microsoft Teams.[MemberCount <Int32?>]
: The number of users assigned to the tag.[Members <IMicrosoftGraphTeamworkTagMember-
[]>]
: Users assigned to the tag.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The member's display name.[TenantId <String>]
: The ID of the tenant that the tag member is a part of.[UserId <String>]
: The user ID of the member.
[TagType <String>]
: teamworkTagType[TeamId <String>]
: ID of the team in which the tag is defined.
[Template <IMicrosoftGraphTeamsTemplate>]
: teamsTemplate[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
[TemplateDefinition <IMicrosoftGraphTeamTemplateDefinition>]
: teamTemplateDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Audience <String>]
: teamTemplateAudience[Categories <String-
[]>]
: The assigned categories for the team template.[Description <String>]
: A brief description of the team template as it will appear to the users in Microsoft Teams.[DisplayName <String>]
: The user defined name of the team template.[IconUrl <String>]
: The icon url for the team template.[LanguageTag <String>]
: Language the template is available in.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: The date time of when the team template was last modified.[ParentTemplateId <String>]
: The templateId for the team template[PublisherName <String>]
: The organization which published the team template.[ShortDescription <String>]
: A short-description of the team template as it will appear to the users in Microsoft Teams.[TeamDefinition <IMicrosoftGraphTeam>]
: team
[TenantId <String>]
: The ID of the Microsoft Entra tenant.[Visibility <String>]
: teamVisibilityType[WebUrl <String>]
: A hyperlink that goes to the team in the Microsoft Teams client. It is the URL 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.
LICENSEASSIGNMENTSTATES <IMicrosoftGraphLicenseAssignmentState- []
>: 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.
[AssignedByGroup <String>]
: Indicates whether the license is directly-assigned or inherited from a group. If directly-assigned, this field is null; if inherited through a group membership, this field contains the ID of the group. Read-Only.[DisabledPlans <String-
[]>]
: The service plans that are disabled in this assignment. Read-Only.[Error <String>]
: License assignment failure error. If the license is assigned successfully, this field will be Null. Read-Only. The possible values are CountViolation, MutuallyExclusiveViolation, DependencyViolation, ProhibitedInUsageLocationViolation, UniquenessViolation, and Other. For more information on how to identify and resolve license assignment errors, see here.[LastUpdatedDateTime <DateTime?>]
: The timestamp when the state of the license assignment was last updated.[SkuId <String>]
: The unique identifier for the SKU. Read-Only.[State <String>]
: Indicate the current state of this assignment. Read-Only. The possible values are Active, ActiveWithError, Disabled, and Error.
LICENSEDETAILS <IMicrosoftGraphLicenseDetails- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license. Read-only. Not nullable.[AppliesTo <String>]
: 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.[ProvisioningStatus <String>]
: 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.[ServicePlanId <String>]
: The unique identifier of the service plan.[ServicePlanName <String>]
: The name of the service plan.
[SkuId <String>]
: Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.[SkuPartNumber <String>]
: Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.
MAILBOXSETTINGS <IMicrosoftGraphMailboxSettings>
: mailboxSettings
[(Any) <Object>]
: This indicates any property can be added to this object.[ArchiveFolder <String>]
: Folder ID of an archive folder for the user. Read-only.[AutomaticRepliesSetting <IMicrosoftGraphAutomaticRepliesSetting>]
: automaticRepliesSetting[(Any) <Object>]
: This indicates any property can be added to this object.[ExternalAudience <String>]
: externalAudienceScope[ExternalReplyMessage <String>]
: The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.[InternalReplyMessage <String>]
: The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.[ScheduledEndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[ScheduledStartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: automaticRepliesStatus
[DateFormat <String>]
: The date format for the user's mailbox.[DelegateMeetingMessageDeliveryOptions <String>]
: delegateMeetingMessageDeliveryOptions[Language <IMicrosoftGraphLocaleInfo>]
: localeInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: A name representing the user's locale in natural language, for example, 'English (United States)'.[Locale <String>]
: 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.
[TimeFormat <String>]
: The time format for the user's mailbox.[TimeZone <String>]
: The default time zone for the user's mailbox.[UserPurpose <String>]
: userPurpose[UserPurposeV2 <String>]
: mailboxRecipientType[WorkingHours <IMicrosoftGraphWorkingHours>]
: workingHours[(Any) <Object>]
: This indicates any property can be added to this object.[DaysOfWeek <String-
[]>]
: The days of the week on which the user works.[EndTime <String>]
: The time of the day that the user stops working.[StartTime <String>]
: The time of the day that the user starts working.[TimeZone <IMicrosoftGraphTimeZoneBase>]
: timeZoneBase[(Any) <Object>]
: This indicates any property can be added to this object.[Name <String>]
: The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.
MAILFOLDERS <IMicrosoftGraphMailFolder- []
>: The user's mail folders.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[ChildFolderCount <Int32?>]
: The number of immediate child mailFolders in the current mailFolder.[ChildFolders <IMicrosoftGraphMailFolder-
[]>]
: The collection of child folders in the mailFolder.[DisplayName <String>]
: The mailFolder's display name.[IsHidden <Boolean?>]
: Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders.[MessageRules <IMicrosoftGraphMessageRule-
[]>]
: The collection of rules that apply to the user's Inbox folder.[Id <String>]
: The unique identifier for an entity. Read-only.[Actions <IMicrosoftGraphMessageRuleActions>]
: messageRuleActions[(Any) <Object>]
: This indicates any property can be added to this object.[AssignCategories <String-
[]>]
: A list of categories to be assigned to a message.[CopyToFolder <String>]
: The ID of a folder that a message is to be copied to.[Delete <Boolean?>]
: Indicates whether a message should be moved to the Deleted Items folder.[ForwardAsAttachmentTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses of the recipients to which a message should be forwarded as an attachment.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[ForwardTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses of the recipients to which a message should be forwarded.[MarkAsRead <Boolean?>]
: Indicates whether a message should be marked as read.[MarkImportance <String>]
: importance[MoveToFolder <String>]
: The ID of the folder that a message will be moved to.[PermanentDelete <Boolean?>]
: Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder.[RedirectTo <IMicrosoftGraphRecipient-
[]>]
: The email address to which a message should be redirected.[StopProcessingRules <Boolean?>]
: Indicates whether subsequent rules should be evaluated.
[Conditions <IMicrosoftGraphMessageRulePredicates>]
: messageRulePredicates[(Any) <Object>]
: This indicates any property can be added to this object.[BodyContains <String-
[]>]
: Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply.[BodyOrSubjectContains <String-
[]>]
: 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 <String-
[]>]
: Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply.[FromAddresses <IMicrosoftGraphRecipient-
[]>]
: Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply.[HasAttachments <Boolean?>]
: Indicates whether an incoming message must have attachments in order for the condition or exception to apply.[HeaderContains <String-
[]>]
: Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply.[Importance <String>]
: importance[IsApprovalRequest <Boolean?>]
: Indicates whether an incoming message must be an approval request in order for the condition or exception to apply.[IsAutomaticForward <Boolean?>]
: Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply.[IsAutomaticReply <Boolean?>]
: Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply.[IsEncrypted <Boolean?>]
: Indicates whether an incoming message must be encrypted in order for the condition or exception to apply.[IsMeetingRequest <Boolean?>]
: Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply.[IsMeetingResponse <Boolean?>]
: Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply.[IsNonDeliveryReport <Boolean?>]
: Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply.[IsPermissionControlled <Boolean?>]
: Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply.[IsReadReceipt <Boolean?>]
: Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply.[IsSigned <Boolean?>]
: Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply.[IsVoicemail <Boolean?>]
: Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply.[MessageActionFlag <String>]
: messageActionFlag[NotSentToMe <Boolean?>]
: 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.[RecipientContains <String-
[]>]
: 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 <String-
[]>]
: Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply.[Sensitivity <String>]
: sensitivity[SentCcMe <Boolean?>]
: 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.[SentOnlyToMe <Boolean?>]
: 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.[SentToAddresses <IMicrosoftGraphRecipient-
[]>]
: Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply.[SentToMe <Boolean?>]
: 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.[SentToOrCcMe <Boolean?>]
: 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.[SubjectContains <String-
[]>]
: Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply.[WithinSizeRange <IMicrosoftGraphSizeRange>]
: sizeRange[(Any) <Object>]
: This indicates any property can be added to this object.[MaximumSize <Int32?>]
: The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.[MinimumSize <Int32?>]
: The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply.
[DisplayName <String>]
: The display name of the rule.[Exceptions <IMicrosoftGraphMessageRulePredicates>]
: messageRulePredicates[HasError <Boolean?>]
: Indicates whether the rule is in an error condition. Read-only.[IsEnabled <Boolean?>]
: Indicates whether the rule is enabled to be applied to messages.[IsReadOnly <Boolean?>]
: Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API.[Sequence <Int32?>]
: Indicates the order in which the rule is executed, among other rules.
[Messages <IMicrosoftGraphMessage-
[]>]
: The collection of messages in the mailFolder.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The fileAttachment and itemAttachment attachments for the message.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[BccRecipients <IMicrosoftGraphRecipient-
[]>]
: The Bcc: recipients for the message.[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: 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.[CcRecipients <IMicrosoftGraphRecipient-
[]>]
: The Cc: recipients for the message.[ConversationId <String>]
: The ID of the conversation the email belongs to.[ConversationIndex <Byte-
[]>]
: Indicates the position of the message within the conversation.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the message. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag[(Any) <Object>]
: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[FlagStatus <String>]
: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[From <IMicrosoftGraphRecipient>]
: recipient[HasAttachments <Boolean?>]
: 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 .[Importance <String>]
: importance[InferenceClassification <String>]
: inferenceClassificationType[InternetMessageHeaders <IMicrosoftGraphInternetMessageHeader-
[]>]
: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.[Name <String>]
: Represents the key in a key-value pair.[Value <String>]
: The value in a key-value pair.
[InternetMessageId <String>]
: The message ID in the format specified by RFC5322. Updatable only if isDraft is true.[IsDeliveryReceiptRequested <Boolean?>]
: Indicates whether a read receipt is requested for the message.[IsDraft <Boolean?>]
: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.[IsRead <Boolean?>]
: Indicates whether the message has been read.[IsReadReceiptRequested <Boolean?>]
: Indicates whether a read receipt is requested for the message.[Mentions <IMicrosoftGraphMention-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Application <String>]
: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.[ClientReference <String>]
: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.[CreatedBy <IMicrosoftGraphEmailAddress>]
: emailAddress[CreatedDateTime <DateTime?>]
: The date and time that the mention is created on the client.[DeepLink <String>]
: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.[MentionText <String>]
: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.[Mentioned <IMicrosoftGraphEmailAddress>]
: emailAddress[ServerCreatedDateTime <DateTime?>]
: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
[MentionsPreview <IMicrosoftGraphMentionsPreview>]
: mentionsPreview[(Any) <Object>]
: This indicates any property can be added to this object.[IsMentioned <Boolean?>]
: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the message. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[ParentFolderId <String>]
: The unique identifier for the message's parent mailFolder.[ReceivedDateTime <DateTime?>]
: The date and time the message was received. 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.[ReplyTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses to use when replying.[Sender <IMicrosoftGraphRecipient>]
: recipient[SentDateTime <DateTime?>]
: The date and time the message was sent. 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.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the message. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Subject <String>]
: The subject of the message.[ToRecipients <IMicrosoftGraphRecipient-
[]>]
: The To: recipients for the message.[UniqueBody <IMicrosoftGraphItemBody>]
: itemBody[UnsubscribeData <String-
[]>]
: The valid entries parsed from the List-Unsubscribe header. This is the data for the mail command in the List-Unsubscribe header if UnsubscribeEnabled property is true.[UnsubscribeEnabled <Boolean?>]
: Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369.[WebLink <String>]
: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable.[ParentFolderId <String>]
: The unique identifier for the mailFolder's parent mailFolder.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable.[TotalItemCount <Int32?>]
: The number of items in the mailFolder.[UnreadItemCount <Int32?>]
: The number of items in the mailFolder marked as unread.[UserConfigurations <IMicrosoftGraphUserConfiguration-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[BinaryData <Byte-
[]>]
:
[WellKnownName <String>]
: 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.
MANAGEDAPPLOGCOLLECTIONREQUESTS <IMicrosoftGraphManagedAppLogCollectionRequest- []
>: Zero or more log collection requests triggered for the user.
[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: DateTime of when the log upload request was completed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.[ManagedAppRegistrationId <String>]
: The unique identifier of the app instance for which diagnostic logs were collected. Read-only.[RequestedBy <String>]
: The user principal name associated with the request for the managed application log collection. Read-only.[RequestedByUserPrincipalName <String>]
: The user principal name associated with the request for the managed application log collection. Read-only.[RequestedDateTime <DateTime?>]
: DateTime of when the log upload request was received. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.[Status <String>]
: Indicates the status for the app log collection request - pending, completed or failed. Default is pending.[UploadedLogs <IMicrosoftGraphManagedAppLogUpload-
[]>]
: The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs. Read-only.[ManagedAppComponent <String>]
: The Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. Read-only.[ManagedAppComponentDescription <String>]
: The Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. Read-only.[ReferenceId <String>]
: A provider-specific reference id for the uploaded logs. Read-only.[Status <ManagedAppLogUploadState?>]
: Represents the current status of the associated `managedAppLogCollectionRequest`.
[UserLogUploadConsent <ManagedAppLogUploadConsent?>]
: Represents the current consent status of the associated `managedAppLogCollectionRequest`.[Version <String>]
: Version of the entity.
MANAGEDAPPREGISTRATIONS <IMicrosoftGraphManagedAppRegistration- []
>: Zero or more managed app registrations that belong to the user.
[Id <String>]
: The unique identifier for an entity. Read-only.[AppIdentifier <IMicrosoftGraphMobileAppIdentifier>]
: The identifier for a mobile app.[(Any) <Object>]
: This indicates any property can be added to this object.
[ApplicationVersion <String>]
: App version[AppliedPolicies <IMicrosoftGraphManagedAppPolicy-
[]>]
: Zero or more policys already applied on the registered app when it last synchronized with managment service.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The date and time the policy was created.[Description <String>]
: The policy's description.[DisplayName <String>]
: Policy display name.[LastModifiedDateTime <DateTime?>]
: Last time the policy was modified.[RoleScopeTagIds <String-
[]>]
: List of Scope Tags for this Entity instance.[Version <String>]
: Version of the entity.
[AzureAdDeviceId <String>]
: The Azure Active Directory Device identifier of the host device. Value could be empty even when the host device is Azure Active Directory registered.[CreatedDateTime <DateTime?>]
: Date and time of creation[DeviceManufacturer <String>]
: The device manufacturer for the current app registration[DeviceModel <String>]
: The device model for the current app registration[DeviceName <String>]
: Host device name[DeviceTag <String>]
: App management SDK generated tag, which helps relate apps hosted on the same device. Not guaranteed to relate apps in all conditions.[DeviceType <String>]
: Host device type[FlaggedReasons <ManagedAppFlaggedReason-
[]>]
: Zero or more reasons an app registration is flagged. E.g. app running on rooted device[IntendedPolicies <IMicrosoftGraphManagedAppPolicy-
[]>]
: Zero or more policies admin intended for the app as of now.[LastSyncDateTime <DateTime?>]
: Date and time of last the app synced with management service.[ManagedAppLogCollectionRequests <IMicrosoftGraphManagedAppLogCollectionRequest-
[]>]
: Zero or more log collection requests triggered for the app.[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: DateTime of when the log upload request was completed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.[ManagedAppRegistrationId <String>]
: The unique identifier of the app instance for which diagnostic logs were collected. Read-only.[RequestedBy <String>]
: The user principal name associated with the request for the managed application log collection. Read-only.[RequestedByUserPrincipalName <String>]
: The user principal name associated with the request for the managed application log collection. Read-only.[RequestedDateTime <DateTime?>]
: DateTime of when the log upload request was received. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only.[Status <String>]
: Indicates the status for the app log collection request - pending, completed or failed. Default is pending.[UploadedLogs <IMicrosoftGraphManagedAppLogUpload-
[]>]
: The collection of log upload results as reported by each component on the device. Such components can be the application itself, the Mobile Application Management (MAM) SDK, and other on-device components that are requested to upload diagnostic logs. Read-only.[ManagedAppComponent <String>]
: The Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. Read-only.[ManagedAppComponentDescription <String>]
: The Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. Read-only.[ReferenceId <String>]
: A provider-specific reference id for the uploaded logs. Read-only.[Status <ManagedAppLogUploadState?>]
: Represents the current status of the associated `managedAppLogCollectionRequest`.
[UserLogUploadConsent <ManagedAppLogUploadConsent?>]
: Represents the current consent status of the associated `managedAppLogCollectionRequest`.[Version <String>]
: Version of the entity.
[ManagedDeviceId <String>]
: The Managed Device identifier of the host device. Value could be empty even when the host device is managed.[ManagementSdkVersion <String>]
: App management SDK version[Operations <IMicrosoftGraphManagedAppOperation-
[]>]
: Zero or more long running operations triggered on the app registration.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The operation name.[LastModifiedDateTime <DateTime?>]
: The last time the app operation was modified.[State <String>]
: The current state of the operation[Version <String>]
: Version of the entity.
[PlatformVersion <String>]
: Operating System version[UserId <String>]
: The user Id to who this app registration belongs.[Version <String>]
: Version of the entity.
MANAGEDDEVICES <IMicrosoftGraphManagedDevice- []
>: The managed devices associated with the user.
[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentFilterEvaluationStatusDetails <IMicrosoftGraphAssignmentFilterEvaluationStatusDetails-
[]>]
: Managed device mobile app configuration states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[PayloadId <String>]
: PayloadId on which filter has been applied.
[ChassisType <ChassisType?>]
: Chassis type.[ChromeOSDeviceInfo <IMicrosoftGraphChromeOSDeviceProperty-
[]>]
: 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.[Name <String>]
: Name of the property[Updatable <Boolean?>]
: Whether this property is updatable[Value <String>]
: Value of the property[ValueType <String>]
: Type of the value
[CloudPcRemoteActionResults <IMicrosoftGraphCloudPcRemoteActionResult-
[]>]
:[ActionName <String>]
: 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.[ActionState <String>]
: actionState[CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed. Read-only.[LastUpdatedDateTime <DateTime?>]
: 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'.[ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed. Read-only.[StartDateTime <DateTime?>]
: 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'.[StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail[(Any) <Object>]
: This indicates any property can be added to this object.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status. For example, 'additionalInformation': -['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'[Name <String>]
: Name for this key-value pair[Value <String>]
: Value for this key-value pair
[Code <String>]
: The error/warning code associated with the Cloud PC status. Example: 'code': 'internalServerError'.[Message <String>]
: The status message associated with error code. Example: 'message': 'There was an internal server error. Please contact support xxx.'.
[StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails[(Any) <Object>]
: This indicates any property can be added to this object.[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.[Code <String>]
: The code associated with the Cloud PC status.[Message <String>]
: The status message.
[ComplianceState <ComplianceState?>]
: Compliance state.[ConfigurationManagerClientEnabledFeatures <IMicrosoftGraphConfigurationManagerClientEnabledFeatures>]
: configuration Manager client enabled features[(Any) <Object>]
: This indicates any property can be added to this object.[CompliancePolicy <Boolean?>]
: Whether compliance policy is managed by Intune[DeviceConfiguration <Boolean?>]
: Whether device configuration is managed by Intune[EndpointProtection <Boolean?>]
: Whether Endpoint Protection is managed by Intune[Inventory <Boolean?>]
: Whether inventory is managed by Intune[ModernApps <Boolean?>]
: Whether modern application is managed by Intune[OfficeApps <Boolean?>]
: Whether Office application is managed by Intune[ResourceAccess <Boolean?>]
: Whether resource access is managed by Intune[WindowsUpdateForBusiness <Boolean?>]
: Whether Windows Update for Business is managed by Intune
[ConfigurationManagerClientHealthState <IMicrosoftGraphConfigurationManagerClientHealthState>]
: Configuration manager client health state[(Any) <Object>]
: This indicates any property can be added to this object.[ErrorCode <Int32?>]
: Error code for failed state.[LastSyncDateTime <DateTime?>]
: Datetime for last sync with configuration manager management point.[State <ConfigurationManagerClientState?>]
: Configuration manager client state
[ConfigurationManagerClientInformation <IMicrosoftGraphConfigurationManagerClientInformation>]
: Configuration Manager client information synced from SCCM[(Any) <Object>]
: This indicates any property can be added to this object.[ClientIdentifier <String>]
: Configuration Manager Client Id from SCCM[ClientVersion <String>]
: Configuration Manager Client version from SCCM[IsBlocked <Boolean?>]
: Configuration Manager Client blocked status from SCCM
[DetectedApps <IMicrosoftGraphDetectedApp-
[]>]
: All applications currently installed on the device[Id <String>]
: The unique identifier for an entity. Read-only.[DeviceCount <Int32?>]
: The number of devices that have installed this application[DisplayName <String>]
: Name of the discovered application. Read-only[ManagedDevices <IMicrosoftGraphManagedDevice-
[]>]
: The devices that have the discovered application installed[Platform <DetectedAppPlatformType?>]
: Indicates the operating system / platform of the discovered application. Some possible values are Windows, iOS, macOS. The default value is unknown (0).[Publisher <String>]
: Indicates the publisher of the discovered application. For example: 'Microsoft'. The default value is an empty string.[SizeInByte <Int64?>]
: Discovered application size in bytes. Read-only[Version <String>]
: Version of the discovered application. Read-only
[DeviceCategory <IMicrosoftGraphDeviceCategory>]
: 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.[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Optional description for the device category.[DisplayName <String>]
: Display name for the device category.[RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the device category.
[DeviceCompliancePolicyStates <IMicrosoftGraphDeviceCompliancePolicyState-
[]>]
: Device compliance policy states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the policy for this policyBase[PlatformType <PolicyPlatformType?>]
: Supported platform types for policies.[SettingCount <Int32?>]
: Count of how many setting a policy holds[SettingStates <IMicrosoftGraphDeviceCompliancePolicySettingState-
[]>]
:[CurrentValue <String>]
: Current value of setting on device[ErrorCode <Int64?>]
: Error code for the setting[ErrorDescription <String>]
: Error description[InstanceDisplayName <String>]
: Name of setting instance that is being reported.[Setting <String>]
: The setting that is being reported[SettingInstanceId <String>]
: SettingInstanceId[SettingName <String>]
: Localized/user friendly setting name that is being reported[Sources <IMicrosoftGraphSettingSource-
[]>]
: Contributing policies[DisplayName <String>]
:[Id <String>]
:[SourceType <String>]
: settingSourceType
[State <String>]
: complianceStatus[UserEmail <String>]
: UserEmail[UserId <String>]
: UserId[UserName <String>]
: UserName[UserPrincipalName <String>]
: UserPrincipalName.
[State <String>]
: complianceStatus[UserId <String>]
: User unique identifier, must be Guid[UserPrincipalName <String>]
: User Principal Name[Version <Int32?>]
: The version of the policy
[DeviceConfigurationStates <IMicrosoftGraphDeviceConfigurationState-
[]>]
: Device configuration states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the policy for this policyBase[PlatformType <PolicyPlatformType?>]
: Supported platform types for policies.[SettingCount <Int32?>]
: Count of how many setting a policy holds[SettingStates <IMicrosoftGraphDeviceConfigurationSettingState-
[]>]
:[CurrentValue <String>]
: Current value of setting on device[ErrorCode <Int64?>]
: Error code for the setting[ErrorDescription <String>]
: Error description[InstanceDisplayName <String>]
: Name of setting instance that is being reported.[Setting <String>]
: The setting that is being reported[SettingInstanceId <String>]
: SettingInstanceId[SettingName <String>]
: Localized/user friendly setting name that is being reported[Sources <IMicrosoftGraphSettingSource-
[]>]
: Contributing policies[State <String>]
: complianceStatus[UserEmail <String>]
: UserEmail[UserId <String>]
: UserId[UserName <String>]
: UserName[UserPrincipalName <String>]
: UserPrincipalName.
[State <String>]
: complianceStatus[UserId <String>]
: User unique identifier, must be Guid[UserPrincipalName <String>]
: User Principal Name[Version <Int32?>]
: The version of the policy
[DeviceEnrollmentType <DeviceEnrollmentType?>]
: Possible ways of adding a mobile device to management.[DeviceFirmwareConfigurationInterfaceManaged <Boolean?>]
: 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 <IMicrosoftGraphDeviceHealthAttestationState>]
: deviceHealthAttestationState[(Any) <Object>]
: This indicates any property can be added to this object.[AttestationIdentityKey <String>]
: TWhen an Attestation Identity Key (AIK) is present on a device, it indicates that the device has an endorsement key (EK) certificate.[BitLockerStatus <String>]
: On or Off of BitLocker Drive Encryption[BootAppSecurityVersion <String>]
: The security version number of the Boot Application[BootDebugging <String>]
: When bootDebugging is enabled, the device is used in development and testing[BootManagerSecurityVersion <String>]
: The security version number of the Boot Application[BootManagerVersion <String>]
: The version of the Boot Manager[BootRevisionListInfo <String>]
: The Boot Revision List that was loaded during initial boot on the attested device[CodeIntegrity <String>]
: When code integrity is enabled, code execution is restricted to integrity verified code[CodeIntegrityCheckVersion <String>]
: The version of the Boot Manager[CodeIntegrityPolicy <String>]
: The Code Integrity policy that is controlling the security of the boot environment[ContentNamespaceUrl <String>]
: The DHA report version. (Namespace version)[ContentVersion <String>]
: The HealthAttestation state schema version[DataExcutionPolicy <String>]
: DEP Policy defines a set of hardware and software technologies that perform additional checks on memory[DeviceHealthAttestationStatus <String>]
: The DHA report version. (Namespace version)[EarlyLaunchAntiMalwareDriverProtection <String>]
: ELAM provides protection for the computers in your network when they start up[FirmwareProtection <FirmwareProtectionType?>]
: A list of possible Firmware protection type for a device. Firmware protection is a set of features that helps to ensure attackers can't get your device to start with untrusted or malicious firmware. Firmware protection type is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "systemGuardSecureLaunch" or "firmwareAttackSurfaceReduction" or "disabled". Windows 10 devices will have value "notApplicable".[HealthAttestationSupportedStatus <String>]
: This attribute indicates if DHA is supported for the device[HealthStatusMismatchInfo <String>]
: This attribute appears if DHA-Service detects an integrity issue[IssuedDateTime <DateTime?>]
: The DateTime when device was evaluated or issued to MDM[LastUpdateDateTime <String>]
: The Timestamp of the last update.[MemoryAccessProtection <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[MemoryIntegrityProtection <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[OperatingSystemKernelDebugging <String>]
: When operatingSystemKernelDebugging is enabled, the device is used in development and testing[OperatingSystemRevListInfo <String>]
: The Operating System Revision List that was loaded during initial boot on the attested device[Pcr0 <String>]
: The measurement that is captured in PCR-[0]
[PcrHashAlgorithm <String>]
: Informational attribute that identifies the HASH algorithm that was used by TPM[ResetCount <Int64?>]
: The number of times a PC device has hibernated or resumed[RestartCount <Int64?>]
: The number of times a PC device has rebooted[SafeMode <String>]
: Safe mode is a troubleshooting option for Windows that starts your computer in a limited state[SecureBoot <String>]
: When Secure Boot is enabled, the core components must have the correct cryptographic signatures[SecureBootConfigurationPolicyFingerPrint <String>]
: Fingerprint of the Custom Secure Boot Configuration Policy[SecuredCorePc <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[SystemManagementMode <SystemManagementModeLevel?>]
: A list of possible System Management Mode levels for a device. System Management Mode levels is determined by report sent from Microsoft Azure Attestation service. Only specific hardwares support System Management Mode. Windows 11 devices will have values "notApplicable", "level1", "level2" or "level3". Windows 10 devices will have value "notApplicable".[TestSigning <String>]
: When test signing is allowed, the device does not enforce signature validation during boot[TpmVersion <String>]
: The security version number of the Boot Application[VirtualSecureMode <String>]
: Indicates whether the device has Virtual Secure Mode (VSM) enabled. Virtual Secure Mode (VSM) is a container that protects high value assets from a compromised kernel. This property will be deprecated in beta from August 2023. Support for this property will end in August 2025 for v1.0 API. A new property virtualizationBasedSecurity is added and used instead. The value used for virtualSecureMode will be passed by virtualizationBasedSecurity during the deprecation process. Possible values are 'enabled', 'disabled' and 'notApplicable'. 'enabled' indicates Virtual Secure Mode (VSM) is enabled. 'disabled' indicates Virtual Secure Mode (VSM) is disabled. 'notApplicable' indicates the device is not a Windows 11 device. Default value is 'notApplicable'.[VirtualizationBasedSecurity <AzureAttestationSettingStatus?>]
: A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable".[WindowsPe <String>]
: Operating system running with limited services that is used to prepare a computer for Windows
[DeviceHealthScriptStates <IMicrosoftGraphDeviceHealthScriptPolicyState-
[]>]
: Results of device health scripts that ran for this device. Default is empty list. This property is read-only.[AssignmentFilterIds <String-
[]>]
: A list of the assignment filter ids used for health script applicability evaluation[DetectionState <RunState?>]
: Indicates the type of execution status of the device management script.[DeviceId <String>]
: The Intune device Id[DeviceName <String>]
: Display name of the device[ExpectedStateUpdateDateTime <DateTime?>]
: The next timestamp of when the device health script is expected to execute[Id <String>]
: Key of the device health script policy state is a concatenation of the MT sideCar policy Id and Intune device Id[LastStateUpdateDateTime <DateTime?>]
: The last timestamp of when the device health script executed[LastSyncDateTime <DateTime?>]
: The last time that Intune Managment Extension synced with Intune[OSVersion <String>]
: Value of the OS Version in string[PolicyId <String>]
: The MT sideCar policy Id[PolicyName <String>]
: Display name of the device health script[PostRemediationDetectionScriptError <String>]
: Error from the detection script after remediation[PostRemediationDetectionScriptOutput <String>]
: Detection script output after remediation[PreRemediationDetectionScriptError <String>]
: Error from the detection script before remediation[PreRemediationDetectionScriptOutput <String>]
: Output of the detection script before remediation[RemediationScriptError <String>]
: Error output of the remediation script[RemediationState <RemediationState?>]
: Indicates the type of execution status of the device management script.[UserName <String>]
: Name of the user whom ran the device health script
[DeviceRegistrationState <DeviceRegistrationState?>]
: Device registration status.[DeviceType <DeviceType?>]
: Device type.[ExchangeAccessState <DeviceManagementExchangeAccessState?>]
: Device Exchange Access State.[ExchangeAccessStateReason <DeviceManagementExchangeAccessStateReason?>]
: Device Exchange Access State Reason.[HardwareInformation <IMicrosoftGraphHardwareInformation>]
: Hardware information of a given device.[(Any) <Object>]
: This indicates any property can be added to this object.[BatteryChargeCycles <Int32?>]
: The number of charge cycles the device's current battery has gone through. Valid values 0 to 2147483647[BatteryHealthPercentage <Int32?>]
: The device's current battery's health percentage. Valid values 0 to 100[BatteryLevelPercentage <Double?>]
: 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[BatterySerialNumber <String>]
: The serial number of the device's current battery[CellularTechnology <String>]
: Cellular technology of the device[DeviceFullQualifiedDomainName <String>]
: Returns the fully qualified domain name of the device (if any). If the device is not domain-joined, it returns an empty string.[DeviceGuardLocalSystemAuthorityCredentialGuardState <DeviceGuardLocalSystemAuthorityCredentialGuardState?>]
: deviceGuardLocalSystemAuthorityCredentialGuardState[DeviceGuardVirtualizationBasedSecurityHardwareRequirementState <DeviceGuardVirtualizationBasedSecurityHardwareRequirementState?>]
: deviceGuardVirtualizationBasedSecurityHardwareRequirementState[DeviceGuardVirtualizationBasedSecurityState <DeviceGuardVirtualizationBasedSecurityState?>]
: deviceGuardVirtualizationBasedSecurityState[DeviceLicensingLastErrorCode <Int32?>]
: 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[DeviceLicensingLastErrorDescription <String>]
: 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.[DeviceLicensingStatus <DeviceLicensingStatus?>]
: Indicates the device licensing status after Windows device based subscription has been enabled.[EsimIdentifier <String>]
: eSIM identifier[FreeStorageSpace <Int64?>]
: Free storage space of the device.[IPAddressV4 <String>]
: IPAddressV4[Imei <String>]
: IMEI[IsEncrypted <Boolean?>]
: Encryption status of the device[IsSharedDevice <Boolean?>]
: Shared iPad[IsSupervised <Boolean?>]
: Supervised mode of the device[Manufacturer <String>]
: Manufacturer of the device[Meid <String>]
: MEID[Model <String>]
: Model of the device[OSBuildNumber <String>]
: Operating System Build Number on Android device[OperatingSystemEdition <String>]
: String that specifies the OS edition.[OperatingSystemLanguage <String>]
: Operating system language of the device[OperatingSystemProductType <Int32?>]
: Int that specifies the Windows Operating System ProductType. More details here https://go.microsoft.com/fwlink/?linkid=2126950. Valid values 0 to 2147483647[PhoneNumber <String>]
: Phone number of the device[ProductName <String>]
: 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.[ResidentUsersCount <Int32?>]
: 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[SerialNumber <String>]
: Serial number.[SharedDeviceCachedUsers <IMicrosoftGraphSharedAppleDeviceUser-
[]>]
: All users on the shared Apple device[DataQuota <Int64?>]
: Data quota[DataToSync <Boolean?>]
: Data to sync[DataUsed <Int64?>]
: Data quota[UserPrincipalName <String>]
: User name
[SubnetAddress <String>]
: SubnetAddress[SubscriberCarrier <String>]
: Subscriber carrier of the device[SystemManagementBiosVersion <String>]
: BIOS version as reported by SMBIOS[TotalStorageSpace <Int64?>]
: Total storage space of the device.[TpmManufacturer <String>]
: The identifying information that uniquely names the TPM manufacturer[TpmSpecificationVersion <String>]
: String that specifies the specification version.[TpmVersion <String>]
: The version of the TPM, as specified by the manufacturer[WifiMac <String>]
: WiFi MAC address of the device[WiredIPv4Addresses <String-
[]>]
: 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.
[JoinType <JoinType?>]
: Device enrollment join type.[LogCollectionRequests <IMicrosoftGraphDeviceLogCollectionResponse-
[]>]
: List of log collection requests[Id <String>]
: The unique identifier for an entity. Read-only.[EnrolledByUser <String>]
: The User Principal Name (UPN) of the user that enrolled the device.[ErrorCode <Int64?>]
: The error code, if any. Valid values -9.22337203685478E+18 to 9.22337203685478E+18[ExpirationDateTimeUtc <DateTime?>]
: The DateTime of the expiration of the logs.[InitiatedByUserPrincipalName <String>]
: The UPN for who initiated the request.[ManagedDeviceId <String>]
: Indicates Intune device unique identifier.[ReceivedDateTimeUtc <DateTime?>]
: The DateTime the request was received.[RequestedDateTimeUtc <DateTime?>]
: The DateTime of the request.[Size <Double?>]
: The size of the logs. Valid values -1.79769313486232E+308 to 1.79769313486232E+308[SizeInKb <Double?>]
: The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308[Status <AppLogUploadState?>]
: AppLogUploadStatus
[LostModeState <LostModeState?>]
: State of lost mode, indicating if lost mode is enabled or disabled[ManagedDeviceMobileAppConfigurationStates <IMicrosoftGraphManagedDeviceMobileAppConfigurationState-
[]>]
: Managed device mobile app configuration states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the policy for this policyBase[PlatformType <PolicyPlatformType?>]
: Supported platform types for policies.[SettingCount <Int32?>]
: Count of how many setting a policy holds[SettingStates <IMicrosoftGraphManagedDeviceMobileAppConfigurationSettingState-
[]>]
:[CurrentValue <String>]
: Current value of setting on device[ErrorCode <Int64?>]
: Error code for the setting[ErrorDescription <String>]
: Error description[InstanceDisplayName <String>]
: Name of setting instance that is being reported.[Setting <String>]
: The setting that is being reported[SettingInstanceId <String>]
: SettingInstanceId[SettingName <String>]
: Localized/user friendly setting name that is being reported[Sources <IMicrosoftGraphSettingSource-
[]>]
: Contributing policies[State <String>]
: complianceStatus[UserEmail <String>]
: UserEmail[UserId <String>]
: UserId[UserName <String>]
: UserName[UserPrincipalName <String>]
: UserPrincipalName.
[State <String>]
: complianceStatus[UserId <String>]
: User unique identifier, must be Guid[UserPrincipalName <String>]
: User Principal Name[Version <Int32?>]
: The version of the policy
[ManagedDeviceName <String>]
: Automatically generated name to identify a device. Can be overwritten to a user friendly name.[ManagedDeviceOwnerType <ManagedDeviceOwnerType?>]
: Owner type of device.[ManagementAgent <ManagementAgentType?>]
: Management agent type.[ManagementFeatures <ManagedDeviceManagementFeatures?>]
: Device management features.[ManagementState <ManagementState?>]
: Management state of device in Microsoft Intune.[Notes <String>]
: Notes on the device created by IT Admin. Default is null. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported.[OwnerType <OwnerType?>]
: Owner type of device.[PartnerReportedThreatState <ManagedDevicePartnerReportedHealthState?>]
: Available health states for the Device Health API[ProcessorArchitecture <ManagedDeviceArchitecture?>]
: Processor architecture[RoleScopeTagIds <String-
[]>]
: List of Scope Tag IDs for this Device instance.[SecurityBaselineStates <IMicrosoftGraphSecurityBaselineState-
[]>]
: Security baseline states for this device.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the security baseline[SecurityBaselineTemplateId <String>]
: The security baseline template id[SettingStates <IMicrosoftGraphSecurityBaselineSettingState-
[]>]
: The security baseline state for different settings for a device[Id <String>]
: The unique identifier for an entity. Read-only.[ContributingPolicies <IMicrosoftGraphSecurityBaselineContributingPolicy-
[]>]
: The policies that contribute to this setting instance[DisplayName <String>]
: Name of the policy[SourceId <String>]
: Unique identifier of the policy[SourceType <String>]
: Authoring source of a policy
[ErrorCode <String>]
: The error code if the setting is in error state[SettingCategoryId <String>]
: The setting category id which this setting belongs to[SettingCategoryName <String>]
: The setting category name which this setting belongs to[SettingId <String>]
: The setting id guid[SettingName <String>]
: The setting name that is being reported[SourcePolicies <IMicrosoftGraphSettingSource-
[]>]
: The policies that contribute to this setting instance[State <SecurityBaselineComplianceState?>]
: Security Baseline Compliance State
[State <SecurityBaselineComplianceState?>]
: Security Baseline Compliance State[UserPrincipalName <String>]
: User Principal Name
[SkuFamily <String>]
: Device sku family[Users <IMicrosoftGraphUser-
[]>]
: The primary users associated with the managed device.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).
- [DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled.
IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]
: The unique identifier for the SKU.
Corresponds to the skuId from subscribedSkus or companySubscription.
- [AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar.
If the user has never explicitly set a group for the calendar, this property is null.
- [CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar.
Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.
- [IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise.
The 'My organization' user determines the permissions other people within your organization have to the given calendar.
You can't remove 'My organization' as a recipient to a calendar.
- [Role <String>]
: calendarRoleType
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Navigation property.
Read-only.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false.
Optional.
Default is true.
- [Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event.
Navigation property.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentType <String>]
: The MIME type.
- [IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.
- [LastModifiedDateTime <DateTime?>]
: 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
- [Name <String>]
: The display name of the attachment.
This does not need to be the actual file name.
- [Size <Int32?>]
: The length of the attachment in bytes.
- [Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.
- [Type <String>]
: attendeeType
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
- [TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <IMicrosoftGraphResponseStatus>]
: responseStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Response <String>]
: responseType
- [Time <DateTime?>]
: The date and time that the response was returned.
It uses ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <String>]
: The content of the item.
- [ContentType <String>]
: bodyType
- [BodyPreview <String>]
: The preview of the message associated with the event.
It is in text format.
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master.
Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event.
Nullable.
- [HasAttachments <Boolean?>]
: Set to true if the event has attachments.
- [HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
Default is false.
- [ICalUId <String>]
: A unique identifier for an event across calendars.
This ID is different for each occurrence in a recurring series.
Read-only.
- [Importance <String>]
: importance
- [Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master.
This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified.
It doesn't include occurrences that have been canceled from the series.
Navigation property.
Read-only.
Nullable.
- [IsAllDay <Boolean?>]
: Set to true if the event lasts all day.
If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
- [IsCancelled <Boolean?>]
: Set to true if the event has been canceled.
- [IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
Set to false if all changes have been sent, or if the event is an appointment without any attendees.
- [IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
Default is false (onlineMeeting is null).
Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.
- [IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event).
This also applies if a delegate organized the event on behalf of the owner.
- [IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.
- [Location <IMicrosoftGraphLocation>]
: location
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [City <String>]
: The city.
- [CountryOrRegion <String>]
: The country or region.
It's a free-format string value, for example, 'United States'.
- [PostOfficeBox <String>]
: The post office box number.
- [PostalCode <String>]
: The postal code.
- [State <String>]
: The state.
- [Street <String>]
: The street.
- [Type <String>]
: physicalAddressType
- [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Accuracy <Double?>]
: The accuracy of the latitude and longitude.
As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
- [Altitude <Double?>]
: The altitude of the location.
- [AltitudeAccuracy <Double?>]
: The accuracy of the altitude.
- [Latitude <Double?>]
: The latitude of the location.
- [Longitude <Double?>]
: The longitude of the location.
- [DisplayName <String>]
: The name associated with the location.
- [LocationEmailAddress <String>]
: Optional email address of the location.
- [LocationType <String>]
: locationType
- [LocationUri <String>]
: Optional URI representing the location.
- [UniqueId <String>]
: For internal use only.
- [UniqueIdType <String>]
: locationUniqueIdType
- [Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from.
The location and locations properties always correspond with each other.
If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String-
[]>]
: A collection of property values.
- [OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series.
Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}.
The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled.
You can use this property to perform all operations supported by occurrences in the recurring series.
- [OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ConferenceId <String>]
: The ID of the conference.
- [JoinUrl <String>]
: The external link that launches the online meeting.
This is a URL that clients launch into a browser and will redirect the user to join the meeting.
- [Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.
- [Number <String>]
: The phone number.
- [Type <String>]
: phoneType
- [QuickDial <String>]
: The preformatted quick dial for this call.
- [TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.
- [TollNumber <String>]
: The toll number that can be used to join the conference.
- [OnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [OnlineMeetingUrl <String>]
: A URL for an online meeting.
The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype.
Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event.
The onlineMeetingUrl property will be deprecated in the future.
- [Organizer <IMicrosoftGraphRecipient>]
: recipient
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series.
This property isn't returned for events that are single instances.
Its date and time information is expressed in ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DayOfMonth <Int32?>]
: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
- [DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
- [FirstDayOfWeek <String>]
: dayOfWeek
- [Index <String>]
: weekIndex
- [Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
- [Month <Int32?>]
: The month in which the event occurs.
This is a number from 1 to 12.
- [Type <String>]
: recurrencePatternType
- [Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDate <DateTime?>]
: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
- [NumberOfOccurrences <Int32?>]
: The number of times to repeat the event.
Required and must be positive if type is numbered.
- [RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
- [StartDate <DateTime?>]
: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
- [Type <String>]
: recurrenceRangeType
- [ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.
- [ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.
- [ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus
- [Sensitivity <String>]
: sensitivity
- [SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.
- [ShowAs <String>]
: freeBusyStatus
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String>]
: A property value.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Subject <String>]
: The text of the event's subject line.
- [TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event.
This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request.
After you set transactionId when creating an event, you can't change transactionId in a subsequent update.
This property is only returned in a response payload if an app has set it.
Optional.
- [Type <String>]
: eventType
- [Uid <String>]
: A unique identifier for calendar events.
For recurring events, the value is the same for the series master and all of its occurrences including exceptions.
- [WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox.
Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
- [CanEdit <Boolean?>]
: 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.
- [CanShare <Boolean?>]
: 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.
- [CanViewPrivateItems <Boolean?>]
: 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.
- [ChangeKey <String>]
: 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.
- [Color <String>]
: calendarColor
- [DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar.
Navigation property.
Read-only.
- [HexColor <String>]
: 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.
- [IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.
- [IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.
- [IsShared <Boolean?>]
: 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.
- [IsSharedWithMe <Boolean?>]
: 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.
- [IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses.
Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar.
Read-only.
Nullable.
- [Name <String>]
: The calendar name.
- [Owner <IMicrosoftGraphEmailAddress>]
: emailAddress
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar.
Read-only.
Nullable.
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Create <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Delete <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Edit <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [EndDateTime <DateTime?>]
: When the interval ends.
Read-only.
- [IncompleteData <IMicrosoftGraphIncompleteData>]
: incompleteData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [MissingDataBeforeDateTime <DateTime?>]
: The service doesn't have source data before the specified time.
- [WasThrottled <Boolean?>]
: Some data wasn't recorded due to excessive activity.
- [IsTrending <Boolean?>]
: Indicates whether the item is 'trending.' Read-only.
- [Move <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [StartDateTime <DateTime?>]
: When the interval starts.
Read-only.
- [ItemActivityStats <IMicrosoftGraphItemActivityStat-
[]>]
:
- [LastSevenDays <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [Audio <IMicrosoftGraphAudio>]
: audio
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <String>]
: The title of the album for this audio file.
- [AlbumArtist <String>]
: The artist named on the album for the audio file.
- [Artist <String>]
: The performing artist for the audio file.
- [Bitrate <Int64?>]
: Bitrate expressed in kbps.
- [Composers <String>]
: The name of the composer of the audio file.
- [Copyright <String>]
: Copyright information for the audio file.
- [Disc <Int32?>]
: The number of the disc this audio file came from.
- [DiscCount <Int32?>]
: The total number of discs in this album.
- [Duration <Int64?>]
: Duration of the audio file, expressed in milliseconds
- [Genre <String>]
: The genre of this audio file.
- [HasDrm <Boolean?>]
: Indicates if the file is protected with digital rights management.
- [IsVariableBitrate <Boolean?>]
: Indicates if the file is encoded with a variable bitrate.
- [Title <String>]
: The title of the audio file.
- [Track <Int32?>]
: The number of the track on the original disc for this audio file.
- [TrackCount <Int32?>]
: The total number of tracks on the original disc for this audio file.
- [Year <Int32?>]
: The year the audio file was recorded.
- [Bundle <IMicrosoftGraphBundle>]
: bundle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <IMicrosoftGraphAlbum>]
: album
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CoverImageItemId <String>]
: Unique identifier of the driveItem that is the cover of the album.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [CTag <String>]
: An eTag for the content of the item.
This eTag isn't changed if only the metadata is changed.
Note This property isn't returned if the item is a folder.
Read-only.
- [Children <IMicrosoftGraphDriveItem-
[]>]
: Collection containing Item objects for the immediate children of Item.
Only items representing folders have children.
Read-only.
Nullable.
- [Content <Byte-
[]>]
: The content stream, if the item represents a file.
The content property will have a potentially breaking change in behavior in the future.
It will stream content directly instead of redirecting.
To proactively opt in to the new behavior ahead of time, use the contentStream property instead.
- [ContentStream <Byte-
[]>]
: The content stream, if the item represents a file.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [File <IMicrosoftGraphFile>]
: file
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Hashes <IMicrosoftGraphHashes>]
: hashes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Crc32Hash <String>]
: The CRC32 value of the file (if available).
Read-only.
- [QuickXorHash <String>]
: A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available).
Read-only.
- [Sha1Hash <String>]
: SHA1 hash for the contents of the file (if available).
Read-only.
- [Sha256Hash <String>]
: SHA256 hash for the contents of the file (if available).
Read-only.
- [MimeType <String>]
: 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.
- [ProcessingMetadata <Boolean?>]
:
- [FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: The UTC date and time the file was created on a client.
- [LastAccessedDateTime <DateTime?>]
: The UTC date and time the file was last accessed.
Available for the recent file list only.
- [LastModifiedDateTime <DateTime?>]
: The UTC date and time the file was last modified on a client.
- [Folder <IMicrosoftGraphFolder>]
: folder
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [View <IMicrosoftGraphFolderView>]
: folderView
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [SortBy <String>]
: The method by which the folder should be sorted.
- [SortOrder <String>]
: If true, indicates that items should be sorted in descending order.
Otherwise, items should be sorted ascending.
- [ViewType <String>]
: The type of view that should be used to represent the folder.
- [Image <IMicrosoftGraphImage>]
: image
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Height <Int32?>]
: Optional.
Height of the image, in pixels.
Read-only.
- [Width <Int32?>]
: Optional.
Width of the image, in pixels.
Read-only.
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
[WindowsProtectionState <IMicrosoftGraphWindowsProtectionState>]
: Device protection status entity.[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AntiMalwareVersion <String>]
: Current anti malware version[DetectedMalwareState <IMicrosoftGraphWindowsDeviceMalwareState-
[]>]
: Device malware list[Id <String>]
: The unique identifier for an entity. Read-only.[AdditionalInformationUrl <String>]
: Information URL to learn more about the malware[Category <WindowsMalwareCategory?>]
: Malware category id[DetectionCount <Int32?>]
: Number of times the malware is detected[DisplayName <String>]
: Malware name[ExecutionState <WindowsMalwareExecutionState?>]
: Malware execution status[InitialDetectionDateTime <DateTime?>]
: Initial detection datetime of the malware[LastStateChangeDateTime <DateTime?>]
: The last time this particular threat was changed[Severity <WindowsMalwareSeverity?>]
: Malware severity[State <WindowsMalwareState?>]
: Malware current status[ThreatState <WindowsMalwareThreatState?>]
: Malware threat status
[DeviceState <WindowsDeviceHealthState?>]
: Computer endpoint protection state[EngineVersion <String>]
: Current endpoint protection engine's version[FullScanOverdue <Boolean?>]
: When TRUE indicates full scan is overdue, when FALSE indicates full scan is not overdue. Defaults to setting on client device.[FullScanRequired <Boolean?>]
: When TRUE indicates full scan is required, when FALSE indicates full scan is not required. Defaults to setting on client device.[IsVirtualMachine <Boolean?>]
: 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.[LastFullScanDateTime <DateTime?>]
: Last quick scan datetime[LastFullScanSignatureVersion <String>]
: Last full scan signature version[LastQuickScanDateTime <DateTime?>]
: Last quick scan datetime[LastQuickScanSignatureVersion <String>]
: Last quick scan signature version[LastReportedDateTime <DateTime?>]
: Last device health status reported time[MalwareProtectionEnabled <Boolean?>]
: When TRUE indicates anti malware is enabled when FALSE indicates anti malware is not enabled.[NetworkInspectionSystemEnabled <Boolean?>]
: When TRUE indicates network inspection system enabled, when FALSE indicates network inspection system is not enabled. Defaults to setting on client device.[ProductStatus <WindowsDefenderProductStatus?>]
: Product Status of Windows Defender[QuickScanOverdue <Boolean?>]
: When TRUE indicates quick scan is overdue, when FALSE indicates quick scan is not overdue. Defaults to setting on client device.[RealTimeProtectionEnabled <Boolean?>]
: When TRUE indicates real time protection is enabled, when FALSE indicates real time protection is not enabled. Defaults to setting on client device.[RebootRequired <Boolean?>]
: When TRUE indicates reboot is required, when FALSE indicates when TRUE indicates reboot is not required. Defaults to setting on client device.[SignatureUpdateOverdue <Boolean?>]
: When TRUE indicates signature is out of date, when FALSE indicates signature is not out of date. Defaults to setting on client device.[SignatureVersion <String>]
: Current malware definitions version[TamperProtectionEnabled <Boolean?>]
: 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.
MANAGER <IMicrosoftGraphDirectoryObject>
: directoryObject
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
MEMBEROF <IMicrosoftGraphDirectoryObject- []
>: The groups, directory roles, and administrative units that the user is a member of.
Read-only.
Nullable.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
MESSAGES <IMicrosoftGraphMessage- []
>: The messages in a mailbox or folder.
Read-only.
Nullable.
[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The fileAttachment and itemAttachment attachments for the message.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[BccRecipients <IMicrosoftGraphRecipient-
[]>]
: The Bcc: recipients for the message.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: 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.[CcRecipients <IMicrosoftGraphRecipient-
[]>]
: The Cc: recipients for the message.[ConversationId <String>]
: The ID of the conversation the email belongs to.[ConversationIndex <Byte-
[]>]
: Indicates the position of the message within the conversation.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the message. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag[(Any) <Object>]
: This indicates any property can be added to this object.[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[FlagStatus <String>]
: followupFlagStatus[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[From <IMicrosoftGraphRecipient>]
: recipient[HasAttachments <Boolean?>]
: 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 .[Importance <String>]
: importance[InferenceClassification <String>]
: inferenceClassificationType[InternetMessageHeaders <IMicrosoftGraphInternetMessageHeader-
[]>]
: A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only.[Name <String>]
: Represents the key in a key-value pair.[Value <String>]
: The value in a key-value pair.
[InternetMessageId <String>]
: The message ID in the format specified by RFC5322. Updatable only if isDraft is true.[IsDeliveryReceiptRequested <Boolean?>]
: Indicates whether a read receipt is requested for the message.[IsDraft <Boolean?>]
: Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.[IsRead <Boolean?>]
: Indicates whether the message has been read.[IsReadReceiptRequested <Boolean?>]
: Indicates whether a read receipt is requested for the message.[Mentions <IMicrosoftGraphMention-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Application <String>]
: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.[ClientReference <String>]
: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.[CreatedBy <IMicrosoftGraphEmailAddress>]
: emailAddress[CreatedDateTime <DateTime?>]
: The date and time that the mention is created on the client.[DeepLink <String>]
: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.[MentionText <String>]
: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.[Mentioned <IMicrosoftGraphEmailAddress>]
: emailAddress[ServerCreatedDateTime <DateTime?>]
: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
[MentionsPreview <IMicrosoftGraphMentionsPreview>]
: mentionsPreview[(Any) <Object>]
: This indicates any property can be added to this object.[IsMentioned <Boolean?>]
: True if the signed-in user is mentioned in the parent resource instance. Read-only. Supports filter.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the message. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[ParentFolderId <String>]
: The unique identifier for the message's parent mailFolder.[ReceivedDateTime <DateTime?>]
: The date and time the message was received. 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.[ReplyTo <IMicrosoftGraphRecipient-
[]>]
: The email addresses to use when replying.[Sender <IMicrosoftGraphRecipient>]
: recipient[SentDateTime <DateTime?>]
: The date and time the message was sent. 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.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the message. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Subject <String>]
: The subject of the message.[ToRecipients <IMicrosoftGraphRecipient-
[]>]
: The To: recipients for the message.[UniqueBody <IMicrosoftGraphItemBody>]
: itemBody[UnsubscribeData <String-
[]>]
: The valid entries parsed from the List-Unsubscribe header. This is the data for the mail command in the List-Unsubscribe header if UnsubscribeEnabled property is true.[UnsubscribeEnabled <Boolean?>]
: Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369.[WebLink <String>]
: The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.
MOBILEAPPINTENTANDSTATES <IMicrosoftGraphMobileAppIntentAndState- []
>: The list of troubleshooting events for this user.
[Id <String>]
: The unique identifier for an entity. Read-only.[ManagedDeviceIdentifier <String>]
: Device identifier created or collected by Intune.[MobileAppList <IMicrosoftGraphMobileAppIntentAndStateDetail-
[]>]
: The list of payload intents and states for the tenant.[ApplicationId <String>]
: MobieApp identifier.[DisplayName <String>]
: The admin provided or imported title of the app.[DisplayVersion <String>]
: Human readable version of the application[InstallState <ResultantAppState?>]
: A list of possible states for application status on an individual device. When devices contact the Intune service and find targeted application enforcement intent, the status of the enforcement is recorded and becomes accessible in the Graph API. Since the application status is identified during device interaction with the Intune service, status records do not immediately appear upon application group assignment; it is created only after the assignment is evaluated in the service and devices start receiving the policy during check-ins.[MobileAppIntent <MobileAppIntent?>]
: Indicates the status of the mobile app on the device.[SupportedDeviceTypes <IMicrosoftGraphMobileAppSupportedDeviceType-
[]>]
: The supported platforms for the app.[MaximumOperatingSystemVersion <String>]
: Maximum OS version[MinimumOperatingSystemVersion <String>]
: Minimum OS version[Type <DeviceType?>]
: Device type.
[UserId <String>]
: Identifier for the user that tried to enroll the device.
MOBILEAPPTROUBLESHOOTINGEVENTS <IMicrosoftGraphMobileAppTroubleshootingEvent- []
>: The list of mobile app troubleshooting events for this user.
[AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event[Name <String>]
: Name for this key-value pair[Value <String>]
: Value for this key-value pair
[CorrelationId <String>]
: Id used for tracing the failure in the service.[EventDateTime <DateTime?>]
: Time when the event occurred .[EventName <String>]
: Event Name corresponding to the Troubleshooting Event. It is an Optional field[TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.[(Any) <Object>]
: This indicates any property can be added to this object.[Context <String>]
:[Failure <String>]
:[FailureDetails <String>]
: The detailed description of what went wrong.[Remediation <String>]
: The detailed description of how to remediate this issue.[Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.[Link <String>]
: The link to the web resource. Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}[Text <String>]
:
[Id <String>]
: The unique identifier for an entity. Read-only.[AppLogCollectionRequests <IMicrosoftGraphAppLogCollectionRequest-
[]>]
: The collection property of AppLogUploadRequest.[Id <String>]
: The unique identifier for an entity. Read-only.[CompletedDateTime <DateTime?>]
: Time at which the upload log request reached a completed state if not completed yet NULL will be returned.[CustomLogFolders <String-
[]>]
: List of log folders.[ErrorMessage <String>]
: Indicates error message if any during the upload process.[Status <AppLogUploadState?>]
: AppLogUploadStatus
[ApplicationId <String>]
: Intune application identifier.[DeviceId <String>]
: Device identifier created or collected by Intune.[History <IMicrosoftGraphMobileAppTroubleshootingHistoryItem-
[]>]
: Intune Mobile Application Troubleshooting History Item[OccurrenceDateTime <DateTime?>]
: Time when the history item occurred.[TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
[ManagedDeviceIdentifier <String>]
: Device identifier created or collected by Intune.[UserId <String>]
: Identifier for the user that tried to enroll the device.
NOTIFICATIONS <IMicrosoftGraphNotification- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayTimeToLive <Int32?>]
: Sets how long (in seconds) this notification content stays in each platform's notification viewer. For example, when the notification is delivered to a Windows device, the value of this property is passed on to ToastNotification.ExpirationTime, which determines how long the toast notification stays in the user's Windows Action Center.[ExpirationDateTime <DateTime?>]
: Sets a UTC expiration date and time on a user notification using ISO 8601 format (for example, midnight UTC on Jan 1, 2019 would look like this: '2019-01-01T00:00:00Z'). When time is up, the notification is removed from the Microsoft Graph notification feed store completely and is no longer part of notification history. Max value is 30 days.[GroupName <String>]
: The name of the group that this notification belongs to. It is set by the developer for grouping notifications together.[Payload <IMicrosoftGraphPayloadTypes>]
: payloadTypes[(Any) <Object>]
: This indicates any property can be added to this object.[RawContent <String>]
: 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.[VisualContent <IMicrosoftGraphVisualProperties>]
: visualProperties[(Any) <Object>]
: This indicates any property can be added to this object.[Body <String>]
: The body of a visual user notification. Body is optional.[Title <String>]
: The title of a visual user notification. This field is required for visual notification payloads.
[Priority <String>]
: priority[TargetHostName <String>]
: Represents the host name of the app to which the calling service wants to post the notification, for the given user. If targeting web endpoints (see targetPolicy.platformTypes), ensure that targetHostName is the same as the name used when creating a subscription on the client side within the application JSON property.[TargetPolicy <IMicrosoftGraphTargetPolicyEndpoints>]
: targetPolicyEndpoints[(Any) <Object>]
: This indicates any property can be added to this object.[PlatformTypes <String-
[]>]
: 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.
OAUTH2PERMISSIONGRANTS <IMicrosoftGraphOAuth2PermissionGrant- []
>: .
[Id <String>]
: The unique identifier for an entity. Read-only.[ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only).[ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only).[ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant. Required.[PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only).[ResourceId <String>]
: The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).[Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.[StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant. Required.
ONENOTE <IMicrosoftGraphOnenote>
: onenote
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Notebooks <IMicrosoftGraphNotebook-
[]>]
: The collection of OneNote notebooks that are owned by the user or group. Read-only. Nullable.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[DisplayName <String>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[IsDefault <Boolean?>]
: Indicates whether this is the user's default notebook. Read-only.[IsShared <Boolean?>]
: Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.[Links <IMicrosoftGraphNotebookLinks>]
: notebookLinks[(Any) <Object>]
: This indicates any property can be added to this object.[OneNoteClientUrl <IMicrosoftGraphExternalLink>]
: externalLink[(Any) <Object>]
: This indicates any property can be added to this object.[Href <String>]
: The URL of the link.
[OneNoteWebUrl <IMicrosoftGraphExternalLink>]
: externalLink
[SectionGroups <IMicrosoftGraphSectionGroup-
[]>]
: The section groups in the notebook. Read-only. Nullable.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DisplayName <String>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ParentNotebook <IMicrosoftGraphNotebook>]
: notebook[ParentSectionGroup <IMicrosoftGraphSectionGroup>]
: sectionGroup[SectionGroups <IMicrosoftGraphSectionGroup-
[]>]
: The section groups in the section. Read-only. Nullable.[SectionGroupsUrl <String>]
: The URL for the sectionGroups navigation property, which returns all the section groups in the section group. Read-only.[Sections <IMicrosoftGraphOnenoteSection-
[]>]
: The sections in the section group. Read-only. Nullable.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[DisplayName <String>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[IsDefault <Boolean?>]
: Indicates whether this is the user's default section. Read-only.[Links <IMicrosoftGraphSectionLinks>]
: sectionLinks[(Any) <Object>]
: This indicates any property can be added to this object.[OneNoteClientUrl <IMicrosoftGraphExternalLink>]
: externalLink[OneNoteWebUrl <IMicrosoftGraphExternalLink>]
: externalLink
[Pages <IMicrosoftGraphOnenotePage-
[]>]
: The collection of pages in the section. Read-only. Nullable.[CreatedDateTime <DateTime?>]
:[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
: The page's HTML content.[ContentUrl <String>]
: The URL for the page's HTML content. Read-only.[CreatedByAppId <String>]
: The unique identifier of the application that created the page. Read-only.[LastModifiedDateTime <DateTime?>]
: 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.[Level <Int32?>]
: The indentation level of the page. Read-only.[Links <IMicrosoftGraphPageLinks>]
: pageLinks[(Any) <Object>]
: This indicates any property can be added to this object.[OneNoteClientUrl <IMicrosoftGraphExternalLink>]
: externalLink[OneNoteWebUrl <IMicrosoftGraphExternalLink>]
: externalLink
[Order <Int32?>]
: The order of the page within its parent section. Read-only.[ParentNotebook <IMicrosoftGraphNotebook>]
: notebook[ParentSection <IMicrosoftGraphOnenoteSection>]
: onenoteSection[Title <String>]
: The title of the page.[UserTags <String-
[]>]
:
[PagesUrl <String>]
: The pages endpoint where you can get details for all the pages in the section. Read-only.[ParentNotebook <IMicrosoftGraphNotebook>]
: notebook[ParentSectionGroup <IMicrosoftGraphSectionGroup>]
: sectionGroup
[SectionsUrl <String>]
: The URL for the sections navigation property, which returns all the sections in the section group. Read-only.
[SectionGroupsUrl <String>]
: The URL for the sectionGroups navigation property, which returns all the section groups in the notebook. Read-only.[Sections <IMicrosoftGraphOnenoteSection-
[]>]
: The sections in the notebook. Read-only. Nullable.[SectionsUrl <String>]
: The URL for the sections navigation property, which returns all the sections in the notebook. Read-only.[UserRole <String>]
: onenoteUserRole
[Operations <IMicrosoftGraphOnenoteOperation-
[]>]
: 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.[CreatedDateTime <DateTime?>]
: The start time of the operation.[LastActionDateTime <DateTime?>]
: The time of the last action of the operation.[Status <String>]
: operationStatus[Id <String>]
: The unique identifier for an entity. Read-only.[Error <IMicrosoftGraphOnenoteOperationError>]
: onenoteOperationError[(Any) <Object>]
: This indicates any property can be added to this object.[Code <String>]
: The error code.[Message <String>]
: The error message.
[PercentComplete <String>]
: The operation percent complete if the operation is still in running status.[ResourceId <String>]
: The resource id.[ResourceLocation <String>]
: The resource URI for the object. For example, the resource URI for a copied page or section.
[Pages <IMicrosoftGraphOnenotePage-
[]>]
: The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.[Resources <IMicrosoftGraphOnenoteResource-
[]>]
: 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.[Self <String>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
: The content of the resource.[ContentUrl <String>]
: The URL for the content stream.
[SectionGroups <IMicrosoftGraphSectionGroup-
[]>]
: The section groups in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.[Sections <IMicrosoftGraphOnenoteSection-
[]>]
: The sections in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
ONLINEMEETINGS <IMicrosoftGraphOnlineMeeting- []
>: Information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
[AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.[AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.[AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.[AllowLiveShare <String>]
: meetingLiveShareOptions[AllowMeetingChat <String>]
: meetingChatMode[AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.[AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.[AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.[AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.[AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.[AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.[AllowedPresenters <String>]
: onlineMeetingPresenters[AnonymizeIdentityForRoles <String-
[]>]
: 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.[AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[AttendanceRecords <IMicrosoftGraphAttendanceRecord-
[]>]
: List of attendance records of an attendance report. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[AttendanceIntervals <IMicrosoftGraphAttendanceInterval-
[]>]
: List of time periods between joining and leaving a meeting.[DurationInSeconds <Int32?>]
: Duration of the meeting interval in seconds; that is, the difference between joinDateTime and leaveDateTime.[JoinDateTime <DateTime?>]
: The time the attendee joined in UTC.[LeaveDateTime <DateTime?>]
: The time the attendee left in UTC.
[EmailAddress <String>]
: Email address of the user associated with this attendance record.[Identity <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[RegistrantId <String>]
: Unique identifier of a meetingRegistrant. Presents when the participant has registered for the meeting. (deprecated)[Role <String>]
: Role of the attendee. Possible values are: None, Attendee, Presenter, and Organizer.[TotalAttendanceInSeconds <Int32?>]
: Total duration of the attendances in seconds.
[MeetingEndDateTime <DateTime?>]
: UTC time when the meeting ended. Read-only.[MeetingStartDateTime <DateTime?>]
: UTC time when the meeting started. Read-only.[TotalParticipantCount <Int32?>]
: Total number of participants. Read-only.
[AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The conference id of the online meeting.[DialinUrl <String>]
: A URL to the externally-accessible web page that contains dial-in information.[TollFreeNumber <String>]
: The toll-free number that connects to the Audio Conference Provider.[TollFreeNumbers <String-
[]>]
: List of toll-free numbers that are displayed in the meeting invite.[TollNumber <String>]
: The toll number that connects to the Audio Conference Provider.[TollNumbers <String-
[]>]
: List of toll numbers that are displayed in the meeting invite.
[ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo[(Any) <Object>]
: This indicates any property can be added to this object.[MessageId <String>]
: The unique identifier for a message in a Microsoft Teams channel.[ReplyChainMessageId <String>]
: The ID of the reply message.[ThreadId <String>]
: The unique identifier for a thread in Microsoft Teams.
[ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions[(Any) <Object>]
: This indicates any property can be added to this object.[AllowTextOnly <Boolean?>]
: Indicates whether only text is allowed in the meeting chat. Optional.
[IsEndToEndEncryptionEnabled <Boolean?>]
:[IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.[JoinInformation <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsPasscodeRequired <Boolean?>]
: Indicates whether a passcode is required to join a meeting when using joinMeetingId. Optional.[JoinMeetingId <String>]
: The meeting ID to be used to join a meeting. Optional. Read-only.[Passcode <String>]
: The passcode to join a meeting. Optional. Read-only.
[JoinWebUrl <String>]
: The join URL of the online meeting. Read-only.[LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsDialInBypassEnabled <Boolean?>]
: Specifies whether or not to always let dial-in callers bypass the lobby. Optional.[Scope <String>]
: lobbyBypassScope
[RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.[ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode[Subject <String>]
: The subject of the online meeting.[VideoTeleconferenceId <String>]
: The video teleconferencing ID. Read-only.[WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues[(Any) <Object>]
: This indicates any property can be added to this object.[IsEnabledForContentSharing <Boolean?>]
: Indicates whether to apply a watermark to any shared content.[IsEnabledForVideo <Boolean?>]
: Indicates whether to apply a watermark to everyone's video feed.
[Id <String>]
: The unique identifier for an entity. Read-only.[AiInsights <IMicrosoftGraphCallAiInsight-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[ActionItems <IMicrosoftGraphActionItem-
[]>]
:[OwnerDisplayName <String>]
:[Text <String>]
:[Title <String>]
:
[CallId <String>]
:[ContentCorrelationId <String>]
:[CreatedDateTime <DateTime?>]
:[EndDateTime <DateTime?>]
:[MeetingNotes <IMicrosoftGraphMeetingNote-
[]>]
:[Subpoints <IMicrosoftGraphMeetingNoteSubpoint-
[]>]
:[Text <String>]
:[Title <String>]
:
[Text <String>]
:[Title <String>]
:
[Viewpoint <IMicrosoftGraphCallAiInsightViewPoint>]
: callAiInsightViewPoint[(Any) <Object>]
: This indicates any property can be added to this object.[MentionEvents <IMicrosoftGraphMentionEvent-
[]>]
:[EventDateTime <DateTime?>]
:[Speaker <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[TranscriptUtterance <String>]
:
[AlternativeRecording <Byte-
[]>]
: The content stream of the alternative recording of a Microsoft Teams live event. Read-only.[AttendeeReport <Byte-
[]>]
: The content stream of the attendee report of a Teams live event. Read-only.[BroadcastRecording <Byte-
[]>]
:[BroadcastSettings <IMicrosoftGraphBroadcastMeetingSettings>]
: broadcastMeetingSettings[(Any) <Object>]
: This indicates any property can be added to this object.[AllowedAudience <String>]
: broadcastMeetingAudience[Captions <IMicrosoftGraphBroadcastMeetingCaptionSettings>]
: broadcastMeetingCaptionSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsCaptionEnabled <Boolean?>]
: Indicates whether captions are enabled for this Teams live event.[SpokenLanguage <String>]
: The spoken language.[TranslationLanguages <String-
[]>]
: The translation languages (choose up to 6).
[IsAttendeeReportEnabled <Boolean?>]
: Indicates whether attendee report is enabled for this Teams live event. Default value is false.[IsQuestionAndAnswerEnabled <Boolean?>]
: Indicates whether Q&A is enabled for this Teams live event. Default value is false.[IsRecordingEnabled <Boolean?>]
: Indicates whether recording is enabled for this Teams live event. Default value is false.[IsVideoOnDemandEnabled <Boolean?>]
: Indicates whether video on demand is enabled for this Teams live event. Default value is false.
[Capabilities <String-
[]>]
: The list of meeting capabilities. Possible values are: questionAndAnswer,unknownFutureValue.[CreationDateTime <DateTime?>]
: The meeting creation time in UTC. Read-only.[EndDateTime <DateTime?>]
: The meeting end time in UTC. Required when you create an online meeting.[ExternalId <String>]
: The external ID. A custom ID. Optional.[IsBroadcast <Boolean?>]
: Indicates whether this event is a Teams live event.[JoinUrl <String>]
:[MeetingAttendanceReport <IMicrosoftGraphMeetingAttendanceReport>]
: meetingAttendanceReport[MeetingTemplateId <String>]
: The ID of the meeting template.[Participants <IMicrosoftGraphMeetingParticipants>]
: meetingParticipants[(Any) <Object>]
: This indicates any property can be added to this object.[Attendees <IMicrosoftGraphMeetingParticipantInfo-
[]>]
: Information of the meeting attendees.[Identity <IMicrosoftGraphIdentitySet>]
: identitySet[Role <String>]
: onlineMeetingRole[Upn <String>]
: User principal name of the participant.
[Contributors <IMicrosoftGraphMeetingParticipantInfo-
[]>]
: For broadcast meeting only.[Organizer <IMicrosoftGraphMeetingParticipantInfo>]
: meetingParticipantInfo[Producers <IMicrosoftGraphMeetingParticipantInfo-
[]>]
: For broadcast meeting only.
[Recording <Byte-
[]>]
: The content stream of the recording of a Teams live event. Read-only.[Recordings <IMicrosoftGraphCallRecording-
[]>]
: The recordings of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[CallId <String>]
: The unique identifier for the call that is related to this recording. Read-only.[Content <Byte-
[]>]
: The content of the recording. Read-only.[ContentCorrelationId <String>]
: The unique identifier that links the transcript with its corresponding recording. Read-only.[CreatedDateTime <DateTime?>]
: 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.[EndDateTime <DateTime?>]
: Date and time at which the recording ends. 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.[MeetingId <String>]
: The unique identifier of the onlineMeeting related to this recording. Read-only.[MeetingOrganizer <IMicrosoftGraphIdentitySet>]
: identitySet[RecordingContentUrl <String>]
: The URL that can be used to access the content of the recording. Read-only.
[Registration <IMicrosoftGraphMeetingRegistration>]
: meetingRegistration[(Any) <Object>]
: This indicates any property can be added to this object.[AllowedRegistrant <String>]
: meetingAudience[Registrants <IMicrosoftGraphMeetingRegistrantBase-
[]>]
: Registrants of the online meeting.[Id <String>]
: The unique identifier for an entity. Read-only.[JoinWebUrl <String>]
: A unique web URL for the registrant to join the meeting. Read-only.
[Id <String>]
: The unique identifier for an entity. Read-only.[CustomQuestions <IMicrosoftGraphMeetingRegistrationQuestion-
[]>]
: Custom registration questions.[Id <String>]
: The unique identifier for an entity. Read-only.[AnswerInputType <String>]
: answerInputType[AnswerOptions <String-
[]>]
: Answer options when answerInputType is radioButton.[DisplayName <String>]
: Display name of the custom registration question.[IsRequired <Boolean?>]
: Indicates whether the question is required. Default value is false.
[Description <String>]
: The description of the meeting.[EndDateTime <DateTime?>]
: The meeting end time in UTC.[RegistrationPageViewCount <Int32?>]
: The number of times the registration page has been visited. Read-only.[RegistrationPageWebUrl <String>]
: The URL of the registration page. Read-only.[Speakers <IMicrosoftGraphMeetingSpeaker-
[]>]
: The meeting speaker's information.[Bio <String>]
: Bio of the speaker.[DisplayName <String>]
: Display name of the speaker.
[StartDateTime <DateTime?>]
: The meeting start time in UTC.[Subject <String>]
: The subject of the meeting.
[StartDateTime <DateTime?>]
: The meeting start time in UTC. Required when you create an online meeting.[Transcripts <IMicrosoftGraphCallTranscript-
[]>]
: The transcripts of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[CallId <String>]
: The unique identifier for the call that is related to this transcript. Read-only.[Content <Byte-
[]>]
: The content of the transcript. Read-only.[ContentCorrelationId <String>]
: The unique identifier that links the transcript with its corresponding recording. Read-only.[CreatedDateTime <DateTime?>]
: Date and time at which the transcript 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.[EndDateTime <DateTime?>]
: Date and time at which the transcription ends. 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.[MeetingId <String>]
: The unique identifier of the online meeting related to this transcript. Read-only.[MeetingOrganizer <IMicrosoftGraphIdentitySet>]
: identitySet[MetadataContent <Byte-
[]>]
: The time-aligned metadata of the utterances in the transcript. Read-only.[TranscriptContentUrl <String>]
: The URL that can be used to access the content of the transcript. Read-only.
ONPREMISESEXTENSIONATTRIBUTES <IMicrosoftGraphOnPremisesExtensionAttributes>
: onPremisesExtensionAttributes
[(Any) <Object>]
: This indicates any property can be added to this object.[ExtensionAttribute1 <String>]
: First customizable extension attribute.[ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.[ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.[ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.[ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.[ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.[ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.[ExtensionAttribute2 <String>]
: Second customizable extension attribute.[ExtensionAttribute3 <String>]
: Third customizable extension attribute.[ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.[ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.[ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.[ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.[ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.[ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
ONPREMISESPROVISIONINGERRORS <IMicrosoftGraphOnPremisesProvisioningError- []
>: Errors when using Microsoft synchronization product during provisioning.
Supports $filter (eq, not, ge, le).
[Category <String>]
: Category of the provisioning error. Note: Currently, there is only one possible value. Possible value: PropertyConflict - indicates a property value is not unique. Other objects contain the same value for the property.[OccurredDateTime <DateTime?>]
: The date and time at which the error occurred.[PropertyCausingError <String>]
: Name of the directory property causing the error. Current possible values: UserPrincipalName or ProxyAddress[Value <String>]
: Value of the property causing the error.
ONPREMISESSIPINFO <IMicrosoftGraphOnPremisesSipInfo>
: onPremisesSipInfo
[(Any) <Object>]
: This indicates any property can be added to this object.[IsSipEnabled <Boolean?>]
: Indicates whether the user is currently enabled for on-premises Skype for Business.[SipDeploymentLocation <String>]
: Indicates a fully qualified DNS name of the Microsoft Online Communications Server deployment.[SipPrimaryAddress <String>]
: Serves as a unique identifier for each user on the on-premises Skype for Business.
OUTLOOK <IMicrosoftGraphOutlookUser>
: outlookUser
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[MasterCategories <IMicrosoftGraphOutlookCategory-
[]>]
: A list of categories defined for the user.[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: categoryColor[DisplayName <String>]
: A unique name that identifies a category in the user's mailbox. After a category is created, the name can't be changed. Read-only.
[TaskFolders <IMicrosoftGraphOutlookTaskFolder-
[]>]
: The user's Outlook task folders. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ChangeKey <String>]
: The version of the task folder.[IsDefaultFolder <Boolean?>]
: True if the folder is the default task folder.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the task folder. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[Name <String>]
: The name of the task folder.[ParentGroupKey <String>]
: The unique GUID identifier for the task folder's parent group.[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the task folder. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Tasks <IMicrosoftGraphOutlookTask-
[]>]
: The tasks in this task folder. Read-only. Nullable.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedTo <String>]
: The name of the person who has been assigned the task in Outlook. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the task. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[HasAttachments <Boolean?>]
: Set to true if the task has attachments.[Importance <String>]
: importance[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the task.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the task. Read-only. Nullable.[Owner <String>]
: The name of the person who created the task.[ParentFolderId <String>]
: The unique identifier for the task's parent folder.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Sensitivity <String>]
: sensitivity[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the task. Read-only. Nullable.[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: taskStatus[Subject <String>]
: A brief description or title of the task.
[TaskGroups <IMicrosoftGraphOutlookTaskGroup-
[]>]
: The user's Outlook task groups. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ChangeKey <String>]
: The version of the task group.[GroupKey <String>]
: The unique GUID identifier for the task group.[IsDefaultGroup <Boolean?>]
: True if the task group is the default task group.[Name <String>]
: The name of the task group.[TaskFolders <IMicrosoftGraphOutlookTaskFolder-
[]>]
: The collection of task folders in the task group. Read-only. Nullable.
[Tasks <IMicrosoftGraphOutlookTask-
[]>]
: The user's Outlook tasks. Read-only. Nullable.
OWNEDDEVICES <IMicrosoftGraphDirectoryObject- []
>: Devices owned by the user.
Read-only.
Nullable.
Supports $expand.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
OWNEDOBJECTS <IMicrosoftGraphDirectoryObject- []
>: 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).
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
PASSWORDPROFILE <IMicrosoftGraphPasswordProfile>
: passwordProfile
[(Any) <Object>]
: This indicates any property can be added to this object.[ForceChangePasswordNextSignIn <Boolean?>]
: true if the user must change their password on the next sign-in; otherwise false. If not set, default is false.[ForceChangePasswordNextSignInWithMfa <Boolean?>]
: If true, at next sign-in, the user must perform a multifactor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multifactor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false.[Password <String>]
: The password for the user. This property is required when a user is created. It can be updated, but the user will be required to change the password on the next sign-in. The password must satisfy minimum requirements as specified by the user's passwordPolicies property. By default, a strong password is required.
PENDINGACCESSREVIEWINSTANCES <IMicrosoftGraphAccessReviewInstance- []
>: Navigation property to get a list of access reviews pending approval by the reviewer.
[Id <String>]
: The unique identifier for an entity. Read-only.[ContactedReviewers <IMicrosoftGraphAccessReviewReviewer-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: The date when the reviewer was added for the access review.[DisplayName <String>]
: Name of reviewer.[UserPrincipalName <String>]
: User principal name of the user.
[Decisions <IMicrosoftGraphAccessReviewInstanceDecisionItem-
[]>]
: Each user reviewed in an accessReviewInstance has a decision item representing if they were approved, denied, or not yet reviewed.[Id <String>]
: The unique identifier for an entity. Read-only.[AccessReviewId <String>]
: The identifier of the accessReviewInstance parent. Supports $select. Read-only.[AppliedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[IPAddress <String>]
: Indicates the client IP address associated with the user performing the activity (audit log only).[UserPrincipalName <String>]
: The userPrincipalName attribute of the user.
[AppliedDateTime <DateTime?>]
: 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.[ApplyResult <String>]
: The result of applying the decision. Possible values: New, AppliedSuccessfully, AppliedWithUnknownFailure, AppliedSuccessfullyButObjectNotFound, and ApplyNotSupported. Supports $select, $orderby, and $filter (eq only). Read-only.[Decision <String>]
: Result of the review. Possible values: Approve, Deny, NotReviewed, or DontKnow. Supports $select, $orderby, and $filter (eq only).[Insights <IMicrosoftGraphGovernanceInsight-
[]>]
: Insights are recommendations to reviewers on whether to approve or deny a decision. There can be multiple insights associated with an accessReviewInstanceDecisionItem.[Id <String>]
: The unique identifier for an entity. Read-only.[InsightCreatedDateTime <DateTime?>]
: Indicates when the insight was created.
[Instance <IMicrosoftGraphAccessReviewInstance>]
: accessReviewInstance[Justification <String>]
: Justification left by the reviewer when they made the decision.[Principal <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[PrincipalLink <String>]
: Link to the principal object. For example: https://graph.microsoft.com/v1.0/users/a6c7aecb-cbfd-4763-87ef-e91b4bd509d9. Read-only.[PrincipalResourceMembership <IMicrosoftGraphDecisionItemPrincipalResourceMembership>]
: decisionItemPrincipalResourceMembership[(Any) <Object>]
: This indicates any property can be added to this object.[MembershipType <String>]
: decisionItemPrincipalResourceMembershipType
[Recommendation <String>]
: A system-generated recommendation for the approval decision based off last interactive sign-in to tenant. Recommend approve if sign-in is within 30 days of start of review. Recommend deny if sign-in is greater than 30 days of start of review. Recommendation not available otherwise. Possible values: Approve, Deny, or NoInfoAvailable. Supports $select, $orderby, and $filter (eq only). Read-only.[Resource <IMicrosoftGraphAccessReviewInstanceDecisionItemResource>]
: accessReviewInstanceDecisionItemResource[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: Display name of the resource[Id <String>]
: Resource ID[Type <String>]
: Type of resource. Types include: Group, ServicePrincipal, DirectoryRole, AzureRole, AccessPackageAssignmentPolicy.
[ResourceLink <String>]
: A link to the resource. For example, https://graph.microsoft.com/v1.0/servicePrincipals/c86300f3-8695-4320-9f6e-32a2555f5ff8. Supports $select. Read-only.[ReviewedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[ReviewedDateTime <DateTime?>]
: The timestamp when the review decision occurred. Supports $select. Read-only.[Target <IMicrosoftGraphAccessReviewInstanceDecisionItemTarget>]
: accessReviewInstanceDecisionItemTarget[(Any) <Object>]
: This indicates any property can be added to this object.
[Definition <IMicrosoftGraphAccessReviewScheduleDefinition>]
: accessReviewScheduleDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AdditionalNotificationRecipients <IMicrosoftGraphAccessReviewNotificationRecipientItem-
[]>]
: Defines the list of additional users or group members to be notified of the access review progress.[NotificationRecipientScope <IMicrosoftGraphAccessReviewNotificationRecipientScope>]
: accessReviewNotificationRecipientScope[(Any) <Object>]
: This indicates any property can be added to this object.
[NotificationTemplateType <String>]
: Indicates the type of access review email to be sent. Supported template type is CompletedAdditionalRecipients which sends review completion notifications to the recipients.
[BackupReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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. Note: This property has been replaced by fallbackReviewers. However, specifying either backupReviewers or fallbackReviewers automatically populates the same values to the other property.[Query <String>]
: The query specifying who will be the reviewer.[QueryRoot <String>]
: 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.[QueryType <String>]
: The type of query. Examples include MicrosoftGraph and ARM.
[CreatedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[CreatedDateTime <DateTime?>]
: Timestamp when the access review series was created. Supports $select. Read-only.[DescriptionForAdmins <String>]
: Description provided by review creators to provide more context of the review to admins. Supports $select.[DescriptionForReviewers <String>]
: 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.[DisplayName <String>]
: Name of the access review series. Supports $select and $orderby. Required on create.[FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewScope>]
: accessReviewScope[(Any) <Object>]
: This indicates any property can be added to this object.
[Instances <IMicrosoftGraphAccessReviewInstance-
[]>]
: 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.[LastModifiedDateTime <DateTime?>]
: Timestamp when the access review series was last modified. Supports $select. Read-only.[Reviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewScope>]
: accessReviewScope[Settings <IMicrosoftGraphAccessReviewScheduleSettings>]
: accessReviewScheduleSettings[(Any) <Object>]
: This indicates any property can be added to this object.[ApplyActions <IMicrosoftGraphAccessReviewApplyAction-
[]>]
: Optional field. Describes the actions to take once a review is complete. There are two types that are currently supported: removeAccessApplyAction (default) and disableAndDeleteUserApplyAction. Field only needs to be specified in the case of disableAndDeleteUserApplyAction.[AutoApplyDecisionsEnabled <Boolean?>]
: Indicates whether decisions are automatically applied. When set to false, an admin must apply the decisions manually once the reviewer completes the access review. When set to true, decisions are applied automatically after the access review instance duration ends, whether or not the reviewers have responded. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.[DecisionHistoriesForReviewersEnabled <Boolean?>]
: Indicates whether decisions on previous access review stages are available for reviewers on an accessReviewInstance with multiple subsequent stages. If not provided, the default is disabled (false).[DefaultDecision <String>]
: Decision chosen if defaultDecisionEnabled is enabled. Can be one of Approve, Deny, or Recommendation.[DefaultDecisionEnabled <Boolean?>]
: Indicates whether the default decision is enabled or disabled when reviewers do not respond. Default value is false. CAUTION: If both autoApplyDecisionsEnabled and defaultDecisionEnabled are true, all access for the principals to the resource risks being revoked if the reviewers fail to respond.[InstanceDurationInDays <Int32?>]
: Duration of each recurrence of review (accessReviewInstance) in number of days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its durationInDays setting will be used instead of the value of this property.[JustificationRequiredOnApproval <Boolean?>]
: Indicates whether reviewers are required to provide justification with their decision. Default value is false.[MailNotificationsEnabled <Boolean?>]
: Indicates whether emails are enabled or disabled. Default value is false.[RecommendationInsightSettings <IMicrosoftGraphAccessReviewRecommendationInsightSetting-
[]>]
: Optional. Describes the types of insights that aid reviewers to make access review decisions. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationInsightSettings setting will be used instead of the value of this property.[RecommendationLookBackDuration <TimeSpan?>]
: Optional field. Indicates the period of inactivity (with respect to the start date of the review instance) that recommendations will be configured from. The recommendation will be to deny if the user is inactive during the look-back duration. For reviews of groups and Microsoft Entra roles, any duration is accepted. For reviews of applications, 30 days is the maximum duration. If not specified, the duration is 30 days. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationLookBackDuration setting will be used instead of the value of this property.[RecommendationsEnabled <Boolean?>]
: Indicates whether decision recommendations are enabled or disabled. NOTE: If the stageSettings of the accessReviewScheduleDefinition object is defined, its recommendationsEnabled setting will be used instead of the value of this property.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderNotificationsEnabled <Boolean?>]
: Indicates whether reminders are enabled or disabled. Default value is false.
[StageSettings <IMicrosoftGraphAccessReviewStageSettings-
[]>]
: 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.[DecisionsThatWillMoveToNextStage <String-
[]>]
: Indicate which decisions will go to the next stage. Can be a subset of Approve, Deny, Recommendation, or NotReviewed. If not provided, all decisions will go to the next stage. Optional.[DependsOn <String-
[]>]
: Defines the sequential or parallel order of the stages and depends on the stageId. Only sequential stages are currently supported. For example, if stageId is 2, then dependsOn must be 1. If stageId is 1, don't specify dependsOn. Required if stageId isn't 1.[DurationInDays <Int32?>]
: The duration of the stage. Required. NOTE: The cumulative value of this property across all stages 1. Will override the instanceDurationInDays setting on the accessReviewScheduleDefinition object.
Can't exceed the length of one recurrence.
That is, if the review recurs weekly, the cumulative durationInDays can't exceed 7.
- [FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: If provided, the fallback reviewers are asked to complete a review if the primary reviewers don't exist.
For example, if managers are selected as reviewers and a principal under review doesn't have a manager in Microsoft Entra ID, the fallback reviewers are asked to review that principal.
NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.
- [RecommendationInsightSettings <IMicrosoftGraphAccessReviewRecommendationInsightSetting-
[]>]
:
- [RecommendationLookBackDuration <TimeSpan?>]
: Optional field.
Indicates the time period of inactivity (with respect to the start date of the review instance) from which that recommendations will be configured.
The recommendation is to deny if the user is inactive during the look back duration.
For reviews of groups and Microsoft Entra roles, any duration is accepted.
For reviews of applications, 30 days is the maximum duration.
If not specified, the duration is 30 days.
NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.
- [RecommendationsEnabled <Boolean?>]
: Indicates whether showing recommendations to reviewers is enabled.
Required.
NOTE: The value of this property overrides the corresponding setting on the accessReviewScheduleDefinition object.
- [Reviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: Defines who the reviewers are.
If none is specified, the review is a self-review (users review their own access).
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 overrides the corresponding setting on the accessReviewScheduleDefinition.
- [StageId <String>]
: Unique identifier of the accessReviewStageSettings.
The stageId is used in dependsOn property to indicate the stage relationship.
Required.
- [Status <String>]
: 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.
[EndDateTime <DateTime?>]
: 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.[Errors <IMicrosoftGraphAccessReviewError-
[]>]
: Collection of errors in an access review instance lifecycle. Read-only.[Code <String>]
: The error code.[Message <String>]
: The error message.
[FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewScope>]
: accessReviewScope[Stages <IMicrosoftGraphAccessReviewStage-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Decisions <IMicrosoftGraphAccessReviewInstanceDecisionItem-
[]>]
: Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.[EndDateTime <DateTime?>]
: 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.[FallbackReviewers <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <IMicrosoftGraphAccessReviewReviewerScope-
[]>]
: 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 <DateTime?>]
: 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.[Status <String>]
: 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.
[StartDateTime <DateTime?>]
: 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.[Status <String>]
: 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.
PEOPLE <IMicrosoftGraphPerson- []
>: 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.
[Id <String>]
: The unique identifier for an entity. Read-only.[Birthday <String>]
: The person's birthday.[CompanyName <String>]
: The name of the person's company.[Department <String>]
: The person's department.[DisplayName <String>]
: The person's display name.[EmailAddresses <IMicrosoftGraphRankedEmailAddress-
[]>]
: The person's email addresses.[Address <String>]
: The email address.[Rank <Double?>]
: 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.
[GivenName <String>]
: The person's given name.[IsFavorite <Boolean?>]
: True if the user has flagged this person as a favorite.[MailboxType <String>]
: The type of mailbox that is represented by the person's email address.[OfficeLocation <String>]
: The location of the person's office.[PersonNotes <String>]
: Free-form notes that the user has taken about this person.[PersonType <String>]
: The type of person, for example distribution list.[Phones <IMicrosoftGraphPhone-
[]>]
: The person's phone numbers.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[PostalAddresses <IMicrosoftGraphLocation-
[]>]
: The person's addresses.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Profession <String>]
: The person's profession.[Sources <IMicrosoftGraphPersonDataSource-
[]>]
: The sources the user data comes from, for example Directory or Outlook Contacts.[Type <String>]
: The type of data source.
[Surname <String>]
: The person's surname.[Title <String>]
: The person's title.[UserPrincipalName <String>]
: 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.[Websites <IMicrosoftGraphWebsite-
[]>]
: The person's websites.[Address <String>]
: The URL of the website.[DisplayName <String>]
: The display name of the web site.[Type <String>]
: websiteType
[YomiCompany <String>]
: The phonetic Japanese name of the person's company.
PERMISSIONGRANTS <IMicrosoftGraphResourceSpecificPermissionGrant- []
>: List all resource-specific permission grants of a user.
[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access. Read-only.[ClientId <String>]
: ID of the Microsoft Entra app that has been granted access. Read-only.[Permission <String>]
: The name of the resource-specific permission. Read-only.[PermissionType <String>]
: The type of permission. Possible values are: Application, Delegated. Read-only.[ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource. Read-only.
PHOTO <IMicrosoftGraphProfilePhoto>
: profilePhoto
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Height <Int32?>]
: The height of the photo. Read-only.[Width <Int32?>]
: The width of the photo. Read-only.
PHOTOS <IMicrosoftGraphProfilePhoto- []
>: The collection of the user's profile photos in different sizes.
Read-only.
[Id <String>]
: The unique identifier for an entity. Read-only.[Height <Int32?>]
: The height of the photo. Read-only.[Width <Int32?>]
: The width of the photo. Read-only.
PLANNER <IMicrosoftGraphPlannerUser>
: plannerUser
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[All <IMicrosoftGraphPlannerDelta-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.
[FavoritePlanReferences <IMicrosoftGraphPlannerFavoritePlanReferenceCollection>]
: plannerFavoritePlanReferenceCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[FavoritePlans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans that the user marked as favorites.[Id <String>]
: The unique identifier for an entity. Read-only.[ArchivalInfo <IMicrosoftGraphPlannerArchivalInfo>]
: plannerArchivalInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Justification <String>]
: Read-only. Reason why the entity was archived or unarchived.[StatusChangedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[StatusChangedDateTime <DateTime?>]
: Read-only. Date and time at which the entity's archive status changed.
[Buckets <IMicrosoftGraphPlannerBucket-
[]>]
: Collection of buckets in the plan. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ArchivalInfo <IMicrosoftGraphPlannerArchivalInfo>]
: plannerArchivalInfo[CreationSource <IMicrosoftGraphPlannerBucketCreation>]
: plannerBucketCreation[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind
[IsArchived <Boolean?>]
: Read-only. If set totrue, the bucket is archived. An archived bucket is read-only.[Name <String>]
: Name of the bucket.[OrderHint <String>]
: Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.[PlanId <String>]
: Plan ID to which the bucket belongs.[Tasks <IMicrosoftGraphPlannerTask-
[]>]
: Read-only. Nullable. The collection of tasks in the bucket.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveChecklistItemCount <Int32?>]
: The number of checklist items with value set to false, representing incomplete items.[AppliedCategories <IMicrosoftGraphPlannerAppliedCategories>]
: plannerAppliedCategories[(Any) <Object>]
: This indicates any property can be added to this object.
[ArchivalInfo <IMicrosoftGraphPlannerArchivalInfo>]
: plannerArchivalInfo[AssignedToTaskBoardFormat <IMicrosoftGraphPlannerAssignedToTaskBoardTaskFormat>]
: plannerAssignedToTaskBoardTaskFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[OrderHintsByAssignee <IMicrosoftGraphPlannerOrderHintsByAssignee>]
: plannerOrderHintsByAssignee[(Any) <Object>]
: This indicates any property can be added to this object.
[UnassignedOrderHint <String>]
: Hint value used to order the task on the AssignedTo view of the Task Board when the task isn't assigned to anyone, or if the orderHintsByAssignee dictionary doesn't provide an order hint for the user the task is assigned to. The format is defined as outlined here.
[AssigneePriority <String>]
: A hint that is used to order items of this type in a list view. For more information, see Using order hints in planner.[Assignments <IMicrosoftGraphPlannerAssignments>]
: plannerAssignments[(Any) <Object>]
: This indicates any property can be added to this object.
[BucketId <String>]
: Bucket ID to which the task belongs. The bucket needs to be in the same plan as the task. The value of the bucketId property is 28 characters long and case-sensitive. Format validation is done on the service.[BucketTaskBoardFormat <IMicrosoftGraphPlannerBucketTaskBoardTaskFormat>]
: plannerBucketTaskBoardTaskFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[OrderHint <String>]
: Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.
[ChecklistItemCount <Int32?>]
: The number of checklist items that are present on the task.[CompletedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CompletedDateTime <DateTime?>]
: Read-only. The 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[ConversationThreadId <String>]
: The thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Read-only. The 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[CreationSource <IMicrosoftGraphPlannerTaskCreation>]
: plannerTaskCreation[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind[TeamsPublicationInfo <IMicrosoftGraphPlannerTeamsPublicationInfo>]
: plannerTeamsPublicationInfo[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind[TeamsPublicationInfo <IMicrosoftGraphPlannerTeamsPublicationInfo>]
: plannerTeamsPublicationInfo[LastModifiedDateTime <DateTime?>]
: The date and time when this task was last modified by the publication process. Read-only.[PublicationId <String>]
: The identifier of the publication. Read-only.[PublishedToPlanId <String>]
: The identifier of the plannerPlan this task was originally placed in. Read-only.[PublishingTeamId <String>]
: The identifier of the team that initiated the publication process. Read-only.[PublishingTeamName <String>]
: The display name of the team that initiated the publication process. This display name is for reference only, and might not represent the most up-to-date name of the team. Read-only.
[Details <IMicrosoftGraphPlannerTaskDetails>]
: plannerTaskDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ApprovalAttachment <IMicrosoftGraphPlannerBaseApprovalAttachment>]
: plannerBaseApprovalAttachment[(Any) <Object>]
: This indicates any property can be added to this object.[Status <String>]
: plannerApprovalStatus
[Checklist <IMicrosoftGraphPlannerChecklistItems>]
: plannerChecklistItems[(Any) <Object>]
: This indicates any property can be added to this object.
[CompletionRequirements <IMicrosoftGraphPlannerTaskCompletionRequirementDetails>]
: plannerTaskCompletionRequirementDetails[(Any) <Object>]
: This indicates any property can be added to this object.[ApprovalRequirement <IMicrosoftGraphPlannerApprovalRequirement>]
: plannerApprovalRequirement[(Any) <Object>]
: This indicates any property can be added to this object.[IsApprovalRequired <Boolean?>]
: Specifies whether approval is required to complete the plannerTask. When this property is set to true, the task can only be marked complete if an approval is created for the task and approved.
[ChecklistRequirement <IMicrosoftGraphPlannerChecklistRequirement>]
: plannerChecklistRequirement[(Any) <Object>]
: This indicates any property can be added to this object.[RequiredChecklistItemIds <String-
[]>]
: A collection of required plannerChecklistItems identifiers to complete the plannerTask.
[FormsRequirement <IMicrosoftGraphPlannerFormsRequirement>]
: plannerFormsRequirement[(Any) <Object>]
: This indicates any property can be added to this object.[RequiredForms <String-
[]>]
: Read-only. A collection of keys from the plannerFormsDictionary that identify the plannerFormReference objects that specify the requirements to complete the plannerTask.
[Description <String>]
: Description of the task.[Forms <IMicrosoftGraphPlannerFormsDictionary>]
: plannerFormsDictionary[(Any) <Object>]
: This indicates any property can be added to this object.
[Notes <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[PreviewType <String>]
: plannerPreviewType[References <IMicrosoftGraphPlannerExternalReferences>]
: plannerExternalReferences[(Any) <Object>]
: This indicates any property can be added to this object.
[DueDateTime <DateTime?>]
: The 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[HasDescription <Boolean?>]
: Read-only. This value is true if the details object of the task has a nonempty description. Otherwise,false.[IsArchived <Boolean?>]
: Read-only. If set to true, the task is archived. An archived task is read-only.[IsOnMyDay <Boolean?>]
: Indicates whether to show this task in the MyDay view. If true, it shows the task.[IsOnMyDayLastModifiedDate <DateTime?>]
: Read-only. The date on which task is added to or removed from MyDay.[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
:[OrderHint <String>]
: The hint used to order items of this type in a list view. For more information, see Using order hints in plannern.[PercentComplete <Int32?>]
: The percentage of task completion. When set to 100, the task is completed.[PlanId <String>]
: Plan ID to which the task belongs.[PreviewType <String>]
: plannerPreviewType[Priority <Int32?>]
: The priority of the task. Valid values are between 0 and 10, inclusive. Larger values indicate lower priority. For example, 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'.[ProgressTaskBoardFormat <IMicrosoftGraphPlannerProgressTaskBoardTaskFormat>]
: plannerProgressTaskBoardTaskFormat[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[OrderHint <String>]
: Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.
[Recurrence <IMicrosoftGraphPlannerTaskRecurrence>]
: plannerTaskRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[NextInSeriesTaskId <String>]
: The taskId of the next task in this series. This value is assigned at the time the next task in the series is created, and is null prior to that time.[OccurrenceId <Int32?>]
: The 1-based index of this task within the recurrence series. The first task in a series has the value 1, the next task in the series has the value 2, and so on.[PreviousInSeriesTaskId <String>]
: The taskId of the previous task in this series. null for the first task in a series since it has no predecessor. All subsequent tasks in the series have a value that corresponds to their predecessors.[RecurrenceStartDateTime <DateTime?>]
: The date and time when this recurrence series begin. For the first task in a series (occurrenceId = 1) this value is copied from schedule.patternStartDateTime. For subsequent tasks in the series (occurrenceId >= 2) this value is copied from the previous task and never changes; it preserves the start date of the recurring series. 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.[Schedule <IMicrosoftGraphPlannerRecurrenceSchedule>]
: plannerRecurrenceSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[NextOccurrenceDateTime <DateTime?>]
: The next date for this schedule. When a new task is instantiated to continue the recurrence series, this date is used for the dueDateTime of the new plannerTask. Auto-generated by the service. 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.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[PatternStartDateTime <DateTime?>]
: The start date for the recurrence pattern. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Required.
[SeriesId <String>]
: The recurrence series this task belongs to. A GUID-based value that serves as the unique identifier for a series.
[ReferenceCount <Int32?>]
: Number of external references that exist on the task.[SpecifiedCompletionRequirements <String>]
: plannerTaskCompletionRequirements[StartDateTime <DateTime?>]
: 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[Title <String>]
: Title of the task.
[Container <IMicrosoftGraphPlannerPlanContainer>]
: plannerPlanContainer[(Any) <Object>]
: This indicates any property can be added to this object.[ContainerId <String>]
: The identifier of the resource that contains the plan. Optional.[Type <String>]
: plannerContainerType[Url <String>]
: The full canonical URL of the container. Optional.
[Contexts <IMicrosoftGraphPlannerPlanContextCollection>]
: plannerPlanContextCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: 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[CreationSource <IMicrosoftGraphPlannerPlanCreation>]
: plannerPlanCreation[(Any) <Object>]
: This indicates any property can be added to this object.[CreationSourceKind <String>]
: plannerCreationSourceKind
[Details <IMicrosoftGraphPlannerPlanDetails>]
: plannerPlanDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CategoryDescriptions <IMicrosoftGraphPlannerCategoryDescriptions>]
: plannerCategoryDescriptions[(Any) <Object>]
: This indicates any property can be added to this object.[Category1 <String>]
: The label associated with Category 1[Category10 <String>]
: The label associated with Category 10[Category11 <String>]
: The label associated with Category 11[Category12 <String>]
: The label associated with Category 12[Category13 <String>]
: The label associated with Category 13[Category14 <String>]
: The label associated with Category 14[Category15 <String>]
: The label associated with Category 15[Category16 <String>]
: The label associated with Category 16[Category17 <String>]
: The label associated with Category 17[Category18 <String>]
: The label associated with Category 18[Category19 <String>]
: The label associated with Category 19[Category2 <String>]
: The label associated with Category 2[Category20 <String>]
: The label associated with Category 20[Category21 <String>]
: The label associated with Category 21[Category22 <String>]
: The label associated with Category 22[Category23 <String>]
: The label associated with Category 23[Category24 <String>]
: The label associated with Category 24[Category25 <String>]
: The label associated with Category 25[Category3 <String>]
: The label associated with Category 3[Category4 <String>]
: The label associated with Category 4[Category5 <String>]
: The label associated with Category 5[Category6 <String>]
: The label associated with Category 6[Category7 <String>]
: The label associated with Category 7[Category8 <String>]
: The label associated with Category 8[Category9 <String>]
: The label associated with Category 9
[ContextDetails <IMicrosoftGraphPlannerPlanContextDetailsCollection>]
: plannerPlanContextDetailsCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[SharedWith <IMicrosoftGraphPlannerUserIds>]
: plannerUserIds[(Any) <Object>]
: This indicates any property can be added to this object.
[IsArchived <Boolean?>]
: Read-only. If set to true, the plan is archived. An archived plan is read-only.[Owner <String>]
: Use the container property instead. ID of the group that owns the plan. After it's set, this property can't be updated. This property doesn't return a valid group ID if the container of the plan isn't a group.[SharedWithContainers <IMicrosoftGraphPlannerSharedWithContainer-
[]>]
: List of containers the plan is shared with.[ContainerId <String>]
: The identifier of the resource that contains the plan. Optional.[Type <String>]
: plannerContainerType[Url <String>]
: The full canonical URL of the container. Optional.[AccessLevel <String>]
: plannerPlanAccessLevel
[Tasks <IMicrosoftGraphPlannerTask-
[]>]
: Collection of tasks in the plan. Read-only. Nullable.[Title <String>]
: Required. Title of the plan.
[MyDayTasks <IMicrosoftGraphPlannerTask-
[]>]
: Read-only. Nullable. Returns the plannerTasks to be shown in the My Day view of the user.[Plans <IMicrosoftGraphPlannerPlan-
[]>]
:[RecentPlanReferences <IMicrosoftGraphPlannerRecentPlanReferenceCollection>]
: plannerRecentPlanReferenceCollection[(Any) <Object>]
: This indicates any property can be added to this object.
[RecentPlans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans that the user recently viewed in apps that support recent plans.[RosterPlans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only. Nullable. Returns the plannerPlans contained by the plannerRosters the user is a member.[Tasks <IMicrosoftGraphPlannerTask-
[]>]
: Read-only. Nullable. Returns the plannerTasks assigned to the user.
PRESENCE <IMicrosoftGraphPresence>
: presence
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: 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.[Availability <String>]
: The base presence information for a user. Possible values are Available, AvailableIdle, Away, BeRightBack, Busy, BusyIdle, DoNotDisturb, Offline, PresenceUnknown.[OutOfOfficeSettings <IMicrosoftGraphOutOfOfficeSettings>]
: outOfOfficeSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsOutOfOffice <Boolean?>]
: 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.[Message <String>]
: 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).
[StatusMessage <IMicrosoftGraphPresenceStatusMessage>]
: presenceStatusMessage[(Any) <Object>]
: This indicates any property can be added to this object.[ExpiryDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Message <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[PublishedDateTime <DateTime?>]
: Time in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
PRINT <IMicrosoftGraphUserPrint>
: userPrint
[(Any) <Object>]
: This indicates any property can be added to this object.[RecentPrinterShares <IMicrosoftGraphPrinterShare-
[]>]
:[Capabilities <IMicrosoftGraphPrinterCapabilities>]
: printerCapabilities[(Any) <Object>]
: This indicates any property can be added to this object.[BottomMargins <Int32-
[]>]
: A list of supported bottom margins(in microns) for the printer.[Collation <Boolean?>]
: True if the printer supports collating when printing multiple copies of a multi-page document; false otherwise.[ColorModes <String-
[]>]
: The color modes supported by the printer. Valid values are described in the following table.[ContentTypes <String-
[]>]
: A list of supported content (MIME) types that the printer supports. It isn't guaranteed that the Universal Print service supports printing all of these MIME types.[CopiesPerJob <IMicrosoftGraphIntegerRange>]
: integerRange[(Any) <Object>]
: This indicates any property can be added to this object.[End <Int64?>]
: The inclusive upper bound of the integer range.[Maximum <Int64?>]
:[Minimum <Int64?>]
:[Start <Int64?>]
: The inclusive lower bound of the integer range.
[Dpis <Int32-
[]>]
: The list of print resolutions in DPI that are supported by the printer.[DuplexModes <String-
[]>]
: The list of duplex modes that are supported by the printer. Valid values are described in the following table.[FeedDirections <String-
[]>]
:[FeedOrientations <String-
[]>]
: The list of feed orientations that are supported by the printer.[Finishings <String-
[]>]
: Finishing processes the printer supports for a printed document.[InputBins <String-
[]>]
: Supported input bins for the printer.[IsColorPrintingSupported <Boolean?>]
: True if color printing is supported by the printer; false otherwise. Read-only.[IsPageRangeSupported <Boolean?>]
: True if the printer supports printing by page ranges; false otherwise.[LeftMargins <Int32-
[]>]
: A list of supported left margins(in microns) for the printer.[MediaColors <String-
[]>]
: The media (that is, paper) colors supported by the printer.[MediaSizes <String-
[]>]
: The media sizes supported by the printer. Supports standard size names for ISO and ANSI media sizes. Valid values are in the following table.[MediaTypes <String-
[]>]
: The media types supported by the printer.[MultipageLayouts <String-
[]>]
: The presentation directions supported by the printer. Supported values are described in the following table.[Orientations <String-
[]>]
: The print orientations supported by the printer. Valid values are described in the following table.[OutputBins <String-
[]>]
: The printer's supported output bins (trays).[PagesPerSheet <Int32-
[]>]
: Supported number of Input Pages to impose upon a single Impression.[Qualities <String-
[]>]
: The print qualities supported by the printer.[RightMargins <Int32-
[]>]
: A list of supported right margins(in microns) for the printer.[Scalings <String-
[]>]
: Supported print scalings.[SupportedColorConfigurations <String-
[]>]
:[SupportedCopiesPerJob <IMicrosoftGraphIntegerRange>]
: integerRange[SupportedDocumentMimeTypes <String-
[]>]
:[SupportedDuplexConfigurations <String-
[]>]
:[SupportedFinishings <String-
[]>]
:[SupportedMediaColors <String-
[]>]
:[SupportedMediaSizes <String-
[]>]
:[SupportedMediaTypes <String-
[]>]
:[SupportedOrientations <String-
[]>]
:[SupportedOutputBins <String-
[]>]
:[SupportedPagesPerSheet <IMicrosoftGraphIntegerRange>]
: integerRange[SupportedPresentationDirections <String-
[]>]
:[SupportedPrintQualities <String-
[]>]
:[SupportsFitPdfToPage <Boolean?>]
: True if the printer supports scaling PDF pages to match the print media size; false otherwise.[TopMargins <Int32-
[]>]
: A list of supported top margins(in microns) for the printer.
[Defaults <IMicrosoftGraphPrinterDefaults>]
: printerDefaults[(Any) <Object>]
: This indicates any property can be added to this object.[ColorMode <String>]
: printColorMode[ContentType <String>]
: The default content (MIME) type to use when processing documents.[CopiesPerJob <Int32?>]
: The default number of copies printed per job.[DocumentMimeType <String>]
:[Dpi <Int32?>]
: The default resolution in DPI to use when printing the job.[DuplexConfiguration <String>]
: printDuplexConfiguration[DuplexMode <String>]
: printDuplexMode[Finishings <String-
[]>]
: The default set of finishings to apply to print jobs. Valid values are described in the following table.[FitPdfToPage <Boolean?>]
: The default fitPdfToPage setting. True to fit each page of a PDF document to a physical sheet of media; false to let the printer decide how to lay out impressions.[InputBin <String>]
: The default input bin that serves as the paper source.[MediaColor <String>]
: The default media (such as paper) color to print the document on.[MediaSize <String>]
: The default media size to use. Supports standard size names for ISO and ANSI media sizes. Valid values are listed in the printerCapabilities topic.[MediaType <String>]
: The default media (such as paper) type to print the document on.[MultipageLayout <String>]
: printMultipageLayout[Orientation <String>]
: printOrientation[OutputBin <String>]
: The default output bin to place completed prints into. See the printer's capabilities for a list of supported output bins.[PagesPerSheet <Int32?>]
: The default number of document pages to print on each sheet.[PdfFitToPage <Boolean?>]
:[PresentationDirection <String>]
: printPresentationDirection[PrintColorConfiguration <String>]
: printColorConfiguration[PrintQuality <String>]
: printQuality[Quality <String>]
: printQuality[Scaling <String>]
: printScaling
[DisplayName <String>]
:[IsAcceptingJobs <Boolean?>]
:[Jobs <IMicrosoftGraphPrintJob-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AcknowledgedDateTime <DateTime?>]
:[CompletedDateTime <DateTime?>]
:[Configuration <IMicrosoftGraphPrintJobConfiguration>]
: printJobConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Collate <Boolean?>]
: Whether the printer should collate pages when printing multiple copies of a multi-page document.[ColorMode <String>]
: printColorMode[Copies <Int32?>]
: The number of copies that should be printed. Read-only.[Dpi <Int32?>]
: The resolution to use when printing the job, expressed in dots per inch (DPI). Read-only.[DuplexMode <String>]
: printDuplexMode[FeedOrientation <String>]
: printerFeedOrientation[Finishings <String-
[]>]
: Finishing processes to use when printing.[FitPdfToPage <Boolean?>]
:[InputBin <String>]
: The input bin (tray) to use when printing. See the printer's capabilities for a list of supported input bins.[Margin <IMicrosoftGraphPrintMargin>]
: printMargin[(Any) <Object>]
: This indicates any property can be added to this object.[Bottom <Int32?>]
: The margin in microns from the bottom edge.[Left <Int32?>]
: The margin in microns from the left edge.[Right <Int32?>]
: The margin in microns from the right edge.[Top <Int32?>]
: The margin in microns from the top edge.
[MediaSize <String>]
: The media sizeto use when printing. Supports standard size names for ISO and ANSI media sizes. Valid values are listed in the printerCapabilities topic.[MediaType <String>]
: The default media (such as paper) type to print the document on.[MultipageLayout <String>]
: printMultipageLayout[Orientation <String>]
: printOrientation[OutputBin <String>]
: The output bin to place completed prints into. See the printer's capabilities for a list of supported output bins.[PageRanges <IMicrosoftGraphIntegerRange-
[]>]
: The page ranges to print. Read-only.[PagesPerSheet <Int32?>]
: The number of document pages to print on each sheet.[Quality <String>]
: printQuality[Scaling <String>]
: printScaling
[CreatedBy <IMicrosoftGraphUserIdentity>]
: userIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[IPAddress <String>]
: Indicates the client IP address associated with the user performing the activity (audit log only).[UserPrincipalName <String>]
: The userPrincipalName attribute of the user.
[CreatedDateTime <DateTime?>]
: The DateTimeOffset when the job was created. Read-only.[DisplayName <String>]
: The name of the print job.[Documents <IMicrosoftGraphPrintDocument-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Configuration <IMicrosoftGraphPrinterDocumentConfiguration>]
: printerDocumentConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Collate <Boolean?>]
:[ColorMode <String>]
: printColorMode[Copies <Int32?>]
:[Dpi <Int32?>]
:[DuplexMode <String>]
: printDuplexMode[FeedDirection <String>]
: printerFeedDirection[FeedOrientation <String>]
: printerFeedOrientation[Finishings <String-
[]>]
:[FitPdfToPage <Boolean?>]
:[InputBin <String>]
:[Margin <IMicrosoftGraphPrintMargin>]
: printMargin[MediaSize <String>]
:[MediaType <String>]
:[MultipageLayout <String>]
: printMultipageLayout[Orientation <String>]
: printOrientation[OutputBin <String>]
:[PageRanges <IMicrosoftGraphIntegerRange-
[]>]
:[PagesPerSheet <Int32?>]
:[Quality <String>]
: printQuality[Scaling <String>]
: printScaling
[ContentType <String>]
: The document's content (MIME) type. Read-only.[DisplayName <String>]
: The document's name. Read-only.[DownloadedDateTime <DateTime?>]
:[Size <Int64?>]
: The document's size in bytes. Read-only.[UploadedDateTime <DateTime?>]
:
[ErrorCode <Int32?>]
:[IsFetchable <Boolean?>]
: If true, document can be fetched by printer.[RedirectedFrom <String>]
: Contains the source job URL, if the job has been redirected from another printer.[RedirectedTo <String>]
: Contains the destination job URL, if the job has been redirected to another printer.[Status <IMicrosoftGraphPrintJobStatus>]
: printJobStatus[(Any) <Object>]
: This indicates any property can be added to this object.[AcquiredByPrinter <Boolean?>]
:[Description <String>]
: A human-readable description of the print job's current processing state. Read-only.[Details <String-
[]>]
: Additional details for print job state. Valid values are described in the following table. Read-only.[IsAcquiredByPrinter <Boolean?>]
: True if the job was acknowledged by a printer; false otherwise. Read-only.[ProcessingState <String>]
: printJobProcessingState[ProcessingStateDescription <String>]
:[State <String>]
: printJobProcessingState
[Tasks <IMicrosoftGraphPrintTask-
[]>]
: A list of printTasks that were triggered by this print job.[Id <String>]
: The unique identifier for an entity. Read-only.[Definition <IMicrosoftGraphPrintTaskDefinition>]
: printTaskDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedBy <IMicrosoftGraphAppIdentity>]
: appIdentity[(Any) <Object>]
: This indicates any property can be added to this object.[AppId <String>]
: Refers to the unique identifier representing application ID in the Microsoft Entra ID.[DisplayName <String>]
: Refers to the application name displayed in the Microsoft Entra admin center.[ServicePrincipalId <String>]
: Refers to the unique identifier indicating service principal ID in Microsoft Entra ID for the corresponding App.[ServicePrincipalName <String>]
: Refers to the Service Principal Name is the Application name in the tenant.
[DisplayName <String>]
: The name of the printTaskDefinition.[Tasks <IMicrosoftGraphPrintTask-
[]>]
: A list of tasks that have been created based on this definition. The list includes currently running tasks and recently completed tasks. Read-only.
[ParentUrl <String>]
: The URL for the print entity that triggered this task. For example, https://graph.microsoft.com/beta/print/printers/{printerId}/jobs/{jobId}. Read-only.[Status <IMicrosoftGraphPrintTaskStatus>]
: printTaskStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: A human-readable description of the current processing state of the printTask.[State <String>]
: printTaskProcessingState
[Trigger <IMicrosoftGraphPrintTaskTrigger>]
: printTaskTrigger[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Definition <IMicrosoftGraphPrintTaskDefinition>]
: printTaskDefinition[Event <String>]
: printEvent
[Location <IMicrosoftGraphPrinterLocation>]
: printerLocation[(Any) <Object>]
: This indicates any property can be added to this object.[AltitudeInMeters <Int32?>]
: The altitude, in meters, that the printer is located at.[Building <String>]
: The building that the printer is located in.[City <String>]
: The city that the printer is located in.[CountryOrRegion <String>]
: The country or region that the printer is located in.[Floor <String>]
: The floor that the printer is located on. Only numerical values are supported right now.[FloorDescription <String>]
: The description of the floor that the printer is located on.[FloorNumber <Int32?>]
:[Latitude <Double?>]
: The latitude that the printer is located at.[Longitude <Double?>]
: The longitude that the printer is located at.[Organization <String-
[]>]
: The organizational hierarchy that the printer belongs to. The elements should be in hierarchical order.[PostalCode <String>]
: The postal code that the printer is located in.[RoomDescription <String>]
: The description of the room that the printer is located in.[RoomName <String>]
: The room that the printer is located in. Only numerical values are supported right now.[RoomNumber <Int32?>]
:[Site <String>]
: The site that the printer is located in.[StateOrProvince <String>]
: The state or province that the printer is located in.[StreetAddress <String>]
: The street address where the printer is located.[Subdivision <String-
[]>]
: The subdivision that the printer is located in. The elements should be in hierarchical order.[Subunit <String-
[]>]
:
[Manufacturer <String>]
:[Model <String>]
:[Name <String>]
:[Status <IMicrosoftGraphPrinterStatus>]
: printerStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: A human-readable description of the printer's current processing state. Read-only.[Details <String-
[]>]
: The list of details describing why the printer is in the current state. Valid values are described in the following table. Read-only.[ProcessingState <String>]
: printerProcessingState[ProcessingStateDescription <String>]
:[ProcessingStateReasons <String-
[]>]
:[State <String>]
: printerProcessingState
[Id <String>]
: The unique identifier for an entity. Read-only.[AllowAllUsers <Boolean?>]
: If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties.[AllowedGroups <IMicrosoftGraphGroup-
[]>]
: The groups whose users have access to print using the printer.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AcceptedSenders <IMicrosoftGraphDirectoryObject-
[]>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[AccessType <String>]
: groupAccessType[AllowExternalSenders <Boolean?>]
: 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}).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a group has been granted for an application. Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AssignedLabels <IMicrosoftGraphAssignedLabel-
[]>]
: The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role.[DisplayName <String>]
: The display name of the label. Read-only.[LabelId <String>]
: The unique identifier of the label.
[AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq). Read-only.[DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled. IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.[SkuId <String>]
: The unique identifier for the SKU. Corresponds to the skuId from subscribedSkus or companySubscription.
[AutoSubscribeNewMembers <Boolean?>]
: 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}).[Calendar <IMicrosoftGraphCalendar>]
: calendar[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar. If the user has never explicitly set a group for the calendar, this property is null.[CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.[Id <String>]
: The unique identifier for an entity. Read-only.[AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar. Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[(Any) <Object>]
: This indicates any property can be added to this object.[Address <String>]
: The email address of an entity instance.[Name <String>]
: The display name of an entity instance.
[IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.[IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a recipient to a calendar.[Role <String>]
: calendarRoleType
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Navigation property. Read-only.[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false. Optional. Default is true.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event. Navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.[LastModifiedDateTime <DateTime?>]
: 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[Name <String>]
: The display name of the attachment. This does not need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.[Type <String>]
: attendeeType[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress[ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot[(Any) <Object>]
: This indicates any property can be added to this object.[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Status <IMicrosoftGraphResponseStatus>]
: responseStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Response <String>]
: responseType[Time <DateTime?>]
: The date and time that the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyPreview <String>]
: The preview of the message associated with the event. It is in text format.[Calendar <IMicrosoftGraphCalendar>]
: calendar[CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).[End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[HasAttachments <Boolean?>]
: Set to true if the event has attachments.[HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.[ICalUId <String>]
: A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.[Importance <String>]
: importance[Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.[IsAllDay <Boolean?>]
: Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.[IsCancelled <Boolean?>]
: Set to true if the event has been canceled.[IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.[IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.[IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.[Location <IMicrosoftGraphLocation>]
: location[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Accuracy <Double?>]
: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.[Altitude <Double?>]
: The altitude of the location.[AltitudeAccuracy <Double?>]
: The accuracy of the altitude.[Latitude <Double?>]
: The latitude of the location.[Longitude <Double?>]
: The longitude of the location.
[DisplayName <String>]
: The name associated with the location.[LocationEmailAddress <String>]
: Optional email address of the location.[LocationType <String>]
: locationType[LocationUri <String>]
: Optional URI representing the location.[UniqueId <String>]
: For internal use only.[UniqueIdType <String>]
: locationUniqueIdType
[Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String-
[]>]
: A collection of property values.
[OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.[OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The ID of the conference.[JoinUrl <String>]
: The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting.[Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.[Number <String>]
: The phone number.[Type <String>]
: phoneType
[QuickDial <String>]
: The preformatted quick dial for this call.[TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.[TollNumber <String>]
: The toll number that can be used to join the conference.
[OnlineMeetingProvider <String>]
: onlineMeetingProviderType[OnlineMeetingUrl <String>]
: A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.[Organizer <IMicrosoftGraphRecipient>]
: recipient[(Any) <Object>]
: This indicates any property can be added to this object.[EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
[OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.[ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.[ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus[Sensitivity <String>]
: sensitivity[SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.[ShowAs <String>]
: freeBusyStatus[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Value <String>]
: A property value.
[Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Subject <String>]
: The text of the event's subject line.[TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.[Type <String>]
: eventType[Uid <String>]
: A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.[WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
[CanEdit <Boolean?>]
: 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.[CanShare <Boolean?>]
: 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.[CanViewPrivateItems <Boolean?>]
: 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.[ChangeKey <String>]
: 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.[Color <String>]
: calendarColor[DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType[Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar. Navigation property. Read-only.[HexColor <String>]
: 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.[IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.[IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.[IsShared <Boolean?>]
: 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.[IsSharedWithMe <Boolean?>]
: 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.[IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar. Read-only. Nullable.[Name <String>]
: The calendar name.[Owner <IMicrosoftGraphEmailAddress>]
: emailAddress[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar. Read-only. Nullable.
[CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar. Read-only.[Classification <String>]
: 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).[Conversations <IMicrosoftGraphConversation-
[]>]
: The group's conversations.[Id <String>]
: The unique identifier for an entity. Read-only.[HasAttachments <Boolean?>]
: Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq, ne) and $search.[LastDeliveredDateTime <DateTime?>]
: 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).[Preview <String>]
: A short summary from the body of the latest post in this conversation.[Threads <IMicrosoftGraphConversationThread-
[]>]
: A collection of all the conversation threads in the conversation. A navigation property. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[CcRecipients <IMicrosoftGraphRecipient-
[]>]
: The Cc: recipients for the thread. Returned only on $select.[HasAttachments <Boolean?>]
: Indicates whether any of the posts within this thread has at least one attachment. Returned by default.[IsLocked <Boolean?>]
: Indicates if the thread is locked. Returned by default.[LastDeliveredDateTime <DateTime?>]
: 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.[Posts <IMicrosoftGraphPost-
[]>]
:[Categories <String-
[]>]
: The categories associated with the item.[ChangeKey <String>]
: Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.[CreatedDateTime <DateTime?>]
: 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[LastModifiedDateTime <DateTime?>]
: 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[Id <String>]
: The unique identifier for an entity. Read-only.[Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the post. Read-only. Nullable. Supports $expand.[Body <IMicrosoftGraphItemBody>]
: itemBody[ConversationId <String>]
: Unique ID of the conversation. Read-only.[ConversationThreadId <String>]
: Unique ID of the conversation thread. Read-only.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the post. Read-only. Nullable. Supports $expand.[From <IMicrosoftGraphRecipient>]
: recipient[HasAttachments <Boolean?>]
: Indicates whether the post has at least one attachment. This is a default property.[Importance <String>]
: importance[InReplyTo <IMicrosoftGraphPost>]
: post[Mentions <IMicrosoftGraphMention-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Application <String>]
: The name of the application where the mention is created. Optional. Not used and defaulted as null for message.[ClientReference <String>]
: A unique identifier that represents a parent of the resource instance. Optional. Not used and defaulted as null for message.[CreatedBy <IMicrosoftGraphEmailAddress>]
: emailAddress[CreatedDateTime <DateTime?>]
: The date and time that the mention is created on the client.[DeepLink <String>]
: A deep web link to the context of the mention in the resource instance. Optional. Not used and defaulted as null for message.[MentionText <String>]
: Optional. Not used and defaulted as null for message. To get the mentions in a message, see the bodyPreview property of the message instead.[Mentioned <IMicrosoftGraphEmailAddress>]
: emailAddress[ServerCreatedDateTime <DateTime?>]
: The date and time that the mention is created on the server. Optional. Not used and defaulted as null for message.
[MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the post. Read-only. Nullable.[NewParticipants <IMicrosoftGraphRecipient-
[]>]
: Conversation participants that were added to the thread as part of this post.[ReceivedDateTime <DateTime?>]
: Specifies when the post was received. 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[Sender <IMicrosoftGraphRecipient>]
: recipient[SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the post. Read-only. Nullable.
[Preview <String>]
: A short summary from the body of the latest post in this conversation. Returned by default.[ToRecipients <IMicrosoftGraphRecipient-
[]>]
: The To: recipients for the thread. Returned only on $select.[Topic <String>]
: The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. Returned by default.[UniqueSenders <String-
[]>]
: All the users that sent a message to this thread. Returned by default.
[Topic <String>]
: The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.[UniqueSenders <String-
[]>]
: All the users that sent a message to this Conversation.
[CreatedByAppId <String>]
: App ID of the app used to create the group. Can be null for some groups. Returned by default. Read-only. Supports $filter (eq, ne, not, in, startsWith).[CreatedDateTime <DateTime?>]
: 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.[CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]
: directoryObject[Description <String>]
: An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.[DisplayName <String>]
: The display name for the group. Required. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.[Drive <IMicrosoftGraphDrive>]
: drive[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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 <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [Drives <IMicrosoftGraphDrive-
[]>]
: A collection of drives available for this user.
Read-only.
- [EmployeeExperience <IMicrosoftGraphEmployeeExperienceUser>]
: employeeExperienceUser
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LearningCourseActivities <IMicrosoftGraphLearningCourseActivity-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CompletedDateTime <DateTime?>]
: Date and time when the assignment was completed.
Optional.
- [CompletionPercentage <Int32?>]
: The percentage completion value of the course activity.
Optional.
- [ExternalcourseActivityId <String>]
:
- [LearnerUserId <String>]
: The user ID of the learner to whom the activity is assigned.
Required.
- [LearningContentId <String>]
: The ID of the learning content created in Viva Learning.
Required.
- [LearningProviderId <String>]
: The registration ID of the provider.
Required.
- [Status <String>]
: courseStatus
- [EmployeeHireDate <DateTime?>]
: 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).
- [EmployeeId <String>]
: The employee identifier assigned to the user by the organization.
The maximum length is 16 characters.Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [EmployeeLeaveDateTime <DateTime?>]
: The date and time when the user left or will leave the organization.
To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission.
To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions.
To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator, Global Reader.
To write this property in delegated scenarios, the admin needs the Global Administrator role.
Supports $filter (eq, ne, not , ge, le, in).
For more information, see Configure the employeeLeaveDateTime property for a user.
- [EmployeeOrgData <IMicrosoftGraphEmployeeOrgData>]
: employeeOrgData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CostCenter <String>]
: The cost center associated with the user.
Returned only on $select.
Supports $filter.
- [Division <String>]
: The name of the division in which the user works.
Returned only on $select.
Supports $filter.
- [EmployeeType <String>]
: Captures enterprise worker type.
For example, Employee, Contractor, Consultant, or Vendor.
Supports $filter (eq, ne, not , ge, le, in, startsWith).
- [Events <IMicrosoftGraphEvent-
[]>]
: The user's events.
The default is to show events under the Default Calendar.
Read-only.
Nullable.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the user.
Supports $expand.
Nullable.
- [ExternalUserState <String>]
: For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status.
For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.
Supports $filter (eq, ne, not , in).
- [ExternalUserStateChangeDateTime <String>]
: Shows the timestamp for the latest change to the externalUserState property.
Supports $filter (eq, ne, not , in).
- [FaxNumber <String>]
: The fax number of the user.
Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
- [FollowedSites <IMicrosoftGraphSite-
[]>]
:
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.
- [Bundles <IMicrosoftGraphDriveItem-
[]>]
: Collection of bundles (albums and multi-select-shared sets of items).
Only in personal OneDrive.
- [DriveType <String>]
: Describes the type of drive represented by this resource.
OneDrive personal drives return personal.
OneDrive for Business returns business.
SharePoint document libraries return documentLibrary.
Read-only.
- [Following <IMicrosoftGraphDriveItem-
[]>]
: The list of items the user is following.
Only in OneDrive for Business.
- [Items <IMicrosoftGraphDriveItem-
[]>]
: All items contained in the drive.
Read-only.
Nullable.
- [List <IMicrosoftGraphList>]
: list
- [Owner <IMicrosoftGraphIdentitySet>]
: identitySet
- [Quota <IMicrosoftGraphQuota>]
: quota
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Deleted <Int64?>]
: Total space consumed by files in the recycle bin, in bytes.
Read-only.
- [Remaining <Int64?>]
: Total space remaining before reaching the quota limit, in bytes.
Read-only.
- [State <String>]
: Enumeration value that indicates the state of the storage space.
Read-only.
- [StoragePlanInformation <IMicrosoftGraphStoragePlanInformation>]
: storagePlanInformation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [UpgradeAvailable <Boolean?>]
: Indicates if there are higher storage quota plans available.
Read-only.
- [Total <Int64?>]
: Total allowed storage space, in bytes.
Read-only.
- [Used <Int64?>]
: Total space used, in bytes.
Read-only.
- [Root <IMicrosoftGraphDriveItem>]
: driveItem
- [SharePointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [Special <IMicrosoftGraphDriveItem-
[]>]
: Collection of common folders available in OneDrive.
Read-only.
Nullable.
- [System <IMicrosoftGraphSystemFacet>]
: systemFacet
- [Drives <IMicrosoftGraphDrive-
[]>]
: The group's drives.
Read-only.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints for the group.
Read-only.
Nullable.
- [Events <IMicrosoftGraphEvent-
[]>]
: The group's events.
- [ExpirationDateTime <DateTime?>]
: 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.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the group.
Read-only.
Nullable.
- [GroupLifecyclePolicies <IMicrosoftGraphGroupLifecyclePolicy-
[]>]
: The collection of lifecycle policies for this group.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AlternateNotificationEmails <String>]
: List of email address to send notifications for groups without owners.
Multiple email address can be defined by separating email address with a semicolon.
- [GroupLifetimeInDays <Int32?>]
: 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.
- [ManagedGroupTypes <String>]
: The group type for which the expiration policy applies.
Possible values are All, Selected or None.
- [GroupTypes <String-
[]>]
: 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 <Boolean?>]
: 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).
- [HideFromAddressLists <Boolean?>]
: 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}).
- [HideFromOutlookClients <Boolean?>]
: 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}).
- [InfoCatalogs <String-
[]>]
: Identifies the info segments assigned to the group.
Returned by default.
Supports $filter (eq, not, ge, le, startsWith).
- [IsArchived <Boolean?>]
: 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.
- [IsAssignableToRole <Boolean?>]
: 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 with at least the Privileged Role Administrator role 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).
- [IsFavorite <Boolean?>]
: Indicates whether the user marked the group as favorite.
- [IsManagementRestricted <Boolean?>]
: Indicates whether the group is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsSubscribedByMail <Boolean?>]
: 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}).
- [LicenseProcessingState <IMicrosoftGraphLicenseProcessingState>]
: licenseProcessingState
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
:
- [Mail <String>]
: The SMTP address for the group, for example, 'serviceadmins@contoso.com'.
Returned by default.
Read-only.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [MailEnabled <Boolean?>]
: Specifies whether the group is mail-enabled.
Required.
Returned by default.
Supports $filter (eq, ne, not, and eq on null values).
- [MailNickname <String>]
: The mail alias for the group, unique for Microsoft 365 groups in the organization.
Maximum length is 64 characters.
This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () / - []
' ; : <> , SPACE.
Returned by default.
Supports $filter (eq, ne, not, ge, le, in, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this group is a member of.
HTTP Methods: GET (supported for all groups).
Read-only.
Nullable.
Supports $expand.
- [Members <IMicrosoftGraphDirectoryObject-
[]>]
: 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).
- [MembersWithLicenseErrors <IMicrosoftGraphDirectoryObject-
[]>]
: A list of group members with license errors from this group-based license assignment.
Read-only.
- [MembershipRule <String>]
: The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership).
For more information about the syntax of the membership rule, see Membership Rules syntax.
Returned by default.
Supports $filter (eq, ne, not, ge, le, startsWith).
- [MembershipRuleProcessingState <String>]
: 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).
- [MembershipRuleProcessingStatus <IMicrosoftGraphMembershipRuleProcessingStatus>]
: membershipRuleProcessingStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ErrorMessage <String>]
: Detailed error message if dynamic group processing ran into an error.
Optional.
Read-only.
- [LastMembershipUpdated <DateTime?>]
: Most recent date and time when membership of a dynamic group was updated.
Optional.
Read-only.
- [Status <String>]
: MembershipRuleProcessingStatusDetails
- [OnPremisesDomainName <String>]
: 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.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesNetBiosName <String>]
: 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.
- [OnPremisesProvisioningErrors <IMicrosoftGraphOnPremisesProvisioningError-
[]>]
: Errors when using Microsoft synchronization product during provisioning.
Returned by default.
Supports $filter (eq, not).
- [OnPremisesSamAccountName <String>]
: 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.
- [OnPremisesSecurityIdentifier <String>]
: Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud.
Read-only.
Returned by default.
Supports $filter (eq including on null values).
- [OnPremisesSyncEnabled <Boolean?>]
: true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default).
Returned by default.
Read-only.
Supports $filter (eq, ne, not, in, and eq on null values).
- [Onenote <IMicrosoftGraphOnenote>]
: onenote
- [OrganizationId <String>]
:
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: The owners of the group who can be users or service principals.
Limited to 100 owners.
Nullable.
If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner.
A non-admin user can't explicitly add themselves to this collection when they're creating the group.
For more information, see the related known issue.
For security groups, the admin user isn't automatically added to this collection.
For more information, see the related known issue.
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).
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: The permissions granted for a group to a specific application.
Supports $expand.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [Photos <IMicrosoftGraphProfilePhoto-
[]>]
: The profile photos owned by the group.
Read-only.
Nullable.
- [Planner <IMicrosoftGraphPlannerGroup>]
: plannerGroup
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Plans <IMicrosoftGraphPlannerPlan-
[]>]
: Read-only.
Nullable.
Returns the plannerPlans owned by the group.
- [PreferredDataLocation <String>]
: 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 at least one of the following Microsoft Entra roles: 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.
- [PreferredLanguage <String>]
: 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).
- [ProxyAddresses <String-
[]>]
: Email addresses for the group that direct to the same group mailbox.
For example: - ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']
.
The any operator is required for filter expressions on multi-valued properties.
Returned by default.
Read-only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
- [RejectedSenders <IMicrosoftGraphDirectoryObject-
[]>]
: The list of users or groups not allowed to create posts or calendar events in this group.
Nullable
- [RenewedDateTime <DateTime?>]
: 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.
- [ResourceBehaviorOptions <String-
[]>]
: Specifies the group behaviors that can be set for a Microsoft 365 group during creation.
This property can be set only as part of creation (POST).
For the list of possible values, see Microsoft 365 group behaviors and provisioning options.
- [ResourceProvisioningOptions <String-
[]>]
: Specifies the group resources that are associated with the Microsoft 365 group.
The possible value is Team.
For more information, see Microsoft 365 group behaviors and provisioning options.
Returned by default.
Supports $filter (eq, not, startsWith.
- [SecurityEnabled <Boolean?>]
: Specifies whether the group is a security group.
Required.Returned by default.
Supports $filter (eq, ne, not, in).
- [SecurityIdentifier <String>]
: Security identifier of the group, used in Windows scenarios.
Read-only.
Returned by default.
- [ServiceProvisioningErrors <IMicrosoftGraphServiceProvisioningError-
[]>]
: Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from a group object.
- [Settings <IMicrosoftGraphDirectorySetting-
[]>]
: Settings that can govern this group's behavior, like whether members can invite guest users to the group.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of this group of settings, which comes from the associated template.
Read-only.
- [TemplateId <String>]
: Unique identifier for the template used to create this group of settings.
Read-only.
- [Values <IMicrosoftGraphSettingValue-
[]>]
: Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.
- [Name <String>]
: Name of the setting (as defined by the directorySettingTemplate).
- [Value <String>]
: Value of the setting.
- [Sites <IMicrosoftGraphSite-
[]>]
: The list of SharePoint sites in this group.
Access the default site with /sites/root.
- [Team <IMicrosoftGraphTeam>]
: team
- [Theme <String>]
: Specifies a Microsoft 365 group's color theme.
Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red.
Returned by default.
- [Threads <IMicrosoftGraphConversationThread-
[]>]
: The group's conversation threads.
Nullable.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: The groups a group is a member of, either directly or through nested membership.
Nullable.
- [TransitiveMembers <IMicrosoftGraphDirectoryObject-
[]>]
: The direct and transitive members of a group.
Nullable.
- [UniqueName <String>]
: The unique identifier that can be assigned to a group and used as an alternate key.
Immutable.
Read-only.
- [UnseenConversationsCount <Int32?>]
: 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.
- [UnseenCount <Int32?>]
: Count of conversations that have received new posts since the signed-in user last visited the group.
This property is the same as unseenConversationsCount.Returned only on $select.
Supported only on the Get group API (GET /groups/{ID}).
- [UnseenMessagesCount <Int32?>]
: 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.
- [Visibility <String>]
: 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.
- [WritebackConfiguration <IMicrosoftGraphGroupWritebackConfiguration>]
: groupWritebackConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsEnabled <Boolean?>]
: Indicates whether writeback of cloud groups to on-premise Active Directory is enabled.
Default value is true for Microsoft 365 groups and false for security groups.
- [OnPremisesGroupType <String>]
: 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
- [AllowedUsers <IMicrosoftGraphUser-
[]>]
: The users who have access to print using the printer.
- [CreatedDateTime <DateTime?>]
: The DateTimeOffset when the printer share was created.
Read-only.
- [Printer <IMicrosoftGraphPrinter>]
: printer
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capabilities <IMicrosoftGraphPrinterCapabilities>]
: printerCapabilities
- [Defaults <IMicrosoftGraphPrinterDefaults>]
: printerDefaults
- [DisplayName <String>]
:
- [IsAcceptingJobs <Boolean?>]
:
- [Jobs <IMicrosoftGraphPrintJob-
[]>]
:
- [Location <IMicrosoftGraphPrinterLocation>]
: printerLocation
- [Manufacturer <String>]
:
- [Model <String>]
:
- [Name <String>]
:
- [Status <IMicrosoftGraphPrinterStatus>]
: printerStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AcceptingJobs <Boolean?>]
:
- [Connectors <IMicrosoftGraphPrintConnector-
[]>]
: The connectors that are associated with the printer.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppVersion <String>]
: The connector's version.
- [DeviceHealth <IMicrosoftGraphDeviceHealth>]
: deviceHealth
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LastConnectionTime <DateTime?>]
: The last time the device was connected.
- [DisplayName <String>]
: The name of the connector.
- [FullyQualifiedDomainName <String>]
: The connector machine's hostname.
- [Location <IMicrosoftGraphPrinterLocation>]
: printerLocation
- [Name <String>]
:
- [OperatingSystem <String>]
: The connector machine's operating system version.
- [RegisteredDateTime <DateTime?>]
: The DateTimeOffset when the connector was registered.
- [HasPhysicalDevice <Boolean?>]
: True if the printer has a physical device for printing.
Read-only.
- [IsShared <Boolean?>]
: True if the printer is shared; false otherwise.
Read-only.
- [LastSeenDateTime <DateTime?>]
: The most recent dateTimeOffset when a printer interacted with Universal Print.
Read-only.
- [RegisteredDateTime <DateTime?>]
: The DateTimeOffset when the printer was registered.
Read-only.
- [Share <IMicrosoftGraphPrinterShare>]
: printerShare
- [Shares <IMicrosoftGraphPrinterShare-
[]>]
: The list of printerShares that are associated with the printer.
Currently, only one printerShare can be associated with the printer.
Read-only.
Nullable.
- [TaskTriggers <IMicrosoftGraphPrintTaskTrigger-
[]>]
: A list of task triggers that are associated with the printer.
- [ViewPoint <IMicrosoftGraphPrinterShareViewpoint>]
: printerShareViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LastUsedDateTime <DateTime?>]
: Date and time when the printer was last used by the signed-in 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.
PROFILE <IMicrosoftGraphProfile>
: profile
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Account <IMicrosoftGraphUserAccountInformation-
[]>]
:[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[(Any) <Object>]
: This indicates any property can be added to this object.[ConfidenceScore <Double?>]
: Confidence score reflecting the accuracy of the data inferred about the user.[UserHasVerifiedAccuracy <Boolean?>]
: Records if the user has confirmed this inference as being True or False.
[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[(Any) <Object>]
: This indicates any property can be added to this object.[Type <String-
[]>]
:
[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[IsDefaultSource <Boolean?>]
: Indicates whether the source is the default one.[Properties <String-
[]>]
: Names of properties that have data from this source.[SourceId <String>]
:
[Id <String>]
: The unique identifier for an entity. Read-only.[AgeGroup <String>]
: Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and can't be changed.[CountryCode <String>]
: Contains the two-character country code associated with the users' account.[PreferredLanguageTag <IMicrosoftGraphLocaleInfo>]
: localeInfo[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: A name representing the user's locale in natural language, for example, 'English (United States)'.[Locale <String>]
: 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.
[UserPrincipalName <String>]
: The user principal name (UPN) of the user associated with the account.
[Addresses <IMicrosoftGraphItemAddress-
[]>]
: Represents details of addresses associated with the user.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Detail <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[(Any) <Object>]
: This indicates any property can be added to this object.[City <String>]
: The city.[CountryOrRegion <String>]
: The country or region. It's a free-format string value, for example, 'United States'.[PostOfficeBox <String>]
: The post office box number.[PostalCode <String>]
: The postal code.[State <String>]
: The state.[Street <String>]
: The street.[Type <String>]
: physicalAddressType
[DisplayName <String>]
: Friendly name the user has assigned to this address.[GeoCoordinates <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates[(Any) <Object>]
: This indicates any property can be added to this object.[Altitude <Double?>]
: Optional. The altitude (height), in feet, above sea level for the item. Read-only.[Latitude <Double?>]
: Optional. The latitude, in decimal, for the item. Writable on OneDrive Personal.[Longitude <Double?>]
: Optional. The longitude, in decimal, for the item. Writable on OneDrive Personal.
[Anniversaries <IMicrosoftGraphPersonAnnualEvent-
[]>]
: Represents the details of meaningful dates associated with a person.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Date <DateTime?>]
:[DisplayName <String>]
:[Type <String>]
: personAnnualEventType
[Awards <IMicrosoftGraphPersonAward-
[]>]
: Represents the details of awards or honors associated with a person.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Descpription of the award or honor.[DisplayName <String>]
: Name of the award or honor.[IssuedDate <DateTime?>]
: The date that the award or honor was granted.[IssuingAuthority <String>]
: Authority which granted the award or honor.[ThumbnailUrl <String>]
: URL referencing a thumbnail of the award or honor.[WebUrl <String>]
: URL referencing the award or honor.
[Certifications <IMicrosoftGraphPersonCertification-
[]>]
: Represents the details of certifications associated with a person.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[CertificationId <String>]
: The referenceable identifier for the certification.[Description <String>]
: Description of the certification.[DisplayName <String>]
: Title of the certification.[EndDate <DateTime?>]
: The date that the certification expires.[IssuedDate <DateTime?>]
: The date that the certification was issued.[IssuingAuthority <String>]
: Authority which granted the certification.[IssuingCompany <String>]
: Company which granted the certification.[StartDate <DateTime?>]
: The date that the certification became valid.[ThumbnailUrl <String>]
: URL referencing a thumbnail of the certification.[WebUrl <String>]
: URL referencing the certification.
[EducationalActivities <IMicrosoftGraphEducationalActivity-
[]>]
: Represents data that a user has supplied related to undergraduate, graduate, postgraduate or other educational activities.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[CompletionMonthYear <DateTime?>]
: The month and year the user graduated or completed the activity.[EndMonthYear <DateTime?>]
: The month and year the user completed the educational activity referenced.[Institution <IMicrosoftGraphInstitutionData>]
: institutionData[(Any) <Object>]
: This indicates any property can be added to this object.[Description <String>]
: Short description of the institution the user studied at.[DisplayName <String>]
: Name of the institution the user studied at.[Location <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[WebUrl <String>]
: Link to the institution or department homepage.
[Program <IMicrosoftGraphEducationalActivityDetail>]
: educationalActivityDetail[(Any) <Object>]
: This indicates any property can be added to this object.[Abbreviation <String>]
: Shortened name of the degree or program (example: PhD, MBA)[Activities <String-
[]>]
: Extracurricular activities undertaken alongside the program.[Awards <String-
[]>]
: Any awards or honors associated with the program.[Description <String>]
: Short description of the program provided by the user.[DisplayName <String>]
: Long-form name of the program that the user has provided.[FieldsOfStudy <String-
[]>]
: Majors and minors associated with the program. (if applicable)[Grade <String>]
: The final grade, class, GPA or score.[Notes <String>]
: Additional notes the user has provided.[WebUrl <String>]
: Link to the degree or program page.
[StartMonthYear <DateTime?>]
: The month and year the user commenced the activity referenced.
[Emails <IMicrosoftGraphItemEmail-
[]>]
: Represents detailed information about email addresses associated with the user.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Address <String>]
: The email address itself.[DisplayName <String>]
: The name or label a user has associated with a particular email address.[Type <String>]
: emailType
[Interests <IMicrosoftGraphPersonInterest-
[]>]
: Provides detailed information about interests the user has associated with themselves in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the interest (for example, personal, recipies).[CollaborationTags <String-
[]>]
: Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.[Description <String>]
: Contains a description of the interest.[DisplayName <String>]
: Contains a friendly name for the interest.[ThumbnailUrl <String>]
:[WebUrl <String>]
: Contains a link to a web page or resource about the interest.
[Languages <IMicrosoftGraphLanguageProficiency-
[]>]
: Represents detailed information about languages that a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Contains the long-form name for the language.[Proficiency <String>]
: languageProficiencyLevel[Reading <String>]
: languageProficiencyLevel[Spoken <String>]
: languageProficiencyLevel[Tag <String>]
: Contains the four-character BCP47 name for the language (en-US, no-NB, en-AU).[ThumbnailUrl <String>]
:[Written <String>]
: languageProficiencyLevel
[Names <IMicrosoftGraphPersonName-
[]>]
: Represents the names a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.[First <String>]
: First name of the user.[Initials <String>]
: Initials of the user.[LanguageTag <String>]
: Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.[Last <String>]
: Last name of the user.[Maiden <String>]
: Maiden name of the user.[Middle <String>]
: Middle name of the user.[Nickname <String>]
: Nickname of the user.[Pronunciation <IMicrosoftGraphPersonNamePronounciation>]
: personNamePronounciation[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
:[First <String>]
:[Last <String>]
:[Maiden <String>]
:[Middle <String>]
:
[Suffix <String>]
: Designators used after the users name (eg: PhD.)[Title <String>]
: Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)
[Notes <IMicrosoftGraphPersonAnnotation-
[]>]
: Represents notes that a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Detail <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[DisplayName <String>]
: Contains a friendly name for the note.[ThumbnailUrl <String>]
:
[Patents <IMicrosoftGraphItemPatent-
[]>]
: Represents patents that a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Descpription of the patent or filing.[DisplayName <String>]
: Title of the patent or filing.[IsPending <Boolean?>]
: Indicates the patent is pending.[IssuedDate <DateTime?>]
: The date that the patent was granted.[IssuingAuthority <String>]
: Authority which granted the patent.[Number <String>]
: The patent number.[WebUrl <String>]
: URL referencing the patent or filing.
[Phones <IMicrosoftGraphItemPhone-
[]>]
: Represents detailed information about phone numbers associated with a user in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Friendly name the user has assigned this phone number.[Number <String>]
: Phone number provided by the user.[Type <String>]
: phoneType
[Positions <IMicrosoftGraphWorkPosition-
[]>]
: Represents detailed information about work positions associated with a user's profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Categories that the user has associated with this position.[Colleagues <IMicrosoftGraphRelatedPerson-
[]>]
: Colleagues that are associated with this position.[DisplayName <String>]
: Name of the person.[Relationship <String>]
: personRelationship[UserId <String>]
: The user's directory object ID (Microsoft Entra ID or CID).[UserPrincipalName <String>]
: Email address or reference to person within the organization.
[Detail <IMicrosoftGraphPositionDetail>]
: positionDetail[(Any) <Object>]
: This indicates any property can be added to this object.[Company <IMicrosoftGraphCompanyDetail>]
: companyDetail[(Any) <Object>]
: This indicates any property can be added to this object.[Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress[CompanyCode <String>]
: Legal entity number of the company or its subdivision. For information on how to set the value for the companyCode, see profileSourceAnnotation.[Department <String>]
: Department Name within a company.[DisplayName <String>]
: Company name.[OfficeLocation <String>]
: Office Location of the person referred to.[Pronunciation <String>]
: Pronunciation guide for the company name.[SecondaryDepartment <String>]
: Secondary Department Name within a company.[WebUrl <String>]
: Link to the company home page.
[Description <String>]
: A description for the position in question.[EndMonthYear <DateTime?>]
: The date when the position ended.[JobTitle <String>]
: The title of the position.[Layer <Int32?>]
: The place where the employee is within the organizational hierarchy.[Level <String>]
: The employee's experience or management level.[Role <String>]
: The role the position entailed.[SecondaryJobTitle <String>]
: An optional job title for the position.[SecondaryRole <String>]
: An optional role for the position entailed.[StartMonthYear <DateTime?>]
: The start date of the position.[Summary <String>]
: The summary of the position.
[IsCurrent <Boolean?>]
: Denotes whether or not the position is current.[Manager <IMicrosoftGraphRelatedPerson>]
: relatedPerson
[Projects <IMicrosoftGraphProjectParticipation-
[]>]
: Represents detailed information about projects associated with a user.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the project (for example, digital transformation, oil rig).[Client <IMicrosoftGraphCompanyDetail>]
: companyDetail[CollaborationTags <String-
[]>]
: Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.[Colleagues <IMicrosoftGraphRelatedPerson-
[]>]
: Lists people that also worked on the project.[Detail <IMicrosoftGraphPositionDetail>]
: positionDetail[DisplayName <String>]
: Contains a friendly name for the project.[Sponsors <IMicrosoftGraphRelatedPerson-
[]>]
: The Person or people who sponsored the project.[ThumbnailUrl <String>]
:
[Publications <IMicrosoftGraphItemPublication-
[]>]
: Represents details of any publications a user has added to their profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Description of the publication.[DisplayName <String>]
: Title of the publication.[PublishedDate <DateTime?>]
: The date that the publication was published.[Publisher <String>]
: Publication or publisher for the publication.[ThumbnailUrl <String>]
: URL referencing a thumbnail of the publication.[WebUrl <String>]
: URL referencing the publication.
[Skills <IMicrosoftGraphSkillProficiency-
[]>]
: Represents detailed information about skills associated with a user in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the skill (for example, personal, professional, hobby).[CollaborationTags <String-
[]>]
: Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout, ableToMentor, wantsToLearn, wantsToImprove.[DisplayName <String>]
: Contains a friendly name for the skill.[Proficiency <String>]
: skillProficiencyLevel[ThumbnailUrl <String>]
:[WebUrl <String>]
: Contains a link to an information source about the skill.
[WebAccounts <IMicrosoftGraphWebAccount-
[]>]
: Represents web accounts the user has indicated they use or has added to their user profile.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Description <String>]
: Contains the description the user has provided for the account on the service being referenced.[Service <IMicrosoftGraphServiceInformation>]
: serviceInformation[(Any) <Object>]
: This indicates any property can be added to this object.[Name <String>]
: The name of the cloud service (for example, Twitter, Instagram).[WebUrl <String>]
: Contains the URL for the service being referenced.
[StatusMessage <String>]
: Contains a status message from the cloud service if provided or synchronized.[ThumbnailUrl <String>]
:[UserId <String>]
: The user name displayed for the webaccount.[WebUrl <String>]
: Contains a link to the user's profile on the cloud service if one exists.
[Websites <IMicrosoftGraphPersonWebsite-
[]>]
: Represents detailed information about websites associated with a user in various services.[AllowedAudiences <String>]
: allowedAudiences[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Inference <IMicrosoftGraphInferenceData>]
: inferenceData[IsSearchable <Boolean?>]
:[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[LastModifiedDateTime <DateTime?>]
: Provides the dateTimeOffset for when the entity was created.[Source <IMicrosoftGraphPersonDataSources>]
: personDataSources[Sources <IMicrosoftGraphProfileSourceAnnotation-
[]>]
: Where the values within an entity originated if synced from another source.[Id <String>]
: The unique identifier for an entity. Read-only.[Categories <String-
[]>]
: Contains categories a user has associated with the website (for example, personal, recipes).[Description <String>]
: Contains a description of the website.[DisplayName <String>]
: Contains a friendly name for the website.[ThumbnailUrl <String>]
:[WebUrl <String>]
: Contains a link to the website itself.
PROVISIONEDPLANS <IMicrosoftGraphProvisionedPlan- []
>: The plans that are provisioned for the user.
Read-only.
Not nullable.
Supports $filter (eq, not, ge, le).
[CapabilityStatus <String>]
: For example, 'Enabled'.[ProvisioningStatus <String>]
: For example, 'Success'.[Service <String>]
: The name of the service; for example, 'AccessControlS2S'
REGISTEREDDEVICES <IMicrosoftGraphDirectoryObject- []
>: Devices that are registered for the user.
Read-only.
Nullable.
Supports $expand and returns up to 100 objects.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
SCOPEDROLEMEMBEROF <IMicrosoftGraphScopedRoleMembership- []
>: The scoped-role administrative unit memberships for this user.
Read-only.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[AdministrativeUnitId <String>]
: Unique identifier for the administrative unit that the directory role is scoped to[RoleId <String>]
: Unique identifier for the directory role that the member is in.[RoleMemberInfo <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
SECURITY <IMicrosoftGraphSecurity>
: security
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[InformationProtection <IMicrosoftGraphSecurityInformationProtection>]
: informationProtection[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[LabelPolicySettings <IMicrosoftGraphSecurityInformationProtectionPolicySetting>]
: informationProtectionPolicySetting[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DefaultLabelId <String>]
:[IsDowngradeJustificationRequired <Boolean?>]
: Exposes whether justification input is required on label downgrade.[IsMandatory <Boolean?>]
: Exposes whether mandatory labeling is enabled.[MoreInfoUrl <String>]
: Exposes the more information URL that can be configured by the administrator.
[SensitivityLabels <IMicrosoftGraphSecuritySensitivityLabel-
[]>]
: Read the Microsoft Purview Information Protection labels for the user or organization.[Id <String>]
: The unique identifier for an entity. Read-only.[Color <String>]
: The color that the UI should display for the label, if configured.[ContentFormats <String-
[]>]
: Returns the supported content formats for the label.[Description <String>]
: The admin-defined description for the label.[HasProtection <Boolean?>]
: Indicates whether the label has protection actions configured.[IsActive <Boolean?>]
: Indicates whether the label is active or not. Active labels should be hidden or disabled in the UI.[IsAppliable <Boolean?>]
: Indicates whether the label can be applied to content. False if the label is a parent with child labels.[Name <String>]
: The plaintext name of the label.[Parent <IMicrosoftGraphSecuritySensitivityLabel>]
: sensitivityLabel[Sensitivity <Int32?>]
: The sensitivity value of the label, where lower is less sensitive.[Tooltip <String>]
: The tooltip that should be displayed for the label in a UI.
SERVICEPROVISIONINGERRORS <IMicrosoftGraphServiceProvisioningError- []
>: Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object.
[CreatedDateTime <DateTime?>]
: The date and time at which the error occurred.[IsResolved <Boolean?>]
: Indicates whether the Error has been attended to.[ServiceInstance <String>]
: Qualified service instance (for example, 'SharePoint/Dublin') that published the service error information.
SETTINGS <IMicrosoftGraphUserSettings>
: userSettings
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ContactMergeSuggestions <IMicrosoftGraphContactMergeSuggestions>]
: contactMergeSuggestions[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsEnabled <Boolean?>]
: true if the duplicate contact merge suggestions feature is enabled for the user; false if the feature is disabled. Default value is true.
[ContributionToContentDiscoveryAsOrganizationDisabled <Boolean?>]
: 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 <Boolean?>]
: When set to true, documents in the user's Office Delve are disabled. Users can control this setting in Office Delve.[ItemInsights <IMicrosoftGraphUserInsightsSettings>]
: userInsightsSettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[IsEnabled <Boolean?>]
: True if the user's itemInsights and meeting hours insights are enabled; false if the user's itemInsights and meeting hours insights are disabled. The default value is true. Optional.
[RegionalAndLanguageSettings <IMicrosoftGraphRegionalAndLanguageSettings>]
: regionalAndLanguageSettings[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AuthoringLanguages <IMicrosoftGraphLocaleInfo-
[]>]
: Prioritized list of languages the user reads and authors in.Returned by default. Not nullable.[DisplayName <String>]
: A name representing the user's locale in natural language, for example, 'English (United States)'.[Locale <String>]
: 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.
[DefaultDisplayLanguage <IMicrosoftGraphLocaleInfo>]
: localeInfo[DefaultRegionalFormat <IMicrosoftGraphLocaleInfo>]
: localeInfo[DefaultSpeechInputLanguage <IMicrosoftGraphLocaleInfo>]
: localeInfo[DefaultTranslationLanguage <IMicrosoftGraphLocaleInfo>]
: localeInfo[RegionalFormatOverrides <IMicrosoftGraphRegionalFormatOverrides>]
: regionalFormatOverrides[(Any) <Object>]
: This indicates any property can be added to this object.[Calendar <String>]
: The calendar to use, e.g., Gregorian Calendar.Returned by default.[FirstDayOfWeek <String>]
: The first day of the week to use, e.g., Sunday.Returned by default.[LongDateFormat <String>]
: The long date time format to be used for displaying dates.Returned by default.[LongTimeFormat <String>]
: The long time format to be used for displaying time.Returned by default.[ShortDateFormat <String>]
: The short date time format to be used for displaying dates.Returned by default.[ShortTimeFormat <String>]
: The short time format to be used for displaying time.Returned by default.[TimeZone <String>]
: The timezone to be used for displaying time.Returned by default.
[TranslationPreferences <IMicrosoftGraphTranslationPreferences>]
: translationPreferences[(Any) <Object>]
: This indicates any property can be added to this object.[LanguageOverrides <IMicrosoftGraphTranslationLanguageOverride-
[]>]
: Translation override behavior for languages, if any.Returned by default.[LanguageTag <String>]
: The language to apply the override.Returned by default. Not nullable.[TranslationBehavior <String>]
: translationBehavior
[TranslationBehavior <String>]
: translationBehavior[UntranslatedLanguages <String-
[]>]
: The list of languages the user does not need translated. This is computed from the authoringLanguages collection in regionalAndLanguageSettings, and the languageOverrides collection in translationPreferences. The list specifies neutral culture values that include the language code without any country or region association. For example, it would specify 'fr' for the neutral French culture, but not 'fr-FR' for the French culture in France. Returned by default. Read only.
[ShiftPreferences <IMicrosoftGraphShiftPreferences>]
: shiftPreferences[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet[Id <String>]
: The unique identifier for an entity. Read-only.[Availability <IMicrosoftGraphShiftAvailability-
[]>]
: Availability of the user to be scheduled for work and its recurrence pattern.[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[TimeSlots <IMicrosoftGraphTimeRange-
[]>]
: The time slot(s) preferred by the user.[EndTime <String>]
: End time for the time range.[StartTime <String>]
: Start time for the time range.
[TimeZone <String>]
: Specifies the time zone for the indicated time.
[Storage <IMicrosoftGraphUserStorage>]
: userStorage[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Quota <IMicrosoftGraphUnifiedStorageQuota>]
: unifiedStorageQuota[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Deleted <Int64?>]
:[ManageWebUrl <String>]
: A URL that can be used in a browser to manage the breakdown. Read-only.[Remaining <Int64?>]
: Total space remaining before reaching the quota limit in bytes.[Services <IMicrosoftGraphServiceStorageQuotaBreakdown-
[]>]
: The breakdown of services contributing to the user's quota usage.[DisplayName <String>]
:[ManageWebUrl <String>]
:[Used <Int64?>]
:[Id <String>]
: The unique identifier for an entity. Read-only.
[State <String>]
: Indicates the state of the storage space. The possible values are: normal, nearing, critical, full, and overLimit.[Total <Int64?>]
: Total allowed storage space in bytes.[Used <Int64?>]
: Total space used in bytes.
[Windows <IMicrosoftGraphWindowsSetting-
[]>]
: The Windows settings of the user stored in the cloud.[Id <String>]
: The unique identifier for an entity. Read-only.[Instances <IMicrosoftGraphWindowsSettingInstance-
[]>]
: A collection of setting values for a given windowsSetting.[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Set by the server. Represents the dateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. The object expires at the specified dateTime in UTC, making it unavailable after that time.[LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the request from the Windows client device. Refers to the user's Windows device that modified the object at the specified dateTime in UTC.[Payload <String>]
: Base64-encoded JSON setting value.
[PayloadType <String>]
: The type of setting payloads contained in the instances navigation property.[SettingType <String>]
: windowsSettingType[WindowsDeviceId <String>]
: A unique identifier for the device the setting might belong to if it is of the settingType backup.
SIGNINACTIVITY <IMicrosoftGraphSignInActivity>
: signInActivity
[(Any) <Object>]
: This indicates any property can be added to this object.[LastNonInteractiveSignInDateTime <DateTime?>]
: The last non-interactive sign-in date for a specific user. You can use this field to calculate the last time a client attempted (either successfully or unsuccessfully) to sign in to 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 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. 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.[LastNonInteractiveSignInRequestId <String>]
: Request identifier of the last non-interactive sign-in performed by this user.[LastSignInDateTime <DateTime?>]
: 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 (either successfully or unsuccessfully) to sign in to the directory the directory with an interactive authentication method. This field can be used to build reports, such as inactive users. 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. 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.[LastSignInRequestId <String>]
: Request identifier of the last interactive sign-in performed by this user.[LastSuccessfulSignInDateTime <DateTime?>]
: The date and time of the user's most recent successful sign-in activity. 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.[LastSuccessfulSignInRequestId <String>]
: The request ID of the last successful sign-in.
SOLUTIONS <IMicrosoftGraphUserSolutionRoot>
: userSolutionRoot
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[WorkingTimeSchedule <IMicrosoftGraphWorkingTimeSchedule>]
: workingTimeSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.
SPONSORS <IMicrosoftGraphDirectoryObject- []
>: 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.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
TEAMWORK <IMicrosoftGraphUserTeamwork>
: userTeamwork
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AssociatedTeams <IMicrosoftGraphAssociatedTeamInfo-
[]>]
: The list of associatedTeamInfo objects that a user is associated with.[DisplayName <String>]
: The name of the team.[Team <IMicrosoftGraphTeam>]
: team[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AllChannels <IMicrosoftGraphChannel-
[]>]
: List of channels either hosted in or shared with the team (incoming channels).[Id <String>]
: The unique identifier for an entity. Read-only.[CreatedDateTime <DateTime?>]
: Read only. Timestamp at which the channel was created.[Description <String>]
: Optional textual description for the channel.[DisplayName <String>]
: Channel name as it appears to the user in Microsoft Teams. The maximum length is 50 characters.[Email <String>]
: The email address for sending messages to the channel. Read-only.[FilesFolder <IMicrosoftGraphDriveItem>]
: driveItem[(Any) <Object>]
: This indicates any property can be added to this object.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity
[CreatedByUser <IMicrosoftGraphUser>]
: user[(Any) <Object>]
: This indicates any property can be added to this object.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AboutMe <String>]
: A freeform text entry field for users to describe themselves. Returned only on $select.[AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter (eq, ne, not, and in).[Activities <IMicrosoftGraphUserActivity-
[]>]
: The user's activities across devices. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivationUrl <String>]
: 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 <String>]
: 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 <String>]
: Required. The unique activity ID in the context of the app - supplied by caller and immutable thereafter.[AppDisplayName <String>]
: 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.[ContentInfo <IMicrosoftGraphJson>]
: Json[(Any) <Object>]
: This indicates any property can be added to this object.
[ContentUrl <String>]
: 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).[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object expired on the server.[FallbackUrl <String>]
: Optional. URL used to launch the activity in a web-based app, if available.[HistoryItems <IMicrosoftGraphActivityHistoryItem-
[]>]
: Optional. NavigationProperty/Containment; navigation property to the activity's activityHistoryItems.[Id <String>]
: The unique identifier for an entity. Read-only.[ActiveDurationSeconds <Int32?>]
: Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.[Activity <IMicrosoftGraphUserActivity>]
: userActivity[CreatedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was created on the server.[ExpirationDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem will undergo hard-delete. Can be set by the client.[LastActiveDateTime <DateTime?>]
: Optional. UTC DateTime when the activityHistoryItem (activity session) was last understood as active or finished - if null, activityHistoryItem status should be Ongoing.[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[StartedDateTime <DateTime?>]
: Required. UTC DateTime when the activityHistoryItem (activity session) was started. Required for timeline history.[Status <String>]
: status[UserTimezone <String>]
: 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.
[LastModifiedDateTime <DateTime?>]
: Set by the server. DateTime in UTC when the object was modified on the server.[Status <String>]
: status[UserTimezone <String>]
: 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.[VisualElements <IMicrosoftGraphVisualInfo>]
: visualInfo[(Any) <Object>]
: This indicates any property can be added to this object.[Attribution <IMicrosoftGraphImageInfo>]
: imageInfo[(Any) <Object>]
: This indicates any property can be added to this object.[AddImageQuery <Boolean?>]
: Optional; parameter used to indicate the server is able to render image dynamically in response to parameterization. For example - a high contrast image[AlternateText <String>]
: Optional; alt-text accessible content for the image[AlternativeText <String>]
:[IconUrl <String>]
: Optional; URI that points to an icon which represents the application used to generate the activity
[BackgroundColor <String>]
: 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[Content <IMicrosoftGraphJson>]
: Json[Description <String>]
: Optional. Longer text description of the user's unique activity (example: document name, first sentence, and/or metadata)[DisplayText <String>]
: Required. Short text description of the user's unique activity (for example, document name in cases where an activity refers to document creation)
[AgeGroup <String>]
: 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).[AgreementAcceptances <IMicrosoftGraphAgreementAcceptance-
[]>]
: The user's terms of use acceptance statuses. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AgreementFileId <String>]
: ID of the agreement file accepted by the user.[AgreementId <String>]
: ID of the agreement.[DeviceDisplayName <String>]
: The display name of the device used for accepting the agreement.[DeviceId <String>]
: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.[DeviceOSType <String>]
: The operating system used for accepting the agreement.[DeviceOSVersion <String>]
: The operating system version of the device used for accepting the agreement.[ExpirationDateTime <DateTime?>]
: 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.[RecordedDateTime <DateTime?>]
: 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.[State <String>]
: agreementAcceptanceState[UserDisplayName <String>]
: Display name of the user when the acceptance was recorded.[UserEmail <String>]
: Email of the user when the acceptance was recorded.[UserId <String>]
: ID of the user who accepted the agreement. Supports $filter (eq).[UserPrincipalName <String>]
: UPN of the user when the acceptance was recorded.
[Analytics <IMicrosoftGraphUserAnalytics>]
: userAnalytics[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[ActivityStatistics <IMicrosoftGraphActivityStatistics-
[]>]
: The collection of work activities that a user spent time on during and outside of working hours. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[Activity <String>]
: analyticsActivityType[Duration <TimeSpan?>]
: Total hours spent on the activity. The value is represented in ISO 8601 format for durations.[EndDate <DateTime?>]
: Date when the activity ended, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-03' that follows the YYYY-MM-DD format.[StartDate <DateTime?>]
: Date when the activity started, expressed in ISO 8601 format for calendar dates. For example, the property value could be '2019-07-04' that follows the YYYY-MM-DD format.[TimeZoneUsed <String>]
: The time zone that the user sets in Microsoft Outlook is used for the computation. For example, the property value could be 'Pacific Standard Time.'
[Settings <IMicrosoftGraphSettings>]
: settings[(Any) <Object>]
: This indicates any property can be added to this object.[HasGraphMailbox <Boolean?>]
: Specifies if the user's primary mailbox is hosted in the cloud and is enabled for Microsoft Graph.[HasLicense <Boolean?>]
: Specifies if the user has a MyAnalytics license assigned.[HasOptedOut <Boolean?>]
: Specifies if the user opted out of MyAnalytics.
[AppConsentRequestsForApproval <IMicrosoftGraphAppConsentRequest-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[AppDisplayName <String>]
: The display name of the app for which consent is requested. Required. Supports $filter (eq only) and $orderby.[AppId <String>]
: The identifier of the application. Required. Supports $filter (eq only) and $orderby.[ConsentType <String>]
: 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.[PendingScopes <IMicrosoftGraphAppConsentRequestScope-
[]>]
: A list of pending scopes waiting for approval. This is empty if the consentType is Static. Required.[DisplayName <String>]
: The name of the scope.
[UserConsentRequests <IMicrosoftGraphUserConsentRequest-
[]>]
: A list of pending user consent requests. Supports $filter (eq).[ApprovalId <String>]
: The identifier of the approval of the request.[CompletedDateTime <DateTime?>]
: The request completion date time.[CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet[CreatedDateTime <DateTime?>]
: The request creation date time.[CustomData <String>]
: Free text field to define any custom data for the request. Not used.[Status <String>]
: 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.[Id <String>]
: The unique identifier for an entity. Read-only.[Approval <IMicrosoftGraphApproval>]
: approval[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Steps <IMicrosoftGraphApprovalStep-
[]>]
: Used to represent the decision associated with a single step in the approval process configured in approvalStage.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignedToMe <Boolean?>]
: Indicates whether the step is assigned to the calling user to review. Read-only.[DisplayName <String>]
: The label provided by the policy creator to identify an approval step. Read-only.[Justification <String>]
: The justification associated with the approval step decision.[ReviewResult <String>]
: The result of this approval record. Possible values include: NotReviewed, Approved, Denied.[ReviewedBy <IMicrosoftGraphIdentity>]
: identity[ReviewedDateTime <DateTime?>]
: 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.[Status <String>]
: The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only.
[Reason <String>]
: The user's justification for requiring access to the app. Supports $filter (eq only) and $orderby.
[AppRoleAssignedResources <IMicrosoftGraphServicePrincipal-
[]>]
:[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AccountEnabled <Boolean?>]
: true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in).[AddIns <IMicrosoftGraphAddIn-
[]>]
: Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its 'FileHandler' functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on.[Id <String>]
: The unique identifier for the addIn object.[Properties <IMicrosoftGraphKeyValue-
[]>]
: The collection of key-value pairs that define parameters that the consuming service can use or call. You must specify this property when performing a POST or a PATCH operation on the addIns collection. Required.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[Type <String>]
: The unique name for the functionality exposed by the app.
[AlternativeNames <String-
[]>]
: Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith).[AppDescription <String>]
: The description exposed by the associated application.[AppDisplayName <String>]
: The display name exposed by the associated application.[AppId <String>]
: The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith).[AppManagementPolicies <IMicrosoftGraphAppManagementPolicy-
[]>]
: The appManagementPolicy applied to this service principal.[Description <String>]
: Description for this policy. Required.[DisplayName <String>]
: Display name for this policy. Required.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]
: The unique identifier for an entity. Read-only.[AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
: Collection of application and service principals to which a policy is applied.[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[IsEnabled <Boolean?>]
: Denotes whether the policy is enabled.[Restrictions <IMicrosoftGraphCustomAppManagementConfiguration>]
: customAppManagementConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[KeyCredentials <IMicrosoftGraphKeyCredentialConfiguration-
[]>]
: Collection of certificate restrictions settings to be applied to an application or service principal.[CertificateBasedApplicationConfigurationIds <String-
[]>]
: Collection of GUIDs that represent certificateBasedApplicationConfiguration that is allowed as root and intermediate certificate authorities.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to keyLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appKeyCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[PasswordCredentials <IMicrosoftGraphPasswordCredentialConfiguration-
[]>]
: Collection of password restrictions settings to be applied to an application or service principal.[MaxLifetime <TimeSpan?>]
: String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, P4DT12H30M5S represents four days, 12 hours, 30 minutes, and five seconds. This property is required when restrictionType is set to passwordLifetime.[RestrictForAppsCreatedAfterDateTime <DateTime?>]
: Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.[RestrictionType <String>]
: appCredentialRestrictionType[State <String>]
: appManagementRestrictionState
[AppOwnerOrganizationId <String>]
: Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).[AppRoleAssignedTo <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignments for this app or service, granted to users, groups, and other service principals.Supports $expand.[Id <String>]
: The unique identifier for an entity. Read-only.[AppRoleId <String>]
: The identifier (id) for the app role that is assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create.[CreationTimestamp <DateTime?>]
: The time when the app role assignment 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.[PrincipalDisplayName <String>]
: The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith).[PrincipalId <String>]
: The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create.[PrincipalType <String>]
: The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only.[ResourceDisplayName <String>]
: The display name of the resource app's service principal to which the assignment is made.[ResourceId <String>]
: The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. Supports $filter (eq only).
[AppRoleAssignmentRequired <Boolean?>]
: Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT).[AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: App role assignment for another app or service, granted to this service principal. Supports $expand.[AppRoles <IMicrosoftGraphAppRole-
[]>]
: The roles exposed by the application, which this service principal represents. For more information, see the appRoles property definition on the application entity. Not nullable.[AllowedMemberTypes <String-
[]>]
: Specifies whether this app role can be assigned to users and groups (by setting to -['User']
), to other application's (by setting to -['Application']
, or both (by setting to -['User', 'Application']
). App roles supporting assignment to other applications' service principals are also known as application permissions. The 'Application' value is only supported for app roles defined on application entities.[Description <String>]
: The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences.[DisplayName <String>]
: Display name for the permission that appears in the app role assignment and consent experiences.[Id <String>]
: Unique role identifier inside the appRoles collection. You must specify a new GUID identifier when you create a new app role.[IsEnabled <Boolean?>]
: When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed.[Origin <String>]
: Specifies if the app role is defined on the application object or on the servicePrincipal entity. Must not be included in any POST or PATCH requests. Read-only.[Value <String>]
: Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [ApplicationTemplateId <String>]
: Unique identifier of the applicationTemplate.
Supports $filter (eq, not, ne).
Read-only.
null if the app wasn't created from an application template.
- [ClaimsMappingPolicies <IMicrosoftGraphClaimsMappingPolicy-
[]>]
: The claimsMappingPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClaimsPolicy <IMicrosoftGraphCustomClaimsPolicy>]
: customClaimsPolicy
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AudienceOverride <String>]
: If specified, it overrides the content of the audience claim for WS-Federation and SAML2 protocols.
A custom signing key must be used for audienceOverride to be applied, otherwise, the audienceOverride value is ignored.
The value provided must be in the format of an absolute URI.
- [Claims <IMicrosoftGraphCustomClaimBase-
[]>]
: Defines which claims are present in the tokens affected by the policy, in addition to the basic claim and the core claim set.
Inherited from customclaimbase.
- [Configurations <IMicrosoftGraphCustomClaimConfiguration-
[]>]
: One or more configurations that describe how the claim is sourced and under what conditions.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Condition <IMicrosoftGraphCustomClaimConditionBase>]
: customClaimConditionBase
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Transformations <IMicrosoftGraphCustomClaimTransformation-
[]>]
: An ordered list of transformations that are applied in sequence.
- [Input <IMicrosoftGraphTransformationAttribute>]
: transformationAttribute
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Attribute <IMicrosoftGraphCustomClaimAttributeBase>]
: customClaimAttributeBase
- [TreatAsMultiValue <Boolean?>]
: This flag is only relevant in the case where the attribute is multivalued.
By default, transformations are only applied to the first element in a multi-valued claim, however setting this flag to true ensures the transformation is applied to all values, resulting in a multivalued output.
- [IncludeApplicationIdInIssuer <Boolean?>]
: Indicates whether the application ID is added to the claim.
It is relevant only for SAML2.0 and if a custom signing key is used.
the default value is true.
Optional.
- [IncludeBasicClaimSet <Boolean?>]
: Determines whether the basic claim set is included in tokens affected by this policy.
If set to true, all claims in the basic claim set are emitted in tokens affected by the policy.
By default the basic claim set isn't in the tokens unless they're explicitly configured in this policy.
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects created by this service principal.
Read-only.
Nullable.
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DelegatedPermissionClassifications <IMicrosoftGraphDelegatedPermissionClassification-
[]>]
: The permission classifications for delegated permissions exposed by the app that this service principal represents.
Supports $expand.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Classification <String>]
: permissionClassificationType
- [PermissionId <String>]
: The unique identifier (id) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Required on create.
Doesn't support $filter.
- [PermissionName <String>]
: The claim value (value) for the delegated permission listed in the publishedPermissionScopes collection of the servicePrincipal.
Doesn't support $filter.
- [Description <String>]
: Free text field to provide an internal end-user facing description of the service principal.
End-user portals such MyApps displays the application description in this field.
The maximum allowed size is 1,024 characters.
Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
- [DisabledByMicrosoftStatus <String>]
: Specifies whether Microsoft has disabled the registered application.
Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).
Supports $filter (eq, ne, not).
- [DisplayName <String>]
: The display name for the service principal.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [Endpoints <IMicrosoftGraphEndpoint-
[]>]
: Endpoints available for discovery.
Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Capability <String>]
: Describes the capability that is associated with this resource.
(for example, Messages, Conversations, etc.) Not nullable.
Read-only.
- [ProviderId <String>]
: Application id of the publishing underlying service.
Not nullable.
Read-only.
- [ProviderName <String>]
: Name of the publishing underlying service.
Read-only.
- [ProviderResourceId <String>]
: For Microsoft 365 groups, this is set to a well-known name for the resource (for example, Yammer.FeedURL etc.).
Not nullable.
Read-only.
- [Uri <String>]
: URL of the published resource.
Not nullable.
Read-only.
- [ErrorUrl <String>]
: Deprecated.
Don't use.
- [FederatedIdentityCredentials <IMicrosoftGraphFederatedIdentityCredential-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audiences <String-
[]>]
: The audience that can appear in the external token.
This field is mandatory and should be set to api://AzureADTokenExchange for Microsoft Entra ID.
It says what Microsoft identity platform should accept in the aud claim in the incoming token.
This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token.
This field can only accept a single value and has a limit of 600 characters.
Required.
- [Description <String>]
: The un-validated, user-provided description of the federated identity credential.
It has a limit of 600 characters.
Optional.
- [Issuer <String>]
: The URL of the external identity provider and must match the issuer claim of the external token being exchanged.
The combination of the values of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Required.
- [Name <String>]
: The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly.
It is immutable once created.
Alternate key.
Required.
Not nullable.
Supports $filter (eq).
- [Subject <String>]
: Required.
The identifier of the external software workload within the external identity provider.
Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings.
The value here must match the sub claim within the token presented to Microsoft Entra ID.
The combination of issuer and subject must be unique on the app.
It has a limit of 600 characters.
Supports $filter (eq).
- [HomeRealmDiscoveryPolicies <IMicrosoftGraphHomeRealmDiscoveryPolicy-
[]>]
: The homeRealmDiscoveryPolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Homepage <String>]
: Home page or landing page of the application.
- [Info <IMicrosoftGraphInformationalUrl>]
: informationalUrl
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LogoUrl <String>]
: CDN URL to the application's logo, Read-only.
- [MarketingUrl <String>]
: Link to the application's marketing page.
For example, https://www.contoso.com/app/marketing
- [PrivacyStatementUrl <String>]
: Link to the application's privacy statement.
For example, https://www.contoso.com/app/privacy
- [SupportUrl <String>]
: Link to the application's support page.
For example, https://www.contoso.com/app/support
- [TermsOfServiceUrl <String>]
: Link to the application's terms of service statement.
For example, https://www.contoso.com/app/termsofservice
- [KeyCredentials <IMicrosoftGraphKeyCredential-
[]>]
: The collection of key credentials associated with the service principal.
Not nullable.
Supports $filter (eq, not, ge, le).
- [CustomKeyIdentifier <Byte-
[]>]
: A 40-character binary type that can be used to identify the credential.
Optional.
When not provided in the payload, defaults to the thumbprint of the certificate.
- [DisplayName <String>]
: Friendly name for the key.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the credential expires.
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.
- [Key <Byte-
[]>]
: Value for the key credential.
Should be a Base64 encoded value.
Returned only on $select for a single object, that is, GET applications/{applicationId}?$select=keyCredentials or GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials; otherwise, it is always null.
From a .cer certificate, you can read the key using the Convert.ToBase64String() method.
For more information, see Get the certificate key.
- [KeyId <String>]
: The unique identifier for the key.
- [StartDateTime <DateTime?>]
: The date and time at which the credential becomes valid.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.
- [Type <String>]
: The type of key credential; for example, Symmetric, AsymmetricX509Cert, or X509CertAndPassword.
- [Usage <String>]
: A string that describes the purpose for which the key can be used; for example, None​, Verify​, PairwiseIdentifier​, Delegation​, Decrypt​, Encrypt​, HashedIdentifier​, SelfSignedTls, or Sign.
If usage is Sign​, the type should be X509CertAndPassword​, and the passwordCredentials​ for signing should be defined.
- [LicenseDetails <IMicrosoftGraphLicenseDetails-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ServicePlans <IMicrosoftGraphServicePlanInfo-
[]>]
: Information about the service plans assigned with the license.
Read-only.
Not nullable.
- [AppliesTo <String>]
: 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.
- [ProvisioningStatus <String>]
: 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.
- [ServicePlanId <String>]
: The unique identifier of the service plan.
- [ServicePlanName <String>]
: The name of the service plan.
- [SkuId <String>]
: Unique identifier (GUID) for the service SKU.
Equal to the skuId property on the related subscribedSku object.
Read-only.
- [SkuPartNumber <String>]
: Unique SKU display name.
Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium.
Read-only.
- [LoginUrl <String>]
: Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate.
Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps.
When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on.
The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL.
- [LogoutUrl <String>]
: Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenId Connect front-channel, back-channel, or SAML sign out protocols.
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Roles that this service principal is a member of.
HTTP Methods: GET Read-only.
Nullable.
Supports $expand.
- [Notes <String>]
: Free text field to capture information about the service principal, typically used for operational purposes.
Maximum allowed size is 1,024 characters.
- [NotificationEmailAddresses <String-
[]>]
: Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date.
This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.
- [Oauth2PermissionGrants <IMicrosoftGraphOAuth2PermissionGrant-
[]>]
: Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientId <String>]
: The object id (not appId) of the client service principal for the application that is authorized to act on behalf of a signed-in user when accessing an API.
Required.
Supports $filter (eq only).
- [ConsentType <String>]
: Indicates whether authorization is granted for the client application to impersonate all users or only a specific user.
AllPrincipals indicates authorization to impersonate all users.
Principal indicates authorization to impersonate a specific user.
Consent on behalf of all users can be granted by an administrator.
Nonadmin users may be authorized to consent on behalf of themselves in some cases, for some delegated permissions.
Required.
Supports $filter (eq only).
- [ExpiryTime <DateTime?>]
: Currently, the end time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [PrincipalId <String>]
: The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal.
If consentType is AllPrincipals this value is null.
Required when consentType is Principal.
Supports $filter (eq only).
- [ResourceId <String>]
: The id of the resource service principal to which access is authorized.
This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user.
Supports $filter (eq only).
- [Scope <String>]
: A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API).
For example, openid User.Read GroupMember.Read.All.
Each claim value should match the value field of one of the delegated permissions defined by the API, listed in the publishedPermissionScopes property of the resource service principal.
Must not exceed 3850 characters in length.
- [StartTime <DateTime?>]
: Currently, the start time value is ignored, but a value is required when creating an oAuth2PermissionGrant.
Required.
- [OwnedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owned by this service principal.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [Owners <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that are owners of this servicePrincipal.
The owners are a set of nonadmin users or servicePrincipals who are allowed to modify this object.
Read-only.
Nullable.
Supports $expand and $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
- [PasswordCredentials <IMicrosoftGraphPasswordCredential-
[]>]
: The collection of password credentials associated with the service principal.
Not nullable.
- [CustomKeyIdentifier <Byte-
[]>]
: Do not use.
- [DisplayName <String>]
: Friendly name for the password.
Optional.
- [EndDateTime <DateTime?>]
: The date and time at which the password expires represented using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Optional.
- [Hint <String>]
: Contains the first three characters of the password.
Read-only.
- [KeyId <String>]
: The unique identifier for the password.
- [SecretText <String>]
: Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length.
The generated password value is only returned during the initial POST request to addPassword.
There is no way to retrieve this password in the future.
- [StartDateTime <DateTime?>]
: The date and time at which the password becomes valid.
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.
Optional.
- [PasswordSingleSignOnSettings <IMicrosoftGraphPasswordSingleSignOnSettings>]
: passwordSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Fields <IMicrosoftGraphPasswordSingleSignOnField-
[]>]
: The fields to capture to fill the user credentials for password-based single sign-on.
- [CustomizedLabel <String>]
: Title/label override for customization.
- [DefaultLabel <String>]
: Label that would be used if no customizedLabel is provided.
Read only.
- [FieldId <String>]
: Id used to identity the field type.
This is an internal ID and possible values are param1, param2, paramuserName, parampassword.
- [Type <String>]
: Type of the credential.
The values can be text, password.
- [PermissionGrantPreApprovalPolicies <IMicrosoftGraphPermissionGrantPreApprovalPolicy-
[]>]
:
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Conditions <IMicrosoftGraphPreApprovalDetail-
[]>]
: A list of condition sets describing the conditions under which the permission to grant consent for the app has been preapproved.
- [Permissions <IMicrosoftGraphPreApprovedPermissions>]
: preApprovedPermissions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionKind <String>]
: permissionKind
- [PermissionType <String>]
: permissionType
- [ScopeType <String>]
: resourceScopeType
- [SensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]
: scopeSensitivityLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [LabelKind <String>]
: labelKind
- [PreferredSingleSignOnMode <String>]
: 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.
Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically.
- [PreferredTokenSigningKeyEndDateTime <DateTime?>]
: Specifies the expiration date of the keyCredential used for token signing, marked by preferredTokenSigningKeyThumbprint.
Updating this attribute isn't currently supported.
For details, see ServicePrincipal property differences.
- [PreferredTokenSigningKeyThumbprint <String>]
: This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses.
For applications that aren't SAML, don't write or otherwise rely on this property.
- [PublishedPermissionScopes <IMicrosoftGraphPermissionScope-
[]>]
: The delegated permissions exposed by the application.
For more information, see the oauth2PermissionScopes property on the application entity's api property.
Not nullable.
Note: This property is named oauth2PermissionScopes in v1.0.
- [AdminConsentDescription <String>]
: A description of the delegated permissions, intended to be read by an administrator granting the permission on behalf of all users.
This text appears in tenant-wide admin consent experiences.
- [AdminConsentDisplayName <String>]
: The permission's title, intended to be read by an administrator granting the permission on behalf of all users.
- [Id <String>]
: Unique delegated permission identifier inside the collection of delegated permissions defined for a resource application.
- [IsEnabled <Boolean?>]
: When you create or update a permission, this property must be set to true (which is the default).
To delete a permission, this property must first be set to false.
At that point, in a subsequent call, the permission may be removed.
- [Origin <String>]
:
- [Type <String>]
: The possible values are: User and Admin.
Specifies whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator consent should always be required.
While Microsoft Graph defines the default consent requirement for each permission, the tenant administrator may override the behavior in their organization (by allowing, restricting, or limiting user consent to this delegated permission).
For more information, see Configure how users consent to applications.
- [UserConsentDescription <String>]
: A description of the delegated permissions, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [UserConsentDisplayName <String>]
: A title for the permission, intended to be read by a user granting the permission on their own behalf.
This text appears in consent experiences where the user is consenting only on behalf of themselves.
- [Value <String>]
: Specifies the value to include in the scp (scope) claim in access tokens.
Must not exceed 120 characters in length.
Allowed characters are : ! # $ % & ' ( ) * + , - . / : ; = ? @ [ ] ^ + _ { } ~, and characters in the ranges
@ - [ ]
^ + _ { } ~, and characters in the ranges 0-9, A-Z and a-z.
Any other character, including the space character, aren't allowed.
May not begin with ..
- [PublisherName <String>]
: The name of the Microsoft Entra tenant that published the application.
- [RemoteDesktopSecurityConfiguration <IMicrosoftGraphRemoteDesktopSecurityConfiguration>]
: remoteDesktopSecurityConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsRemoteDesktopProtocolEnabled <Boolean?>]
: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
- [TargetDeviceGroups <IMicrosoftGraphTargetDeviceGroup-
[]>]
: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name for the target device group.
- [ReplyUrls <String-
[]>]
: The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application.
Not nullable.
- [SamlMetadataUrl <String>]
: The url where the service exposes SAML metadata for federation.
- [SamlSingleSignOnSettings <IMicrosoftGraphSamlSingleSignOnSettings>]
: samlSingleSignOnSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [RelayState <String>]
: The relative URI the service provider would redirect to after completion of the single sign-on flow.
- [ServicePrincipalNames <String-
[]>]
: Contains the list of identifiersUris, copied over from the associated application.
More values can be added to hybrid applications.
These values can be used to identify the permissions exposed by this app within Microsoft Entra ID.
For example,Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued properties.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith).
- [ServicePrincipalType <String>]
: Identifies if the service principal represents an application or a managed identity.
This is set by Microsoft Entra ID internally.
For a service principal that represents an application this is set as Application.
For a service principal that represents a managed identity this is set as ManagedIdentity.
The SocialIdp type is for internal use.
- [SignInAudience <String>]
: Specifies the Microsoft accounts that are supported for the current application.
Read-only.
Supported values are:AzureADMyOrg: Users with a Microsoft work or school account in my organization's Microsoft Entra tenant (single-tenant).AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization's Microsoft Entra tenant (multitenant).AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization's Microsoft Entra tenant.PersonalMicrosoftAccount: Users with a personal Microsoft account only.
- [Synchronization <IMicrosoftGraphSynchronization>]
: synchronization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Jobs <IMicrosoftGraphSynchronizationJob-
[]>]
: Performs synchronization by periodically running in the background, polling for changes in one directory, and pushing them to another directory.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [BulkUpload <IMicrosoftGraphBulkUpload>]
: bulkUpload
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Schedule <IMicrosoftGraphSynchronizationSchedule>]
: synchronizationSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expiration <DateTime?>]
: 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.
- [Interval <TimeSpan?>]
: The interval between synchronization iterations.
The value is represented in ISO 8601 format for durations.
For example, P1M represents a period of one month and PT1M represents a period of one minute.
- [State <String>]
: synchronizationScheduleState
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Directories <IMicrosoftGraphDirectoryDefinition-
[]>]
: Contains the collection of directories and all of their objects.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Discoverabilities <String>]
: directoryDefinitionDiscoverabilities
- [DiscoveryDateTime <DateTime?>]
: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [Name <String>]
: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
- [Objects <IMicrosoftGraphObjectDefinition-
[]>]
: Collection of objects supported by the directory.
- [Attributes <IMicrosoftGraphAttributeDefinition-
[]>]
: Defines attributes of the object.
- [Anchor <Boolean?>]
: true if the attribute should be used as the anchor for the object.
Anchor attributes must have a unique value identifying an object, and must be immutable.
Default is false.
One, and only one, of the object's attributes must be designated as the anchor to support synchronization.
- [ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-
[]>]
:
- [Key <String>]
: Key.
- [Value <String>]
: Value.
- [CaseExact <Boolean?>]
: true if value of this attribute should be treated as case-sensitive.
This setting affects how the synchronization engine detects changes for the attribute.
- [DefaultValue <String>]
: The default value of the attribute.
- [FlowNullValues <Boolean?>]
: 'true' to allow null values for attributes.
- [Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: attributeDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Multivalued <Boolean?>]
: true if an attribute can have multiple values.
Default is false.
- [Mutability <String>]
: mutability
- [Name <String>]
: Name of the attribute.
Must be unique within the object definition.
Not nullable.
- [ReferencedObjects <IMicrosoftGraphReferencedObject-
[]>]
: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).
- [ReferencedObjectName <String>]
: Name of the referenced object.
Must match one of the objects in the directory definition.
- [ReferencedProperty <String>]
: Currently not supported.
Name of the property in the referenced object, the value for which is used as the reference.
- [Required <Boolean?>]
: true if attribute is required.
Object can not be created if any of the required attributes are missing.
If during synchronization, the required attribute has no value, the default value will be used.
If default the value was not set, synchronization will record an error.
- [Type <String>]
: attributeType
- [Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-
[]>]
: Metadata for the given object.
- [Key <String>]
: objectDefinitionMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Name of the object.
Must be unique within a directory definition.
Not nullable.
- [SupportedApis <String-
[]>]
: The API that the provisioning service queries to retrieve data for synchronization.
- [ReadOnly <Boolean?>]
: Whether this object is read-only.
- [Version <String>]
: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
- [SynchronizationRules <IMicrosoftGraphSynchronizationRule-
[]>]
: A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
- [ContainerFilter <IMicrosoftGraphContainerFilter>]
: containerFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedContainers <String-
[]>]
: The identifiers of containers, such as organizational units, that are in scope for a synchronization rule.
For Active Directory organizational units, use the distinguished names.
An empty list means no container filtering is configured.
- [Editable <Boolean?>]
: true if the synchronization rule can be customized; false if this rule is read-only and shouldn't be changed.
- [GroupFilter <IMicrosoftGraphGroupFilter>]
: groupFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IncludedGroups <String-
[]>]
: Identifiers of groups that are in scope for a synchronization rule.
For Active Directory groups, use the distinguished names.
An empty list means no group filtering is configured.
- [Id <String>]
: 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.
- [Metadata <IMicrosoftGraphStringKeyStringValuePair-
[]>]
: Additional extension properties.
Unless instructed explicitly by the support team, metadata values shouldn't be changed.
- [Name <String>]
: Human-readable name of the synchronization rule.
Not nullable.
- [ObjectMappings <IMicrosoftGraphObjectMapping-
[]>]
: Collection of object mappings supported by the rule.
Tells the synchronization engine which objects should be synchronized.
- [AttributeMappings <IMicrosoftGraphAttributeMapping-
[]>]
: Attribute mappings define which attributes to map from the source object into the target object and how they should flow.
A number of functions are available to support the transformation of the original source values.
- [DefaultValue <String>]
: Default value to be used in case the source property was evaluated to null.
Optional.
- [ExportMissingReferences <Boolean?>]
: For internal use only.
- [FlowBehavior <String>]
: attributeFlowBehavior
- [FlowType <String>]
: attributeFlowType
- [MatchingPriority <Int32?>]
: If higher than 0, this attribute will be used to perform an initial match of the objects between source and target directories.
The synchronization engine will try to find the matching object using attribute with lowest value of matching priority first.
If not found, the attribute with the next matching priority will be used, and so on a until match is found or no more matching attributes are left.
Only attributes that are expected to have unique values, such as email, should be used as matching attributes.
- [Source <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Expression <String>]
: Equivalent expression representation of this attributeMappingSource object.
- [Name <String>]
: 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.
- [Parameters <IMicrosoftGraphStringKeyAttributeMappingSourceValuePair-
[]>]
: 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.
- [Key <String>]
: The name of the parameter.
- [Value <IMicrosoftGraphAttributeMappingSource>]
: attributeMappingSource
- [Type <String>]
: attributeMappingSourceType
- [TargetAttributeName <String>]
: Name of the attribute on the target object.
- [Enabled <Boolean?>]
: When true, this object mapping will be processed during synchronization.
When false, this object mapping will be skipped.
- [FlowTypes <String>]
: objectFlowTypes
- [Metadata <IMicrosoftGraphObjectMappingMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values should not be changed.
- [Key <String>]
: objectMappingMetadata
- [Value <String>]
: Value of the metadata property.
- [Name <String>]
: Human-friendly name of the object mapping.
- [Scope <IMicrosoftGraphFilter>]
: filter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CategoryFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to decide whether given object belongs and should be processed as part of this object mapping.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [Clauses <IMicrosoftGraphFilterClause-
[]>]
: Filter clauses (conditions) of this group.
All clauses in a group must be satisfied in order for the filter group to evaluate to true.
- [OperatorName <String>]
: Name of the operator to be applied to the source and target operands.
Must be one of the supported operators.
Supported operators can be discovered.
- [SourceOperandName <String>]
: Name of source operand (the operand being tested).
The source operand name must match one of the attribute names on the source object.
- [TargetOperand <IMicrosoftGraphFilterOperand>]
: filterOperand
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Values <String-
[]>]
: Collection of values.
- [Name <String>]
: Human-readable name of the filter group.
- [Groups <IMicrosoftGraphFilterGroup-
[]>]
: Filter group set used to decide whether given object is in scope for provisioning.
This is the filter which should be used in most cases.
If an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter isn't satisfied any longer, such object will get de-provisioned'.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [InputFilterGroups <IMicrosoftGraphFilterGroup-
[]>]
: Experimental Filter group set used to filter out objects at the early stage of reading them from the directory.
If an object doesn't satisfy this filter, it will not be processed further.
Important to understand is that if an object used to satisfy this filter at a given moment, and then the object or the filter was changed so that filter is no longer satisfied, such object will NOT get de-provisioned.
An object is considered in scope if ANY of the groups in the collection is evaluated to true.
- [SourceObjectName <String>]
: Name of the object in the source directory.
Must match the object name from the source directory definition.
- [TargetObjectName <String>]
: Name of the object in target directory.
Must match the object name from the target directory definition.
- [Priority <Int32?>]
: Priority relative to other rules in the synchronizationSchema.
Rules with the lowest priority number will be processed first.
- [SourceDirectoryName <String>]
: Name of the source directory.
Must match one of the directory definitions in synchronizationSchema.
- [TargetDirectoryName <String>]
: Name of the target directory.
Must match one of the directory definitions in synchronizationSchema.
- [Version <String>]
: The version of the schema, updated automatically with every schema change.
- [Status <IMicrosoftGraphSynchronizationStatus>]
: synchronizationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: synchronizationStatusCode
- [CountSuccessiveCompleteFailures <Int64?>]
: Number of consecutive times this job failed.
- [EscrowsPruned <Boolean?>]
: 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 <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityIdentifier <String>]
: Identifier of the job run.
- [CountEntitled <Int64?>]
: Count of processed entries that were assigned for this application.
- [CountEntitledForProvisioning <Int64?>]
: Count of processed entries that were assigned for provisioning.
- [CountEscrowed <Int64?>]
: Count of entries that were escrowed (errors).
- [CountEscrowedRaw <Int64?>]
: Count of entries that were escrowed, including system-generated escrows.
- [CountExported <Int64?>]
: Count of exported entries.
- [CountExports <Int64?>]
: Count of entries that were expected to be exported.
- [CountImported <Int64?>]
: Count of imported entries.
- [CountImportedDeltas <Int64?>]
: Count of imported delta-changes.
- [CountImportedReferenceDeltas <Int64?>]
: Count of imported delta-changes pertaining to reference changes.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
For example, AzureDirectoryB2BManagementPolicyCheckFailure.
- [Message <String>]
: The error message.
For example, Policy permitting auto-redemption of invitations not configured.
- [TenantActionable <Boolean?>]
: The action to take to resolve the error.
For example, false.
- [State <String>]
: synchronizationTaskExecutionResult
- [TimeBegan <DateTime?>]
: Time when this job run began.
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.
- [TimeEnded <DateTime?>]
: Time when this job run ended.
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.
- [LastSuccessfulExecution <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [LastSuccessfulExecutionWithExports <IMicrosoftGraphSynchronizationTaskExecution>]
: synchronizationTaskExecution
- [Progress <IMicrosoftGraphSynchronizationProgress-
[]>]
: Details of the progress of a job toward completion.
- [CompletedUnits <Int64?>]
: The numerator of a progress ratio; the number of units of changes already processed.
- [ProgressObservationDateTime <DateTime?>]
: The time of a progress observation as an offset in minutes from UTC.
- [TotalUnits <Int64?>]
: The denominator of a progress ratio; a number of units of changes to be processed to accomplish synchronization.
- [Units <String>]
: An optional description of the units.
- [Quarantine <IMicrosoftGraphSynchronizationQuarantine>]
: synchronizationQuarantine
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CurrentBegan <DateTime?>]
: Date and time when the quarantine was last evaluated and imposed.
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.
- [Error <IMicrosoftGraphSynchronizationError>]
: synchronizationError
- [NextAttempt <DateTime?>]
: Date and time when the next attempt to re-evaluate the quarantine will be made.
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.
- [Reason <String>]
: quarantineReason
- [SeriesBegan <DateTime?>]
: Date and time when the quarantine was first imposed in this series (a series starts when a quarantine is first imposed, and is reset as soon as the quarantine is lifted).
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.
- [SeriesCount <Int64?>]
: Number of times in this series the quarantine was re-evaluated and left in effect (a series starts when quarantine is first imposed, and is reset as soon as quarantine is lifted).
- [SteadyStateFirstAchievedTime <DateTime?>]
: 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.
- [SteadyStateLastAchievedTime <DateTime?>]
: 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.
- [SynchronizedEntryCountByType <IMicrosoftGraphStringKeyLongValuePair-
[]>]
: Count of synchronized objects, listed by object type.
- [Key <String>]
: The mapping of the user type from the source system to the target system.
For example:User to User - For Microsoft Entra ID to Microsoft Entra synchronization worker to user - For Workday to Microsoft Entra synchronization.
- [Value <Int64?>]
: Total number of synchronized objects.
- [TroubleshootingUrl <String>]
: In the event of an error, the URL with the troubleshooting steps for the issue.
- [SynchronizationJobSettings <IMicrosoftGraphKeyValuePair-
[]>]
: Settings associated with the job.
Some settings are inherited from the template.
- [Name <String>]
: Name for this key-value pair
- [Value <String>]
: Value for this key-value pair
- [TemplateId <String>]
: Identifier of the synchronization template this job is based on.
- [Secrets <IMicrosoftGraphSynchronizationSecretKeyStringValuePair-
[]>]
: Represents a collection of credentials to access provisioned cloud applications.
- [Key <String>]
: synchronizationSecret
- [Value <String>]
: The value of the secret.
- [Templates <IMicrosoftGraphSynchronizationTemplate-
[]>]
: Pre-configured synchronization settings for a particular application.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ApplicationId <String>]
: Identifier of the application this template belongs to.
- [Default <Boolean?>]
: true if this template is recommended to be the default for the application.
- [Description <String>]
: Description of the template.
- [Discoverable <Boolean?>]
: true if this template should appear in the collection of templates available for the application instance (service principal).
- [FactoryTag <String>]
: One of the well-known factory tags supported by the synchronization engine.
The factoryTag tells the synchronization engine which implementation to use when processing jobs based on this template.
- [Metadata <IMicrosoftGraphSynchronizationMetadataEntry-
[]>]
: Additional extension properties.
Unless mentioned explicitly, metadata values shouldn't be changed.
- [Key <String>]
: synchronizationMetadata
- [Value <String>]
: Value of the metadata property.
- [Schema <IMicrosoftGraphSynchronizationSchema>]
: synchronizationSchema
- [Tags <String-
[]>]
: Custom strings that can be used to categorize and identify the service principal.
Not nullable.
The value is the union of strings set here and on the associated application entity's tags property.Supports $filter (eq, not, ge, le, startsWith).
- [TokenEncryptionKeyId <String>]
: Specifies the keyId of a public key from the keyCredentials collection.
When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property.
The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
- [TokenIssuancePolicies <IMicrosoftGraphTokenIssuancePolicy-
[]>]
: The tokenIssuancePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TokenLifetimePolicies <IMicrosoftGraphTokenLifetimePolicy-
[]>]
: The tokenLifetimePolicies assigned to this service principal.
Supports $expand.
- [AppliesTo <IMicrosoftGraphDirectoryObject-
[]>]
:
- [Definition <String-
[]>]
: A string collection containing a JSON string that defines the rules and settings for a policy.
The syntax for the definition differs for each derived policy type.
Required.
- [IsOrganizationDefault <Boolean?>]
: If set to true, activates this policy.
There can be many policies for the same policy type, but only one can be activated as the organization default.
Optional, default value is false.
- [Description <String>]
: Description for this policy.
Required.
- [DisplayName <String>]
: Display name for this policy.
Required.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
:
- [VerifiedPublisher <IMicrosoftGraphVerifiedPublisher>]
: verifiedPublisher
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddedDateTime <DateTime?>]
: The timestamp when the verified publisher was first added or most recently updated.
- [DisplayName <String>]
: The verified publisher name from the app publisher's Microsoft Partner Network (MPN) account.
- [VerifiedPublisherId <String>]
: The ID of the verified publisher from the app publisher's Partner Center account.
- [AppRoleAssignments <IMicrosoftGraphAppRoleAssignment-
[]>]
: Represents the app roles a user has been granted for an application.
Supports $expand.
- [Approvals <IMicrosoftGraphApproval-
[]>]
:
- [AssignedLicenses <IMicrosoftGraphAssignedLicense-
[]>]
: 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).
- [DisabledPlans <String-
[]>]
: A collection of the unique identifiers for plans that have been disabled.
IDs are available in servicePlans > servicePlanId in the tenant's subscribedSkus or serviceStatus > servicePlanId in the tenant's companySubscription.
- [SkuId <String>]
: The unique identifier for the SKU.
Corresponds to the skuId from subscribedSkus or companySubscription.
- [AssignedPlans <IMicrosoftGraphAssignedPlan-
[]>]
: The plans that are assigned to the user.
Read-only.
Not nullable.Supports $filter (eq and not).
- [AssignedDateTime <DateTime?>]
: The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z.
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
- [CapabilityStatus <String>]
: Condition of the capability assignment.
The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
- [Service <String>]
: The name of the service; for example, exchange.
- [ServicePlanId <String>]
: A GUID that identifies the service plan.
For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.
- [Authentication <IMicrosoftGraphAuthentication>]
: authentication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailMethods <IMicrosoftGraphEmailAuthenticationMethod-
[]>]
: Represents the email addresses registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EmailAddress <String>]
: The email address registered to this user.
- [Fido2Methods <IMicrosoftGraphFido2AuthenticationMethod-
[]>]
: Represents the FIDO2 security keys registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AaGuid <String>]
: Authenticator Attestation GUID, an identifier that indicates the type (such as make and model) of the authenticator.
- [AttestationCertificates <String-
[]>]
: The attestation certificate or certificates attached to this security key.
- [AttestationLevel <String>]
: attestationLevel
- [DisplayName <String>]
: The display name of the key as given by the user.
- [Model <String>]
: The manufacturer-assigned model of the FIDO2 security key.
- [PublicKeyCredential <IMicrosoftGraphWebauthnPublicKeyCredential>]
: webauthnPublicKeyCredential
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientExtensionResults <IMicrosoftGraphWebauthnAuthenticationExtensionsClientOutputs>]
: webauthnAuthenticationExtensionsClientOutputs
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The credential ID created by the WebAuthn Authenticator.
- [Response <IMicrosoftGraphWebauthnAuthenticatorAttestationResponse>]
: webauthnAuthenticatorAttestationResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AttestationObject <String>]
: Base64URL encoded, cryptographically protected attestation about the WebAuthn Authenticator.
- [ClientDataJson <String>]
:
- [Methods <IMicrosoftGraphAuthenticationMethod-
[]>]
: Represents all authentication methods registered to a user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
:
- [MicrosoftAuthenticatorMethods <IMicrosoftGraphMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: The details of the Microsoft Authenticator app registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppName <String>]
: microsoftAuthenticatorAuthenticationMethodClientAppName
- [Device <IMicrosoftGraphDevice>]
: device
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AccountEnabled <Boolean?>]
: true if the account is enabled; otherwise, false.
Default is true.
Supports $filter (eq, ne, not, in).
Only callers with at least the Cloud Device Administrator role can set this property.
- [AlternativeSecurityIds <IMicrosoftGraphAlternativeSecurityId-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le).
- [IdentityProvider <String>]
: For internal use only.
- [Key <Byte-
[]>]
: For internal use only.
- [Type <Int32?>]
: For internal use only.
- [ApproximateLastSignInDateTime <DateTime?>]
: 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.
- [Commands <IMicrosoftGraphCommand-
[]>]
: Set of commands sent to this device.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppServiceName <String>]
:
- [Error <String>]
:
- [PackageFamilyName <String>]
:
- [Payload <IMicrosoftGraphPayloadRequest>]
: payloadRequest
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PermissionTicket <String>]
:
- [PostBackUri <String>]
:
- [Responsepayload <IMicrosoftGraphPayloadResponse>]
: payloadResponse
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Status <String>]
:
- [Type <String>]
:
- [ComplianceExpirationDateTime <DateTime?>]
: 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.
- [DeviceCategory <String>]
: User-defined property set by Intune to automatically add devices to groups and simplify managing devices.
- [DeviceId <String>]
: 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).
- [DeviceMetadata <String>]
: For internal use only.
Set to null.
- [DeviceOwnership <String>]
: Ownership of the device.
This property is set by Intune.
Possible values are: unknown, company, personal.
- [DeviceVersion <Int32?>]
: For internal use only.
- [DisplayName <String>]
: The display name for the device.
Required.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
- [DomainName <String>]
: The on-premises domain name of Microsoft Entra hybrid joined devices.
This property is set by Intune.
- [EnrollmentProfileName <String>]
: 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.
- [EnrollmentType <String>]
: Enrollment type of the device.
This property is set by Intune.
Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount.
NOTE: This property might return other values apart from those listed.
- [ExtensionAttributes <IMicrosoftGraphOnPremisesExtensionAttributes>]
: onPremisesExtensionAttributes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ExtensionAttribute1 <String>]
: First customizable extension attribute.
- [ExtensionAttribute10 <String>]
: Tenth customizable extension attribute.
- [ExtensionAttribute11 <String>]
: Eleventh customizable extension attribute.
- [ExtensionAttribute12 <String>]
: Twelfth customizable extension attribute.
- [ExtensionAttribute13 <String>]
: Thirteenth customizable extension attribute.
- [ExtensionAttribute14 <String>]
: Fourteenth customizable extension attribute.
- [ExtensionAttribute15 <String>]
: Fifteenth customizable extension attribute.
- [ExtensionAttribute2 <String>]
: Second customizable extension attribute.
- [ExtensionAttribute3 <String>]
: Third customizable extension attribute.
- [ExtensionAttribute4 <String>]
: Fourth customizable extension attribute.
- [ExtensionAttribute5 <String>]
: Fifth customizable extension attribute.
- [ExtensionAttribute6 <String>]
: Sixth customizable extension attribute.
- [ExtensionAttribute7 <String>]
: Seventh customizable extension attribute.
- [ExtensionAttribute8 <String>]
: Eighth customizable extension attribute.
- [ExtensionAttribute9 <String>]
: Ninth customizable extension attribute.
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the device.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Hostnames <String-
[]>]
: List of host names for the device.
- [IsCompliant <Boolean?>]
: 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).
- [IsManaged <Boolean?>]
: 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).
- [IsManagementRestricted <Boolean?>]
: Indicates whether the device is a member of a restricted management administrative unit.
The default value is false.
Read-only.
To manage a device that's a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit.
- [IsRooted <Boolean?>]
: true if the device is rooted or jail-broken.
This property can only be updated by Intune.
- [Kind <String>]
: Form factor of the device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ManagementType <String>]
: 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.
- [Manufacturer <String>]
: Manufacturer of the device.
Read-only.
- [MdmAppId <String>]
: Application identifier used to register device into MDM.
Read-only.
Supports $filter (eq, ne, not, startsWith).
- [MemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
Read-only.
Nullable.
Supports $expand.
- [Model <String>]
: Model of the device.
Read-only.
- [Name <String>]
: Friendly name of the device.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [OnPremisesLastSyncDateTime <DateTime?>]
: 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).
- [OnPremisesSecurityIdentifier <String>]
: 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).
- [OnPremisesSyncEnabled <Boolean?>]
: 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).
- [OperatingSystem <String>]
: The type of operating system on the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [OperatingSystemVersion <String>]
: Operating system version of the device.
Required.
Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
- [PhysicalIds <String-
[]>]
: For internal use only.
Not nullable.
Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0.
- [Platform <String>]
: Platform of device.
Only returned if the user signs in with a Microsoft account as part of Project Rome.
- [ProfileType <String>]
: The profile type of the device.
Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
- [RegisteredOwners <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegisteredUsers <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [RegistrationDateTime <DateTime?>]
: 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.
- [Status <String>]
: Device is online or offline.
Only returned if user signs in with a Microsoft account as part of Project Rome.
- [SystemLabels <String-
[]>]
: List of labels applied to the device by the system.
Supports $filter (/$count eq 0, /$count ne 0).
- [TransitiveMemberOf <IMicrosoftGraphDirectoryObject-
[]>]
: Groups and administrative units that this device is a member of.
This operation is transitive.
Supports $expand.
- [TrustType <String>]
: 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 information, see Introduction to device management in Microsoft Entra ID.
- [UsageRights <IMicrosoftGraphUsageRight-
[]>]
: Represents the usage rights a device has been granted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CatalogId <String>]
: Product id corresponding to the usage right.
- [ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.
- [State <String>]
: usageRightState
- [DeviceTag <String>]
: Tags containing app metadata.
- [DisplayName <String>]
: The name of the device on which this app is registered.
- [PhoneAppVersion <String>]
: Numerical version of this instance of the Authenticator app.
- [Operations <IMicrosoftGraphLongRunningOperation-
[]>]
: Represents the status of a long-running operation, such as a password reset operation.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: The start time of the operation.
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.
- [LastActionDateTime <DateTime?>]
: 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.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
- [ResourceLocation <String>]
: URI of the resource that the operation is performed on.
- [Status <String>]
: longRunningOperationStatus
- [StatusDetail <String>]
: Details about the status of the operation.
- [PasswordMethods <IMicrosoftGraphPasswordAuthenticationMethod-
[]>]
: Represents the details of the password authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Password <String>]
: For security, the password is always returned as null from a LIST or GET operation.
- [PasswordlessMicrosoftAuthenticatorMethods <IMicrosoftGraphPasswordlessMicrosoftAuthenticatorAuthenticationMethod-
[]>]
: Represents the Microsoft Authenticator Passwordless Phone Sign-in methods registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreationDateTime <DateTime?>]
: The timestamp when this method was registered to the user.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The display name of the mobile device as given by the user.
- [PhoneMethods <IMicrosoftGraphPhoneAuthenticationMethod-
[]>]
: Represents the phone registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [PhoneNumber <String>]
: The phone number to text or call for authentication.
Phone numbers use the format '+<country code>
<number>
x<extension>
', 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.
- [PhoneType <String>]
: authenticationPhoneType
- [SmsSignInState <String>]
: authenticationMethodSignInState
- [PlatformCredentialMethods <IMicrosoftGraphPlatformCredentialAuthenticationMethod-
[]>]
:
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Platform Credential is registered.
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [Platform <String>]
: authenticationMethodPlatform
- [Requirements <IMicrosoftGraphStrongAuthenticationRequirements>]
: strongAuthenticationRequirements
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PerUserMfaState <String>]
: perUserMfaState
- [SignInPreferences <IMicrosoftGraphSignInPreferences>]
: signInPreferences
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSystemPreferredAuthenticationMethodEnabled <Boolean?>]
: Indicates whether the credential preferences of the system are enabled.
- [UserPreferredMethodForSecondaryAuthentication <String>]
: userDefaultAuthenticationMethodType
- [SoftwareOathMethods <IMicrosoftGraphSoftwareOathAuthenticationMethod-
[]>]
: The software OATH time-based one-time password (TOTP) applications registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [SecretKey <String>]
: The secret key of the method.
Always returns null.
- [TemporaryAccessPassMethods <IMicrosoftGraphTemporaryAccessPassAuthenticationMethod-
[]>]
: Represents a Temporary Access Pass registered to a user for authentication through time-limited passcodes.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsUsableOnce <Boolean?>]
: 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.
- [LifetimeInMinutes <Int32?>]
: The lifetime of the Temporary Access Pass in minutes starting at startDateTime.
Must be between 10 and 43200 inclusive (equivalent to 30 days).
- [StartDateTime <DateTime?>]
: The date and time when the Temporary Access Pass becomes available to use and when isUsable is true is enforced.
- [TemporaryAccessPass <String>]
: 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.
- [WindowsHelloForBusinessMethods <IMicrosoftGraphWindowsHelloForBusinessAuthenticationMethod-
[]>]
: Represents the Windows Hello for Business authentication method registered to a user for authentication.
- [CreatedDateTime <DateTime?>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Device <IMicrosoftGraphDevice>]
: device
- [DisplayName <String>]
: The name of the device on which Windows Hello for Business is registered
- [KeyStrength <String>]
: authenticationMethodKeyStrength
- [AuthorizationInfo <IMicrosoftGraphAuthorizationInfo>]
: authorizationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CertificateUserIds <String-
[]>]
: The collection of unique identifiers that can be associated with a user and can be used to bind the Microsoft Entra user to a certificate for authentication and authorization into non-Azure AD environments.
The identifiers must be unique in the tenant.
- [Birthday <DateTime?>]
: 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.
- [BusinessPhones <String-
[]>]
: The telephone numbers for the user.
Only one number can be set for this property.
Read-only for users synced from on-premises directory.
Supports $filter (eq, not, ge, le, startsWith).
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedOnlineMeetingProviders <String-
[]>]
: 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 <String>]
: The calendarGroup in which to create the calendar.
If the user has never explicitly set a group for the calendar, this property is null.
- [CalendarPermissions <IMicrosoftGraphCalendarPermission-
[]>]
: The permissions of the users with whom the calendar is shared.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedRoles <String-
[]>]
: List of allowed sharing or delegating permission levels for the calendar.
Possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [IsInsideOrganization <Boolean?>]
: True if the user in context (share recipient or delegate) is inside the same organization as the calendar owner.
- [IsRemovable <Boolean?>]
: True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise.
The 'My organization' user determines the permissions other people within your organization have to the given calendar.
You can't remove 'My organization' as a recipient to a calendar.
- [Role <String>]
: calendarRoleType
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Navigation property.
Read-only.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowNewTimeProposals <Boolean?>]
: true if the meeting organizer allows invitees to propose a new time when responding; otherwise false.
Optional.
Default is true.
- [Attachments <IMicrosoftGraphAttachment-
[]>]
: The collection of FileAttachment, ItemAttachment, and referenceAttachment attachments for the event.
Navigation property.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentType <String>]
: The MIME type.
- [IsInline <Boolean?>]
: true if the attachment is an inline attachment; otherwise, false.
- [LastModifiedDateTime <DateTime?>]
: 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
- [Name <String>]
: The display name of the attachment.
This does not need to be the actual file name.
- [Size <Int32?>]
: The length of the attachment in bytes.
- [Attendees <IMicrosoftGraphAttendee-
[]>]
: The collection of attendees for the event.
- [Type <String>]
: attendeeType
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [ProposedNewTime <IMicrosoftGraphTimeSlot>]
: timeSlot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}).
For example, '2019-04-16T09:00:00'.
- [TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'.
See below for possible values.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <IMicrosoftGraphResponseStatus>]
: responseStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Response <String>]
: responseType
- [Time <DateTime?>]
: The date and time that the response was returned.
It uses ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <String>]
: The content of the item.
- [ContentType <String>]
: bodyType
- [BodyPreview <String>]
: The preview of the message associated with the event.
It is in text format.
- [Calendar <IMicrosoftGraphCalendar>]
: calendar
- [CancelledOccurrences <String-
[]>]
: Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master.
Instances in a recurring series that are canceled are called cancelledOccurences.Returned only on $select in a Get operation which specifies the id of a series master event (that is, the seriesMasterId property value).
- [End <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [ExceptionOccurrences <IMicrosoftGraphEvent-
[]>]
:
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the event.
Nullable.
- [HasAttachments <Boolean?>]
: Set to true if the event has attachments.
- [HideAttendees <Boolean?>]
: When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list.
Default is false.
- [ICalUId <String>]
: A unique identifier for an event across calendars.
This ID is different for each occurrence in a recurring series.
Read-only.
- [Importance <String>]
: importance
- [Instances <IMicrosoftGraphEvent-
[]>]
: The occurrences of a recurring series, if the event is a series master.
This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified.
It doesn't include occurrences that have been canceled from the series.
Navigation property.
Read-only.
Nullable.
- [IsAllDay <Boolean?>]
: Set to true if the event lasts all day.
If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
- [IsCancelled <Boolean?>]
: Set to true if the event has been canceled.
- [IsDraft <Boolean?>]
: Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees.
Set to false if all changes have been sent, or if the event is an appointment without any attendees.
- [IsOnlineMeeting <Boolean?>]
: True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise.
Default is false (onlineMeeting is null).
Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting.
Outlook then ignores any further changes to isOnlineMeeting, and the meeting remains available online.
- [IsOrganizer <Boolean?>]
: Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event).
This also applies if a delegate organized the event on behalf of the owner.
- [IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the event.
- [Location <IMicrosoftGraphLocation>]
: location
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Address <IMicrosoftGraphPhysicalAddress>]
: physicalAddress
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [City <String>]
: The city.
- [CountryOrRegion <String>]
: The country or region.
It's a free-format string value, for example, 'United States'.
- [PostOfficeBox <String>]
: The post office box number.
- [PostalCode <String>]
: The postal code.
- [State <String>]
: The state.
- [Street <String>]
: The street.
- [Type <String>]
: physicalAddressType
- [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]
: outlookGeoCoordinates
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Accuracy <Double?>]
: The accuracy of the latitude and longitude.
As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
- [Altitude <Double?>]
: The altitude of the location.
- [AltitudeAccuracy <Double?>]
: The accuracy of the altitude.
- [Latitude <Double?>]
: The latitude of the location.
- [Longitude <Double?>]
: The longitude of the location.
- [DisplayName <String>]
: The name associated with the location.
- [LocationEmailAddress <String>]
: Optional email address of the location.
- [LocationType <String>]
: locationType
- [LocationUri <String>]
: Optional URI representing the location.
- [UniqueId <String>]
: For internal use only.
- [UniqueIdType <String>]
: locationUniqueIdType
- [Locations <IMicrosoftGraphLocation-
[]>]
: The locations where the event is held or attended from.
The location and locations properties always correspond with each other.
If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String-
[]>]
: A collection of property values.
- [OccurrenceId <String>]
: An identifier for an occurrence in a recurring event series.
Null if the event isn't part of a recurring series.The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}.
The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding recurrenceRange.This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled.
You can use this property to perform all operations supported by occurrences in the recurring series.
- [OnlineMeeting <IMicrosoftGraphOnlineMeetingInfo>]
: onlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ConferenceId <String>]
: The ID of the conference.
- [JoinUrl <String>]
: The external link that launches the online meeting.
This is a URL that clients launch into a browser and will redirect the user to join the meeting.
- [Phones <IMicrosoftGraphPhone-
[]>]
: All of the phone numbers associated with this conference.
- [Number <String>]
: The phone number.
- [Type <String>]
: phoneType
- [QuickDial <String>]
: The preformatted quick dial for this call.
- [TollFreeNumbers <String-
[]>]
: The toll free numbers that can be used to join the conference.
- [TollNumber <String>]
: The toll number that can be used to join the conference.
- [OnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [OnlineMeetingUrl <String>]
: A URL for an online meeting.
The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype.
Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event.
The onlineMeetingUrl property will be deprecated in the future.
- [Organizer <IMicrosoftGraphRecipient>]
: recipient
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EmailAddress <IMicrosoftGraphEmailAddress>]
: emailAddress
- [OriginalEndTimeZone <String>]
: The end time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [OriginalStart <DateTime?>]
: Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series.
This property isn't returned for events that are single instances.
Its date and time information is expressed in ISO 8601 format and is always in UTC.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [OriginalStartTimeZone <String>]
: The start time zone that was set when the event was created.
A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
- [Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DayOfMonth <Int32?>]
: The day of the month on which the event occurs.
Required if type is absoluteMonthly or absoluteYearly.
- [DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs.
The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday.
If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern.
Required if type is weekly, relativeMonthly, or relativeYearly.
- [FirstDayOfWeek <String>]
: dayOfWeek
- [Index <String>]
: weekIndex
- [Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Required.
- [Month <Int32?>]
: The month in which the event occurs.
This is a number from 1 to 12.
- [Type <String>]
: recurrencePatternType
- [Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDate <DateTime?>]
: The date to stop applying the recurrence pattern.
Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date.
Required if type is endDate.
- [NumberOfOccurrences <Int32?>]
: The number of times to repeat the event.
Required and must be positive if type is numbered.
- [RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties.
Optional.
If not specified, the time zone of the event is used.
- [StartDate <DateTime?>]
: The date to start applying the recurrence pattern.
The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event.
Must be the same value as the start property of the recurring event.
Required.
- [Type <String>]
: recurrenceRangeType
- [ReminderMinutesBeforeStart <Int32?>]
: The number of minutes before the event start time that the reminder alert occurs.
- [ResponseRequested <Boolean?>]
: Default is true, which represents the organizer would like an invitee to send a response to the event.
- [ResponseStatus <IMicrosoftGraphResponseStatus>]
: responseStatus
- [Sensitivity <String>]
: sensitivity
- [SeriesMasterId <String>]
: The ID for the recurring series master item, if this event is part of a recurring series.
- [ShowAs <String>]
: freeBusyStatus
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the event.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Value <String>]
: A property value.
- [Start <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Subject <String>]
: The text of the event's subject line.
- [TransactionId <String>]
: A custom identifier specified by a client app for the server to avoid redundant POST operations if the client retries to create the same event.
This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request.
After you set transactionId when creating an event, you can't change transactionId in a subsequent update.
This property is only returned in a response payload if an app has set it.
Optional.
- [Type <String>]
: eventType
- [Uid <String>]
: A unique identifier for calendar events.
For recurring events, the value is the same for the series master and all of its occurrences including exceptions.
- [WebLink <String>]
: The URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you're signed in to your mailbox.
Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
- [CanEdit <Boolean?>]
: 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.
- [CanShare <Boolean?>]
: 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.
- [CanViewPrivateItems <Boolean?>]
: 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.
- [ChangeKey <String>]
: 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.
- [Color <String>]
: calendarColor
- [DefaultOnlineMeetingProvider <String>]
: onlineMeetingProviderType
- [Events <IMicrosoftGraphEvent-
[]>]
: The events in the calendar.
Navigation property.
Read-only.
- [HexColor <String>]
: 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.
- [IsDefaultCalendar <Boolean?>]
: true if this is the default calendar where new events are created by default, false otherwise.
- [IsRemovable <Boolean?>]
: Indicates whether this user calendar can be deleted from the user mailbox.
- [IsShared <Boolean?>]
: 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.
- [IsSharedWithMe <Boolean?>]
: 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.
- [IsTallyingResponses <Boolean?>]
: Indicates whether this user calendar supports tracking of meeting responses.
Only meeting invites sent from users' primary calendars support tracking of meeting responses.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the calendar.
Read-only.
Nullable.
- [Name <String>]
: The calendar name.
- [Owner <IMicrosoftGraphEmailAddress>]
: emailAddress
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the calendar.
Read-only.
Nullable.
- [CalendarGroups <IMicrosoftGraphCalendarGroup-
[]>]
: The user's calendar groups.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The calendars in the calendar group.
Navigation property.
Read-only.
Nullable.
- [ChangeKey <String>]
: Identifies the version of the calendar group.
Every time the calendar group is changed, ChangeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [ClassId <String>]
: The class identifier.
Read-only.
- [Name <String>]
: The group name.
- [CalendarView <IMicrosoftGraphEvent-
[]>]
: The calendar view for the calendar.
Read-only.
Nullable.
- [Calendars <IMicrosoftGraphCalendar-
[]>]
: The user's calendars.
Read-only.
Nullable.
- [Chats <IMicrosoftGraphChat-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChatType <String>]
: chatType
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time at which the chat was created.
Read-only.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: A collection of all the apps in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ResourceSpecificPermissions <IMicrosoftGraphTeamsAppResourceSpecificPermission-
[]>]
: A collection of resource-specific permissions.
- [PermissionType <String>]
: teamsAppResourceSpecificPermissionType
- [PermissionValue <String>]
: The name of the resource-specific permission.
- [ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Scope <String>]
: teamsAppInstallationScopes
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AppDefinitions <IMicrosoftGraphTeamsAppDefinition-
[]>]
: The details for each version of the app.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedInstallationScopes <String>]
: teamsAppInstallationScopes
- [Authorization <IMicrosoftGraphTeamsAppAuthorization>]
: teamsAppAuthorization
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ClientAppId <String>]
: The registration ID of the Microsoft Entra app ID associated with the teamsApp.
- [RequiredPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet
- [AzureAdAppId <String>]
: The WebApplicationInfo.Id from the Teams app manifest.
- [Bot <IMicrosoftGraphTeamworkBot>]
: teamworkBot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ColorIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [HostedContent <IMicrosoftGraphTeamworkHostedContent>]
: teamworkHostedContent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [WebUrl <String>]
: The web URL that can be used for downloading the image.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [DashboardCards <IMicrosoftGraphTeamsAppDashboardCardDefinition-
[]>]
: Dashboard cards specified in the Teams app manifest.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ContentSource <IMicrosoftGraphTeamsAppDashboardCardContentSource>]
: teamsAppDashboardCardContentSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotConfiguration <IMicrosoftGraphTeamsAppDashboardCardBotConfiguration>]
: teamsAppDashboardCardBotConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BotId <String>]
: The ID (usually a GUID) of the bot associated with the specific teamsAppDefinition.
This is a unique app ID for the bot as registered with the Bot Framework.
- [SourceType <String>]
: teamsAppDashboardCardSourceType
- [DefaultSize <String>]
: teamsAppDashboardCardSize
- [Description <String>]
: The description for the card.
Required.
- [DisplayName <String>]
: The name of the card.
Required.
- [Icon <IMicrosoftGraphTeamsAppDashboardCardIcon>]
: teamsAppDashboardCardIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IconUrl <String>]
: The icon for the card, displayed in the toolbox and card bar, is represented as a URL.
The preferred size for raster images is 28x28 pixels.
If this property has a value, the officeFabricIconFontName property is ignored.
- [OfficeUiFabricIconName <String>]
: The friendly name of the Office UI Fabric/Fluent UI icon for the card that is used when the iconUrl property isn't specified.
For example, 'officeUIFabricIconName': 'Search'.
- [PickerGroupId <String>]
: ID for the group in the card picker.
Required.
- [Description <String>]
:
- [DisplayName <String>]
: The name of the app provided by the app developer.
- [LastModifiedDateTime <DateTime?>]
:
- [OutlineIcon <IMicrosoftGraphTeamsAppIcon>]
: teamsAppIcon
- [PublishingState <String>]
: teamsAppPublishingState
- [Shortdescription <String>]
:
- [TeamsAppId <String>]
: The ID from the Teams app manifest.
- [Version <String>]
: The version number of the application.
- [DisplayName <String>]
: The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
- [DistributionMethod <String>]
: teamsAppDistributionMethod
- [ExternalId <String>]
: The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
- [TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition
- [IsHiddenForAllMembers <Boolean?>]
: Indicates whether the chat is hidden for all its members.
Read-only.
- [LastMessagePreview <IMicrosoftGraphChatMessageInfo>]
: chatMessageInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [CreatedDateTime <DateTime?>]
: Date time object representing the time at which message was created.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [IsDeleted <Boolean?>]
: If set to true, the original message has been deleted.
- [MessageType <String>]
: chatMessageType
- [LastUpdatedDateTime <DateTime?>]
: Date and time at which the chat was renamed or list of members were last changed.
Read-only.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of all the members in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The display name of the user.
- [Roles <String-
[]>]
: 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 <DateTime?>]
: 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.
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Attachments <IMicrosoftGraphChatMessageAttachment-
[]>]
: References to attached objects like files, tabs, meetings etc.
- [Content <String>]
: 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.
- [ContentType <String>]
: 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 contentType that is supported by the Bot Framework's Attachment object.application/vnd.microsoft.card.codesnippet: A code snippet.
application/vnd.microsoft.card.announcement: An announcement header.
- [ContentUrl <String>]
: The URL for the content of the attachment.
- [Id <String>]
: Read-only.
The unique id of the attachment.
- [Name <String>]
: Name of the attachment.
- [TeamsAppId <String>]
: The ID of the Teams app that is associated with the attachment.
The property is used to attribute a Teams message card to the specified app.
- [ThumbnailUrl <String>]
: The 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 selects the image, the channel would open the document.
- [Body <IMicrosoftGraphItemBody>]
: itemBody
- [ChannelIdentity <IMicrosoftGraphChannelIdentity>]
: channelIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChannelId <String>]
: The identity of the channel in which the message was posted.
- [TeamId <String>]
: The identity of the team in which the message was posted.
- [ChatId <String>]
: If the message was sent in a chat, represents the identity of the chat.
- [CreatedDateTime <DateTime?>]
: Timestamp of when the chat message was created.
- [DeletedDateTime <DateTime?>]
: Read only.
Timestamp at which the chat message was deleted, or null if not deleted.
- [Etag <String>]
: Read-only.
Version number of the chat message.
- [EventDetail <IMicrosoftGraphEventMessageDetail>]
: eventMessageDetail
- [From <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [HostedContents <IMicrosoftGraphChatMessageHostedContent-
[]>]
: Content in a message hosted by Microsoft Teams - for example, images or code snippets.
- [ContentBytes <Byte-
[]>]
: Write only.
Bytes for the hosted content (such as images).
- [ContentType <String>]
: Write only.
Content type, such as image/png, image/jpg.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Importance <String>]
: chatMessageImportance
- [LastEditedDateTime <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: Read only.
Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
- [Locale <String>]
: Locale of the chat message set by the client.
Always set to en-us.
- [Mentions <IMicrosoftGraphChatMessageMention-
[]>]
: List of entities mentioned in the chat message.
Supported entities are: user, bot, team, channel, chat, and tag.
- [Id <Int32?>]
: Index of an entity being mentioned in the specified chatMessage.
Matches the {index} value in the corresponding <at id='{index}'>
tag in the message body.
- [MentionText <String>]
: String used to represent the mention.
For example, a user's display name, a team name.
- [Mentioned <IMicrosoftGraphChatMessageMentionedIdentitySet>]
: chatMessageMentionedIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Conversation <IMicrosoftGraphTeamworkConversationIdentity>]
: teamworkConversationIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [ConversationIdentityType <String>]
: teamworkConversationIdentityType
- [Tag <IMicrosoftGraphTeamworkTagIdentity>]
: teamworkTagIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [MessageHistory <IMicrosoftGraphChatMessageHistoryItem-
[]>]
: List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.
- [Actions <String>]
: chatMessageActions
- [ModifiedDateTime <DateTime?>]
: The date and time when the message was modified.
- [Reaction <IMicrosoftGraphChatMessageReaction>]
: chatMessageReaction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: 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.
- [DisplayName <String>]
: The name of the reaction.
- [ReactionContentUrl <String>]
: The hosted content URL for the custom reaction type.
- [ReactionType <String>]
: The reaction type.
Supported values include Unicode characters, custom, and some backward-compatible reaction types, such as like, angry, sad, laugh, heart, and surprised.
- [User <IMicrosoftGraphChatMessageReactionIdentitySet>]
: chatMessageReactionIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [MessageType <String>]
: chatMessageType
- [OnBehalfOf <IMicrosoftGraphChatMessageFromIdentitySet>]
: chatMessageFromIdentitySet
- [PolicyViolation <IMicrosoftGraphChatMessagePolicyViolation>]
: chatMessagePolicyViolation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DlpAction <String>]
: chatMessagePolicyViolationDlpActionTypes
- [JustificationText <String>]
: Justification text provided by the sender of the message when overriding a policy violation.
- [PolicyTip <IMicrosoftGraphChatMessagePolicyViolationPolicyTip>]
: chatMessagePolicyViolationPolicyTip
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ComplianceUrl <String>]
: The URL a user can visit to read about the data loss prevention policies for the organization.
(ie, policies about what users shouldn't say in chats)
- [GeneralText <String>]
: Explanatory text shown to the sender of the message.
- [MatchedConditionDescriptions <String-
[]>]
: The list of improper data in the message that was detected by the data loss prevention app.
Each DLP app defines its own conditions, examples include 'Credit Card Number' and 'Social Security Number'.
- [UserAction <String>]
: chatMessagePolicyViolationUserActionTypes
- [VerdictDetails <String>]
: chatMessagePolicyViolationVerdictDetailsTypes
- [Reactions <IMicrosoftGraphChatMessageReaction-
[]>]
: Reactions for this chat message (for example, Like).
- [Replies <IMicrosoftGraphChatMessage-
[]>]
: Replies for a specified message.
Supports $expand for channel messages.
- [ReplyToId <String>]
: Read-only.
ID of the parent chat message or root chat message of the thread.
(Only applies to chat messages in channels, not chats.)
- [Subject <String>]
: The subject of the chat message, in plaintext.
- [Summary <String>]
: 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.
- [WebUrl <String>]
: Read-only.
Link to the message in Microsoft Teams.
- [OnlineMeetingInfo <IMicrosoftGraphTeamworkOnlineMeetingInfo>]
: teamworkOnlineMeetingInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CalendarEventId <String>]
: The identifier of the calendar event associated with the meeting.
- [JoinWebUrl <String>]
: The URL which can be clicked on to join or uniquely identify the meeting.
- [Organizer <IMicrosoftGraphTeamworkUserIdentity>]
: teamworkUserIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [UserIdentityType <String>]
: teamworkUserIdentityType
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: A collection of all the Teams async operations that ran or are running on the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AttemptsCount <Int32?>]
: Number of times the operation was attempted before being marked successful or failed.
- [CreatedDateTime <DateTime?>]
: Time when the operation was created.
- [Error <IMicrosoftGraphOperationError>]
: operationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: Operation error code.
- [Message <String>]
: Operation error message.
- [LastActionDateTime <DateTime?>]
: Time when the async operation was last updated.
- [OperationType <String>]
: teamsAsyncOperationType
- [Status <String>]
: teamsAsyncOperationStatus
- [TargetResourceId <String>]
: The ID of the object that's created or modified as result of this async operation, typically a team.
- [TargetResourceLocation <String>]
: 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.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps for the chat.
- [DeletedDateTime <DateTime?>]
: Date and time when this object was deleted.
Always null when the object hasn't been deleted.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ClientAppId <String>]
: ID of the service principal of the Microsoft Entra app that has been granted access.
Read-only.
- [ClientId <String>]
: ID of the Microsoft Entra app that has been granted access.
Read-only.
- [Permission <String>]
: The name of the resource-specific permission.
Read-only.
- [PermissionType <String>]
: The type of permission.
Possible values are: Application, Delegated.
Read-only.
- [ResourceAppId <String>]
: ID of the Microsoft Entra app that is hosting the resource.
Read-only.
- [PinnedMessages <IMicrosoftGraphPinnedChatMessageInfo-
[]>]
: A collection of all the pinned messages in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Message <IMicrosoftGraphChatMessage>]
: chatMessage
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the chat.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Configuration <IMicrosoftGraphTeamsTabConfiguration>]
: teamsTabConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentUrl <String>]
: Url used for rendering tab contents in Teams.
Required.
- [EntityId <String>]
: Identifier for the entity hosted by the tab provider.
- [RemoveUrl <String>]
: Url called by Teams client when a Tab is removed using the Teams Client.
- [WebsiteUrl <String>]
: Url for showing tab contents outside of Teams.
- [DisplayName <String>]
: Name of the tab.
- [MessageId <String>]
:
- [SortOrderIndex <String>]
: Index of the order used for sorting tabs.
- [TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp
- [TeamsAppId <String>]
: App definition identifier of the tab.
This value can't be changed after tab creation.
Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
- [WebUrl <String>]
: Deep link URL of the tab instance.
Read only.
- [TenantId <String>]
: The identifier of the tenant in which the chat was created.
Read-only.
- [Topic <String>]
: (Optional) Subject or topic for the chat.
Only available for group chats.
- [Viewpoint <IMicrosoftGraphChatViewpoint>]
: chatViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsHidden <Boolean?>]
: Indicates whether the chat is hidden for the current user.
- [LastMessageReadDateTime <DateTime?>]
: Represents the dateTime up until which the current user has read chatMessages in a specific chat.
- [WebUrl <String>]
: The URL for the chat in Microsoft Teams.
The URL should be treated as an opaque blob, and not parsed.
Read-only.
- [City <String>]
: The city where the user is located.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CloudClipboard <IMicrosoftGraphCloudClipboardRoot>]
: cloudClipboardRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Items <IMicrosoftGraphCloudClipboardItem-
[]>]
: Represents a collection of Cloud Clipboard items.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CreatedDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object was created on the server.
- [ExpirationDateTime <DateTime?>]
: Set by the server.
DateTime in UTC when the object expires and after that the object is no longer available.
The default and also maximum TTL is 12 hours after the creation, but it might change for performance optimization.
- [LastModifiedDateTime <DateTime?>]
: Set by the server if not provided in the client's request.
DateTime in UTC when the object was modified by the client.
- [Payloads <IMicrosoftGraphCloudClipboardItemPayload-
[]>]
: A cloudClipboardItem can have multiple cloudClipboardItemPayload objects in the payloads.
A window can place more than one clipboard object on the clipboard.
Each one represents the same information in a different clipboard format.
- [Content <String>]
: The formatName version of the value of a cloud clipboard encoded in base64.
- [FormatName <String>]
: For a list of possible values see formatName values.
- [CloudPCs <IMicrosoftGraphCloudPc-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AadDeviceId <String>]
: The Microsoft Entra device ID of the Cloud PC.
- [AllotmentDisplayName <String>]
: The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment.
When the provisioningType is dedicated, the allotment name is null.
Read-only.
- [ConnectionSetting <IMicrosoftGraphCloudPcConnectionSetting>]
: cloudPcConnectionSetting
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
: Indicates whether single sign-on is enabled.
The default value is false.
- [ConnectionSettings <IMicrosoftGraphCloudPcConnectionSettings>]
: cloudPcConnectionSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EnableSingleSignOn <Boolean?>]
:
- [ConnectivityResult <IMicrosoftGraphCloudPcConnectivityResult>]
: cloudPcConnectivityResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [FailedHealthCheckItems <IMicrosoftGraphCloudPcHealthCheckItem-
[]>]
: A list of failed health check items.
If the status property is available, this property is empty.
- [AdditionalDetails <String>]
: Additional message for this health check.
- [DisplayName <String>]
: The connectivity health check item name.
- [LastHealthCheckDateTime <DateTime?>]
: 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.
- [Result <String>]
: cloudPcConnectivityEventResult
- [LastModifiedDateTime <DateTime?>]
: The last modified time for connectivity status 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 would look like this: 2014-01-01T00:00:00Z.
- [Status <String>]
: cloudPcConnectivityStatus
- [UpdatedDateTime <DateTime?>]
: Datetime when the status was updated.
This property is deprecated and will no longer be supported effective August 31, 2024.
Use lastModifiedDateTime instead.
Read-Only.
- [DeviceRegionName <String>]
: The name of the geographical region where the Cloud PC is currently provisioned.
For example, westus3, eastus2, and southeastasia.
Read-only.
- [DisasterRecoveryCapability <IMicrosoftGraphCloudPcDisasterRecoveryCapability>]
: cloudPcDisasterRecoveryCapability
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CapabilityType <String>]
: cloudPcDisasterRecoveryCapabilityType
- [PrimaryRegion <String>]
: The primary and mainly used region where the Cloud PC is located.
- [SecondaryRegion <String>]
: The secondary region to which the Cloud PC can be failed over during a regional outage.
- [DiskEncryptionState <String>]
: cloudPcDiskEncryptionState
- [DisplayName <String>]
: The display name of the Cloud PC.
- [GracePeriodEndDateTime <DateTime?>]
: The date and time when the grace period ends and reprovisioning or deprovisioning happens.
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.
- [ImageDisplayName <String>]
: Name of the OS image that's on the Cloud PC.
- [LastLoginResult <IMicrosoftGraphCloudPcLoginResult>]
: cloudPcLoginResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Time <DateTime?>]
: 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.
- [LastModifiedDateTime <DateTime?>]
: 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.
- [LastRemoteActionResult <IMicrosoftGraphCloudPcRemoteActionResult>]
: cloudPcRemoteActionResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionName <String>]
: 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.
- [ActionState <String>]
: actionState
- [CloudPcId <String>]
: The ID of the Cloud PC device on which the remote action is performed.
Read-only.
- [LastUpdatedDateTime <DateTime?>]
: 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'.
- [ManagedDeviceId <String>]
: The ID of the Intune managed device on which the remote action is performed.
Read-only.
- [StartDateTime <DateTime?>]
: 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'.
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: More information about the Cloud PC status.
For example, 'additionalInformation': - ['{'@odata.type': 'microsoft.graph.keyValuePair','name': 'retriable','value': true }]
'
- [Code <String>]
: The error/warning code associated with the Cloud PC status.
Example: 'code': 'internalServerError'.
- [Message <String>]
: The status message associated with error code.
Example: 'message': 'There was an internal server error.
Please contact support xxx.'.
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: Any additional information about the Cloud PC status.
- [Code <String>]
: The code associated with the Cloud PC status.
- [Message <String>]
: The status message.
- [ManagedDeviceId <String>]
: The Intune device ID of the Cloud PC.
- [ManagedDeviceName <String>]
: The Intune device name of the Cloud PC.
- [OSVersion <String>]
: cloudPcOperatingSystem
- [OnPremisesConnectionName <String>]
: The Azure network connection that is applied during the provisioning of Cloud PCs.
- [PartnerAgentInstallResults <IMicrosoftGraphCloudPcPartnerAgentInstallResult-
[]>]
: The results of every partner agent's installation status on Cloud PC.
- [ErrorMessage <String>]
: Contains a detailed error message when the partner agent installation failed.
- [InstallStatus <String>]
: cloudPcPartnerAgentInstallStatus
- [IsThirdPartyPartner <Boolean?>]
: Indicates whether 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.
- [PartnerAgentName <String>]
: cloudPcPartnerAgentName
- [Retriable <Boolean?>]
: Indicates whether the partner agent installation should be retried.
The default value is false.
- [PowerState <String>]
: cloudPcPowerState
- [ProvisioningPolicyId <String>]
: The provisioning policy ID of the Cloud PC.
- [ProvisioningPolicyName <String>]
: The provisioning policy that is applied during the provisioning of Cloud PCs.
- [ProvisioningType <String>]
: cloudPcProvisioningType
- [ScopeIds <String-
[]>]
:
- [ServicePlanId <String>]
: The service plan ID of the Cloud PC.
- [ServicePlanName <String>]
: The service plan name of the Cloud PC.
- [ServicePlanType <String>]
: cloudPcServicePlanType
- [Status <String>]
: cloudPcStatus
- [StatusDetail <IMicrosoftGraphCloudPcStatusDetail>]
: cloudPcStatusDetail
- [StatusDetails <IMicrosoftGraphCloudPcStatusDetails>]
: cloudPcStatusDetails
- [UserAccountType <String>]
: cloudPcUserAccountType
- [UserPrincipalName <String>]
: The user principal name (UPN) of the user assigned to the Cloud PC.
- [CloudRealtimeCommunicationInfo <IMicrosoftGraphCloudRealtimeCommunicationInfo>]
: cloudRealtimeCommunicationInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsSipEnabled <Boolean?>]
: Indicates whether the user has a SIP-enabled client registered for them.
Read-only.
- [CompanyName <String>]
: 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).
- [ConsentProvidedForMinor <String>]
: Sets whether consent has been obtained for minors.
Allowed values: null, Granted, Denied and NotRequired.
Refer to the legal age group property definitions for further information.
Supports $filter (eq, ne, not, and in).
- [ContactFolders <IMicrosoftGraphContactFolder-
[]>]
: The user's contacts folders.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ChildFolders <IMicrosoftGraphContactFolder-
[]>]
: The collection of child folders in the folder.
Navigation property.
Read-only.
Nullable.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The contacts in the folder.
Navigation property.
Read-only.
Nullable.
- [Categories <String-
[]>]
: The categories associated with the item.
- [ChangeKey <String>]
: Identifies the version of the item.
Every time the item is changed, changeKey changes as well.
This allows Exchange to apply changes to the correct version of the object.
Read-only.
- [CreatedDateTime <DateTime?>]
: 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
- [LastModifiedDateTime <DateTime?>]
: 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
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AssistantName <String>]
: The name of the contact's assistant.
- [Birthday <DateTime?>]
: The contact's birthday.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
- [Children <String-
[]>]
: The names of the contact's children.
- [CompanyName <String>]
: The name of the contact's company.
- [Department <String>]
: The contact's department.
- [DisplayName <String>]
: The contact's display name.
You can specify the display name in a create or update operation.
Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified.
To preserve a pre-existing value, always include it as displayName in an update operation.
- [EmailAddresses <IMicrosoftGraphTypedEmailAddress-
[]>]
: The contact's email addresses.
- [Address <String>]
: The email address of an entity instance.
- [Name <String>]
: The display name of an entity instance.
- [OtherLabel <String>]
: 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.
- [Type <String>]
: emailType
- [Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the contact.
Nullable.
- [FileAs <String>]
: The name the contact is filed under.
- [Flag <IMicrosoftGraphFollowupFlag>]
: followupFlag
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [FlagStatus <String>]
: followupFlagStatus
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Gender <String>]
: The contact's gender.
- [Generation <String>]
: The contact's suffix.
- [GivenName <String>]
: The contact's given name.
- [ImAddresses <String-
[]>]
: The contact's instant messaging (IM) addresses.
- [Initials <String>]
: The contact's initials.
- [IsFavorite <Boolean?>]
:
- [JobTitle <String>]
: The contact's job title.
- [Manager <String>]
: The name of the contact's manager.
- [MiddleName <String>]
: The contact's middle name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contact.
Read-only.
Nullable.
- [NickName <String>]
: The contact's nickname.
- [OfficeLocation <String>]
: The location of the contact's office.
- [ParentFolderId <String>]
: The ID of the contact's parent folder.
- [PersonalNotes <String>]
: The user's notes about the contact.
- [Phones <IMicrosoftGraphPhone-
[]>]
: Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Height <Int32?>]
: The height of the photo.
Read-only.
- [Width <Int32?>]
: The width of the photo.
Read-only.
- [PostalAddresses <IMicrosoftGraphPhysicalAddress-
[]>]
: Addresses associated with the contact, for example, home address and business address.
- [Profession <String>]
: The contact's profession.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contact.
Read-only.
Nullable.
- [SpouseName <String>]
: The name of the contact's spouse/partner.
- [Surname <String>]
: The contact's surname.
- [Title <String>]
: The contact's title.
- [Websites <IMicrosoftGraphWebsite-
[]>]
: Web sites associated with the contact.
- [Address <String>]
: The URL of the website.
- [DisplayName <String>]
: The display name of the web site.
- [Type <String>]
: websiteType
- [WeddingAnniversary <DateTime?>]
: The contact's wedding anniversary.
- [YomiCompanyName <String>]
: The phonetic Japanese company name of the contact.
- [YomiGivenName <String>]
: The phonetic Japanese given name (first name) of the contact.
- [YomiSurname <String>]
: The phonetic Japanese surname (last name) of the contact.
- [DisplayName <String>]
: The folder's display name.
- [MultiValueExtendedProperties <IMicrosoftGraphMultiValueLegacyExtendedProperty-
[]>]
: The collection of multi-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [ParentFolderId <String>]
: The ID of the folder's parent folder.
- [SingleValueExtendedProperties <IMicrosoftGraphSingleValueLegacyExtendedProperty-
[]>]
: The collection of single-value extended properties defined for the contactFolder.
Read-only.
Nullable.
- [WellKnownName <String>]
: The name of the folder if the folder is a recognized folder.
Currently contacts is the only recognized contacts folder.
- [Contacts <IMicrosoftGraphContact-
[]>]
: The user's contacts.
Read-only.
Nullable.
- [Country <String>]
: The country or region where the user is located; for example, US or UK.
Maximum length is 128 characters.
Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
- [CreatedDateTime <DateTime?>]
: 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).
- [CreatedObjects <IMicrosoftGraphDirectoryObject-
[]>]
: Directory objects that the user created.
Read-only.
Nullable.
- [CreationType <String>]
: Indicates whether the user account was created through one of the following methods: As a regular school or work account (null).
As an external account (Invitation).
As a local account for an Azure Active Directory B2C tenant (LocalAccount).
Through self-service sign-up by an internal user using email verification (EmailVerified).
Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).
Read-only.Supports $filter (eq, ne, not, and in).
- [CustomSecurityAttributes <IMicrosoftGraphCustomSecurityAttributeValue>]
: customSecurityAttributeValue
- [Department <String>]
: 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).
- [DeviceEnrollmentConfigurations <IMicrosoftGraphDeviceEnrollmentConfiguration-
[]>]
: Get enrollment configurations targeted to the user
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignments <IMicrosoftGraphEnrollmentConfigurationAssignment-
[]>]
: The list of group assignments for the device configuration profile
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Source <DeviceAndAppManagementAssignmentSource?>]
: Represents source of assignment.
- [SourceId <String>]
: Identifier for resource used for deployment to a group
- [Target <IMicrosoftGraphDeviceAndAppManagementAssignmentTarget>]
: Base type for assignment targets.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DeviceAndAppManagementAssignmentFilterId <String>]
: The Id of the filter for the target assignment.
- [DeviceAndAppManagementAssignmentFilterType <DeviceAndAppManagementAssignmentFilterType?>]
: Represents type of the assignment filter.
- [CreatedDateTime <DateTime?>]
: Created date time in UTC of the device enrollment configuration
- [Description <String>]
: The description of the device enrollment configuration
- [DeviceEnrollmentConfigurationType <DeviceEnrollmentConfigurationType?>]
: Describes the TemplateFamily for the Template entity
- [DisplayName <String>]
: The display name of the device enrollment configuration
- [LastModifiedDateTime <DateTime?>]
: Last modified date time in UTC of the device enrollment configuration
- [Priority <Int32?>]
: 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.
- [RoleScopeTagIds <String-
[]>]
: Optional role scope tags for the enrollment restrictions.
- [Version <Int32?>]
: The version of the device enrollment configuration
- [DeviceEnrollmentLimit <Int32?>]
: The limit on the maximum number of devices that the user is permitted to enroll.
Allowed values are 5 or 1000.
- [DeviceKeys <IMicrosoftGraphDeviceKey-
[]>]
:
- [DeviceId <String>]
:
- [KeyMaterial <Byte-
[]>]
:
- [KeyType <String>]
:
- [DeviceManagementTroubleshootingEvents <IMicrosoftGraphDeviceManagementTroubleshootingEvent-
[]>]
: The list of troubleshooting events for this user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AdditionalInformation <IMicrosoftGraphKeyValuePair-
[]>]
: A set of string key and string value pairs which provides additional information on the Troubleshooting event
- [CorrelationId <String>]
: Id used for tracing the failure in the service.
- [EventDateTime <DateTime?>]
: Time when the event occurred .
- [EventName <String>]
: Event Name corresponding to the Troubleshooting Event.
It is an Optional field
- [TroubleshootingErrorDetails <IMicrosoftGraphDeviceManagementTroubleshootingErrorDetails>]
: Object containing detailed information about the error and its remediation.
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Context <String>]
:
- [Failure <String>]
:
- [FailureDetails <String>]
: The detailed description of what went wrong.
- [Remediation <String>]
: The detailed description of how to remediate this issue.
- [Resources <IMicrosoftGraphDeviceManagementTroubleshootingErrorResource-
[]>]
: Links to helpful documentation about this failure.
- [Link <String>]
: The link to the web resource.
Can contain any of the following formatters: {{UPN}}, {{DeviceGUID}}, {{UserGUID}}
- [Text <String>]
:
- [Devices <IMicrosoftGraphDevice-
[]>]
:
- [DirectReports <IMicrosoftGraphDirectoryObject-
[]>]
: 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.
- [DisplayName <String>]
: 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.
- [Drive <IMicrosoftGraphDrive>]
: drive
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DriveId <String>]
: Unique identifier of the drive instance that contains the driveItem.
Only returned if the item is located in a drive.
Read-only.
- [DriveType <String>]
: Identifies the type of drive.
Only returned if the item is located in a drive.
See drive resource for values.
- [Id <String>]
: Unique identifier of the driveItem in the drive or a listItem in a list.
Read-only.
- [Name <String>]
: The name of the item being referenced.
Read-only.
- [Path <String>]
: Percent-encoded path that can be used to navigate to the item.
Read-only.
- [ShareId <String>]
: A unique identifier for a shared resource that can be accessed via the Shares API.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ListId <String>]
: The unique identifier (guid) for the item's list in SharePoint.
- [ListItemId <String>]
: An integer identifier for the item within the containing list.
- [ListItemUniqueId <String>]
: The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site.
- [SiteId <String>]
: The unique identifier (guid) for the item's site collection (SPSite).
- [SiteUrl <String>]
: The SharePoint URL for the site that contains the item.
- [TenantId <String>]
: The unique identifier (guid) for the tenancy.
- [WebId <String>]
: The unique identifier (guid) for the item's site (SPWeb).
- [SiteId <String>]
: 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's an opaque string that consists of three identifiers of the site.
For OneDrive, this property isn't populated.
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place under this drive.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Action <IMicrosoftGraphItemActionSet>]
: itemActionSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Comment <IMicrosoftGraphCommentAction>]
: commentAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsReply <Boolean?>]
: If true, this activity was a reply to an existing comment thread.
- [ParentAuthor <IMicrosoftGraphIdentitySet>]
: identitySet
- [Participants <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users participating in this comment thread.
- [Create <IMicrosoftGraphCreateAction>]
: createAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Delete <IMicrosoftGraphDeleteAction>]
: deleteAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The name of the item that was deleted.
- [ObjectType <String>]
: File or Folder, depending on the type of the deleted item.
- [Edit <IMicrosoftGraphEditAction>]
: editAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mention <IMicrosoftGraphMentionAction>]
: mentionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Mentionees <IMicrosoftGraphIdentitySet-
[]>]
: The identities of the users mentioned in this action.
- [Move <IMicrosoftGraphMoveAction>]
: moveAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [From <String>]
: The name of the location the item was moved from.
- [To <String>]
: The name of the location the item was moved to.
- [Rename <IMicrosoftGraphRenameAction>]
: renameAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewName <String>]
: The new name of the item.
- [OldName <String>]
: The previous name of the item.
- [Restore <IMicrosoftGraphRestoreAction>]
: restoreAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Share <IMicrosoftGraphShareAction>]
: shareAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Recipients <IMicrosoftGraphIdentitySet-
[]>]
: The identities the item was shared with in this action.
- [Version <IMicrosoftGraphVersionAction>]
: versionAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [NewVersion <String>]
: The name of the new version that was created by this action.
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedByUser <IMicrosoftGraphUser>]
: user
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllTime <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActionCount <Int32?>]
: The number of times the action took place.
Read-only.
- [ActorCount <Int32?>]
: The number of distinct actors that performed the action.
Read-only.
- [Activities <IMicrosoftGraphItemActivity-
[]>]
: Exposes the itemActivities represented in this itemActivityStat resource.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Access <IMicrosoftGraphAccessAction>]
: accessAction
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ActivityDateTime <DateTime?>]
:
- [Actor <IMicrosoftGraphIdentitySet>]
: identitySet
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Create <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Delete <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [Edit <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [EndDateTime <DateTime?>]
: When the interval ends.
Read-only.
- [IncompleteData <IMicrosoftGraphIncompleteData>]
: incompleteData
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [MissingDataBeforeDateTime <DateTime?>]
: The service doesn't have source data before the specified time.
- [WasThrottled <Boolean?>]
: Some data wasn't recorded due to excessive activity.
- [IsTrending <Boolean?>]
: Indicates whether the item is 'trending.' Read-only.
- [Move <IMicrosoftGraphItemActionStat>]
: itemActionStat
- [StartDateTime <DateTime?>]
: When the interval starts.
Read-only.
- [ItemActivityStats <IMicrosoftGraphItemActivityStat-
[]>]
:
- [LastSevenDays <IMicrosoftGraphItemActivityStat>]
: itemActivityStat
- [ContentType <IMicrosoftGraphContentTypeInfo>]
: contentTypeInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The ID of the content type.
- [Name <String>]
: The name of the content type.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [State <String>]
: Represents the state of the deleted item.
- [DocumentSetVersions <IMicrosoftGraphDocumentSetVersion-
[]>]
: Version information for a document set version created by a user.
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CheckedOutBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Level <String>]
: The state of publication for this document.
Either published or checkout.
Read-only.
- [VersionId <String>]
: The unique identifier for the version that is visible to the current caller.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: Comment about the captured version.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time when this version was created.
- [Items <IMicrosoftGraphDocumentSetVersionItem-
[]>]
: Items within the document set that are captured as part of this version.
- [ItemId <String>]
: The unique identifier for the item.
- [Title <String>]
: The title of the item.
- [VersionId <String>]
: The version ID of the item.
- [ShouldCaptureMinorVersion <Boolean?>]
: If true, minor versions of items are also captured; otherwise, only major versions are captured.
The default value is false.
- [DriveItem <IMicrosoftGraphDriveItem>]
: driveItem
- [Fields <IMicrosoftGraphFieldValueSet>]
: fieldValueSet
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ExpirationDateTime <DateTime?>]
: A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission.
DateTime.MinValue indicates there's no expiration set for this permission.
Optional.
- [GrantedTo <IMicrosoftGraphIdentitySet>]
: identitySet
- [GrantedToIdentities <IMicrosoftGraphIdentitySet-
[]>]
: For type permissions, the details of the users to whom permission was granted.
Read-only.
- [GrantedToIdentitiesV2 <IMicrosoftGraphSharePointIdentitySet-
[]>]
: For link type permissions, the details of the users to whom permission was granted.
Read-only.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [Group <IMicrosoftGraphIdentity>]
: identity
- [SiteGroup <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [LoginName <String>]
: The sign in name of the SharePoint identity.
- [SiteUser <IMicrosoftGraphSharePointIdentity>]
: sharePointIdentity
- [GrantedToV2 <IMicrosoftGraphSharePointIdentitySet>]
: sharePointIdentitySet
- [HasPassword <Boolean?>]
: Indicates whether the password is set for this permission.
This property only appears in the response.
Optional.
Read-only.
For OneDrive Personal only.
- [InheritedFrom <IMicrosoftGraphItemReference>]
: itemReference
- [Invitation <IMicrosoftGraphSharingInvitation>]
: sharingInvitation
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Email <String>]
: The email address provided for the recipient of the sharing invitation.
Read-only.
- [InvitedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [RedeemedBy <String>]
:
- [SignInRequired <Boolean?>]
: If true the recipient of the invitation needs to sign in in order to access the shared item.
Read-only.
- [Link <IMicrosoftGraphSharingLink>]
: sharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [ConfiguratorUrl <String>]
:
- [PreventsDownload <Boolean?>]
: 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.
- [Scope <String>]
: 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.
- [Type <String>]
: The type of the link created.
- [WebHtml <String>]
: For embed links, this property contains the HTML code for an
For the complete list of allowed characters, see username policies.
Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby.
- [UserType <String>]
: A String value that can be used to classify user types in your directory.
The possible values are 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?
- [VirtualEvents <IMicrosoftGraphUserVirtualEventsRoot>]
: userVirtualEventsRoot
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:
- [CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <IMicrosoftGraphIdentity>]
: identity
- [Device <IMicrosoftGraphIdentity>]
: identity
- [User <IMicrosoftGraphIdentity>]
: identity
- [ApplicationInstance <IMicrosoftGraphIdentity>]
: identity
- [AssertedIdentity <IMicrosoftGraphIdentity>]
: identity
- [AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity
- [Encrypted <IMicrosoftGraphIdentity>]
: identity
- [EndpointType <String>]
: endpointType
- [Guest <IMicrosoftGraphIdentity>]
: identity
- [OnPremises <IMicrosoftGraphIdentity>]
: identity
- [Phone <IMicrosoftGraphIdentity>]
: identity
- [Description <IMicrosoftGraphItemBody>]
: itemBody
- [DisplayName <String>]
: The display name of the virtual event.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Email <String>]
: Email address of the presenter.
- [Identity <IMicrosoftGraphIdentity>]
: identity
- [PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Bio <IMicrosoftGraphItemBody>]
: itemBody
- [Company <String>]
: The presenter's company name.
- [JobTitle <String>]
: The presenter's job title.
- [LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.
- [PersonalSiteWebUrl <String>]
: The presenter's personal website URL.
- [Photo <Byte-
[]>]
: The content stream of the presenter's photo.
- [TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.
- [AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.
- [AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.
- [AllowLiveShare <String>]
: meetingLiveShareOptions
- [AllowMeetingChat <String>]
: meetingChatMode
- [AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.
- [AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.
- [AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.
- [AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.
- [AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.
- [AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.
- [AllowedPresenters <String>]
: onlineMeetingPresenters
- [AnonymizeIdentityForRoles <String-
[]>]
: 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.
- [AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting.
Read-only.
- [AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing
- [ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo
- [ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions
- [IsEndToEndEncryptionEnabled <Boolean?>]
:
- [IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.
- [JoinInformation <IMicrosoftGraphItemBody>]
: itemBody
- [JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings
- [JoinWebUrl <String>]
: The join URL of the online meeting.
Read-only.
- [LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings
- [RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.
- [ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode
- [Subject <String>]
: The subject of the online meeting.
- [VideoTeleconferenceId <String>]
: The video teleconferencing ID.
Read-only.
- [WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event.
Only appears when applicable.
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.
- [Email <String>]
: Email address of the registrant.
- [FirstName <String>]
: First name of the registrant.
- [LastName <String>]
: Last name of the registrant.
- [PreferredLanguage <String>]
: The registrant's preferred language.
- [PreferredTimezone <String>]
: The registrant's time zone details.
- [RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event.
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.
- [RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.
- [BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is boolean.
- [DisplayName <String>]
: Display name of the registration question.
- [MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion.
Only appears when answerInputType is multiChoice.
- [QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.
- [Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion.
Appears when answerInputType is text, multilineText or singleChoice.
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:
- [Status <String>]
: virtualEventAttendeeRegistrationStatus
- [UserId <String>]
: The registrant's ID in Microsoft Entra ID.
Only appears when the registrant is registered in Microsoft Entra ID.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.
- [Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
- [StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
- [Status <String>]
: virtualEventStatus
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: meetingAudience
- [CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.
- [DisplayName <String>]
: The display name of the identity.
For drive items, the display name 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 don't show up as changed when using delta.
- [Id <String>]
: Unique identifier for the identity or actor.
For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
- [TenantId <String>]
: The user's tenant ID.
- [RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Capacity <Int32?>]
: Total capacity of the virtual event.
- [Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: Display name of the registration question.
- [IsRequired <Boolean?>]
: Indicates whether an answer to the question is required.
The default value is false.
- [RegistrationWebUrl <String>]
: Registration URL of the virtual event.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsManualApprovalEnabled <Boolean?>]
:
- [IsWaitlistEnabled <Boolean?>]
:
- [Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
- [WindowsInformationProtectionDeviceRegistrations <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration-
[]>]
: Zero or more WIP device registrations that belong to the user.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DeviceMacAddress <String>]
: Device Mac address.
- [DeviceName <String>]
: Device name.
- [DeviceRegistrationId <String>]
: Device identifier for this device registration record.
- [DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.
- [LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.
- [UserId <String>]
: UserId associated with this device registration record.
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [Description <String>]
: The description of the item.
- [ETag <String>]
: ETag for the item.
Read-only.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedByUser <IMicrosoftGraphUser>]
: user
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: The name of the item.
Read-write.
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [WebUrl <String>]
: URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Activities <IMicrosoftGraphItemActivityOld-
[]>]
: The list of recent activities that took place on this item.
- [Analytics <IMicrosoftGraphItemAnalytics>]
: itemAnalytics
- [Audio <IMicrosoftGraphAudio>]
: audio
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <String>]
: The title of the album for this audio file.
- [AlbumArtist <String>]
: The artist named on the album for the audio file.
- [Artist <String>]
: The performing artist for the audio file.
- [Bitrate <Int64?>]
: Bitrate expressed in kbps.
- [Composers <String>]
: The name of the composer of the audio file.
- [Copyright <String>]
: Copyright information for the audio file.
- [Disc <Int32?>]
: The number of the disc this audio file came from.
- [DiscCount <Int32?>]
: The total number of discs in this album.
- [Duration <Int64?>]
: Duration of the audio file, expressed in milliseconds
- [Genre <String>]
: The genre of this audio file.
- [HasDrm <Boolean?>]
: Indicates if the file is protected with digital rights management.
- [IsVariableBitrate <Boolean?>]
: Indicates if the file is encoded with a variable bitrate.
- [Title <String>]
: The title of the audio file.
- [Track <Int32?>]
: The number of the track on the original disc for this audio file.
- [TrackCount <Int32?>]
: The total number of tracks on the original disc for this audio file.
- [Year <Int32?>]
: The year the audio file was recorded.
- [Bundle <IMicrosoftGraphBundle>]
: bundle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Album <IMicrosoftGraphAlbum>]
: album
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CoverImageItemId <String>]
: Unique identifier of the driveItem that is the cover of the album.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [CTag <String>]
: An eTag for the content of the item.
This eTag isn't changed if only the metadata is changed.
Note This property isn't returned if the item is a folder.
Read-only.
- [Children <IMicrosoftGraphDriveItem-
[]>]
: Collection containing Item objects for the immediate children of Item.
Only items representing folders have children.
Read-only.
Nullable.
- [Content <Byte-
[]>]
: The content stream, if the item represents a file.
The content property will have a potentially breaking change in behavior in the future.
It will stream content directly instead of redirecting.
To proactively opt in to the new behavior ahead of time, use the contentStream property instead.
- [ContentStream <Byte-
[]>]
: The content stream, if the item represents a file.
- [Deleted <IMicrosoftGraphDeleted>]
: deleted
- [File <IMicrosoftGraphFile>]
: file
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Hashes <IMicrosoftGraphHashes>]
: hashes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Crc32Hash <String>]
: The CRC32 value of the file (if available).
Read-only.
- [QuickXorHash <String>]
: A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available).
Read-only.
- [Sha1Hash <String>]
: SHA1 hash for the contents of the file (if available).
Read-only.
- [Sha256Hash <String>]
: SHA256 hash for the contents of the file (if available).
Read-only.
- [MimeType <String>]
: 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.
- [ProcessingMetadata <Boolean?>]
:
- [FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedDateTime <DateTime?>]
: The UTC date and time the file was created on a client.
- [LastAccessedDateTime <DateTime?>]
: The UTC date and time the file was last accessed.
Available for the recent file list only.
- [LastModifiedDateTime <DateTime?>]
: The UTC date and time the file was last modified on a client.
- [Folder <IMicrosoftGraphFolder>]
: folder
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ChildCount <Int32?>]
: Number of children contained immediately within this container.
- [View <IMicrosoftGraphFolderView>]
: folderView
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [SortBy <String>]
: The method by which the folder should be sorted.
- [SortOrder <String>]
: If true, indicates that items should be sorted in descending order.
Otherwise, items should be sorted ascending.
- [ViewType <String>]
: The type of view that should be used to represent the folder.
- [Image <IMicrosoftGraphImage>]
: image
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Height <Int32?>]
: Optional.
Height of the image, in pixels.
Read-only.
- [Width <Int32?>]
: Optional.
Width of the image, in pixels.
Read-only.
- [ListItem <IMicrosoftGraphListItem>]
: listItem
- [Location <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates
- [Malware <IMicrosoftGraphMalware>]
: malware
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Description <String>]
: Contains the virus details for the malware facet.
- [Media <IMicrosoftGraphMedia>]
: media
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [IsTranscriptionShown <Boolean?>]
: 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.
- [MediaSource <IMicrosoftGraphMediaSource>]
: mediaSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ContentCategory <String>]
: mediaSourceContentCategory
- [Package <IMicrosoftGraphPackage>]
: package
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Type <String>]
: An string indicating the type of package.
While oneNote is the only currently defined value, you should expect other package types to be returned and handle them accordingly.
- [PendingOperations <IMicrosoftGraphPendingOperations>]
: pendingOperations
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [PendingContentUpdate <IMicrosoftGraphPendingContentUpdate>]
: pendingContentUpdate
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [QueuedDateTime <DateTime?>]
: Date and time the pending binary operation was queued in UTC time.
Read-only.
- [Permissions <IMicrosoftGraphPermission-
[]>]
: The set of permissions for the item.
Read-only.
Nullable.
- [Photo <IMicrosoftGraphPhoto>]
: photo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CameraMake <String>]
: Camera manufacturer.
Read-only.
- [CameraModel <String>]
: Camera model.
Read-only.
- [ExposureDenominator <Double?>]
: The denominator for the exposure time fraction from the camera.
Read-only.
- [ExposureNumerator <Double?>]
: The numerator for the exposure time fraction from the camera.
Read-only.
- [FNumber <Double?>]
: The F-stop value from the camera.
Read-only.
- [FocalLength <Double?>]
: The focal length from the camera.
Read-only.
- [Iso <Int32?>]
: The ISO value from the camera.
Read-only.
- [Orientation <Int32?>]
: The orientation value from the camera.
Writable on OneDrive Personal.
- [TakenDateTime <DateTime?>]
: The date and time the photo was taken in UTC time.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [RemoteItem <IMicrosoftGraphRemoteItem>]
: remoteItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [CreatedDateTime <DateTime?>]
: Date and time of item creation.
Read-only.
- [File <IMicrosoftGraphFile>]
: file
- [FileSystemInfo <IMicrosoftGraphFileSystemInfo>]
: fileSystemInfo
- [Folder <IMicrosoftGraphFolder>]
: folder
- [Id <String>]
: Unique identifier for the remote item in its drive.
Read-only.
- [Image <IMicrosoftGraphImage>]
: image
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time the item was last modified.
Read-only.
- [Name <String>]
: Optional.
Filename of the remote item.
Read-only.
- [Package <IMicrosoftGraphPackage>]
: package
- [ParentReference <IMicrosoftGraphItemReference>]
: itemReference
- [Shared <IMicrosoftGraphShared>]
: shared
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Owner <IMicrosoftGraphIdentitySet>]
: identitySet
- [Scope <String>]
: Indicates the scope of how the item is shared.
The possible values are: anonymous, organization, or users.
Read-only.
- [SharedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [SharedDateTime <DateTime?>]
: The UTC date and time when the item was shared.
Read-only.
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [Size <Int64?>]
: Size of the remote item.
Read-only.
- [SpecialFolder <IMicrosoftGraphSpecialFolder>]
: specialFolder
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Name <String>]
: The unique identifier for this item in the /drive/special collection
- [Video <IMicrosoftGraphVideo>]
: video
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AudioBitsPerSample <Int32?>]
: Number of audio bits per sample.
- [AudioChannels <Int32?>]
: Number of audio channels.
- [AudioFormat <String>]
: Name of the audio format (AAC, MP3, etc.).
- [AudioSamplesPerSecond <Int32?>]
: Number of audio samples per second.
- [Bitrate <Int32?>]
: Bit rate of the video in bits per second.
- [Duration <Int64?>]
: Duration of the file in milliseconds.
- [FourCc <String>]
: 'Four character code' name of the video format.
- [FrameRate <Double?>]
:
- [Height <Int32?>]
: Height of the video, in pixels.
- [Width <Int32?>]
: Width of the video, in pixels.
- [WebDavUrl <String>]
: DAV compatible URL for the item.
- [WebUrl <String>]
: URL that displays the resource in the browser.
Read-only.
- [RetentionLabel <IMicrosoftGraphItemRetentionLabel>]
: itemRetentionLabel
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [IsLabelAppliedExplicitly <Boolean?>]
: 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.
- [LabelAppliedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LabelAppliedDateTime <DateTime?>]
: The date and time when the label was applied on the item.
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.
- [Name <String>]
: The retention label on the document.
Read-write.
- [RetentionSettings <IMicrosoftGraphRetentionLabelSettings>]
: retentionLabelSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BehaviorDuringRetentionPeriod <String>]
: behaviorDuringRetentionPeriod
- [IsContentUpdateAllowed <Boolean?>]
: Specifies whether updates to document content are allowed.
Read-only.
- [IsDeleteAllowed <Boolean?>]
: Specifies whether the document deletion is allowed.
Read-only.
- [IsLabelUpdateAllowed <Boolean?>]
: Specifies whether you're allowed to change the retention label on the document.
Read-only.
- [IsMetadataUpdateAllowed <Boolean?>]
: Specifies whether updates to the item metadata (for example, the Title field) are blocked.
Read-only.
- [IsRecordLocked <Boolean?>]
: Specifies whether the item is locked.
Read-write.
- [Root <IMicrosoftGraphRoot>]
: root
- [SearchResult <IMicrosoftGraphSearchResult>]
: searchResult
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [OnClickTelemetryUrl <String>]
: 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.
- [Shared <IMicrosoftGraphShared>]
: shared
- [SharepointIds <IMicrosoftGraphSharepointIds>]
: sharepointIds
- [Size <Int64?>]
: Size of the item in bytes.
Read-only.
- [Source <IMicrosoftGraphDriveItemSource>]
: driveItemSource
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Application <String>]
: driveItemSourceApplication
- [ExternalId <String>]
: The external identifier for the drive item from the source.
- [SpecialFolder <IMicrosoftGraphSpecialFolder>]
: specialFolder
- [Subscriptions <IMicrosoftGraphSubscription-
[]>]
: The set of subscriptions on the item.
Only supported on the root of a drive.
- [Thumbnails <IMicrosoftGraphThumbnailSet-
[]>]
: Collection of thumbnailSet objects associated with the item.
For more information, see getting thumbnails.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Large <IMicrosoftGraphThumbnail>]
: thumbnail
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Content <Byte-
[]>]
: The content stream for the thumbnail.
- [Height <Int32?>]
: The height of the thumbnail, in pixels.
- [SourceItemId <String>]
: The unique identifier of the item that provided the thumbnail.
This is only available when a folder thumbnail is requested.
- [Url <String>]
: The URL used to fetch the thumbnail content.
- [Width <Int32?>]
: The width of the thumbnail, in pixels.
- [Medium <IMicrosoftGraphThumbnail>]
: thumbnail
- [Small <IMicrosoftGraphThumbnail>]
: thumbnail
- [Source <IMicrosoftGraphThumbnail>]
: thumbnail
- [Versions <IMicrosoftGraphDriveItemVersion-
[]>]
: The list of previous versions of the item.
For more info, see getting previous versions.
Read-only.
Nullable.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: Date and time when the version was last modified.
Read-only.
- [Publication <IMicrosoftGraphPublicationFacet>]
: publicationFacet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Content <Byte-
[]>]
:
- [Size <Int64?>]
: Indicates the size of the content stream for this version of the item.
- [Video <IMicrosoftGraphVideo>]
: video
- [Viewpoint <IMicrosoftGraphDriveItemViewpoint>]
: driveItemViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AccessOperations <IMicrosoftGraphDriveItemAccessOperationsViewpoint>]
: driveItemAccessOperationsViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [CanComment <Boolean?>]
: Indicates whether the user can comment on this item.
- [CanCreateFile <Boolean?>]
: Indicates whether the user can create files within this object.
Returned only on folders.
- [CanCreateFolder <Boolean?>]
: Indicates whether the user can create folders within this object.
Returned only on folders.
- [CanDelete <Boolean?>]
: Indicates whether the user can delete this item.
- [CanDownload <Boolean?>]
: Indicates whether the user can download this item.
- [CanRead <Boolean?>]
: Indicates whether the user can read this item.
- [CanUpdate <Boolean?>]
: Indicates whether the user can update this item.
- [Sharing <IMicrosoftGraphSharingViewpoint>]
: sharingViewpoint
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DefaultSharingLink <IMicrosoftGraphDefaultSharingLink>]
: defaultSharingLink
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DefaultToExistingAccess <Boolean?>]
: Indicates whether the default link setting for this object is a direct URL rather than a sharing link.
- [Role <String>]
: sharingRole
- [Scope <String>]
: sharingScope
- [SharingAbilities <IMicrosoftGraphSharePointSharingAbilities>]
: sharePointSharingAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AnyoneLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [BlockDownloadLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddExistingExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisabledReason <String>]
: Provides a description of why this operation is not enabled.
Only returned if this operation is not enabled.
- [Enabled <Boolean?>]
: Indicates whether this operation is enabled.
- [AddNewExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [ApplyVariants <IMicrosoftGraphSharingLinkVariants>]
: sharingLinkVariants
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddressBarLinkPermission <String>]
: sharingRole
- [AllowEmbed <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [PasswordProtected <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [RequiresAuthentication <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [CreateLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [DeleteLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [LinkAllowsExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [LinkExpiration <IMicrosoftGraphSharingLinkExpirationStatus>]
: sharingLinkExpirationStatus
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DefaultExpirationInDays <Int32?>]
: Default link expiration in days.
Returns -1 if there is no required expiration time.
- [DisabledReason <String>]
: Provides a description of why this operation is not enabled.
Only returned if this operation is not enabled.
- [Enabled <Boolean?>]
: Indicates whether this operation is enabled.
- [RetrieveLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [UpdateLink <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [EditLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [ManageListLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [ReadLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [ReviewLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [SubmitOnlyLinkAbilities <IMicrosoftGraphLinkRoleAbilities>]
: linkRoleAbilities
- [DirectSharingAbilities <IMicrosoftGraphDirectSharingAbilities>]
: directSharingAbilities
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AddExistingExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [AddInternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [AddNewExternalUsers <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [RequestGrantAccess <IMicrosoftGraphSharingOperationStatus>]
: sharingOperationStatus
- [OrganizationLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
- [SpecificPeopleLinkAbilities <IMicrosoftGraphLinkScopeAbilities>]
: linkScopeAbilities
- [WebDavUrl <String>]
: WebDAV compatible URL for the item.
- [Workbook <IMicrosoftGraphWorkbook>]
: workbook
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Application <IMicrosoftGraphWorkbookApplication>]
: workbookApplication
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CalculationMode <String>]
: Returns the calculation mode used in the workbook.
Possible values are: Automatic, AutomaticExceptTables, Manual.
- [Comments <IMicrosoftGraphWorkbookComment-
[]>]
:
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Content <String>]
: The content of the comment.
- [ContentType <String>]
: The content type of the comment.
- [Replies <IMicrosoftGraphWorkbookCommentReply-
[]>]
: The list of replies to the comment.
Read-only.
Nullable.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Content <String>]
: The content of the reply.
- [ContentType <String>]
: The content type for the reply.
- [Task <IMicrosoftGraphWorkbookDocumentTask>]
: workbookDocumentTask
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignees <IMicrosoftGraphWorkbookEmailIdentity-
[]>]
: A collection of user identities the task is assigned to.
- [DisplayName <String>]
: Display name of the user.
- [Email <String>]
: Email address of the user.
- [Id <String>]
: The unique identifier of the user.
- [Changes <IMicrosoftGraphWorkbookDocumentTaskChange-
[]>]
: A collection of task change histories.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Assignee <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [ChangedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [CommentId <String>]
: The identifier of the associated comment.
- [CreatedDateTime <DateTime?>]
: Date and time when the task was changed.
Nullable.
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.
- [DueDateTime <DateTime?>]
: The due date and time for the task.
Only present when the type property is setSchedule.
Nullable.
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.
- [PercentComplete <Int32?>]
: An integer value from 0 to 100 that represents the percentage of the completion of the task and associated comment.
100 means that the task and associated comment are completed.
If you change the completion from 100 to a lower value, the associated task and comment are reactivated.
Only present when the type property is setPercentComplete.
Nullable.
- [Priority <Int32?>]
: An integer value from 0 to 10 that represents the priority of the task.
A lower value indicates a higher priority.
5 indicates the default priority if not set.
Only present when the type property is setPriority.
Nullable.
- [StartDateTime <DateTime?>]
: The start date and time for the task.
Only present when the type property is setSchedule.
Nullable.
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.
- [Title <String>]
: The title of the task.
Only present when the type property is setTitle.
Nullable.
- [Type <String>]
: The type of the change history.
Possible values are: create, assign, unassign, unassignAll, setPriority, setTitle, setPercentComplete, setSchedule, remove, restore, undo.
- [UndoChangeId <String>]
: The ID of the workbookDocumentTaskChange that was undone for the undo change action.
Only exists on an undo change history.
Nullable.
- [Comment <IMicrosoftGraphWorkbookComment>]
: workbookComment
- [CompletedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [CompletedDateTime <DateTime?>]
: Date and time when the task was completed.
Nullable.
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.
- [CreatedBy <IMicrosoftGraphWorkbookEmailIdentity>]
: workbookEmailIdentity
- [CreatedDateTime <DateTime?>]
: Date and time when the task was created.
Nullable.
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.
- [PercentComplete <Int32?>]
: An integer value from 0 to 100 that represents the percentage of the completion of the task.
100 means that the task is completed.
Nullable.
- [Priority <Int32?>]
: An integer value from 0 to 10 that represents the priority of the task.
A lower value indicates a higher priority.
Nullable.
- [StartAndDueDateTime <IMicrosoftGraphWorkbookDocumentTaskSchedule>]
: workbookDocumentTaskSchedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DueDateTime <DateTime?>]
: The due date and time for the task.
Nullable.
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.
- [StartDateTime <DateTime?>]
: The start date and time for the task.
Nullable.
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.
- [Title <String>]
: The title of the task.
- [Task <IMicrosoftGraphWorkbookDocumentTask>]
: workbookDocumentTask
- [Functions <IMicrosoftGraphWorkbookFunctions>]
: workbookFunctions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Names <IMicrosoftGraphWorkbookNamedItem-
[]>]
: Represents a collection of workbooks scoped named items (named ranges and constants).
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Comment <String>]
: The comment associated with this name.
- [Name <String>]
: The name of the object.
Read-only.
- [Scope <String>]
: Indicates whether the name is scoped to the workbook or to a specific worksheet.
Read-only.
- [Type <String>]
: The type of reference is associated with the name.
Possible values are: String, Integer, Double, Boolean, Range.
Read-only.
- [Value <IMicrosoftGraphJson>]
: Json
- [Visible <Boolean?>]
: Indicates whether the object is visible.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Charts <IMicrosoftGraphWorkbookChart-
[]>]
: The list of charts that are part of the worksheet.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Axes <IMicrosoftGraphWorkbookChartAxes>]
: workbookChartAxes
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [CategoryAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartAxisFormat>]
: workbookChartAxisFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Bold <Boolean?>]
: Indicates whether the fond is bold.
- [Color <String>]
: The HTML color code representation of the text color.
For example #FF0000 represents Red.
- [Italic <Boolean?>]
: Indicates whether the fond is italic.
- [Name <String>]
: The font name.
For example 'Calibri'.
- [Size <Double?>]
: The size of the font.
For example, 11.
- [Underline <String>]
: The type of underlining applied to the font.
The possible values are: None, Single.
- [Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Color <String>]
: The HTML color code that represents the color of lines in the chart.
- [MajorGridlines <IMicrosoftGraphWorkbookChartGridlines>]
: workbookChartGridlines
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartGridlinesFormat>]
: workbookChartGridlinesFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
- [Visible <Boolean?>]
: Indicates whether the axis gridlines are visible.
- [MajorUnit <IMicrosoftGraphJson>]
: Json
- [Maximum <IMicrosoftGraphJson>]
: Json
- [Minimum <IMicrosoftGraphJson>]
: Json
- [MinorGridlines <IMicrosoftGraphWorkbookChartGridlines>]
: workbookChartGridlines
- [MinorUnit <IMicrosoftGraphJson>]
: Json
- [Title <IMicrosoftGraphWorkbookChartAxisTitle>]
: workbookChartAxisTitle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartAxisTitleFormat>]
: workbookChartAxisTitleFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Text <String>]
: Represents the axis title.
- [Visible <Boolean?>]
: A Boolean that specifies the visibility of an axis title.
- [SeriesAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
- [ValueAxis <IMicrosoftGraphWorkbookChartAxis>]
: workbookChartAxis
- [DataLabels <IMicrosoftGraphWorkbookChartDataLabels>]
: workbookChartDataLabels
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartDataLabelFormat>]
: workbookChartDataLabelFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Position <String>]
: DataLabelPosition value that represents the position of the data label.
The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.
- [Separator <String>]
: String that represents the separator used for the data labels on a chart.
- [ShowBubbleSize <Boolean?>]
: Boolean value that represents whether the data label bubble size is visible.
- [ShowCategoryName <Boolean?>]
: Boolean value that represents whether the data label category name is visible.
- [ShowLegendKey <Boolean?>]
: Boolean value that represents whether the data label legend key is visible.
- [ShowPercentage <Boolean?>]
: Boolean value that represents whether the data label percentage is visible.
- [ShowSeriesName <Boolean?>]
: Boolean value that represents whether the data label series name is visible.
- [ShowValue <Boolean?>]
: Boolean value that represents whether the data label value is visible.
- [Format <IMicrosoftGraphWorkbookChartAreaFormat>]
: workbookChartAreaFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Height <Double?>]
: Represents the height, in points, of the chart object.
- [Left <Double?>]
: The distance, in points, from the left side of the chart to the worksheet origin.
- [Legend <IMicrosoftGraphWorkbookChartLegend>]
: workbookChartLegend
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartLegendFormat>]
: workbookChartLegendFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Overlay <Boolean?>]
: Indicates whether the chart legend should overlap with the main body of the chart.
- [Position <String>]
: Represents the position of the legend on the chart.
The possible values are: Top, Bottom, Left, Right, Corner, Custom.
- [Visible <Boolean?>]
: Indicates whether the chart legend is visible.
- [Name <String>]
: Represents the name of a chart object.
- [Series <IMicrosoftGraphWorkbookChartSeries-
[]>]
: Represents either a single series or collection of series in the chart.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartSeriesFormat>]
: workbookChartSeriesFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Line <IMicrosoftGraphWorkbookChartLineFormat>]
: workbookChartLineFormat
- [Name <String>]
: The name of a series in a chart.
- [Points <IMicrosoftGraphWorkbookChartPoint-
[]>]
: A collection of all points in the series.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartPointFormat>]
: workbookChartPointFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Value <IMicrosoftGraphJson>]
: Json
- [Title <IMicrosoftGraphWorkbookChartTitle>]
: workbookChartTitle
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Format <IMicrosoftGraphWorkbookChartTitleFormat>]
: workbookChartTitleFormat
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fill <IMicrosoftGraphWorkbookChartFill>]
: workbookChartFill
- [Font <IMicrosoftGraphWorkbookChartFont>]
: workbookChartFont
- [Overlay <Boolean?>]
: Indicates whether the chart title will overlay the chart or not.
- [Text <String>]
: The title text of the chart.
- [Visible <Boolean?>]
: Indicates whether the chart title is visible.
- [Top <Double?>]
: Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
- [Width <Double?>]
: Represents the width, in points, of the chart object.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [Name <String>]
: The display name of the worksheet.
- [Names <IMicrosoftGraphWorkbookNamedItem-
[]>]
: The list of names that are associated with the worksheet.
Read-only.
- [PivotTables <IMicrosoftGraphWorkbookPivotTable-
[]>]
: The list of piot tables that are part of the worksheet.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Name <String>]
: The name of the pivot table.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [Position <Int32?>]
: The zero-based position of the worksheet within the workbook.
- [Protection <IMicrosoftGraphWorkbookWorksheetProtection>]
: workbookWorksheetProtection
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Options <IMicrosoftGraphWorkbookWorksheetProtectionOptions>]
: workbookWorksheetProtectionOptions
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowAutoFilter <Boolean?>]
: Represents the worksheet protection option of allowing using auto filter feature.
- [AllowDeleteColumns <Boolean?>]
: Represents the worksheet protection option of allowing deleting columns.
- [AllowDeleteRows <Boolean?>]
: Represents the worksheet protection option of allowing deleting rows.
- [AllowFormatCells <Boolean?>]
: Represents the worksheet protection option of allowing formatting cells.
- [AllowFormatColumns <Boolean?>]
: Represents the worksheet protection option of allowing formatting columns.
- [AllowFormatRows <Boolean?>]
: Represents the worksheet protection option of allowing formatting rows.
- [AllowInsertColumns <Boolean?>]
: Represents the worksheet protection option of allowing inserting columns.
- [AllowInsertHyperlinks <Boolean?>]
: Represents the worksheet protection option of allowing inserting hyperlinks.
- [AllowInsertRows <Boolean?>]
: Represents the worksheet protection option of allowing inserting rows.
- [AllowPivotTables <Boolean?>]
: Represents the worksheet protection option of allowing using pivot table feature.
- [AllowSort <Boolean?>]
: Represents the worksheet protection option of allowing using sort feature.
- [Protected <Boolean?>]
: Indicates whether the worksheet is protected.
Read-only.
- [Tables <IMicrosoftGraphWorkbookTable-
[]>]
: The list of tables that are part of the worksheet.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Columns <IMicrosoftGraphWorkbookTableColumn-
[]>]
: The list of all the columns in the table.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Filter <IMicrosoftGraphWorkbookFilter>]
: workbookFilter
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Criteria <IMicrosoftGraphWorkbookFilterCriteria>]
: workbookFilterCriteria
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Color <String>]
: The color applied to the cell.
- [Criterion1 <String>]
: A custom criterion.
- [Criterion2 <String>]
: A custom criterion.
- [DynamicCriteria <String>]
: A dynamic formula specified in a custom filter.
- [FilterOn <String>]
: Indicates whether a filter is applied to a column.
- [Icon <IMicrosoftGraphWorkbookIcon>]
: workbookIcon
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Index <Int32?>]
: The index of the icon in the given set.
- [Set <String>]
: The set that the icon is part of.
Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes.
- [Operator <String>]
: An operator in a cell; for example, =, >, <, <=, or <>.
- [Values <IMicrosoftGraphJson>]
: Json
- [Index <Int32?>]
: The index of the column within the columns collection of the table.
Zero-indexed.
Read-only.
- [Name <String>]
: The name of the table column.
- [Values <IMicrosoftGraphJson>]
: Json
- [HighlightFirstColumn <Boolean?>]
: Indicates whether the first column contains special formatting.
- [HighlightLastColumn <Boolean?>]
: Indicates whether the last column contains special formatting.
- [LegacyId <String>]
: A legacy identifier used in older Excel clients.
The value of the identifier remains the same even when the table is renamed.
This property should be interpreted as an opaque string value and shouldn't be parsed to any other type.
Read-only.
- [Name <String>]
: The name of the table.
- [Rows <IMicrosoftGraphWorkbookTableRow-
[]>]
: The list of all the rows in the table.
Read-only.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Index <Int32?>]
: The index of the row within the rows collection of the table.
Zero-based.
Read-only.
- [Values <IMicrosoftGraphJson>]
: Json
- [ShowBandedColumns <Boolean?>]
: Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.
- [ShowBandedRows <Boolean?>]
: Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.
- [ShowFilterButton <Boolean?>]
: Indicates whether the filter buttons are visible at the top of each column header.
Setting this is only allowed if the table contains a header row.
- [ShowHeaders <Boolean?>]
: Indicates whether the header row is visible or not.
This value can be set to show or remove the header row.
- [ShowTotals <Boolean?>]
: Indicates whether the total row is visible or not.
This value can be set to show or remove the total row.
- [Sort <IMicrosoftGraphWorkbookTableSort>]
: workbookTableSort
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Fields <IMicrosoftGraphWorkbookSortField-
[]>]
: The list of the current conditions last used to sort the table.
Read-only.
- [Ascending <Boolean?>]
: Represents whether the sorting is done in an ascending fashion.
- [Color <String>]
: Represents the color that is the target of the condition if the sorting is on font or cell color.
- [DataOption <String>]
: Represents additional sorting options for this field.
Possible values are: Normal, TextAsNumber.
- [Icon <IMicrosoftGraphWorkbookIcon>]
: workbookIcon
- [Key <Int32?>]
: Represents the column (or row, depending on the sort orientation) that the condition is on.
Represented as an offset from the first column (or row).
- [SortOn <String>]
: Represents the type of sorting of this condition.
Possible values are: Value, CellColor, FontColor, Icon.
- [MatchCase <Boolean?>]
: Indicates whether the casing impacted the last sort of the table.
Read-only.
- [Method <String>]
: The Chinese character ordering method last used to sort the table.
The possible values are: PinYin, StrokeCount.
Read-only.
- [Style <String>]
: A constant value that represents the Table style.
Possible values are: TableStyleLight1 through TableStyleLight21, TableStyleMedium1 through TableStyleMedium28, TableStyleStyleDark1 through TableStyleStyleDark11.
A custom user-defined style present in the workbook can also be specified.
- [Worksheet <IMicrosoftGraphWorkbookWorksheet>]
: workbookWorksheet
- [Tasks <IMicrosoftGraphWorkbookDocumentTask-
[]>]
: Collection of document tasks on this worksheet.
Read-only.
- [Visibility <String>]
: The visibility of the worksheet.
The possible values are: Visible, Hidden, VeryHidden.
- [Operations <IMicrosoftGraphWorkbookOperation-
[]>]
: 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.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Error <IMicrosoftGraphWorkbookOperationError>]
: workbookOperationError
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The error code.
- [InnerError <IMicrosoftGraphWorkbookOperationError>]
: workbookOperationError
- [Message <String>]
: The error message.
- [ResourceLocation <String>]
: The resource URI for the result.
- [Status <String>]
: workbookOperationStatus
- [Tables <IMicrosoftGraphWorkbookTable-
[]>]
: Represents a collection of tables associated with the workbook.
Read-only.
- [Worksheets <IMicrosoftGraphWorkbookWorksheet-
[]>]
: Represents a collection of worksheets associated with the workbook.
Read-only.
- [IsArchived <Boolean?>]
: Indicates whether the channel is archived.
Read-only.
- [IsFavoriteByDefault <Boolean?>]
: Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list.
Note: All recommended channels automatically show in the channels list for education and frontline worker users.
The property can only be set programmatically via the Create team method.
The default value is false.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: A collection of membership records associated with the channel.
- [MembershipType <String>]
: channelMembershipType
- [Messages <IMicrosoftGraphChatMessage-
[]>]
: A collection of all the messages in the channel.
A navigation property.
Nullable.
- [ModerationSettings <IMicrosoftGraphChannelModerationSettings>]
: channelModerationSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowNewMessageFromBots <Boolean?>]
: Indicates whether bots are allowed to post messages.
- [AllowNewMessageFromConnectors <Boolean?>]
: Indicates whether connectors are allowed to post messages.
- [ReplyRestriction <String>]
: replyRestriction
- [UserNewMessageRestriction <String>]
: userNewMessageRestriction
- [SharedWithTeams <IMicrosoftGraphSharedWithChannelTeamInfo-
[]>]
: A collection of teams with which a channel is shared.
- [DisplayName <String>]
: The name of the team.
- [Team <IMicrosoftGraphTeam>]
: team
- [TenantId <String>]
: The ID of the Microsoft Entra tenant.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [AllowedMembers <IMicrosoftGraphConversationMember-
[]>]
: A collection of team members who have access to the shared channel.
- [IsHostTeam <Boolean?>]
: Indicates whether the team is the host of the channel.
- [Summary <IMicrosoftGraphChannelSummary>]
: channelSummary
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [GuestsCount <Int32?>]
: Count of guests in a channel.
- [HasMembersFromOtherTenants <Boolean?>]
: Indicates whether external members are included on the channel.
- [MembersCount <Int32?>]
: Count of members in a channel.
- [OwnersCount <Int32?>]
: Count of owners in a channel.
- [Tabs <IMicrosoftGraphTeamsTab-
[]>]
: A collection of all the tabs in the channel.
A navigation property.
- [TenantId <String>]
: The ID of the Microsoft Entra tenant.
- [WebUrl <String>]
: A hyperlink to the channel in Microsoft Teams.
This URL is supplied 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.
- [Channels <IMicrosoftGraphChannel-
[]>]
: The collection of channels and messages associated with the team.
- [Classification <String>]
: 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.
- [CreatedDateTime <DateTime?>]
: Timestamp at which the team was created.
- [Description <String>]
: An optional description for the team.
Maximum length: 1024 characters.
- [DiscoverySettings <IMicrosoftGraphTeamDiscoverySettings>]
: teamDiscoverySettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ShowInTeamsSearchAndSuggestions <Boolean?>]
: If set to true, the team is visible via search and suggestions from the Teams client.
- [DisplayName <String>]
: The name of the team.
- [FunSettings <IMicrosoftGraphTeamFunSettings>]
: teamFunSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowCustomMemes <Boolean?>]
: If set to true, enables users to include custom memes.
- [AllowGiphy <Boolean?>]
: If set to true, enables Giphy use.
- [AllowStickersAndMemes <Boolean?>]
: If set to true, enables users to include stickers and memes.
- [GiphyContentRating <String>]
: giphyRatingType
- [Group <IMicrosoftGraphGroup>]
: group
- [GuestSettings <IMicrosoftGraphTeamGuestSettings>]
: teamGuestSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowCreateUpdateChannels <Boolean?>]
: If set to true, guests can add and update channels.
- [AllowDeleteChannels <Boolean?>]
: If set to true, guests can delete channels.
- [IncomingChannels <IMicrosoftGraphChannel-
[]>]
: List of channels shared with the team.
- [InstalledApps <IMicrosoftGraphTeamsAppInstallation-
[]>]
: The apps installed in this team.
- [InternalId <String>]
: A unique ID for the team used in a few places such as the audit log/Office 365 Management Activity API.
- [IsArchived <Boolean?>]
: Whether this team is in read-only mode.
- [IsMembershipLimitedToOwners <Boolean?>]
: If set to true, the team is currently in the owner-only team membership state and inaccessible by other team members, such as students.
- [MemberSettings <IMicrosoftGraphTeamMemberSettings>]
: teamMemberSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowAddRemoveApps <Boolean?>]
: If set to true, members can add and remove apps.
- [AllowCreatePrivateChannels <Boolean?>]
: If set to true, members can add and update private channels.
- [AllowCreateUpdateChannels <Boolean?>]
: If set to true, members can add and update any channels.
- [AllowCreateUpdateRemoveConnectors <Boolean?>]
: If set to true, members can add, update, and remove connectors.
- [AllowCreateUpdateRemoveTabs <Boolean?>]
: If set to true, members can add, update, and remove tabs.
- [AllowDeleteChannels <Boolean?>]
: If set to true, members can delete channels.
- [Members <IMicrosoftGraphConversationMember-
[]>]
: Members and owners of the team.
- [MessagingSettings <IMicrosoftGraphTeamMessagingSettings>]
: teamMessagingSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AllowChannelMentions <Boolean?>]
: If set to true, @channel mentions are allowed.
- [AllowOwnerDeleteMessages <Boolean?>]
: If set to true, owners can delete any message.
- [AllowTeamMentions <Boolean?>]
: If set to true, @team mentions are allowed.
- [AllowUserDeleteMessages <Boolean?>]
: If set to true, users can delete their messages.
- [AllowUserEditMessages <Boolean?>]
: If set to true, users can edit their messages.
- [Operations <IMicrosoftGraphTeamsAsyncOperation-
[]>]
: The async operations that ran or are running on this team.
- [Owners <IMicrosoftGraphUser-
[]>]
: 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).
The owner must be specified as an object ID (GUID), not a UPN.
- [PermissionGrants <IMicrosoftGraphResourceSpecificPermissionGrant-
[]>]
: A collection of permissions granted to apps to access the team.
- [Photo <IMicrosoftGraphProfilePhoto>]
: profilePhoto
- [PrimaryChannel <IMicrosoftGraphChannel>]
: channel
- [Schedule <IMicrosoftGraphSchedule>]
: schedule
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [ActivitiesIncludedWhenCopyingShiftsEnabled <Boolean?>]
: Indicates whether copied shifts should include the activities.
- [DayNotes <IMicrosoftGraphDayNote-
[]>]
: The day notes in the schedule.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DayNoteDate <DateTime?>]
: The date of the day note.
- [DraftDayNote <IMicrosoftGraphItemBody>]
: itemBody
- [SharedDayNote <IMicrosoftGraphItemBody>]
: itemBody
- [Enabled <Boolean?>]
: Indicates whether the schedule is enabled for the team.
Required.
- [IsCrossLocationShiftRequestApprovalRequired <Boolean?>]
: Indicates whether approval is required by a manager of this schedule for cross location shift requests.
- [IsCrossLocationShiftsEnabled <Boolean?>]
: Indicates whether the cross-location marketplace feature is enabled for this schedule.
- [OfferShiftRequests <IMicrosoftGraphOfferShiftRequest-
[]>]
: The offer requests for shifts in the schedule.
- [AssignedTo <String>]
: scheduleChangeRequestActor
- [ManagerActionMessage <String>]
:
- [SenderMessage <String>]
:
- [State <String>]
: scheduleChangeState
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [RecipientActionMessage <String>]
: Custom message sent by recipient of the offer shift request.
- [RecipientUserId <String>]
: User id of the recipient of the offer shift request.
- [SenderShiftId <String>]
: User id of the sender of the offer shift request.
- [OfferShiftRequestsEnabled <Boolean?>]
: Indicates whether offer shift requests are enabled for the schedule.
- [OpenShiftChangeRequests <IMicrosoftGraphOpenShiftChangeRequest-
[]>]
: The open shift requests in the schedule.
- [AssignedTo <String>]
: scheduleChangeRequestActor
- [ManagerActionMessage <String>]
:
- [SenderMessage <String>]
:
- [State <String>]
: scheduleChangeState
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [OpenShiftId <String>]
: ID for the open shift.
- [OpenShifts <IMicrosoftGraphOpenShift-
[]>]
: The set of open shifts in a scheduling group in the schedule.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DraftOpenShift <IMicrosoftGraphOpenShiftItem>]
: openShiftItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Activities <IMicrosoftGraphShiftActivity-
[]>]
: An incremental part of a shift which can cover details of when and where an employee is during their shift.
For example, an assignment or a scheduled break or lunch.
Required.
- [Code <String>]
: Customer defined code for the shiftActivity.
Required.
- [DisplayName <String>]
: The name of the shiftActivity.
Required.
- [EndDateTime <DateTime?>]
: The end date and time for the shiftActivity.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Required.
- [IsPaid <Boolean?>]
: Indicates whether the microsoft.graph.user should be paid for the activity during their shift.
Required.
- [StartDateTime <DateTime?>]
: The start date and time for the shiftActivity.
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Required.
- [Theme <String>]
: scheduleEntityTheme
- [DisplayName <String>]
: The shift label of the shiftItem.
- [Notes <String>]
: The shift notes for the shiftItem.
- [EndDateTime <DateTime?>]
:
- [StartDateTime <DateTime?>]
:
- [Theme <String>]
: scheduleEntityTheme
- [OpenSlotCount <Int32?>]
: Count of the number of slots for the given open shift.
- [IsStagedForDeletion <Boolean?>]
: The openShift is marked for deletion, a process that is finalized when the schedule is shared.
- [SchedulingGroupId <String>]
: The ID of the schedulingGroup that contains the openShift.
- [SchedulingGroupInfo <IMicrosoftGraphSchedulingGroupInfo>]
: schedulingGroupInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Code <String>]
: The code for the schedulingGroup.
- [DisplayName <String>]
: The display name for the schedulingGroup.
Required.
- [SchedulingGroupId <String>]
: ID of the schedulingGroup.
- [SharedOpenShift <IMicrosoftGraphOpenShiftItem>]
: openShiftItem
- [TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name for the team.
Required.
- [TeamId <String>]
: ID of the team.
- [OpenShiftsEnabled <Boolean?>]
: Indicates whether open shifts are enabled for the schedule.
- [ProvisionStatus <String>]
: operationStatus
- [SchedulingGroups <IMicrosoftGraphSchedulingGroup-
[]>]
: The logical grouping of users in the schedule (usually by role).
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Code <String>]
: The code for the schedulingGroup to represent an external identifier.
This field must be unique within the team in Microsoft Teams and uses an alphanumeric format, with a maximum of 100 characters.
- [DisplayName <String>]
: The display name for the schedulingGroup.
Required.
- [UserIds <String-
[]>]
: The list of user IDs that are a member of the schedulingGroup.
Required.
- [Shifts <IMicrosoftGraphShift-
[]>]
: The shifts in the schedule.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DraftShift <IMicrosoftGraphShiftItem>]
: shiftItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDateTime <DateTime?>]
:
- [StartDateTime <DateTime?>]
:
- [Theme <String>]
: scheduleEntityTheme
- [Activities <IMicrosoftGraphShiftActivity-
[]>]
: An incremental part of a shift which can cover details of when and where an employee is during their shift.
For example, an assignment or a scheduled break or lunch.
Required.
- [DisplayName <String>]
: The shift label of the shiftItem.
- [Notes <String>]
: The shift notes for the shiftItem.
- [IsStagedForDeletion <Boolean?>]
: The shift is marked for deletion, a process that is finalized when the schedule is shared.
- [SchedulingGroupId <String>]
: ID of the scheduling group the shift is part of.
Required.
- [SchedulingGroupInfo <IMicrosoftGraphSchedulingGroupInfo>]
: schedulingGroupInfo
- [SharedShift <IMicrosoftGraphShiftItem>]
: shiftItem
- [TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo
- [UserId <String>]
: ID of the user assigned to the shift.
Required.
- [UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [DisplayName <String>]
: The display name for the user.
Required.
- [UserId <String>]
: ID of the user.
- [ShiftsRoleDefinitions <IMicrosoftGraphShiftsRoleDefinition-
[]>]
: The definitions of the roles in the schedule.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Description <String>]
: The description of the role.
- [DisplayName <String>]
: The display name of the role.
- [ShiftsRolePermissions <IMicrosoftGraphShiftsRolePermission-
[]>]
: The collection of role permissions within the role.
- [AllowedResourceActions <String-
[]>]
: The permissions that are allowed for a role.
Permissions that aren't in this collection are disabled.
- [StartDayOfWeek <String>]
: dayOfWeek
- [SwapShiftsChangeRequests <IMicrosoftGraphSwapShiftsChangeRequest-
[]>]
: The swap requests for shifts in the schedule.
- [RecipientActionMessage <String>]
: Custom message sent by recipient of the offer shift request.
- [RecipientUserId <String>]
: User id of the recipient of the offer shift request.
- [SenderShiftId <String>]
: User id of the sender of the offer shift request.
- [AssignedTo <String>]
: scheduleChangeRequestActor
- [ManagerActionMessage <String>]
:
- [SenderMessage <String>]
:
- [State <String>]
: scheduleChangeState
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [RecipientShiftId <String>]
: Shift ID for the recipient user with whom the request is to swap.
- [SwapShiftsRequestsEnabled <Boolean?>]
: Indicates whether swap shifts requests are enabled for the schedule.
- [TimeCards <IMicrosoftGraphTimeCard-
[]>]
: The time cards in the schedule.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Breaks <IMicrosoftGraphTimeCardBreak-
[]>]
: The list of breaks associated with the timeCard.
- [BreakId <String>]
: ID of the timeCardBreak.
- [End <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [AtApprovedLocation <Boolean?>]
: Indicates whether the entry was recorded at the approved location.
- [DateTime <DateTime?>]
: The time the entry is recorded.
- [Notes <IMicrosoftGraphItemBody>]
: itemBody
- [Notes <IMicrosoftGraphItemBody>]
: itemBody
- [Start <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
- [ClockInEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
- [ClockOutEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
- [ConfirmedBy <String>]
: confirmedBy
- [Notes <IMicrosoftGraphItemBody>]
: itemBody
- [OriginalEntry <IMicrosoftGraphTimeCardEntry>]
: timeCardEntry
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Breaks <IMicrosoftGraphTimeCardBreak-
[]>]
: The list of breaks associated with the timeCard.
- [ClockInEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
- [ClockOutEvent <IMicrosoftGraphTimeCardEvent>]
: timeCardEvent
- [State <String>]
: timeCardState
- [UserId <String>]
: User ID to which the timeCard belongs.
- [TimeClockEnabled <Boolean?>]
: Indicates whether time clock is enabled for the schedule.
- [TimeClockSettings <IMicrosoftGraphTimeClockSettings>]
: timeClockSettings
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [ApprovedLocation <IMicrosoftGraphGeoCoordinates>]
: geoCoordinates
- [TimeOffReasons <IMicrosoftGraphTimeOffReason-
[]>]
: The set of reasons for a time off in the schedule.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Code <String>]
: The code of the timeOffReason to represent an external identifier.
This field must be unique within the team in Microsoft Teams and uses an alphanumeric format, with a maximum of 100 characters.
- [DisplayName <String>]
: The name of the timeOffReason.
Required.
- [IconType <String>]
: timeOffReasonIconType
- [IsActive <Boolean?>]
: Indicates whether the timeOffReason can be used when creating new entities or updating existing ones.
Required.
- [TimeOffRequests <IMicrosoftGraphTimeOffRequest-
[]>]
: The time off requests in the schedule.
- [AssignedTo <String>]
: scheduleChangeRequestActor
- [ManagerActionMessage <String>]
:
- [SenderMessage <String>]
:
- [State <String>]
: scheduleChangeState
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [EndDateTime <DateTime?>]
: 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
- [StartDateTime <DateTime?>]
: 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
- [TimeOffReasonId <String>]
: The reason for the time off.
- [TimeOffRequestsEnabled <Boolean?>]
: Indicates whether time off requests are enabled for the schedule.
- [TimeZone <String>]
: Indicates the time zone of the schedule team using tz database format.
Required.
- [TimesOff <IMicrosoftGraphTimeOff-
[]>]
: The instances of times off in the schedule.
- [CreatedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DraftTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [EndDateTime <DateTime?>]
:
- [StartDateTime <DateTime?>]
:
- [Theme <String>]
: scheduleEntityTheme
- [TimeOffReasonId <String>]
: ID of the timeOffReason for this timeOffItem.
Required.
- [IsStagedForDeletion <Boolean?>]
: The timeOff is marked for deletion, a process that is finalized when the schedule is shared.
- [SharedTimeOff <IMicrosoftGraphTimeOffItem>]
: timeOffItem
- [TeamInfo <IMicrosoftGraphShiftsTeamInfo>]
: shiftsTeamInfo
- [UserId <String>]
: ID of the user assigned to the timeOff.
Required.
- [UserInfo <IMicrosoftGraphShiftsUserInfo>]
: shiftsUserInfo
- [WorkforceIntegrationIds <String-
[]>]
: The IDs for the workforce integrations associated with this schedule.
- [Specialization <String>]
: teamSpecialization
- [Summary <IMicrosoftGraphTeamSummary>]
: teamSummary
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [GuestsCount <Int32?>]
: Count of guests in a team.
- [MembersCount <Int32?>]
: Count of members in a team.
- [OwnersCount <Int32?>]
: Count of owners in a team.
- [Tags <IMicrosoftGraphTeamworkTag-
[]>]
: The tags associated with the team.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Description <String>]
: Tag description as it appears to the user in Microsoft Teams.
A teamworkTag can't have more than 200 teamworkTagMembers.
- [DisplayName <String>]
: Tag name as it appears to the user in Microsoft Teams.
- [MemberCount <Int32?>]
: The number of users assigned to the tag.
- [Members <IMicrosoftGraphTeamworkTagMember-
[]>]
: Users assigned to the tag.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [DisplayName <String>]
: The member's display name.
- [TenantId <String>]
: The ID of the tenant that the tag member is a part of.
- [UserId <String>]
: The user ID of the member.
- [TagType <String>]
: teamworkTagType
- [TeamId <String>]
: ID of the team in which the tag is defined.
- [Template <IMicrosoftGraphTeamsTemplate>]
: teamsTemplate
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [TemplateDefinition <IMicrosoftGraphTeamTemplateDefinition>]
: teamTemplateDefinition
- [(Any) <Object>]
: This indicates any property can be added to this object.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
- [Audience <String>]
: teamTemplateAudience
- [Categories <String-
[]>]
: The assigned categories for the team template.
- [Description <String>]
: A brief description of the team template as it will appear to the users in Microsoft Teams.
- [DisplayName <String>]
: The user defined name of the team template.
- [IconUrl <String>]
: The icon url for the team template.
- [LanguageTag <String>]
: Language the template is available in.
- [LastModifiedBy <IMicrosoftGraphIdentitySet>]
: identitySet
- [LastModifiedDateTime <DateTime?>]
: The date time of when the team template was last modified.
- [ParentTemplateId <String>]
: The templateId for the team template
- [PublisherName <String>]
: The organization which published the team template.
- [ShortDescription <String>]
: A short-description of the team template as it will appear to the users in Microsoft Teams.
- [TeamDefinition <IMicrosoftGraphTeam>]
: team
- [TenantId <String>]
: The ID of the Microsoft Entra tenant.
- [Visibility <String>]
: teamVisibilityType
- [WebUrl <String>]
: A hyperlink that goes to the team in the Microsoft Teams client.
It is the URL 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.
- [TenantId <String>]
: The ID of the Microsoft Entra tenant.
- [Id <String>]
: The unique identifier for an entity.
Read-only.
[InstalledApps <IMicrosoftGraphUserScopeTeamsAppInstallation-
[]>]
: The apps installed in the personal scope of this user.[ConsentedPermissionSet <IMicrosoftGraphTeamsAppPermissionSet>]
: teamsAppPermissionSet[ScopeInfo <IMicrosoftGraphTeamsAppInstallationScopeInfo>]
: teamsAppInstallationScopeInfo[TeamsApp <IMicrosoftGraphTeamsApp>]
: teamsApp[TeamsAppDefinition <IMicrosoftGraphTeamsAppDefinition>]
: teamsAppDefinition[Id <String>]
: The unique identifier for an entity. Read-only.[Chat <IMicrosoftGraphChat>]
: chat
[Locale <String>]
: Represents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale setting. A user's locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.[Region <String>]
: Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.
TODO <IMicrosoftGraphTodo>
: todo
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Lists <IMicrosoftGraphTodoTaskList-
[]>]
: The task lists in the users mailbox.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The name of the task list.[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the task list. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.
[IsOwner <Boolean?>]
: True if the user is owner of the given task list.[IsShared <Boolean?>]
: True if the task list is shared with other users[Tasks <IMicrosoftGraphTodoTask-
[]>]
: The tasks in this task list. Read-only. Nullable.[Id <String>]
: The unique identifier for an entity. Read-only.[AttachmentSessions <IMicrosoftGraphAttachmentSession-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[Content <Byte-
[]>]
: The content streams that are uploaded.[ExpirationDateTime <DateTime?>]
: The date and time in UTC when the upload session will expire. The complete file must be uploaded before this expiration time is reached.[NextExpectedRanges <String-
[]>]
: Indicates a single value {start} that represents the location in the file where the next upload should begin.
[Attachments <IMicrosoftGraphAttachmentBase-
[]>]
: A collection of file attachments for the task.[Id <String>]
: The unique identifier for an entity. Read-only.[ContentType <String>]
: The MIME type.[LastModifiedDateTime <DateTime?>]
: 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.[Name <String>]
: The display name of the attachment. This doesn't need to be the actual file name.[Size <Int32?>]
: The length of the attachment in bytes.
[Body <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[BodyLastModifiedDateTime <DateTime?>]
: The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[Categories <String-
[]>]
: The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined.[ChecklistItems <IMicrosoftGraphChecklistItem-
[]>]
: A collection of smaller subtasks linked to the more complex parent task.[Id <String>]
: The unique identifier for an entity. Read-only.[CheckedDateTime <DateTime?>]
: The date and time when the checklistItem was finished.[CreatedDateTime <DateTime?>]
: The date and time when the checklistItem was created.[DisplayName <String>]
: Indicates the title of the checklistItem.[IsChecked <Boolean?>]
: State that indicates whether the item is checked off or not.
[CompletedDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[CreatedDateTime <DateTime?>]
: The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[DueDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Extensions <IMicrosoftGraphExtension-
[]>]
: The collection of open extensions defined for the task. Nullable.[HasAttachments <Boolean?>]
: Indicates whether the task has attachments.[Importance <String>]
: importance[IsReminderOn <Boolean?>]
: Set to true if an alert is set to remind the user of the task.[LastModifiedDateTime <DateTime?>]
: The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.[LinkedResources <IMicrosoftGraphLinkedResource-
[]>]
: A collection of resources linked to the task.[Id <String>]
: The unique identifier for an entity. Read-only.[ApplicationName <String>]
: The app name of the source that sends the linkedResource.[DisplayName <String>]
: The title of the linkedResource.[ExternalId <String>]
: ID of the object that is associated with this task on the third-party/partner system.[WebUrl <String>]
: Deep link to the linkedResource.
[Recurrence <IMicrosoftGraphPatternedRecurrence>]
: patternedRecurrence[(Any) <Object>]
: This indicates any property can be added to this object.[Pattern <IMicrosoftGraphRecurrencePattern>]
: recurrencePattern[(Any) <Object>]
: This indicates any property can be added to this object.[DayOfMonth <Int32?>]
: The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly.[DaysOfWeek <String-
[]>]
: A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.[FirstDayOfWeek <String>]
: dayOfWeek[Index <String>]
: weekIndex[Interval <Int32?>]
: The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required.[Month <Int32?>]
: The month in which the event occurs. This is a number from 1 to 12.[Type <String>]
: recurrencePatternType
[Range <IMicrosoftGraphRecurrenceRange>]
: recurrenceRange[(Any) <Object>]
: This indicates any property can be added to this object.[EndDate <DateTime?>]
: The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate.[NumberOfOccurrences <Int32?>]
: The number of times to repeat the event. Required and must be positive if type is numbered.[RecurrenceTimeZone <String>]
: Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.[StartDate <DateTime?>]
: The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required.[Type <String>]
: recurrenceRangeType
[ReminderDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: taskStatus[Title <String>]
: A brief description of the task.
[WellknownListName <String>]
: wellknownListName
TRANSITIVEMEMBEROF <IMicrosoftGraphDirectoryObject- []
>: The groups, including nested groups and directory roles that a user is a member of.
Nullable.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
TRANSITIVEREPORTS <IMicrosoftGraphDirectoryObject- []
>: The transitive reports for a user.
Read-only.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]
: Date and time when this object was deleted. Always null when the object hasn't been deleted.
USAGERIGHTS <IMicrosoftGraphUsageRight- []
>: Represents the usage rights a user has been granted.
[Id <String>]
: The unique identifier for an entity. Read-only.[CatalogId <String>]
: Product id corresponding to the usage right.[ServiceIdentifier <String>]
: Identifier of the service corresponding to the usage right.[State <String>]
: usageRightState
VIRTUALEVENTS <IMicrosoftGraphUserVirtualEventsRoot>
: userVirtualEventsRoot
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[Webinars <IMicrosoftGraphVirtualEventWebinar-
[]>]
:[CreatedBy <IMicrosoftGraphCommunicationsIdentitySet>]
: communicationsIdentitySet[(Any) <Object>]
: This indicates any property can be added to this object.[Application <IMicrosoftGraphIdentity>]
: identity[(Any) <Object>]
: This indicates any property can be added to this object.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
[Device <IMicrosoftGraphIdentity>]
: identity[User <IMicrosoftGraphIdentity>]
: identity[ApplicationInstance <IMicrosoftGraphIdentity>]
: identity[AssertedIdentity <IMicrosoftGraphIdentity>]
: identity[AzureCommunicationServicesUser <IMicrosoftGraphIdentity>]
: identity[Encrypted <IMicrosoftGraphIdentity>]
: identity[EndpointType <String>]
: endpointType[Guest <IMicrosoftGraphIdentity>]
: identity[OnPremises <IMicrosoftGraphIdentity>]
: identity[Phone <IMicrosoftGraphIdentity>]
: identity
[Description <IMicrosoftGraphItemBody>]
: itemBody[(Any) <Object>]
: This indicates any property can be added to this object.[Content <String>]
: The content of the item.[ContentType <String>]
: bodyType
[DisplayName <String>]
: The display name of the virtual event.[EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[(Any) <Object>]
: This indicates any property can be added to this object.[DateTime <String>]
: A single point of time in a combined date and time representation ({date}T{time}). For example, '2019-04-16T09:00:00'.[TimeZone <String>]
: Represents a time zone, for example, 'Pacific Standard Time'. See below for possible values.
[Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
: The virtual event presenters.[Id <String>]
: The unique identifier for an entity. Read-only.[Email <String>]
: Email address of the presenter.[Identity <IMicrosoftGraphIdentity>]
: identity[PresenterDetails <IMicrosoftGraphVirtualEventPresenterDetails>]
: virtualEventPresenterDetails[(Any) <Object>]
: This indicates any property can be added to this object.[Bio <IMicrosoftGraphItemBody>]
: itemBody[Company <String>]
: The presenter's company name.[JobTitle <String>]
: The presenter's job title.[LinkedInProfileWebUrl <String>]
: The presenter's LinkedIn profile URL.[PersonalSiteWebUrl <String>]
: The presenter's personal website URL.[Photo <Byte-
[]>]
: The content stream of the presenter's photo.[TwitterProfileWebUrl <String>]
: The presenter's Twitter profile URL.
[Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:[AllowAttendeeToEnableCamera <Boolean?>]
: Indicates whether attendees can turn on their camera.[AllowAttendeeToEnableMic <Boolean?>]
: Indicates whether attendees can turn on their microphone.[AllowBreakoutRooms <Boolean?>]
: Indicates whether breakout rooms are enabled for the meeting.[AllowLiveShare <String>]
: meetingLiveShareOptions[AllowMeetingChat <String>]
: meetingChatMode[AllowParticipantsToChangeName <Boolean?>]
: Specifies if participants are allowed to rename themselves in an instance of the meeting.[AllowPowerPointSharing <Boolean?>]
: Indicates whether PowerPoint live is enabled for the meeting.[AllowRecording <Boolean?>]
: Indicates whether recording is enabled for the meeting.[AllowTeamworkReactions <Boolean?>]
: Indicates if Teams reactions are enabled for the meeting.[AllowTranscription <Boolean?>]
: Indicates whether transcription is enabled for the meeting.[AllowWhiteboard <Boolean?>]
: Indicates whether whiteboard is enabled for the meeting.[AllowedPresenters <String>]
: onlineMeetingPresenters[AnonymizeIdentityForRoles <String-
[]>]
: 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.[AttendanceReports <IMicrosoftGraphMeetingAttendanceReport-
[]>]
: The attendance reports of an online meeting. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[AttendanceRecords <IMicrosoftGraphAttendanceRecord-
[]>]
: List of attendance records of an attendance report. Read-only.[Id <String>]
: The unique identifier for an entity. Read-only.[AttendanceIntervals <IMicrosoftGraphAttendanceInterval-
[]>]
: List of time periods between joining and leaving a meeting.[DurationInSeconds <Int32?>]
: Duration of the meeting interval in seconds; that is, the difference between joinDateTime and leaveDateTime.[JoinDateTime <DateTime?>]
: The time the attendee joined in UTC.[LeaveDateTime <DateTime?>]
: The time the attendee left in UTC.
[EmailAddress <String>]
: Email address of the user associated with this attendance record.[Identity <IMicrosoftGraphIdentity>]
: identity[RegistrantId <String>]
: Unique identifier of a meetingRegistrant. Presents when the participant has registered for the meeting. (deprecated)[Role <String>]
: Role of the attendee. Possible values are: None, Attendee, Presenter, and Organizer.[TotalAttendanceInSeconds <Int32?>]
: Total duration of the attendances in seconds.
[MeetingEndDateTime <DateTime?>]
: UTC time when the meeting ended. Read-only.[MeetingStartDateTime <DateTime?>]
: UTC time when the meeting started. Read-only.[TotalParticipantCount <Int32?>]
: Total number of participants. Read-only.
[AudioConferencing <IMicrosoftGraphAudioConferencing>]
: audioConferencing[(Any) <Object>]
: This indicates any property can be added to this object.[ConferenceId <String>]
: The conference id of the online meeting.[DialinUrl <String>]
: A URL to the externally-accessible web page that contains dial-in information.[TollFreeNumber <String>]
: The toll-free number that connects to the Audio Conference Provider.[TollFreeNumbers <String-
[]>]
: List of toll-free numbers that are displayed in the meeting invite.[TollNumber <String>]
: The toll number that connects to the Audio Conference Provider.[TollNumbers <String-
[]>]
: List of toll numbers that are displayed in the meeting invite.
[ChatInfo <IMicrosoftGraphChatInfo>]
: chatInfo[(Any) <Object>]
: This indicates any property can be added to this object.[MessageId <String>]
: The unique identifier for a message in a Microsoft Teams channel.[ReplyChainMessageId <String>]
: The ID of the reply message.[ThreadId <String>]
: The unique identifier for a thread in Microsoft Teams.
[ChatRestrictions <IMicrosoftGraphChatRestrictions>]
: chatRestrictions[(Any) <Object>]
: This indicates any property can be added to this object.[AllowTextOnly <Boolean?>]
: Indicates whether only text is allowed in the meeting chat. Optional.
[IsEndToEndEncryptionEnabled <Boolean?>]
:[IsEntryExitAnnounced <Boolean?>]
: Indicates whether to announce when callers join or leave.[JoinInformation <IMicrosoftGraphItemBody>]
: itemBody[JoinMeetingIdSettings <IMicrosoftGraphJoinMeetingIdSettings>]
: joinMeetingIdSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsPasscodeRequired <Boolean?>]
: Indicates whether a passcode is required to join a meeting when using joinMeetingId. Optional.[JoinMeetingId <String>]
: The meeting ID to be used to join a meeting. Optional. Read-only.[Passcode <String>]
: The passcode to join a meeting. Optional. Read-only.
[JoinWebUrl <String>]
: The join URL of the online meeting. Read-only.[LobbyBypassSettings <IMicrosoftGraphLobbyBypassSettings>]
: lobbyBypassSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsDialInBypassEnabled <Boolean?>]
: Specifies whether or not to always let dial-in callers bypass the lobby. Optional.[Scope <String>]
: lobbyBypassScope
[RecordAutomatically <Boolean?>]
: Indicates whether to record the meeting automatically.[ShareMeetingChatHistoryDefault <String>]
: meetingChatHistoryDefaultMode[Subject <String>]
: The subject of the online meeting.[VideoTeleconferenceId <String>]
: The video teleconferencing ID. Read-only.[WatermarkProtection <IMicrosoftGraphWatermarkProtectionValues>]
: watermarkProtectionValues[(Any) <Object>]
: This indicates any property can be added to this object.[IsEnabledForContentSharing <Boolean?>]
: Indicates whether to apply a watermark to any shared content.[IsEnabledForVideo <Boolean?>]
: Indicates whether to apply a watermark to everyone's video feed.
[Id <String>]
: The unique identifier for an entity. Read-only.[EndDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Presenters <IMicrosoftGraphVirtualEventPresenter-
[]>]
:[Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
:[Id <String>]
: The unique identifier for an entity. Read-only.[CancelationDateTime <DateTime?>]
: Date and time when the registrant cancels their registration for the virtual event. Only appears when applicable. 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.[Email <String>]
: Email address of the registrant.[FirstName <String>]
: First name of the registrant.[LastName <String>]
: Last name of the registrant.[PreferredLanguage <String>]
: The registrant's preferred language.[PreferredTimezone <String>]
: The registrant's time zone details.[RegistrationDateTime <DateTime?>]
: Date and time when the registrant registers for the virtual event. 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.[RegistrationQuestionAnswers <IMicrosoftGraphVirtualEventRegistrationQuestionAnswer-
[]>]
: The registrant's answer to the registration questions.[BooleanValue <Boolean?>]
: Boolean answer to the virtualEventRegistrationCustomQuestion. Only appears when answerInputType is boolean.[DisplayName <String>]
: Display name of the registration question.[MultiChoiceValues <String-
[]>]
: A collection of text answers to the virtualEventRegistrationCustomQuestion. Only appears when answerInputType is multiChoice.[QuestionId <String>]
: The identifier of either a virtualEventRegistrationCustomQuestion or a virtualEventRegistrationPredefinedQuestion.[Value <String>]
: Text answer to the virtualEventRegistrationCustomQuestion or the virtualEventRegistrationPredefinedQuestion. Appears when answerInputType is text, multilineText or singleChoice.
[Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
:[Status <String>]
: virtualEventAttendeeRegistrationStatus[UserId <String>]
: The registrant's ID in Microsoft Entra ID. Only appears when the registrant is registered in Microsoft Entra ID.
[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone
[Sessions <IMicrosoftGraphVirtualEventSession-
[]>]
: The sessions for the virtual event.[Settings <IMicrosoftGraphVirtualEventSettings>]
: virtualEventSettings[(Any) <Object>]
: This indicates any property can be added to this object.[IsAttendeeEmailNotificationEnabled <Boolean?>]
: Indicates whether virtual event attendees receive email notifications.
[StartDateTime <IMicrosoftGraphDateTimeZone>]
: dateTimeTimeZone[Status <String>]
: virtualEventStatus[Id <String>]
: The unique identifier for an entity. Read-only.[Audience <String>]
: meetingAudience[CoOrganizers <IMicrosoftGraphCommunicationsUserIdentity-
[]>]
: Identity information of coorganizers of the webinar.[DisplayName <String>]
: The display name of the identity. For drive items, the display name 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 don't show up as changed when using delta.[Id <String>]
: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.[TenantId <String>]
: The user's tenant ID.
[RegistrationConfiguration <IMicrosoftGraphVirtualEventWebinarRegistrationConfiguration>]
: virtualEventWebinarRegistrationConfiguration[(Any) <Object>]
: This indicates any property can be added to this object.[Capacity <Int32?>]
: Total capacity of the virtual event.[Questions <IMicrosoftGraphVirtualEventRegistrationQuestionBase-
[]>]
: Registration questions.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: Display name of the registration question.[IsRequired <Boolean?>]
: Indicates whether an answer to the question is required. The default value is false.
[RegistrationWebUrl <String>]
: Registration URL of the virtual event.[Id <String>]
: The unique identifier for an entity. Read-only.[IsManualApprovalEnabled <Boolean?>]
:[IsWaitlistEnabled <Boolean?>]
:
[Registrations <IMicrosoftGraphVirtualEventRegistration-
[]>]
: Registration records of the webinar.
WINDOWSINFORMATIONPROTECTIONDEVICEREGISTRATIONS <IMicrosoftGraphWindowsInformationProtectionDeviceRegistration- []
>: Zero or more WIP device registrations that belong to the user.
[Id <String>]
: The unique identifier for an entity. Read-only.[DeviceMacAddress <String>]
: Device Mac address.[DeviceName <String>]
: Device name.[DeviceRegistrationId <String>]
: Device identifier for this device registration record.[DeviceType <String>]
: Device type, for example, Windows laptop VS Windows phone.[LastCheckInDateTime <DateTime?>]
: Last checkin time of the device.[UserId <String>]
: UserId associated with this device registration record.
RELATED LINKS
https://learn.microsoft.com/powershell/module/microsoft.graph.beta.users/update-mgbetauser
https://learn.microsoft.com/graph/api/user-update?view=graph-rest-beta