Tasks.ReadWrite
Allows the app to create, read, update, and delete the signed-in user's tasks and task lists, including any shared with the user.
Merill's Note
For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the
Tasks.ReadWrite
permission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReport
command. See How To: Run a quick OAuth app audit of your tenant
Category | Application | Delegated |
---|---|---|
Identifier | - | 2219042f-cab5-40cc-b0d2-16b1540b4c5f |
DisplayText | - | Create, read, update, and delete user’s tasks and task lists |
Description | - | Allows the app to create, read, update, and delete the signed-in user's tasks and task lists, including any shared with the user. |
AdminConsentRequired | Yes | No |
Graph Methods
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
Methods | |
---|---|
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
Methods | |
---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
Commands | |
---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
Commands | |
---|---|
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- administrativeUnit
- alert
- approvalItem
- attachment
- attachmentInfo
- basetask
- basetasklist
- calendar
- calendarGroup
- callRecording
- callRecord
- callTranscript
- channel
- chat
- chatMessage
- checklistItem
- contact
- contactFolder
- conversation
- conversationMember
- conversationThread
- dateTimeTimeZone
- device
- driveItem
- entity
- event
- extended-properties-overview
- fileAttachment
- group
- itemAttachment
- itemBody
- linkedResource
- linkedresource_v2
- List
- mailFolder
- message
- multiValueLegacyExtendedProperty
- offerShiftRequest
- onlineMeeting
- openShiftChangeRequest
- opentypeextension
- organization
- outlookCategory
- outlooktask
- outlooktaskfolder
- outlooktaskgroup
- patternedRecurrence
- planner-identifiers-disclaimer
- planner-order-hint-format
- planner-overview
- plannerAppliedCategories
- plannerAssignedToTaskBoardTaskFormat
- plannerAssignments
- plannerBucket
- plannerBucketTaskBoardTaskFormat
- plannerCategoryDescriptions
- plannerChecklistItems
- plannerExternalReferences
- plannerFavoritePlanReferenceCollection
- plannerOrderHintsByAssignee
- plannerPlan
- plannerPlanContainer
- plannerPlanDetails
- plannerProgressTaskBoardTaskFormat
- plannerRecentPlanReferenceCollection
- plannerRoster
- plannerRosterMember
- plannerTask
- plannerTaskDetails
- plannerTaskRecurrence
- plannerUser
- plannerUserIds
- post
- presence
- printer
- printTaskDefinition
- sensitivityLabelAssignment
- shift
- singleValueLegacyExtendedProperty
- subscription
- swapShiftsChangeRequest
- taskFileAttachment
- tasklist
- tasks-identifiers-disclaimer
- taskViewpoint
- team
- timeOffRequest
- todoTask
- todoTaskList
- uploadSession
- user
- virtualEventWebinar
Graph reference: administrativeUnit
Property | Type | Description |
---|---|---|
description | String | An optional description for the administrative unit. Supports $filter (eq , ne , in , startsWith ), $search . |
displayName | String | Display name for the administrative unit. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderby . |
id | String | Unique identifier for the administrative unit. Read-only. Supports $filter (eq ). |
membershipRule | String | The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see Manage rules for dynamic membership groups in Microsoft Entra ID. |
membershipRuleProcessingState | String | Controls whether the dynamic membership rule is actively processed. Set to On to activate the dynamic membership rule, or Paused to stop updating membership dynamically. |
membershipType | String | Indicates the membership type for the administrative unit. The possible values are: dynamic , assigned . If not set, the default value is null and the default behavior is assigned. |
visibility | String | Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership . If not set, the default value is null and the default behavior is public. When set to HiddenMembership , only members of the administrative unit can list other members of the administrative unit. |
Graph reference: alert
Property | Type | Description |
---|---|---|
activityGroupName | String | Name or alias of the activity group (attacker) this alert is attributed to. |
assignedTo | String | Name of the analyst the alert is assigned to for triage, investigation, or remediation (supports update). |
azureSubscriptionId | String | Azure subscription ID, present if this alert is related to an Azure resource. |
azureTenantId | String | Microsoft Entra tenant ID. Required. |
category | String | Category of the alert (for example, credentialTheft, ransomware). |
closedDateTime | DateTimeOffset | Time at which the alert was closed. The Timestamp type represents date and time information 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 update). |
cloudAppStates | cloudAppSecurityState collection | Security-related stateful information generated by the provider about the cloud application/s related to this alert. |
comments | String collection | Customer-provided comments on alert (for customer alert management) (supports update). |
confidence | Int32 | Confidence of the detection logic (percentage between 1-100). |
createdDateTime | DateTimeOffset | Time at which the alert was created by the alert provider. The Timestamp type represents date and time information 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. |
description | String | Alert description. |
detectionIds | String collection | Set of alerts related to this alert entity (each alert is pushed to the SIEM as a separate record). |
eventDateTime | DateTimeOffset | Time at which the event or events that served as the trigger to generate the alert occurred. The Timestamp type represents date and time information 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. |
feedback | alertFeedback | Analyst feedback on the alert. Possible values are: unknown , truePositive , falsePositive , benignPositive . Supports update. |
fileStates | fileSecurityState collection | Security-related stateful information generated by the provider about the file(s) related to this alert. |
hostStates | hostSecurityState collection | Security-related stateful information generated by the provider about the host(s) related to this alert. |
id | String | Provider-generated GUID/unique identifier. Read-only. Required. |
incidentIds | String collection | IDs of incidents related to current alert. |
lastModifiedDateTime | DateTimeOffset | Time at which the alert entity was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . |
malwareStates | malwareState collection | Threat Intelligence pertaining to malware related to this alert. |
networkConnections | networkConnection collection | Security-related stateful information generated by the provider about the network connection(s) related to this alert. |
processes | process collection | Security-related stateful information generated by the provider about the process or processes related to this alert. |
recommendedActions | String collection | Vendor/provider recommended action(s) to take as a result of the alert (for example, isolate machine, enforce2FA, reimage host). |
registryKeyStates | registryKeyState collection | Security-related stateful information generated by the provider about the registry keys related to this alert. |
securityResources | securityResource collection | Resources related to current alert. For example, for some alerts this can have the Azure Resource value. |
severity | alertSeverity | Alert severity - set by vendor/provider. Possible values are: unknown , informational , low , medium , high . Required. |
sourceMaterials | String collection | Hyperlinks (URIs) to the source material related to the alert, for example, provider's user interface for alerts or log search. |
status | alertStatus | Alert lifecycle status (stage). Possible values are: unknown , newAlert , inProgress , resolved . (supports update). Required. |
tags | String collection | User-definable labels that can be applied to an alert and can serve as filter conditions (for example "HVA", "SAW") (supports update). |
title | String | Alert title. Required. |
triggers | alertTrigger collection | Security-related information about the specific properties that triggered the alert (properties appearing in the alert). Alerts might contain information about multiple users, hosts, files, ip addresses. This field indicates which properties triggered the alert generation. |
userStates | userSecurityState collection | Security-related stateful information generated by the provider about the user accounts related to this alert. |
vendorInformation | securityVendorInformation | Complex type containing details about the security product/service vendor, provider, and subprovider (for example, vendor=Microsoft; provider=Windows Defender ATP; subProvider=AppLocker). Required. |
vulnerabilityStates | vulnerabilityState collection | Threat intelligence pertaining to one or more vulnerabilities related to this alert. |
Graph reference: approvalItem
Property | Type | Description |
---|---|---|
allowCancel | Boolean | Indicates whether the approval item can be canceled. |
allowEmailNotification | Boolean | Indicates whether email notification is enabled. |
approvalType | approvalItemType | The workflow type of the approval item. The possible values are: basic , basicAwaitAll , custom , customAwaitAll . Required. |
approvers | approvalIdentitySet collection | The identity of the principals to whom the approval item was initially assigned. Required. |
completedDateTime | DateTimeOffset | Approval request completion date and time. Read-only. |
createdDateTime | DateTimeOffset | Creation date and time of the approval request. Read-only. |
description | String | The description of the approval request. |
displayName | String | The displayName of the approval request. Required. |
id | String | The unique id for the approval item. Read-only. |
owner | approvalIdentitySet | The identity set of the principal who owns the approval item. Only provide a value for this property when creating an approval item on behalf of the principal. If the owner field isn't provided, the user information from the user context is used. |
responsePrompts | String collection | Approval response prompts. Only provide a value for this property when creating a custom approval item. For custom approval items, supply two response prompt strings. The default response prompts are "Approve" and "Reject". |
result | String | The result field is only populated once the approval item is in its final state. The result of the approval item is based on the approvalType. For basic approval items, the result is either "Approved" or "Rejected". For custom approval items, the result could either be a single response or multiple responses separated by a semi-colon. Read-only. |
state | approvalItemState | The approval item state. The possible values are: canceled , created , pending , completed . Read-only. |
viewPoint | approvalItemViewPoint | Represents user viewpoints data on the ApprovalItem. The data includes the users roles regarding the approval item. Read-only. |
Graph reference: attachment
Property | Type | Description |
---|---|---|
contentType | String | The MIME type. |
id | String | Read-only. |
isInline | Boolean | true if the attachment is an inline attachment; otherwise, false . |
lastModifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information 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 attachment's file name. |
size | Int32 | The length of the attachment in bytes. |
Graph reference: attachmentInfo
Property | Type | Description |
---|---|---|
attachmentType | attachmentType | The type of the attachment. The possible values are: file , item , reference . Required. |
contentType | String | The nature of the data in the attachment. Optional. |
name | String | The display name of the attachment. This can be a descriptive string and doesn't have to be the actual file name. Required. |
size | Int64 | The length of the attachment in bytes. Required. |
Graph reference: basetask
Property | Type | Description |
---|---|---|
textBody | String | The task body in text format that typically contains information about the task. |
bodyLastModifiedDateTime | DateTimeOffset | 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'. |
completedDateTime | DateTimeOffset | The date when the task was finished. |
createdDateTime | DateTimeOffset | 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'. |
displayName | String | The name of the task. |
dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
id | String | Unique identifier for the task. By default, this value will not change if a task is moved from one list to another. |
importance | importance | The importance of the task. Possible values are: low , normal , high . The possible values are: low , normal , high . |
lastModifiedDateTime | DateTimeOffset | 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'. |
viewpoint | taskViewpoint | Properties that are personal to a user such as reminderDateTime and categories. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
startDateTime | dateTimeTimeZone | The date in the specified time zone when the task is to begin. |
status | taskStatus_v2 | Indicates the state or progress of the task. Possible values are: notStarted , inProgress , completed ,unknownFutureValue . |
Graph reference: basetasklist
Property | Type | Description |
---|---|---|
displayName | String | The name of the task list. |
id | String | The identifier of the task list, unique in the user's mailbox. Read-only. |
Graph reference: calendar
Property | Type | Description |
---|---|---|
allowedOnlineMeetingProviders | onlineMeetingProviderType collection | Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown , skypeForBusiness , skypeForConsumer , teamsForBusiness . |
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. |
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. |
canViewPrivateItems | Boolean | true if the user can read calendar items that have been marked private, false otherwise. |
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 | calendarColor | Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: auto , lightBlue , lightGreen , lightOrange , lightGray , lightYellow , lightTeal , lightPink , lightBrown , lightRed , maxColor . |
defaultOnlineMeetingProvider | onlineMeetingProviderType | The default online meeting provider for meetings sent from this calendar. Possible values are: unknown , skypeForBusiness , skypeForConsumer , teamsForBusiness . |
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. Read-only. |
id | String | The calendar's unique identifier. Read-only. |
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. |
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. |
name | String | The calendar name. |
owner | emailAddress | If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the **o |
Graph reference: calendarGroup
Property | Type | Description |
---|---|---|
name | String | The group name. |
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 | Guid | The class identifier. Read-only. |
id | String | The group's unique identifier. Read-only. |
Graph reference: callRecording
Property | Type | Description |
---|---|---|
callId | String | The unique identifier for the call that is related to this recording. Read-only. |
content | Stream | The content of the recording. Read-only. |
contentCorrelationId | String | The unique identifier that links the transcript with its corresponding recording. Read-only. |
createdDateTime | DateTimeOffset | 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 | DateTimeOffset | 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. |
id | String | The unique identifier for the recording. Read-only. Inherited from entity. |
meetingId | String | The unique identifier of the onlineMeeting related to this recording. Read-only. |
meetingOrganizer | identitySet | The identity information of the organizer of the onlineMeeting related to this recording. Read-only. |
recordingContentUrl | String | The URL that can be used to access the content of the recording. Read-only. |
Graph reference: callRecord
Property | Type | Description |
---|---|---|
endDateTime | DateTimeOffset | UTC time when the last user left the call. 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 |
id | String | Unique identifier for the call record. Read-only. |
joinWebUrl | String | Meeting URL associated to the call. May not be available for a peerToPeer call record type. |
lastModifiedDateTime | DateTimeOffset | UTC time when the call record was created. The DatetimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
modalities | modality collection | List of all the modalities used in the call. Possible values are: unknown , audio , video , videoBasedScreenSharing , data , screenSharing , unknownFutureValue . |
startDateTime | DateTimeOffset | UTC time when the first user joined the call. 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 . |
type | callType | Indicates the type of the call. Possible values are: unknown , groupCall , peerToPeer , unknownFutureValue . |
version | Int64 | Monotonically increasing version of the call record. Higher version call records with the same id includes additional data compared to the lower version. |
organizer (deprecated) | identitySet | The organizing party's identity. The organizer property is deprecated and will stop returning data on June 30, 2026. Going forward, use the organizer_v2 relationship. |
participants (deprecated) | identitySet collection | List of distinct identities involved in the call. Limited to 130 entries. The **p |
Graph reference: callTranscript
Property | Type | Description |
---|---|---|
callId | String | The unique identifier for the call that is related to this transcript. Read-only. |
content | Stream | The content of the transcript. Read-only. |
contentCorrelationId | String | The unique identifier that links the transcript with its corresponding recording. Read-only. |
createdDateTime | DateTimeOffset | 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 | DateTimeOffset | 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. |
id | String | The unique identifier for the transcript. Read-only. |
meetingId | String | The unique identifier of the online meeting related to this transcript. Read-only. |
meetingOrganizer | identitySet | The identity information of the organizer of the onlineMeeting related to this transcript. Read-only. |
metadataContent | Stream | 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. |
Graph reference: channel
Property | Type | Description |
---|---|---|
createdDateTime | dateTimeOffset | Read only. Timestamp at which the channel was created. |
description | String | Optional textual description for the channel. |
displayName | String | Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters. |
String | The email address for sending messages to the channel. Read-only. | |
id | String | The channel's unique identifier. 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 . |
membershipType | channelMembershipType | The type of the channel. Can be set during creation and can't be changed. The possible values are: standard , private , unknownFutureValue , shared . The default value is standard . Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: shared . |
tenantId | string | The ID of the Microsoft Entra tenant. |
webUrl | String | A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only. |
summary | channelSummary | Contains summary information about the channel, including number of owners, members, guests, and an indicator for members from other tenants. The **s |
Graph reference: chat
Property | Type | Description |
---|---|---|
chatType | chatType | Specifies the type of chat. Possible values are: group , oneOnOne , meeting , unknownFutureValue . |
createdDateTime | dateTimeOffset | Date and time at which the chat was created. Read-only. |
id | String | The chat's unique identifier. Read-only. |
lastUpdatedDateTime | dateTimeOffset | Date and time at which the chat was renamed or the list of members was last changed. Read-only. |
onlineMeetingInfo | teamworkOnlineMeetingInfo | Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. 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 | chatViewpoint | Represents caller-specific information about the chat, such as the last message read date and time. This property is populated only when the request is made in a delegated context. |
webUrl | String | The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only. |
Graph reference: chatMessage
Property | Type | Description |
---|---|---|
attachments | chatMessageAttachment collection | References to attached objects like files, tabs, meetings etc. |
body | itemBody | Plaintext/HTML representation of the content of the chat message. Representation is specified by the contentType inside the body. The content is always in HTML if the chat message contains a chatMessageMention. |
chatId | string | If the message was sent in a chat, represents the identity of the chat. |
channelIdentity | channelIdentity | If the message was sent in a channel, represents identity of the channel. |
createdDateTime | dateTimeOffset | Timestamp of when the chat message was created. |
deletedDateTime | dateTimeOffset | 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 | eventMessageDetail | Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to systemEventMessage . |
from | chatMessageFromIdentitySet | Details of the sender of the chat message. Can only be set during migration. |
id | String | Read-only. Unique ID of the message. IDs are unique within a chat/channel/reply-to-message, but might be duplicated in other chats/channels/reply-to-messages. |
importance | string | The importance of the chat message. The possible values are: normal , high , urgent . |
lastModifiedDateTime | dateTimeOffset | Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed. |
lastEditedDateTime | dateTimeOffset | 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 . |
locale | string | Locale of the chat message set by the client. Always set to en-us . |
mentions | chatMessageMention collection | List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel. |
messageHistory | chatMessageHistoryItem collection | List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message. |
messageType | chatMessageType | The type of chat message. The possible values are: message , chatEvent , typing , unknownFutureValue , systemEventMessage . Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: systemEventMessage . |
policyViolation | chatMessagePolicyViolation | Defines the properties of a policy violation set by a data loss prevention (DLP) application. |
reactions | chatMessageReaction collection | Reactions for this chat message (for example, Like). |
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. |
Graph reference: checklistItem
Property | Type | Description |
---|---|---|
checkedDateTime | DateTimeOffset | The date and time when the checklistItem was finished. |
createdDateTime | DateTimeOffset | The date and time when the checklistItem was created. |
displayName | String | Indicates the title of the checklistItem. |
id | String | Server generated ID for the the checkListItem |
isChecked | Boolean | State that indicates whether the item is checked off or not. |
Graph reference: contact
Property | Type | Description |
---|---|---|
assistantName | String | The name of the contact's assistant. |
birthday | DateTimeOffset | 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 |
businessAddress | PhysicalAddress | The contact's business address. |
businessHomePage | String | The business home page of the contact. |
businessPhones | String collection | The contact's business phone numbers. |
categories | String collection | The categories associated with the contact. |
changeKey | String | Identifies the version of the contact. Every time the contact is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
children | String collection | The names of the contact's children. |
companyName | String | The name of the contact's company. |
createdDateTime | DateTimeOffset | The time the contact 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 |
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. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation. |
emailAddresses | EmailAddress collection | The contact's email addresses. |
fileAs | String | The name the contact is filed under. |
generation | String | The contact's suffix. |
givenName | String | The contact's given name. |
homeAddress | PhysicalAddress | The contact's home address. |
homePhones | String collection | The contact's home phone numbers. |
id | String | The contact's unique identifier. !INCLUDE [outlook-beta-id] Read-only. |
imAddresses | String collection | The contact's instant messaging (IM) addresses. |
initials | String | The contact's initials. |
jobTitle | String | The contact’s job title. |
lastModifiedDateTime | DateTimeOffset | The time the contact was modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
manager | String | The name of the contact's manager. |
middleName | String | The contact's middle name. |
mobilePhone | String | The contact's mobile phone number. |
nickName | String | The contact's nickname. |
officeLocation | String | The location of the contact's office. |
otherAddress | PhysicalAddress | Other addresses for the contact. |
parentFolderId | String | The ID of the contact's parent folder. |
personalNotes | String | The user's notes about the contact. |
profession | String | The contact's profession. |
spouseName | String | The name of the contact's spouse/partner. |
surname | String | The contact's surname. |
title | String | The contact's title. |
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. |
Graph reference: contactFolder
Property | Type | Description |
---|---|---|
displayName | String | The folder's display name. |
id | String | Unique identifier of the contact folder. Read-only. |
parentFolderId | String | The ID of the folder's parent folder. |
Graph reference: conversation
Property | Type | Description |
---|---|---|
hasAttachments | Boolean | Indicates whether any of the posts within this Conversation has at least one attachment. Supports $filter (eq , ne ) and $search . |
id | String | The conversations's unique identifier. Read-only. |
lastDeliveredDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
preview | String | A short summary from the body of the latest post in this conversation. Supports $filter (eq , ne , le , ge ). |
topic | String | The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated. |
uniqueSenders | String collection | All the users that sent a message to this Conversation. |
Graph reference: conversationMember
Property | Type | Description |
---|---|---|
displayName | string | The display name of the user. |
id | String | Read-only. Unique ID of the user. |
roles | string collection | 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 | DateTimeOffset | 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. |
Graph reference: conversationThread
Property | Type | Description |
---|---|---|
ccRecipients | recipient collection | 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. |
id | String | Read-only. Returned by default. |
isLocked | Boolean | Indicates if the thread is locked. Returned by default. |
lastDeliveredDateTime | DateTimeOffset | The Timestamp type represents date and time information 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. |
preview | String | A short summary from the body of the latest post in this conversation. 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. Returned by default. |
toRecipients | recipient collection | The To: recipients for the thread. Returned only on $select . |
uniqueSenders | String collection | All the users that sent a message to this thread. Returned by default. |
Graph reference: dateTimeTimeZone
Property | Type | Description |
---|---|---|
dateTime | String | A single point of time in a combined date and time representation ({date}T{time} ; for example, 2017-08-29T04:00:00.0000000 ). |
timeZone | String | Represents a time zone, for example, "Pacific Standard Time". See below for more possible values. |
Graph reference: device
Property | Type | Description |
---|---|---|
accountEnabled | Boolean | true if the account is enabled; otherwise, false . Required. Default is true . Supports $filter (eq , ne , not , in ). Only callers with at least the Cloud Device Administrator role can set this property. |
alternativeSecurityIds | alternativeSecurityId collection | For internal use only. Not nullable. Supports $filter (eq , not , ge , le ). |
approximateLastSignInDateTime | DateTimeOffset | The timestamp type represents date and time information 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 . |
complianceExpirationDateTime | DateTimeOffset | 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 alternate key can be used to reference the device object. Supports $filter (eq , ne , not , startsWith ). |
deviceMetadata | String | For internal use only. Set to null . |
deviceOwnership | String | Ownership of the device. Intune sets this property. 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 . |
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. Intune sets this property. 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 | onPremisesExtensionAttributes | Contains extension attributes 1-15 for the device. The individual extension attributes aren't selectable. These properties are mastered in the cloud and can be set during creation or update of a device object in Microsoft Entra ID. Supports $filter (eq , not , startsWith , and eq on null values). |
id | String | The unique identifier for the device. Inherited from directoryObject. Key, Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
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 ). |
manufacturer | String | Manufacturer of the device. Read-only. |
isRooted | Boolean | true if the device is rooted or jail-broken. This property can only be updated by Intune. |
managementType | String | The 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 . |
mdmAppId | String | Application identifier used to register device into MDM. Read-only. Supports $filter (eq , ne , not , startsWith ). |
model | String | Model of the device. Read-only. |
onPremisesLastSyncDateTime | DateTimeOffset | 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 | The version of the operating system on the device. Required. Supports $filter (eq , ne , not , ge , le , startsWith , and eq on null values). |
physicalIds | String collection | For internal use only. Not nullable. Supports $filter (eq , not , ge , le , startsWith ,/$count eq 0 , /$count ne 0 ). |
profileType | deviceProfileType | The profile type of the device. Possible values: RegisteredDevice (default), SecureVM , Printer , Shared , IoT . |
registrationDateTime | DateTimeOffset | 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. |
systemLabels | String collection | List of labels applied to the device by the system. Supports $filter (/$count eq 0 , /$count ne 0 ). |
trustType | String | Type of trust for the joined device. Read-only. Possible values: Workplace (indicates *b |
Graph reference: driveItem
Property | Type | Description |
---|---|---|
audio | [audio][] | Audio metadata, if the item is an audio file. Read-only. Read-only. Only on OneDrive Personal. |
bundle | [bundle][] | Bundle metadata, if the item is a bundle. Read-only. |
content | Stream | The content stream, if the item represents a file. |
createdBy | [identitySet][] | Identity of the user, device, and application that created the item. Read-only. |
createdDateTime | DateTimeOffset | Date and time of item creation. Read-only. |
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. |
deleted | [deleted][] | Information about the deleted state of the item. Read-only. |
description | String | Provides a user-visible description of the item. Read-write. Only on OneDrive Personal. |
eTag | String | eTag for the entire item (metadata + content). Read-only. |
file | [file][] | File metadata, if the item is a file. Read-only. |
fileSystemInfo | [fileSystemInfo][] | File system information on client. Read-write. |
folder | [folder][] | Folder metadata, if the item is a folder. Read-only. |
id | String | The unique identifier of the item within the Drive. Read-only. |
image | [image][] | Image metadata, if the item is an image. Read-only. |
lastModifiedBy | [identitySet][] | Identity of the user, device, and application that last modified the item. Read-only. |
lastModifiedDateTime | DateTimeOffset | Date and time the item was last modified. Read-only. |
location | [geoCoordinates][] | Location metadata, if the item has location data. Read-only. |
malware | [malware][] | Malware metadata, if the item was detected to contain malware. Read-only. |
name | String | The name of the item (filename and extension). Read-write. |
package | [package][] | If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only. |
parentReference | [itemReference][] | Parent information, if the item has a parent. Read-write. |
pendingOperations | [pendingOperations][] | If present, indicates that one or more operations that might affect the state of the driveItem are pending completion. Read-only. |
photo | [photo][] | Photo metadata, if the item is a photo. Read-only. |
publication | [publicationFacet][] | Provides information about the published or checked-out state of an item, in locations that support such actions. This property isn't returned by default. Read-only. |
remoteItem | [remoteItem][] | Remote item data, if the item is shared from a drive other than the one being accessed. Read-only. |
root | [root][] | If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. |
searchResult | [searchResult][] | Search metadata, if the item is from a search result. Read-only. |
shared | [shared][] | Indicates that the item was shared with others and provides information about the shared state of the item. Read-only. |
sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
size | Int64 | Size of the item in bytes. Read-only. |
specialFolder | [specialFolder][] | If the current item is also available as a special folder, this facet is returned. Read-only. |
video | [video][] | Video metadata, if the item is a video. Read-only. |
webDavUrl | String | WebDAV compatible URL for the item. |
webUrl | String | URL that displays the resource in the browser. Read-only. |
Graph reference: entity
Property | Type | Description |
---|---|---|
id | String | The unique identifier for an entity. Read-only. |
Graph reference: event
Property | Type | Description |
---|---|---|
allowNewTimeProposals | Boolean | true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false . Optional. Default is true . |
attendees | Attendee collection | The collection of attendees for the event. |
body | ItemBody | The body of the message associated with the event. It can be in HTML or text format. |
bodyPreview | String | The preview of the message associated with the event. It is in text format. |
categories | String collection | The categories associated with the event. Each category corresponds to the displayName property of an outlookCategory defined for the user. |
changeKey | String | Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
end | DateTimeTimeZone | The date, time, and time zone that the event ends. By default, the end time is in UTC. |
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. |
id | String | Unique identifier for the event. !INCLUDE [outlook-beta-id] Case-sensitive and read-only. |
importance | String | The importance of the event. The possible values are: low , normal , high . |
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 has not 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. Subsequently Outlook 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. |
lastModifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
location | Location | The location of the event. |
locations | Location collection | 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. |
onlineMeeting | OnlineMeetingInfo | Details for an attendee to join the meeting online. Default is null. Read-only. After you set the isOnlineMeeting and onlineMeetingProvider properties to enable a meeting online, Microsoft Graph initializes onlineMeeting. When set, the meeting remains available online, and you cannot change the isOnlineMeeting, onlineMeetingProvider, and onlneMeeting properties again. |
onlineMeetingProvider | onlineMeetingProviderType | Represents the online meeting service provider. By default, onlineMeetingProvider is unknown . The possible values are unknown , teamsForBusiness , skypeForBusiness , and skypeForConsumer . Optional. After you set onlineMeetingProvider, Microsoft Graph initializes onlineMeeting. Subsequently you cannot change onlineMeetingProvider again, and the meeting remains available online. |
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 | Recipient | The organizer of the event. |
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 | DateTimeOffset | Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not 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 | PatternedRecurrence | The recurrence pattern for the event. |
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 | ResponseStatus | Indicates the type of response sent in response to an event message. |
sensitivity | String | Possible values are: normal , personal , private , confidential . |
seriesMasterId | String | The ID for the recurring series master item, if this event is part of a recurring series. |
showAs | String | The status to show. Possible values are: free , tentative , busy , oof , workingElsewhere , unknown . |
start | DateTimeTimeZone | The start date, time, and time zone of the event. By default, the start time is in UTC. |
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 in case of 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 cannot change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional. |
type | String | The event type. Possible values are: singleInstance , occurrence , exception , seriesMaster . Read-only |
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 are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in. This URL cannot be accessed from within an iFrame. |
Graph reference: extended-properties-overview
Graph reference: fileAttachment
Property | Type | Description |
---|---|---|
contentBytes | Edm.Binary | The base64-encoded contents of the file. |
contentId | String | The ID of the attachment in the Exchange store. |
contentLocation | String | Don't use this property as it isn't supported. |
contentType | String | The content type of the attachment. |
id | String | The attachment ID. |
isInline | Boolean | Set to true if the attachment is an inline attachment. |
lastModifiedDateTime | DateTimeOffset | The date and time when the attachment was last modified. |
name | String | The name representing the text that is displayed below the icon representing the embedded attachment and doesn't need to be the actual file name. |
size | Int32 | The size in bytes of the attachment. |
Graph reference: group
Property | Type | Description |
---|---|---|
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} ). |
assignedLabels | assignedLabel collection | 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. |
assignedLicenses | assignedLicense collection | 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 autosubscribed 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} ). |
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 ). |
createdDateTime | DateTimeOffset | 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 time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Read-only. |
deletedDateTime | DateTimeOffset | For some Microsoft Entra objects (user, group, application), if the object is deleted, it's first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null . If the object is restored, this property is updated to null . Inherited from 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. This property is required when a group is created and can't be cleared during updates. 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 . |
expirationDateTime | DateTimeOffset | Timestamp of when the group is set to expire. It's 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 January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
groupTypes | String collection | 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). See an example. Supports $filter (eq ). |
hideFromAddressLists | Boolean | True if the group isn't displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. 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; otherwise, false. The default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
id | String | The unique identifier for the group. Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
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 can't 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 assignments Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq , ne , not ). |
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 | String | Indicates the status of the group license assignment to all group members. The default value is false . Read-only. Possible values: QueuedForProcessing , ProcessingInProgress , and ProcessingComplete .Returned only on $select . Read-only. |
String | The SMTP address for the group, for example, "[email protected]". 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 ). |
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 characters: @ () \ [] " ; : <> , SPACE . Required. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
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 ). |
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 | DateTimeOffset | Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 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 | onPremisesProvisioningError collection | 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 synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq , ne , not , in , and eq on null values). |
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:
For more information about this property, see OneDrive Online Multi-Geo. 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 collection | Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"] . The any operator is required to 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 ). |
renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This value can't 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 January 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
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 | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq , not , for isResolved and serviceInstance). |
theme | string | Specifies a Microsoft 365 group's color theme. Possible values are Teal , Purple , Green , Blue , Pink , Orange , or Red . Returned by default. |
uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only. |
unseenCount | Int32 | Count of conversations that received new posts since the signed-in user last visited the group. Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
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 the Microsoft 365 group is Public . Groups assignable to roles are always Private . To learn more, see group visibility options. Returned by default. Nullable. |
Graph reference: itemAttachment
Property | Type | Description |
---|---|---|
contentType | String | The content type of the attachment. Returned as null by default, when not set explicitly. Optional. |
id | String | The attachment ID. |
isInline | Boolean | Set to true if the attachment is inline, such as an embedded image within the body of the item. |
lastModifiedDateTime | DateTimeOffset | The last time and date that the attachment was modified. |
name | String | The display name of the attachment. |
size | Int32 | The size in bytes of the attachment. |
Graph reference: itemBody
Property | Type | Description |
---|---|---|
content | String | The content of the item. |
contentType | bodyType | The type of the content. Possible values are text and html . |
Graph reference: linkedResource
Property | Type | Description |
---|---|---|
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. |
id | String | Server generated ID for the linkedResource. Inherited from entity. |
webUrl | String | Deep link to the **l |
Graph reference: linkedresource_v2
Property | Type | Description |
---|---|---|
applicationName | String | Field indicating the app name of the source that is sending the linkedResource. |
displayName | String | Field indicating the title of the linkedResource. |
externalId | String | Id of the object that is associated with this task on the third-party/partner system. |
id | String | Server generated ID for the linkedResource. Inherited from entity. |
webUrl | String | Deep link to the **l |
Graph reference: List
Property | Type | Description |
---|---|---|
createdBy | identitySet | Identity of the creator of this item. Read-only. Inherited from baseItem. |
createdDateTime | DateTimeOffset | The date and time when the item was created. Read-only. Inherited from baseItem. |
description | String | The descriptive text for the item. Inherited from baseItem. |
displayName | String | The displayable title of the list. |
eTag | String | ETag for the item. Inherited from baseItem. |
id | String | The unique identifier of the item. Read-only. Inherited from baseItem. |
lastModifiedBy | identitySet | Identity of the last modifier of this item. Read-only. Inherited from baseItem. |
lastModifiedDateTime | DateTimeOffset | The date and time when the item was last modified. Read-only. Inherited from baseItem. |
list | listInfo | Contains more details about the list. |
name | String | The name of the item. Read-only. Inherited from baseItem. |
parentReference | itemReference | Parent information if the item has a parent. Read-write. Inherited from baseItem. |
sharepointIds | sharepointIds | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
system | systemFacet | If present, indicates that the list is system-managed. Read-only. |
webUrl | String | URL that displays the item in the browser. Read-only. Inherited from baseItem. |
Graph reference: mailFolder
Property | Type | Description |
---|---|---|
childFolderCount | Int32 | The number of immediate child mailFolders in the current mailFolder. |
displayName | String | The mailFolder's display name. |
id | String | The mailFolder's unique identifier. |
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. |
parentFolderId | String | The unique identifier for the mailFolder's parent mailFolder. |
totalItemCount | Int32 | The number of items in the mailFolder. |
unreadItemCount | Int32 | The number of items in the mailFolder marked as unread. |
Graph reference: message
Property | Type | Description |
---|---|---|
bccRecipients | recipient collection | The Bcc: recipients for the message. |
body | itemBody | The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body. |
bodyPreview | String | The first 255 characters of the message body. It is in text format. |
ccRecipients | recipient collection | The Cc: recipients for the message. |
changeKey | String | The version of the message. |
conversationId | String | The ID of the conversation the email belongs to. |
conversationIndex | Edm.Binary | Indicates the position of the message within the conversation. |
createdDateTime | DateTimeOffset | The date and time the message was created. 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 . |
flag | followupFlag | The flag value that indicates the status, start date, due date, or completion date for the message. |
from | recipient | The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
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 <IMG src="cid:[email protected]"> . |
id | String | Unique identifier for the message. !INCLUDE [outlook-beta-id] Read-only. |
importance | importance | The importance of the message. The possible values are: low , normal , and high . |
inferenceClassification | inferenceClassificationType | The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other . |
internetMessageHeaders | internetMessageHeader collection | 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. |
internetMessageId | String | The message ID in the format specified by RFC2822. |
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. |
lastModifiedDateTime | DateTimeOffset | The date and time the message was last changed. 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 . |
parentFolderId | String | The unique identifier for the message's parent mailFolder. |
receivedDateTime | DateTimeOffset | 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 | recipient collection | The email addresses to use when replying. |
sender | recipient | The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
sentDateTime | DateTimeOffset | 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 . |
subject | String | The subject of the message. |
toRecipients | recipient collection | The To: recipients for the message. |
uniqueBody | itemBody | The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format. |
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. |
Graph reference: multiValueLegacyExtendedProperty
Property | Type | Description |
---|---|---|
id | string | The property identifier. Read-only. |
value | string collection | A collection of property values. |
Graph reference: offerShiftRequest
Property | Type | Description |
---|---|---|
recipientActionDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
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. |
Graph reference: onlineMeeting
Property | Type | Description |
---|---|---|
allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from onlineMeetingBase. |
allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from onlineMeetingBase. |
allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. Possible values are listed in the following table. Inherited from onlineMeetingBase. |
allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. Inherited from onlineMeetingBase. |
allowParticipantsToChangeName | Boolean | Specifies if participants are allowed to rename themselves in an instance of the meeting. Inherited from onlineMeetingBase. |
allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. Inherited from onlineMeetingBase. |
audioConferencing | audioConferencing | The phone access (dial-in) information for an online meeting. Read-only. Inherited from onlineMeetingBase. |
chatInfo | chatInfo | The chat information associated with this online meeting. Inherited from onlineMeetingBase. |
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. |
joinWebUrl | String | The join URL of the online meeting. The format of the URL may change; therefore, users shouldn't rely on any information extracted from parsing the URL. Read-only. Inherited from onlineMeetingBase. |
participants | meetingParticipants | The participants associated with the online meeting, including the organizer and the attendees. |
subject | String | The subject of the online meeting. Required when you create an online meeting. |
id | String | The default ID associated with the online meeting. Read-only. Inherited from onlineMeetingBase. |
isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from onlineMeetingBase. |
joinInformation | itemBody | The join information in the language and locale variant specified in the Accept-Language request HTTP header. Read-only. Inherited from onlineMeetingBase. |
joinMeetingIdSettings | joinMeetingIdSettings | Specifies the joinMeetingId, the meeting passcode, and the requirement for the passcode. Once an onlineMeeting is created, the joinMeetingIdSettings can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from onlineMeetingBase. |
lobbyBypassSettings | lobbyBypassSettings | Specifies which participants can bypass the meeting lobby. Inherited from onlineMeetingBase. |
recordAutomatically | Boolean | Indicates whether to record the meeting automatically. Inherited from onlineMeetingBase. |
shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode | Specifies whether meeting chat history is shared with participants. Possible values are: all , none , unknownFutureValue . Inherited from onlineMeetingBase. |
startDateTime | DateTime | The meeting start time in UTC. |
videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from onlineMeetingBase. |
watermarkProtection | watermarkProtectionValues | Specifies whether the client application should apply a watermark a content type. Inherited from onlineMeetingBase. |
attendeeReport (deprecated) | Stream | The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
broadcastSettings (deprecated) | broadcastMeetingSettings | Settings related to a live event. |
isBroadcast (deprecated) | Boolean | Indicates whether this meeting is a Teams live event. |
Graph reference: openShiftChangeRequest
Property | Type | Description |
---|---|---|
openShiftId | String | ID for the open shift. |
Graph reference: opentypeextension
Property | Type | Description |
---|---|---|
extensionName | String | A unique text identifier for an open type data extension. Optional. |
id | String | A fully qualified identifier that concatenates the extension type with the **e |
Graph reference: organization
Property | Type | Description |
---|---|---|
assignedPlans | assignedPlan collection | The collection of service plans associated with the tenant. Not nullable. |
businessPhones | String collection | Telephone number for the organization. Although this property is a string collection, only one number can be set. |
city | String | City name of the address for the organization. |
country | String | Country or region name of the address for the organization. |
countryLetterCode | String | Country or region abbreviation for the organization in ISO 3166-2 format. |
createdDateTime | DateTimeOffset | Timestamp of when the organization was created. The value can't be modified and is automatically populated when the organization 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 . Read-only. |
defaultUsageLocation | String | Two-letter ISO 3166 country code indicating the default service usage location of an organization. |
deletedDateTime | DateTimeOffset | Represents date and time of when the Microsoft Entra tenant was deleted 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. |
displayName | String | The display name for the tenant. |
id | String | The tenant ID, a unique identifier representing the organization (or tenant). Inherited from directoryObject. Key. Not nullable. Read-only. |
isMultipleDataLocationsForServicesEnabled | Boolean | true if organization is Multi-Geo enabled; false if the organization isn't Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo. |
marketingNotificationEmails | String collection | Not nullable. |
onPremisesLastSyncDateTime | DateTimeOffset | The time and date at which the tenant was last 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. |
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. Nullable. null if this object isn't synced from on-premises active directory (default). |
partnerTenantType | partnerTenantType | The type of partnership this tenant has with Microsoft. The possible values are: microsoftSupport , syndicatePartner , breadthPartner , breadthPartnerDelegatedAdmin , resellerPartnerDelegatedAdmin , valueAddedResellerPartnerDelegatedAdmin , unknownFutureValue . Nullable. For more information about the possible types, see partnerTenantType values. |
postalCode | String | Postal code of the address for the organization. |
preferredLanguage | String | The preferred language for the organization. Should follow ISO 639-1 Code; for example, en . |
privacyProfile | privacyProfile | The privacy profile of an organization. |
provisionedPlans | ProvisionedPlan collection | Not nullable. |
securityComplianceNotificationMails | String collection | Not nullable. |
securityComplianceNotificationPhones | String collection | Not nullable. |
state | String | State name of the address for the organization. |
street | String | Street name of the address for organization. |
technicalNotificationMails | String collection | Not nullable. |
tenantType | String | Not nullable. Can be one of the following types: AAD - An enterprise identity access management (IAM) service that serves business-to-employee and business-to-business (B2B) scenarios. AAD B2C An identity access management (IAM) service that serves business-to-consumer (B2C) scenarios. CIAM - A customer identity & access management (CIAM) solution that provides an integrated platform to serve consumers, partners, and citizen scenarios. |
verifiedDomains | VerifiedDomain collection | The collection of domains associated with this tenant. Not nullable. |
Graph reference: outlookCategory
Property | Type | Description |
---|---|---|
color | categoryColor | A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. For more details, see the following note. |
displayName | String | A unique name that identifies a category in the user's mailbox. After a category is created, the name cannot be changed. Read-only. |
Graph reference: outlooktask
Property | Type | Description |
---|---|---|
assignedTo | String | The name of the person who has been assigned the task in Outlook. Read-only. |
body | itemBody | The task body that typically contains information about the task. Only the HTML type is supported. |
categories | String collection | The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined. |
changeKey | String | The version of the task. |
completedDateTime | dateTimeTimeZone | The date in the specified time zone that the task was finished. |
createdDateTime | DateTimeOffset | 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, 2014 is 2014-01-01T00:00:00Z . |
dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
hasAttachments | Boolean | Set to true if the task has attachments. |
id | String | Unique identifier for the task. !INCLUDE [outlook-beta-id] Read-only. |
importance | importance | The importance of the event. Possible values are: low , normal , high . |
isReminderOn | Boolean | Set to true if an alert is set to remind the user of the task. |
lastModifiedDateTime | DateTimeOffset | 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, 2014 is 2014-01-01T00:00:00Z . |
owner | String | The name of the person who created the task. |
parentFolderId | String | The unique identifier for the task's parent folder. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
reminderDateTime | dateTimeTimeZone | The date and time for a reminder alert of the task to occur. |
sensitivity | sensitivity | Indicates the level of privacy for the task. Possible values are: normal , personal , private , confidential . |
startDateTime | dateTimeTimeZone | The date in the specified time zone when the task is to begin. |
status | taskStatus | Indicates the state or progress of the task. Possible values are: notStarted , inProgress , completed , waitingOnOthers , deferred . |
subject | String | A brief description or title of the task. |
Graph reference: outlooktaskfolder
Property | Type | Description |
---|---|---|
changeKey | String | The version of the task folder. |
id | String | The identifier of the task folder, unique in the user's mailbox. Read-only. |
isDefaultFolder | Boolean | True if the folder is the default task folder. |
name | String | The name of the task folder. |
parentGroupKey | Guid | The unique GUID identifier for the task folder's parent group. |
Graph reference: outlooktaskgroup
Property | Type | Description |
---|---|---|
changeKey | String | The version of the task group. |
groupKey | Edm.Guid | The unique GUID identifier for the task group. |
id | String | The unique string identifier of the task group. Read-only. |
isDefaultGroup | Boolean | True if the task group is the default task group. |
name | String | The name of the task group. |
Graph reference: patternedRecurrence
Property | Type | Description |
---|---|---|
pattern | recurrencePattern | The frequency of an event. For access reviews: weekly , absoluteMonthly ) properties of recurrencePattern are supported. |
range | recurrenceRange | The duration of an event. |
Graph reference: planner-identifiers-disclaimer
Graph reference: planner-order-hint-format
Graph reference: planner-overview
Graph reference: plannerAppliedCategories
Graph reference: plannerAssignedToTaskBoardTaskFormat
Property | Type | Description |
---|---|---|
id | String | ID of the resource. It's 28 characters long and case-sensitive. Format validation is done on the service. Read-only. |
orderHintsByAssignee | plannerOrderHintsByAssignee | Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here. |
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. |
Graph reference: plannerAssignments
Graph reference: plannerBucket
Property | Type | Description |
---|---|---|
id | String | Read-only. ID of the bucket. It is 28 characters long and case-sensitive. Format validation is done on the service. |
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. |
Graph reference: plannerBucketTaskBoardTaskFormat
Property | Type | Description |
---|---|---|
id | String | Read-only. ID of the resource. It's 28 characters long and case-sensitive. The format validation is done on the service. |
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. |
Graph reference: plannerCategoryDescriptions
Property | Type | Description |
---|---|---|
category1 | String | The label associated with Category 1 |
category2 | String | The label associated with Category 2 |
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 |
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 |
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 |
Graph reference: plannerChecklistItems
Graph reference: plannerExternalReferences
Graph reference: plannerFavoritePlanReferenceCollection
Graph reference: plannerOrderHintsByAssignee
Graph reference: plannerPlan
Property | Type | Description |
---|---|---|
container | plannerPlanContainer | Identifies the container of the plan. Specify only the url, the containerId and type, or all properties. After it's set, this property can’t be updated. Required. |
createdBy | identitySet | Read-only. The user who created the plan. |
createdDateTime | DateTimeOffset | 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 |
id | String | Read-only. ID of the plan. It's 28 characters long and case-sensitive. Format validation is done on the service. |
owner (deprecated) | 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 won't return a valid group ID if the container of the plan isn't a group. |
title | String | Required. Title of the plan. |
Graph reference: plannerPlanContainer
Property | Type | Description |
---|---|---|
containerId | String | The identifier of the resource that contains the plan. Optional. |
type | plannerContainerType | The type of the resource that contains the plan. For supported types, see the previous table. Possible values are: group , unknownFutureValue , roster . Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: roster . Optional. |
url | String | The full canonical URL of the container. Optional. |
Graph reference: plannerPlanDetails
Property | Type | Description |
---|---|---|
categoryDescriptions | plannerCategoryDescriptions | An object that specifies the descriptions of the 25 categories that can be associated with tasks in the plan. |
id | String | The unique identifier for the plan details. It's 28 characters long and case-sensitive. Format validation is done on the service. Read-only. |
sharedWith | plannerUserIds | Set of user IDs that this plan is shared with. If you're using Microsoft 365 groups, use the Groups API to manage group membership to share the group's plan. You can also add existing members of the group to this collection, although it isn't required for them to access the plan owned by the group. |
Graph reference: plannerProgressTaskBoardTaskFormat
Property | Type | Description |
---|---|---|
id | String | Read-only. ID of the resource. It's 28 characters long and case-sensitive. The format validation is done on the service. |
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. |
Graph reference: plannerRecentPlanReferenceCollection
Graph reference: plannerRoster
Property | Type | Description |
---|---|---|
assignedSensitivityLabel | sensitivityLabelAssignmentMethod | The sensitivity label applied to the roster. If mandatory labeling is enabled for the user and no label is specified, the user can't create the roster. Also, if labels are mandatory for the user, the user can't change the label of the roster to null . Possible values are: standard , privileged , auto , unknownFutureValue . |
id | String | Identifier of the **p |
Graph reference: plannerRosterMember
Property | Type | Description |
---|---|---|
id | String | The identifier of the plannerRosterMember. Inherited from entity |
roles | String collection | Additional roles associated with the PlannerRosterMember, which determines permissions of the member in the plannerRoster. Currently there are no available roles to assign, and every member has full control over the contents of the plannerRoster. |
tenantId | String | Identifier of the tenant the user belongs to. Currently only the users from the same tenant can be added to a plannerRoster. |
userId | String | Identifier of the user. |
Graph reference: plannerTask
Property | Type | Description |
---|---|---|
activeChecklistItemCount | Int32 | Number of checklist items with value set to false , representing incomplete items. |
appliedCategories | plannerAppliedCategories | The categories to which the task has been applied. See applied Categories for possible values. |
assigneePriority | String | Hint used to order items of this type in a list view. The format is defined as outlined here. |
assignments | plannerAssignments | The set of assignees the task is assigned to. |
bucketId | String | Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It's 28 characters long and case-sensitive. Format validation is done on the service. |
checklistItemCount | Int32 | Number of checklist items that are present on the task. |
completedBy | identitySet | Identity of the user that completed the task. |
completedDateTime | DateTimeOffset | Read-only. Date and time at which the 'percentComplete' of the task is set to '100' . The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
conversationThreadId | String | Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group. |
createdBy | identitySet | Identity of the user that created the task. |
createdDateTime | DateTimeOffset | Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
dueDateTime | DateTimeOffset | 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. Value is true if the details object of the task has a nonempty description and false otherwise. |
id | String | Read-only. ID of the task. It's 28 characters long and case-sensitive. Format validation is done on the service. |
orderHint | String | Hint used to order items of this type in a list view. The format is defined as outlined here. |
percentComplete | Int32 | Percentage of task completion. When set to 100 , the task is considered completed. |
planId | String | Plan ID to which the task belongs. |
previewType | String | This sets the type of preview that shows up on the task. The possible values are: automatic , noPreview , checklist , description , reference . |
priority | Int32 | Priority of the task. The valid range of values is between 0 and 10 , with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2 , 3 and 4 as "important", 5 , 6 , and 7 as "medium", and 8 , 9 , and 10 as "low". Additionally, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low". |
referenceCount | Int32 | Number of external references that exist on the task. |
startDateTime | DateTimeOffset | 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. |
Graph reference: plannerTaskDetails
Property | Type | Description |
---|---|---|
checklist | plannerChecklistItems | The collection of checklist items on the task. |
description | String | Description of the task. |
id | String | Read-only. ID of the task details. It's 28 characters long and case-sensitive. Format validation is done on the service. |
previewType | string | This sets the type of preview that shows up on the task. The possible values are: automatic , noPreview , checklist , description , reference . When set to automatic the displayed preview is chosen by the app viewing the task. |
references | plannerExternalReferences | The collection of references on the task. |
Graph reference: plannerTaskRecurrence
Property | Type | Description |
---|---|---|
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 | DateTimeOffset | 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 | plannerRecurrenceSchedule | The schedule for recurrence. Clients define and edit recurrence by specifying the schedule. If nextInSeriesTaskId isn't assigned, clients may terminate the series by assigning null to this property. |
seriesId | String | The recurrence series this task belongs to. A GUID-based value that serves as the unique identifier for a series. |
Graph reference: plannerUser
Property | Type | Description |
---|---|---|
id | String | Read-only. The unique identifier for the **p |
Graph reference: plannerUserIds
Graph reference: post
Property | Type | Description |
---|---|---|
body | itemBody | The contents of the post. This is a default property. This property can be null. |
categories | String collection | The categories associated with the post. |
changeKey | String | Identifies the version of the post. Every time the post is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
conversationId | String | Unique ID of the conversation. Read-only. |
conversationThreadId | String | Unique ID of the conversation thread. Read-only. |
createdDateTime | DateTimeOffset | Specifies when the post was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
from | recipient | Used in delegate access scenarios. Indicates who posted the message on behalf of another user. This is a default property. |
hasAttachments | Boolean | Indicates whether the post has at least one attachment. This is a default property. |
id | String | Read-only. |
lastModifiedDateTime | DateTimeOffset | Specifies when the post was last modified. 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 |
newParticipants | recipient collection | Conversation participants that were added to the thread as part of this post. |
receivedDateTime | DateTimeOffset | 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 | recipient | Contains the address of the sender. The value of Sender is assumed to be the address of the authenticated user in the case when Sender is not specified. This is a default property. |
Graph reference: presence
Property | Type | Description |
---|---|---|
activity | String collection | 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 collection | The base presence information for a user. Possible values are Available , AvailableIdle , Away , BeRightBack , Busy , BusyIdle , DoNotDisturb , Offline , PresenceUnknown |
id | String | The unique identifier for the user. |
statusMessage | presenceStatusMessage | The presence status message of a user. |
Graph reference: printer
Property | Type | Description |
---|---|---|
capabilities | printerCapabilities | The capabilities of the printer associated with this printer share. Inherited from printerBase. |
defaults | printerDefaults | The printer's default print settings. Inherited from printerBase. |
displayName | String | The name of the printer. Inherited from printerBase. |
hasPhysicalDevice | Boolean | True if the printer has a physical device for printing. Read-only. |
id | String | The document's identifier. Inherited from printerBase. Read-only. |
isAcceptingJobs | Boolean | True if the printer is currently accepting new print jobs. Inherited from printerBase. |
isShared | Boolean | True if the printer is shared; false otherwise. Read-only. |
lastSeenDateTime | DateTimeOffset | The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only. |
location | printerLocation | The physical and/or organizational location of the printer. Inherited from printerBase. |
manufacturer | String | The manufacturer reported by the printer. Inherited from printerBase. |
model | String | The model name reported by the printer. Inherited from printerBase. |
registeredDateTime | DateTimeOffset | The DateTimeOffset when the printer was registered. Read-only. |
status | printerStatus | The processing status of the printer, including any errors. Inherited from printerBase. |
Graph reference: printTaskDefinition
Property | Type | Description |
---|---|---|
createdBy | appIdentity | The application that created the printTaskDefinition. Read-only. |
displayName | String | The name of the printTaskDefinition. |
id | String | The printTaskDefinition's identifier. Read-only. |
Graph reference: sensitivityLabelAssignment
Property | Type | Description |
---|---|---|
assignmentMethod | sensitivityLabelAssignmentMethod | Indicates whether the label assignment is done automatically, as a standard, or a privileged operation. The possible values are: standard , privileged , auto , unknownFutureValue . |
sensitivityLabelId | String | The unique identifier for the sensitivity label assigned to the file. |
tenantId | String | The unique identifier for the tenant that hosts the file when this label is applied. |
Graph reference: shift
Graph reference: singleValueLegacyExtendedProperty
Property | Type | Description |
---|---|---|
id | string | The property ID used to identify the property. Read-only. |
value | string | A property value. |
Graph reference: subscription
Property | Type | Description |
---|---|---|
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: updated changeType. 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 128 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. |
expirationDateTime | DateTimeOffset | 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. |
id | String | Optional. Unique identifier for the subscription. Read-only. |
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: v1_0 , v1_1 , v1_2 , v1_3 . 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. |
notificationQueryOptions | String | Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when 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/v1.0/ ). See the possible resource path values for each supported resource. |
Graph reference: swapShiftsChangeRequest
Property | Type | Description |
---|---|---|
recipientShiftId | String | ShiftId for the recipient user with whom the request is to swap. |
Graph reference: taskFileAttachment
Property | Type | Description |
---|---|---|
contentBytes | Binary | The base64-encoded contents of the file. |
contentType | String | The content type of the attachment. Inherited from attachmentBase. |
id | String | The ID of the attachment. Inherited from entity. |
lastModifiedDateTime | DateTimeOffset | The date and time when the attachment was last modified. Inherited from attachmentBase. |
name | String | The name of the text displayed under the icon that represents the embedded attachment. This does not need to be the actual file name. Inherited from attachmentBase. |
size | Int32 | The size in bytes of the attachment. Inherited from attachmentBase. |
Graph reference: tasklist
Property | Type | Description |
---|---|---|
displayName | String | The name of the task list. Inherited from baseTaskList. |
id | String | The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from baseTaskList. |
Graph reference: tasks-identifiers-disclaimer
Graph reference: taskViewpoint
Property | Type | Description |
---|---|---|
reminderDateTime | dateTimeTimeZone | The date and time for a reminder alert of the task to occur. |
categories | String collection | The categories associated with the task. Each category corresponds to the **d |
Graph reference: team
Property | Type | Description |
---|---|---|
id | string | The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type. |
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. |
classSettings | teamClassSettings | Configure settings of a class. Available only when the team represents a class. |
createdDateTime | dateTimeOffset | Timestamp at which the team was created. |
description | string | An optional description for the team. Maximum length: 1024 characters. |
displayName | string | The name of the team. |
funSettings | teamFunSettings | Settings to configure use of Giphy, memes, and stickers in the team. |
guestSettings | teamGuestSettings | Settings to configure whether guests can create, update, or delete channels in the team. |
internalId | string | A unique ID for the team that has been 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. |
memberSettings | teamMemberSettings | Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team. |
messagingSettings | teamMessagingSettings | Settings to configure messaging and mentions in the team. |
specialization | teamSpecialization | Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case. |
summary | teamSummary | Contains summary information about the team, including number of owners, members, and guests. |
tenantId | string | The ID of the Microsoft Entra tenant. |
visibility | teamVisibilityType | The visibility of the group and team. Defaults to Public. |
webUrl | string (readonly) | A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select **G |
Graph reference: timeOffRequest
Property | Type | Description |
---|---|---|
endDateTime | DateTimeOffset | The Timestamp type represents date and time information 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 | DateTimeOffset | The Timestamp type represents date and time information 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. |
Graph reference: todoTask
Property | Type | Description |
---|---|---|
body | itemBody | The task body that typically contains information about the task. |
bodyLastModifiedDateTime | DateTimeOffset | 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 collection | The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined. |
completedDateTime | dateTimeTimeZone | The date and time in the specified time zone that the task was finished. |
createdDateTime | DateTimeOffset | 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 | dateTimeTimeZone | The date and time in the specified time zone that the task is to be finished. |
hasAttachments | Boolean | Indicates whether the task has attachments. |
id | String | Unique identifier for the task. By default, this value changes when the item is moved from one list to another. |
importance | importance | The importance of the task. Possible values are: low , normal , high . |
isReminderOn | Boolean | Set to true if an alert is set to remind the user of the task. |
lastModifiedDateTime | DateTimeOffset | 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'. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
reminderDateTime | dateTimeTimeZone | The date and time in the specified time zone for a reminder alert of the task to occur. |
startDateTime | dateTimeTimeZone | The date and time in the specified time zone at which the task is scheduled to start. |
status | taskStatus | Indicates the state or progress of the task. Possible values are: notStarted , inProgress , completed , waitingOnOthers , deferred . |
title | String | A brief description of the task. |
Graph reference: todoTaskList
Property | Type | Description |
---|---|---|
displayName | String | The name of the task list. |
id | String | The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from entity |
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 |
wellknownListName | wellknownListName | Property indicating the list name if the given list is a well-known list. Possible values are: none , defaultList , flaggedEmails , unknownFutureValue . |
Graph reference: uploadSession
Property | Type | Description |
---|---|---|
expirationDateTime | DateTimeOffset | The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached. |
nextExpectedRanges | String collection | A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (for example "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin. |
uploadUrl | String | The URL endpoint that accepts PUT requests for byte ranges of the file. |
Graph reference: user
Property | Type | Description |
---|---|---|
aboutMe | String | A freeform text entry field for the user 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. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
ageGroup | ageGroup | Sets the age group of the user. Allowed values: null , Minor , NotAdult , and Adult . For more information, see legal age group property definitions. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
assignedLicenses | assignedLicense collection | 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. Returned only on $select . Supports $filter (eq , not , /$count eq 0 , /$count ne 0 ). |
assignedPlans | assignedPlan collection | The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select . Supports $filter (eq and not ). |
birthday | DateTimeOffset | 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 collection | The telephone numbers for the user. NOTE: Although it's a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq , not , ge , le , startsWith ). |
city | String | The city where the user is located. Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
companyName | String | The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
consentProvidedForMinor | consentProvidedForMinor | Sets whether consent was obtained for minors. Allowed values: null , Granted , Denied , and NotRequired . For more information, see legal age group property definitions. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
country | String | The country/region where the user is located; for example, US or UK . Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
createdDateTime | DateTimeOffset | The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
creationType | String | Indicates whether the user account was created through one of the following methods:
Read-only. Returned only on $select . Supports $filter (eq , ne , not , in ). |
customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select . Supports $filter (eq , ne , not , startsWith ). The filter value is case-sensitive. |
deletedDateTime | DateTimeOffset | The date and time the user was deleted. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
department | String | The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , and eq on null values). |
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 family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $orderby , and $search . |
employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in a future hire. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. Supports $filter (eq , ne , not , ge , le , in ). For more information, see Configure the employeeLeaveDateTime property for a user. |
employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
employeeOrgData | employeeOrgData | Represents organization data (for example, division and costCenter) associated with a user. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeType | String | Captures enterprise worker type. For example, Employee , Contractor , Consultant , or Vendor . Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
externalUserState | String | For a guest 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. Returned only on $select . Supports $filter (eq , ne , not , in ). |
externalUserStateChangeDateTime | DateTimeOffset | Shows the timestamp for the latest change to the externalUserState property. Returned only on $select . Supports $filter (eq , ne , not , in ). |
faxNumber | String | The fax number of the user. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
givenName | String | The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
hireDate | DateTimeOffset | 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 in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. |
id | String | The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only. Returned by default. Supports $filter (eq , ne , not , in ). |
identities | objectIdentity collection | Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select . Supports $filter (eq ) with limitations. |
imAddresses | String collection | The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select . Supports $filter (eq , not , ge , le , startsWith ). |
interests | String collection | A list for the user to describe their interests. Returned only on $select . |
isResourceAccount | Boolean | Don't use – reserved for future use. |
jobTitle | String | The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
lastPasswordChangeDateTime | DateTimeOffset | The time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses 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 . |
legalAgeGroupClassification | 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 , Undefined , MinorWithOutParentalConsent , MinorWithParentalConsent , MinorNoParentalConsentRequired , NotAdult , and Adult . For more information, see legal age group property definitions. Returned only on $select . |
licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select . |
String | The SMTP address for the user, for example, [email protected] . Changes to this property 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. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , endsWith , and eq on null values). |
|
mailboxSettings | mailboxSettings | Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select . |
mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. 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 . |
officeLocation | String | The office location in the user's place of business. Returned by default. 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 who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . |
onPremisesDomainName | String | Contains the on-premises domainFQDN , also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . |
onPremisesExtensionAttributes | onPremisesExtensionAttributes | Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. false ), these properties can be set during the creation or update of a user object. Returned only on $select . Supports $filter (eq , ne , not , in ). |
onPremisesImmutableId | String | This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't be used when specifying this property. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesLastSyncDateTime | DateTimeOffset | 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. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned only on $select . 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 who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select . Supports $filter (eq including on null values). |
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. Returned only on $select . 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 who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
otherMails | String collection | A list of other email addresses for the user; for example: ["[email protected]", "[email protected]"] . NOTE: This property can't contain accent characters. Returned only on $select . Supports $filter (eq , not , ge , le , in , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
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 might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword . Returned only on $select . For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne , not , and eq on null values). |
passwordProfile | passwordProfile | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). To update this property: |
pastProjects | String collection | A list for the user to enumerate their past projects. Returned only on $select . |
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. Returned only on $select . 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 is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". Returned by default. 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 . |
provisionedPlans | provisionedPlan collection | The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select . Supports $filter (eq , not , ge , le ). |
proxyAddresses | String collection | For example: "SMTP: [email protected]", "smtp: [email protected]"] . Changes to the mail property update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses 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. Returned only on $select . Supports $filter (eq , not , ge , le , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
refreshTokensValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on $select . Read-only. |
responsibilities | String collection | A list for the user to enumerate their responsibilities. Returned only on $select . |
serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq , not , for isResolved and serviceInstance). |
schools | String collection | A list for the user to enumerate the schools they attended. Returned only on $select . |
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 ). |
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 | signInActivity | Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le ) but not with any other filterable properties. Note: |
signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select . |
skills | String collection | A list for the user to enumerate their skills. Returned only on $select . |
state | String | The state or province in the user's address. Maximum length is 128 characters. Returned only on $select . 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 1,024 characters. Returned only on $select . 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. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
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. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
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 value should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. NOTE: This property can't contain accent characters. Only the following characters are allowed A - Z , a - z , 0 - 9 , ' . - _ ! # ^ ~ . For the complete list of allowed characters, see username policies. Returned by default. 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 . Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). **N |
Graph reference: virtualEventWebinar
Property | Type | Description |
---|---|---|
audience | meetingAudience | To whom the webinar is visible. Possible values are: everyone , organization , and unknownFutureValue . |
coOrganizers | communicationsUserIdentity collection | Identity information of coorganizers of the webinar. |
createdBy | communicationsIdentitySet | Identity information for the creator of the webinar. Inherited from virtualEvent. |
description | itemBody | Description of the webinar. Inherited from virtualEvent. |
displayName | String | Display name of the webinar. Inherited from virtualEvent. |
endDateTime | dateTimeTimeZone | End time of the webinar. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. |
startDateTime | dateTimeTimeZone | Start time of the webinar. The timeZone property can be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see Get-TimeZone. |
id | String | Unique identifier of the webinar. Inherited from entity. |
settings | virtualEventSettings | The webinar settings. Inherited from virtualEvent. |
status | virtualEventStatus | Status of the webinar. Possible values are: draft , published , canceled , and unknownFutureValue . Inherited from virtualEvent. |