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.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver	Type	Method
V1	D	DELETE /me/outlook/taskFolders/{id}
V1	D	DELETE /me/outlook/taskGroups/{id}
V1	D	DELETE /me/outlook/taskGroups/{id}/taskFolders/{id}
V1	D	DELETE /me/outlook/tasks/{id}
V1	D	DELETE /me/tasks/alltasks/{baseTaskId}
V1	D	DELETE /me/tasks/lists/{baseTaskListId}
V1	D	DELETE /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}
V1	A,D	DELETE /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources/{linkedResourceId}
V1	D	DELETE /me/todo/lists/{id}/tasks/{id}/attachments/{id}
V1	D	DELETE /me/todo/lists/{todoTaskListId}
V1	D	DELETE /me/todo/lists/{todoTaskListId}/tasks/{taskId}
V1	D	DELETE /me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourcesId}
V1	D	DELETE /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItemId}
V1	D	DELETE /planner/buckets/{id}
V1	D	DELETE /planner/plans/{id}
V1	D	DELETE /planner/rosters/{plannerRosterId}
V1	D	DELETE /planner/rosters/{plannerRosterId}/members/{plannerRosterMemberId}
V1	D	DELETE /planner/tasks/{id}
V1	A,D	DELETE /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources/{linkedResourceId}
V1	D	DELETE /users/{id \| userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItemId}
V1	D	DELETE /users/{id}/todo/lists/{id}/tasks/{id}/attachments/{id}
V1	D	DELETE /users/{id\|userPrincipalName}/outlook/taskFolders/{id}
V1	D	DELETE /users/{id\|userPrincipalName}/outlook/taskGroups/{id}
V1	D	DELETE /users/{id\|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}
V1	D	DELETE /users/{id\|userPrincipalName}/outlook/tasks/{id}
V1	D	DELETE /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}
V1	D	DELETE /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}
V1	D	DELETE /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourcesId}
V1	D	DELETE /users/{userId\|userPrincipalName}/tasks/alltasks/{baseTaskId}
V1	D	DELETE /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}
V1	D	DELETE /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}
V1	D	GET /drive/root/createdByUser/planner/plans
V1	D	GET /drive/root/createdByUser/planner/tasks
V1	D	GET /groups/{group-id}/planner/plans
V1	D	GET /me/planner
V1	D	GET /me/planner/all/delta
V1	D	GET /me/planner/favoritePlans
V1	D	GET /me/planner/plans
V1	D	GET /me/planner/recentPlans
V1	D	GET /me/planner/tasks
V1	D	GET /me/tasks/alltasks/{baseTaskId}
V1	D	GET /me/tasks/lists
V1	D	GET /me/tasks/lists/{baseTaskListId}/tasks
V1	D	GET /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}
V1	A,D	GET /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/checklistItems
V1	A,D	GET /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources
V1	A,D	GET /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources/{linkedResourceId}
V1	D	GET /me/tasks/lists/{baseTaskListId}/tasks/delta
V1	D	GET /me/tasks/lists/delta
V1	D	GET /me/todo/lists
V1	D	GET /me/todo/lists/{id}/tasks/{id}/attachments/{id}
V1	D	GET /me/todo/lists/{id}/tasks/delta
V1	D	GET /me/todo/lists/{todoTaskListId}
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks/{taskId}
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourcesId}
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/attachments
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems
V1	D	GET /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItemId}
V1	D	GET /me/todo/lists/delta
V1	D	GET /planner/buckets
V1	D	GET /planner/buckets/{id}
V1	D	GET /planner/buckets/{id}/tasks
V1	D	GET /planner/plans
V1	D	GET /planner/plans/{id}/details
V1	D	GET /planner/plans/{plan-id}
V1	D	GET /planner/plans/{plan-id}/buckets
V1	D	GET /planner/plans/{plan-id}/tasks
V1	D	GET /planner/rosters/{plannerRosterId}
V1	D	GET /planner/rosters/{plannerRosterId}/members
V1	D	GET /planner/rosters/{plannerRosterId}/members/{plannerRosterMemberId}
V1	D	GET /planner/rosters/{plannerRosterId}/plans
V1	D	GET /planner/tasks
V1	D	GET /planner/tasks/{id}
V1	D	GET /planner/tasks/{id}/assignedToTaskBoardFormat
V1	D	GET /planner/tasks/{id}/bucketTaskBoardFormat
V1	D	GET /planner/tasks/{id}/details
V1	D	GET /planner/tasks/{id}/progressTaskBoardFormat
V1	A,D	GET /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/checklistItems
V1	A,D	GET /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources
V1	A,D	GET /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources/{linkedResourceId}
V1	D	GET /users/{id \| userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems
V1	D	GET /users/{id \| userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItemId}
V1	D	GET /users/{id}/planner
V1	D	GET /users/{id}/planner/all/delta
V1	D	GET /users/{id}/planner/favoritePlans
V1	D	GET /users/{id}/planner/plans
V1	D	GET /users/{id}/planner/recentPlans
V1	D	GET /users/{id}/planner/tasks
V1	D	GET /users/{id}/todo/lists/{id}/tasks/{id}/attachments
V1	D	GET /users/{id}/todo/lists/{id}/tasks/{id}/attachments/{id}
V1	D	GET /users/{id\|userPrincipalName}/todo/lists
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourcesId}
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/delta
V1	D	GET /users/{id\|userPrincipalName}/todo/lists/delta
V1	D	GET /users/{userId\|userPrincipalName}/tasks/alltasks/{baseTaskId}
V1	D	GET /users/{userId\|userPrincipalName}/tasks/lists
V1	D	GET /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks
V1	D	GET /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}
V1	D	GET /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/delta
V1	D	GET /users/{userId\|userPrincipalName}/tasks/lists/delta
V1	D	GET /users/{usersId}/planner/rosterPlans
V1	D	PATCH /me/outlook/taskFolders/{id}
V1	D	PATCH /me/outlook/taskGroups/{id}
V1	D	PATCH /me/outlook/taskGroups/{id}/taskFolders/{id}
V1	D	PATCH /me/outlook/tasks/{id}
V1	D	PATCH /me/planner
V1	D	PATCH /me/tasks/alltasks/{baseTaskId}
V1	D	PATCH /me/tasks/lists/{baseTaskListId}
V1	D	PATCH /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}
V1	A,D	PATCH /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources/{linkedResourceId}
V1	D	PATCH /me/todo/lists/{todoTaskListId}
V1	D	PATCH /me/todo/lists/{todoTaskListId}/tasks/{taskId}
V1	D	PATCH /me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourcesId}
V1	D	PATCH /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItemId}
V1	D	PATCH /planner/buckets/{id}
V1	D	PATCH /planner/plans/{id}/details
V1	D	PATCH /planner/plans/{plan-id}
V1	D	PATCH /planner/tasks/{id}
V1	D	PATCH /planner/tasks/{id}/assignedToTaskBoardFormat
V1	D	PATCH /planner/tasks/{id}/bucketTaskBoardFormat
V1	D	PATCH /planner/tasks/{id}/details
V1	D	PATCH /planner/tasks/{id}/progressTaskBoardFormat
V1	A,D	PATCH /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources/{linkedResourceId}
V1	D	PATCH /users/{id \| userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems/{checklistItemId}
V1	D	PATCH /users/{id\|userPrincipalName}/outlook/taskFolders/{id}
V1	D	PATCH /users/{id\|userPrincipalName}/outlook/taskGroups/{id}
V1	D	PATCH /users/{id\|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}
V1	D	PATCH /users/{id\|userPrincipalName}/outlook/tasks/{id}
V1	D	PATCH /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks
V1	D	PATCH /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}
V1	D	PATCH /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources/{linkedResourcesId}
V1	D	PATCH /users/{userId\|userPrincipalName}/tasks/alltasks/{baseTaskId}
V1	D	PATCH /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}
V1	D	PATCH /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}
V1	D	POST /me/outlook/taskFolders
V1	D	POST /me/outlook/taskFolders/{id}/tasks
V1	D	POST /me/outlook/taskGroups
V1	D	POST /me/outlook/taskGroups/{id}/taskFolders
V1	D	POST /me/outlook/taskGroups/{id}/taskFolders/{id}/tasks
V1	D	POST /me/outlook/tasks
V1	D	POST /me/outlook/tasks/{id}/attachments
V1	D	POST /me/outlook/tasks/{id}/complete
V1	D	POST /me/tasks/alltasks/{baseTaskId}/move
V1	D	POST /me/tasks/lists
V1	D	POST /me/tasks/lists/{baseTaskListId}/tasks
V1	A,D	POST /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/checklistItems
V1	A,D	POST /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources
V1	D	POST /me/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/move
V1	D	POST /me/todo/lists
V1	D	POST /me/todo/lists/{id}/tasks/{id}/attachments
V1	D	POST /me/todo/lists/{id}/tasks/{id}/attachments/createUploadSession
V1	D	POST /me/todo/lists/{todoTaskListId}/tasks
V1	D	POST /me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources
V1	D	POST /me/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems
V1	D	POST /planner/buckets
V1	D	POST /planner/plans
V1	D	POST /planner/rosters
V1	D	POST /planner/rosters/{plannerRosterId}/members
V1	D	POST /planner/tasks
V1	A,D	POST /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/checklistItems
V1	A,D	POST /users/{id \| userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/linkedResources
V1	D	POST /users/{id \| userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{todoTaskId}/checklistItems
V1	D	POST /users/{id}/todo/lists/{id}/tasks/{id}/attachments
V1	D	POST /users/{id}/todo/lists/{id}/tasks/{id}/attachments/createUploadSession
V1	D	POST /users/{id\|userPrincipalName}/outlook/taskFolders
V1	D	POST /users/{id\|userPrincipalName}/outlook/taskFolders/{id}/tasks
V1	D	POST /users/{id\|userPrincipalName}/outlook/taskGroups
V1	D	POST /users/{id\|userPrincipalName}/outlook/taskGroups/{id}/taskFolders
V1	D	POST /users/{id\|userPrincipalName}/outlook/taskGroups/{id}/taskFolders/{id}/tasks
V1	D	POST /users/{id\|userPrincipalName}/outlook/tasks
V1	D	POST /users/{id\|userPrincipalName}/outlook/tasks/{id}/attachments
V1	D	POST /users/{id\|userPrincipalName}/outlook/tasks/{id}/complete
V1	D	POST /users/{id\|userPrincipalName}/todo/lists
V1	D	POST /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks
V1	D	POST /users/{id\|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources
V1	D	POST /users/{userId\|userPrincipalName}/tasks/alltasks/{baseTaskId}/move
V1	D	POST /users/{userId\|userPrincipalName}/tasks/lists
V1	D	POST /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks
V1	D	POST /users/{userId\|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/{baseTaskId}/move

Delegate Permission


Id	2219042f-cab5-40cc-b0d2-16b1540b4c5f
Consent Type	User
Display String	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.

Application Permission


Id
Display String
Description

Resources

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.

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 does not have to be the actual file name. Required.
size	Int64	The length of the attachment in bytes. Required.

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`.

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.

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	Field indicating the title of checklistItem.
id	String	Server generated ID for the checkListItem
isChecked	Boolean	State indicating whether the item is checked off or not.

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.

entity

Property	Type	Description
id	String	The unique idenfier for an entity. Read-only.

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	Do not use this property as it is not supported.
contentType	String	The content type of the attachment.
id	String	The attachment ID.
isInline	Boolean	Set to `true` if this 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.This does not need to be the actual file name.
size	Int32	The size in bytes of the attachment.

group

Property	Type	Description
allowExternalSenders	Boolean	Indicates if people external to the organization can send messages to the group. Default value is `false`. Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`).
assignedLabels	assignedLabel collection	The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on `$select`.
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 will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is `false`. Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`).
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 cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Returned by default. Read-only.
deletedDateTime	DateTimeOffset	For some Azure Active Directory objects (user, group, application), if the object is deleted, it is 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`.
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 cannot 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. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Returned by default. 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 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 is not 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. Default value is `false`. Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`).
hideFromOutlookClients	Boolean	True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. 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 an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to `true`, the securityEnabled property must also be set to `true`, visibility must be `Hidden`, and the group cannot be a dynamic group (that is, groupTypes cannot contain `DynamicMembership`). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignments Using this feature requires a Azure AD Premium P1 license. Returned by default. Supports `$filter` (`eq`, `ne`, `not`).
isSubscribedByMail	Boolean	Indicates whether the signed-in user is subscribed to receive email conversations. Default value is `true`. Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`).
licenseProcessingState	String	Indicates status of the group license assignment to all members of the group. Default value is `false`. Read-only. Possible values: `QueuedForProcessing`, `ProcessingInProgress`, and `ProcessingComplete`. Returned only on `$select`. Read-only.
mail	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: `@ () \ [] " ; : <> , 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`).
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 Jan 1, 2014 is `2014-01-01T00:00:00Z`. Returned by default. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`).
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 who are synchronizing their on-premises directory to Azure Active Directory via Azure AD 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 that was synchronized from on-premises to the cloud. Returned by default. Supports `$filter` (`eq` including on `null` values). Read-only.
onPremisesSyncEnabled	Boolean	`true` if this group is synced from an on-premises directory; `false` if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values).
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 user must be assigned one of the following Azure AD roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator 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 cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). Read-only.
resourceBehaviorOptions	String collection	Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are `AllowOnlyMembersToPost`, `HideGroupInOutlook`, `SubscribeNewGroupMembers`, `WelcomeEmailDisabled`. For more information, see Set Microsoft 365 group behaviors and provisioning options.
resourceProvisioningOptions	String collection	Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is `Team`. For more information, see Set Microsoft 365 group behaviors and provisioning options.
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. Returned by default.
theme	string	Specifies a Microsoft 365 group's color theme. Possible values are `Teal`, `Purple`, `Green`, `Blue`, `Pink`, `Orange` or `Red`. Returned by default.
unseenCount	Int32	Count of conversations that have 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 is not specified during group creation on Microsoft Graph, a security group is created as `Private` by default and Microsoft 365 group is `Public`. Groups assignable to roles are always `Private`. See group visibility options to learn more. Returned by default. Nullable.

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.

itemBody

Property	Type	Description
content	String	The content of the item.
contentType	bodyType	The type of the content. Possible values are `text` and `html`.

linkedResource

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

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

outlookCategory

Property	Type	Description
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.
color	categoryColor	A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. See the note below.

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. Note that only 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.

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.

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.

patternedRecurrence

Property	Type	Description
pattern	recurrencePattern	The frequency of an event. For access reviews: Do not specify this property for a one-time access review. Only interval, dayOfMonth, and type (`weekly`, `absoluteMonthly`) properties of recurrencePattern are supported.
range	recurrenceRange	The duration of an event.

planner-identifiers-disclaimer

planner-order-hint-format

planner-overview

plannerAppliedCategories

plannerAssignedToTaskBoardTaskFormat

Property	Type	Description
id	String	ID of the resource. It is 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 is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined here.

plannerAssignments

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.

plannerBucketTaskBoardTaskFormat

Property	Type	Description
id	String	Read-only. ID of the resource. It is 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.

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

plannerChecklistItems

plannerExternalReferences

plannerFavoritePlanReferenceCollection

plannerOrderHintsByAssignee

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 is 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 is 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 is set, this property can’t be updated. This property will not return a valid group ID if the container of the plan is not a group.
title	String	Required. Title of the plan.

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.

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 is 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 are leveraging 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 is not required for them to access the plan owned by the group.

plannerProgressTaskBoardTaskFormat

Property	Type	Description
id	String	Read-only. ID of the resource. It is 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.

plannerRecentPlanReferenceCollection

plannerRoster

Property	Type	Description
id	String	Identifier of the **p

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.

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 is 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 non-empty description and `false` otherwise.
id	String	Read-only. ID of the task. It is 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.

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 is 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.

plannerUser

Property	Type	Description
id	String	Read-only. The unique identifier for the **p

plannerUserIds

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.

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.

tasks-identifiers-disclaimer

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

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.

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`.

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" (e.g. "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.

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`. Refer to the legal age group property definitions for further information. 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 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 time. 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 this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory. Returned by default. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`).
city	String	The city in which 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 company name which the user is associated. This property can be useful for describing the company that an external user 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 has been obtained for minors. Allowed values: `null`, `Granted`, `Denied` and `NotRequired`. Refer to the legal age group property definitions for further information. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, and `in`).
country	String	The country/region in which 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 in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is `null` for some users created before June 2018 and on-premises users that were synced to Azure AD 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: As a regular school or work account (`null`). As an external account (`Invitation`). As a local account for an Azure Active Directory B2C tenant (`LocalAccount`). Through self-service sign-up by an internal user using email verification (`EmailVerified`). Through self-service sign-up by an external user signing up through a link that is part of a user flow (`SelfServiceSignUp`). Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`).
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 for 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 is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters. 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 case of 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. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs one of the following Azure AD roles: Lifecycle Workflows Administrator, Global Reader, or Global Administrator. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). For more information, see Configure the employeeLeaveDateTime property for a user.
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 (e.g. 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 an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be `PendingAcceptance` or `Accepted`, or `null` for all other users. 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 time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Returned only on `$select`. Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
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. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on `$select`. Supports `$filter` (`eq`) including on `null` values, only where the signInType is not `userPrincipalName`.
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	Do not 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 Azure AD 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 time. 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`, `MinorWithOutParentalConsent`, `MinorWithParentalConsent`, `MinorNoParentalConsentRequired`, `NotAdult` and `Adult`. Refer to the legal age group property definitions for further information. Returned only on `$select`.
licenseAssignmentStates	licenseAssignmentState collection	State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only. Returned only on `$select`.
mail	String	The SMTP address for the user, for example, `[email protected]`. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters. NOTE: We do not 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 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).
mySite	String	The URL for the user's personal 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 Azure Active Directory via Azure AD 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 Azure Active Directory via Azure AD 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. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is `false`), these properties can be set during creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. 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 Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot 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 time. 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 Azure Active Directory via Azure AD 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 Azure Active Directory (Azure AD). 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 Azure Active Directory via Azure AD Connect. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`).
otherMails	String collection	A list of additional email addresses for the user; for example: `["[email protected]", "[email protected]"]`. NOTE: This property cannot 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 may be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`. Returned only on `$select`. For more information on the default password policies, see Azure AD pasword 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).
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. 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)
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 will also update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with `SMTP` (capitalized) is the primary proxy address while those prefixed with `smtp` are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten 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 sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Returned only on `$select`. Read-only.
responsibilities	String collection	A list for the user to enumerate their responsibilities. Returned only on `$select`.
schools	String collection	A list for the user to enumerate the schools they have 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.
signInSessionsValidFromDateTime	DateTimeOffset	Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize 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 1024 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 will be assigned licenses due to legal requirement 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 login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is [email protected], where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. NOTE: This property cannot 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, such as `Member` and `Guest`. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **N