Sites.Read.All
Allows the application to read documents and list items in all site collections on behalf of the signed-in 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
Sites.Read.Allpermission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReportcommand. See How To: Run a quick OAuth app audit of your tenant
| Category | Application | Delegated |
|---|---|---|
| Identifier | 332a536c-c7ef-4017-ab91-336970924f0d | 205e70e5-aba6-4c52-a976-6d2d46c48043 |
| DisplayText | Read items in all site collections | Read items in all site collections |
| Description | Allows the app to read documents and list items in all site collections without a signed in user. | Allows the application to read documents and list items in all site collections on behalf of the signed-in 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.
- alert
- baseSitePage
- callRecording
- callRecord
- callTranscript
- channel
- chat
- chatMessage
- contact
- contentModel
- contentModelUsage
- contentType
- conversation
- conversationMember
- deleted
- documentSetVersion
- drive
- driveItem
- driveItemVersion
- event
- extractSensitivityLabelsResult
- fileStorageContainer
- group
- horizontalSection
- horizontalSectionColumn
- resourceVisualization
- sharedInsight
- sharingDetail
- trending
- usedInsight
- itemActivity
- itemActivityStat
- itemAnalytics
- itemReference
- itemRetentionLabel
- List
- listItem
- ListItemVersion
- message
- newsLinkPage
- offerShiftRequest
- openShiftChangeRequest
- pageTemplate
- Permission
- presence
- printer
- printTaskDefinition
- recycleBin
- recycleBinItem
- remoteItem
- richLongRunningOperation
- search-api-overview
- searchRequest
- searchResponse
- sharingInvitation
- sharingLink
- shift
- site
- sitePage
- siteSettings
- standardWebPart
- subscription
- swapShiftsChangeRequest
- systemfacet
- team
- textWebPart
- Thumbnail
- ThumbnailSet
- timeOffRequest
- todoTask
- user
- verticalSection
- virtualEventTownhall
- virtualEventWebinar
- webPart
- webPartPosition
- workbookNamedItem
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: baseSitePage
| Property | Type | Description |
|---|---|---|
| contentType | contentTypeInfo | The content type of this item. Inherited from baseItem. |
| createdBy | identitySet | Identity of the creator of this item. Read-only. Inherited from baseItem. |
| createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. Inherited from baseItem. |
| description | String | The descriptive text for the item. Inherited from baseItem. |
| eTag | String | ETag for the item. Inherited from baseItem. |
| id | String | The unique identifier of the item. Inherited from entity. |
| lastModifiedBy | identitySet | The identity of the last modifier of this item. Read-only. Inherited from baseItem. |
| lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. Inherited from baseItem. |
| name | String | The name of the item. Inherited from baseItem. |
| pageLayout | pageLayoutType | The name of the page layout of the page. The possible values are: microsoftReserved, article, home, unknownFutureValue. |
| parentReference | itemReference | Parent information, if the item has a parent. Inherited from baseItem. |
| publishingState | publicationFacet | The publishing status and the MM.mm version of the page. |
| title | String | Title of the sitePage. |
| webUrl | String | URL that displays the resource in the browser. Read-only. Inherited from baseItem. |
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. 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. |
| isHiddenForAllMembers | Boolean | Indicates whether the chat is hidden for all its members. 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, channel, chat, and tag. |
| 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. 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: 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: contentModel
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | Identity of the user, device, or applicationthat created the item. Read-only. |
| createdDateTime | DateTimeOffset | Date and time of item creation. Read-only. |
| id | String | The ID of the content model. Read-only. |
| lastModifiedBy | identitySet | Identity of the user, device, or application that modified the item. Read-only. |
| lastModifiedDateTime | DateTimeOffset | Date and time of item last modification. Read-only. |
| modelType | contentModelType | The type of the contentModel. The possible values are: teachingMethod, layoutMethod, freeformSelectionMethod, prebuiltContractModel, prebuiltInvoiceModel, prebuiltReceiptModel, unknownFutureValue. |
| name | String | The name of the **c |
Graph reference: contentModelUsage
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | Identity of the user, device, or application that first applied the contentModel to the library. |
| createdDateTime | DateTimeOffset | Date and time of the contentModel is first applied. |
| driveId | String | The ID of the drive where the contentModel is applied. |
| lastModifiedBy | identitySet | Identity of the user, device, or application that last applied the contentModel to the library. |
| lastModifiedDateTime | DateTimeOffset | Date and time of the contentModel is last applied. |
| modelId | String | The ID of the contentModel. |
| modelVersion | String | The version of the current applied contentModel. |
Graph reference: contentType
| Property | Type | Description |
|---|---|---|
| associatedHubsUrls | String collection | List of canonical URLs for hub sites with which this content type is associated to. This will contain all hub sites where this content type is queued to be enforced or is already enforced. Enforcing a content type means that the content type is applied to the lists in the enforced sites. |
| description | string | The descriptive text for the item. |
| documentSet | documentSet][] | [Document Set metadata. |
| documentTemplate | [documentSetContent][] | Document template metadata. To make sure that documents have consistent content across a site and its subsites, you can associate a Word, Excel, or PowerPoint template with a site content type. |
| group | string | The name of the group this content type belongs to. Helps organize related content types. |
| hidden | Boolean | Indicates whether the content type is hidden in the list's 'New' menu. |
| id | string | The unique identifier of the content type. |
| inheritedFrom | [itemReference][] | If this content type is inherited from another scope (like a site), provides a reference to the item where the content type is defined. |
| isBuiltIn | Boolean | Specifies if a content type is a built-in content type. |
| name | string | The name of the content type. |
| order | [contentTypeOrder][] | Specifies the order in which the content type appears in the selection UI. |
| parentId | string | The unique identifier of the content type. |
| propagateChanges | Boolean | If true, any changes made to the content type are pushed to inherited content types and lists that implement the content type. |
| readOnly | Boolean | If true, the content type can't be modified unless this value is first set to false. |
| sealed | Boolean | If true, the content type can't be modified by users or through push-down operations. Only site collection administrators can seal or unseal content types. |
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 more 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 shouldn't 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: deleted
| Property | Type | Description |
|---|---|---|
| state | String | Represents the state of the deleted item. |
Graph reference: documentSetVersion
| Property | Type | Description |
|---|---|---|
| comment | string | Comment about the captured version. |
| createdBy | identitySet | User who captured the version. |
| createdDateTime | dateTime | Date and time when this version was created. |
| id | string | The ID of the version. Read-only. Inherited from listItemVersion. |
| items | documentSetVersionItem collection | Items within the document set that are captured as part of this version. |
| lastModifiedBy | identitySet | Identity of the user which last modified the version. Read-only. Inherited from listItemVersion. |
| lastModifiedDateTime | dateTimeOffset | Date and time when the version was last modified. Read-only. Inherited from listItemVersion. |
| published | publicationFacet | Indicates the publication status of this particular version. Read-only. Inherited from listItemVersion. |
| shouldCaptureMinorVersion | Boolean | If true, minor versions of items are also captured; otherwise, only major versions are captured. The default value is false. |
Graph reference: drive
| Property | Type | Description |
|---|---|---|
| createdBy | [identitySet][] | Identity of the user, device, or application which created the item. Read-only. |
| createdDateTime | dateTimeOffset | Date and time of item creation. Read-only. |
| description | String | Provide a user-visible description of the drive. Read-write. |
| driveType | String | Describes the type of drive represented by this resource. OneDrive personal drives return personal. OneDrive for Business returns business. SharePoint document libraries return documentLibrary. Read-only. |
| id | String | The unique identifier of the drive. Read-only. |
| lastModifiedBy | [identitySet][] | Identity of the user, device, and application which last modified the item. Read-only. |
| lastModifiedDateTime | dateTimeOffset | Date and time the item was last modified. Read-only. |
| name | string | The name of the item. Read-write. |
| owner | identitySet | Optional. The user account that owns the drive. Read-only. |
| quota | quota | Optional. Information about the drive's storage space quota. Read-only. |
| sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. This property isn't returned by default and must be selected using the $select query parameter. |
| system | [systemFacet][] | If present, indicates that it's a system-managed drive. Read-only. |
| webUrl | string (url) | URL that displays the resource in the browser. Read-only. |
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: driveItemVersion
| Property | Type | Description |
|---|---|---|
| content | Stream | The content stream for this version of the item. |
| id | String | The ID of the version. Read-only. |
| lastModifiedBy | identitySet | Identity of the user who last modified the version. Read-only. |
| lastModifiedDateTime | DateTimeOffset | Date and time when the version was last modified. Read-only. |
| publication | publicationFacet | Indicates the publication status of this particular version. Read-only. |
| size | Int64 | Indicates the size of the content stream for this version of the item. |
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. The 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's in text format. |
| cancelledOccurrences | String collection | Contains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences. Returned only on $select in a Get operation which specifies the ID (seriesMasterId property value) of a series master event. |
| 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. It 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. The 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 endtime must be set to midnight and be in the same time zone. |
| isCancelled | Boolean | Set to true if the event has been canceled. |
| isDraft | Boolean | Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes are 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). It 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 are removed and replaced by the new location value. |
| onlineMeeting | OnlineMeetingInfo | Details for an attendee to join the meeting online. The 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 can't 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 can't 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's 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, and 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. It's useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional. |
| type | String | 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 can't be accessed from within an iFrame. |
Graph reference: extractSensitivityLabelsResult
| Property | Type | Description |
|---|---|---|
| labels | sensitivityLabelAssignment collection | List of sensitivity labels assigned to a file. |
Graph reference: fileStorageContainer
| Property | Type | Description |
|---|---|---|
| containerTypeId | Guid | Container type ID of the fileStorageContainer. For details about container types, see Container Types. Each container must have only one container type. Read-only. |
| createdDateTime | DateTimeOffset | Date and time of the fileStorageContainer creation. Read-only. |
| customProperties | fileStorageContainerCustomPropertyDictionary | Custom property collection for the fileStorageContainer. Read-write. |
| description | String | Provides a user-visible description of the fileStorageContainer. Read-write. |
| displayName | String | The display name of the fileStorageContainer. Read-write. |
| id | String | The unique stable identifier of the filerStorageContainer. Read-only. |
| lockState | siteLockState | Indicates the lock state of the fileStorageContainer. The possible values are unlocked and lockedReadOnly. Read-only. |
| settings | fileStorageContainerSettings | Settings associated with a fileStorageContainer. Read-write. |
| status | fileStorageContainerStatus | Status of the fileStorageContainer. Containers are created as inactive and require activation. Inactive containers are subjected to automatic deletion in 24 hours. The possible values are: inactive , active . Read-only. |
| viewpoint | fileStorageContainerViewpoint | Data specific to the current user. Read-only. |
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). |
| isManagementRestricted | Boolean | Indicates whether the group is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select. |
| 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: horizontalSection
| Property | Type | Description |
|---|---|---|
| emphasis | sectionEmphasisType | Enumeration value that indicates the emphasis of the section background. The possible values are: none, netural, soft, strong, unknownFutureValue. |
| id | String | Unique identifier of the resource. Inherited from entity. |
| layout | horizontalSectionLayoutType | Layout type of the section. The possible values are: none, oneColumn, twoColumns, threeColumns, oneThirdLeftColumn, oneThirdRightColumn, fullWidth, unknownFutureValue. |
Graph reference: horizontalSectionColumn
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier of the resource. Inherited from entity. |
| width | Int32 | Width of the column. A horizontal section is divided into 12 grids. A column should have a value of 1-12 to represent its range spans. For example, there can be two columns both have a width of 6 in a section. |
Graph reference: resourceVisualization
| Property | Type | Description |
|---|---|---|
| title | String | The item's title text. |
| containerDisplayName | String | A string describing where the item is stored. For example, the name of a SharePoint site or the user name identifying the owner of the OneDrive storing the item. |
| containerType | String | Can be used for filtering by the type of container in which the file is stored. Such as Site or OneDriveBusiness. |
| containerWebUrl | String | A path leading to the folder in which the item is stored. |
| mediaType | String | The item's media type. Can be used for filtering for a specific type of file based on supported IANA Media Mime Types. Not all Media Mime Types are supported. |
| previewImageUrl | String | A URL leading to the preview image for the item. |
| previewText | String | A preview text for the item. |
| type | String | The item's media type. Can be used for filtering for a specific file based on a specific type. See the section Type property values for supported types. |
Graph reference: sharedInsight
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier of the relationship. Read only. |
| lastShared | sharingDetail | Details about the shared item. Read only. |
| resourceReference | resourceReference | Reference properties of the shared document, such as the url and type of the document. Read-only |
| resourceVisualization | resourceVisualization | Properties that you can use to visualize the document in your experience. Read-only |
Graph reference: sharingDetail
| Property | Type | Description |
|---|---|---|
| sharedBy | insightIdentity | The user who shared the document. |
| sharedDateTime | DateTimeOffset | The date and time the file was last shared. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| sharingSubject | String | The subject with which the document was shared. |
| sharingType | String | Determines the way the document was shared. Can be by a 1Link1, 1Attachment1, 1Group1, 1Site1. |
| sharingReference | resourceReference | Reference properties of the document, such as the URL and type of the document. Read-only |
Graph reference: trending
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier of the relationship. Read only. |
| 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 |
| resourceReference | resourceReference | Reference properties of the trending document, such as the url and type of the document. |
| resourceVisualization | resourceVisualization | Properties that you can use to visualize the document in your experience. |
| weight | Double | Value indicating how much the document is currently trending. The larger the number, the more the document is currently trending around the user (the more relevant it is). Returned documents are sorted by this value. |
Graph reference: usedInsight
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier of the relationship. Read only. |
| lastUsed | usageDetails | Information about when the item was last viewed or modified by the user. Read only. |
| resourceReference | resourceReference | Reference properties of the used document, such as the url and type of the document. Read-only |
| resourceVisualization | resourceVisualization | Properties that you can use to visualize the document in your experience. Read-only |
Graph reference: itemActivity
| Property | Type | Description |
|---|---|---|
| access | [accessAction][] | An item was accessed. |
| activityDateTime | DateTimeOffset | Details about when the activity took place. Read-only. |
| actor | [identitySet][] | Identity of who performed the action. Read-only. |
| id | string | The unique identifier of the activity. Read-only. |
Graph reference: itemActivityStat
| Property | Type | Description |
|---|---|---|
| access | [itemActionStat][] | Statistics about the access actions in this interval. Read-only. |
| create | [itemActionStat][] | Statistics about the create actions in this interval. Read-only. |
| delete | [itemActionStat][] | Statistics about the delete actions in this interval. Read-only. |
| edit | [itemActionStat][] | Statistics about the edit actions in this interval. Read-only. |
| endDateTime | DateTimeOffset | When the interval ends. Read-only. |
| incompleteData | [incompleteData][] | Indicates that the statistics in this interval are based on incomplete data. Read-only. |
| isTrending | Boolean | Indicates whether the item is "trending." Read-only. |
| move | [itemActionStat][] | Statistics about the move actions in this interval. Read-only. |
| startDateTime | DateTimeOffset | When the interval starts. Read-only. |
Graph reference: itemAnalytics
| Property | Type | Description |
|---|---|---|
| allTime | [itemActivityStat][] | Analytics over the item's lifespan. |
| lastSevenDays | [itemActivityStat][] | Analytics for the last seven days. |
Graph reference: itemReference
| Property | Type | Description |
|---|---|---|
| driveId | String | Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a [drive][]. Read-only. |
| driveType | String | Identifies the type of drive. Only returned if the item is located in a [drive][]. See [drive][] resource for values. |
| id | String | Unique identifier of the driveItem in the drive or a listItem in a list. Read-only. |
| name | String | The name of the item being referenced. Read-only. |
| path | String | Percent-encoded path that can be used to navigate to the item. Read-only. |
| shareId | String | A unique identifier for a shared resource that can be accessed via the [Shares][] API. |
| sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
| siteId | String | For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that site][] resource. It is an [opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated. |
Graph reference: itemRetentionLabel
| Property | Type | Description |
|---|---|---|
| isLabelAppliedExplicitly | Boolean | Specifies whether the label is applied explicitly on the item. True indicates that the label is applied explicitly; otherwise, the label is inherited from its parent. Read-only. |
| labelAppliedBy | identitySet | Identity of the user who applied the label. Read-only. |
| labelAppliedDateTime | DateTimeOffset | The date and time when the label was applied on the item. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| name | String | The retention label on the document. Read-write. |
| retentionSettings | retentionLabelSettings | The retention settings enforced on the item. Read-write. |
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: listItem
| Property | Type | Description |
|---|---|---|
| contentType | [contentTypeInfo][] | The content type of this list item |
Graph reference: ListItemVersion
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 | 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 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: newsLinkPage
| Property | Type | Description |
|---|---|---|
| bannerImageWebUrl | String | A link to the banner image for the newsLinkPage. |
| createdBy | identitySet | Identity of the creator of this newsLinkPage. Read-only. Inherited from baseSitePage. |
| createdDateTime | DateTimeOffset | The date and time when the newsLinkPage 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. Inherited from baseSitePage. |
| description | String | The descriptive text for the newsLinkPage. The maximum length limit is 250 characters. Inherited from baseSitePage. |
| eTag | String | ETag for the newsLinkPage. Inherited from baseSitePage. |
| id | String | The unique identifier of the newsLinkPage. Inherited from baseSitePage. |
| lastModifiedBy | identitySet | Identity of the last modifier of this newsLinkPage. Read-only. Inherited from baseSitePage. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the newsLinkPage was last modified. 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. Inherited from baseSitePage. |
| name | String | The name of the newsLinkPage. Inherited from baseSitePage. |
| newsSharepointIds | sharepointIds | The SharePoint IDs of the referenced news article if it's recognized as a SharePoint resource. Read-only. |
| newsWebUrl | String | The URL of the news article referenced by the newsLinkPage. It can be an external link. |
| pageLayout | pageLayoutType | The name of the page layout of the page. The possible values are: microsoftReserved, article, home, unknownFutureValue, newsLink. Use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: newsLink. Inherited from baseSitePage. |
| parentReference | itemReference | Parent information if the newsLinkPage has a parent. Inherited from baseSitePage. |
| publishingState | publicationFacet | The publishing status and the version of the page. Inherited from baseSitePage. |
| title | String | Title of the newsLinkPage. The maximum length limit is 110 characters. Inherited from baseSitePage. |
| webUrl | String | URL that displays the resource in the browser. Read-only. Inherited from baseSitePage. |
Graph reference: offerShiftRequest
| Property | Type | Description |
|---|---|---|
| assignedTo | scheduleChangeRequestActor | Indicates who the request is assigned to. Inherited from scheduleChangeRequest.The possible values are: sender, recipient, manager, system, unknownFutureValue. |
| createdBy | identitySet | The user who created the entity. Inherited from changeTrackedEntity. |
| createdDateTime | DateTimeOffset | The date and time when the entity was created. Inherited from changeTrackedEntity. |
| id | String | The unique identifier for the entity. Inherited from entity. Inherits from entity |
| lastModifiedBy | identitySet | The user who last modified the entity. Inherited from changeTrackedEntity. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the entity was last modified. Inherited from changeTrackedEntity. |
| managerActionDateTime | DateTimeOffset | The date and time when the manager approved or declined the request. Inherited from scheduleChangeRequest. |
| managerActionMessage | String | The message sent by the manager regarding the request. Inherited from scheduleChangeRequest. |
| managerUserId | String | The user ID of the manager who approved or declined the request. Inherited from scheduleChangeRequest. |
| recipientActionDateTime | DateTimeOffset | The date and time when the recipient approved or declined the request. |
| recipientActionMessage | String | The message sent by the recipient regarding the request. |
| recipientUserId | String | The recipient's user ID. |
| senderDateTime | DateTimeOffset | The date and time when the sender sent the request. Inherited from scheduleChangeRequest. |
| senderMessage | String | The message sent by the sender of the request. Inherited from scheduleChangeRequest. |
| senderShiftId | String | The sender's shift ID. |
| senderUserId | String | The user ID of the sender of the request. Inherited from scheduleChangeRequest. |
| state | scheduleChangeState | The state of the entity. Inherited from scheduleChangeRequest.The possible values are: pending, approved, declined, unknownFutureValue. |
Graph reference: openShiftChangeRequest
| Property | Type | Description |
|---|---|---|
| assignedTo | scheduleChangeRequestActor | Indicates who the request is assigned to. Inherited from scheduleChangeRequest.The possible values are: sender, recipient, manager, system, unknownFutureValue. |
| createdBy | identitySet | The user who created the entity. Inherited from changeTrackedEntity. |
| createdDateTime | DateTimeOffset | The date and time when the entity was created. Inherited from changeTrackedEntity. |
| id | String | The unique identifier for the entity. Inherited from entity. Inherits from entity |
| lastModifiedBy | identitySet | The user who last modified the entity. Inherited from changeTrackedEntity. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the entity was last modified. Inherited from changeTrackedEntity. |
| managerActionDateTime | DateTimeOffset | The date and time when the manager approved or declined the request. Inherited from scheduleChangeRequest. |
| managerActionMessage | String | The message sent by the manager regarding the request. Inherited from scheduleChangeRequest. |
| managerUserId | String | The user ID of the manager who approved or declined the request. Inherited from scheduleChangeRequest. |
| openShiftId | String | ID for the open shift. |
| senderDateTime | DateTimeOffset | The date and time when the sender sent the request. Inherited from scheduleChangeRequest. |
| senderMessage | String | The message sent by the sender of the request. Inherited from scheduleChangeRequest. |
| senderUserId | String | The user ID of the sender of the request. Inherited from scheduleChangeRequest. |
| state | scheduleChangeState | The state of the **s |
Graph reference: pageTemplate
| Property | Type | Description |
|---|---|---|
| contentType | contentTypeInfo | The content type of the page template. Inherited from baseSitePage. |
| createdBy | identitySet | The identity of the creator of the page template. Read-only. Inherited from baseSitePage. |
| createdDateTime | DateTimeOffset | The date and time the page template was created. Read-only. Inherited from baseSitePage. |
| description | String | The descriptive text for the page template. Inherited from baseSitePage. |
| eTag | String | The eTag for the page template. Inherited from baseSitePage. |
| id | String | The unique identifier of the page template. Inherited from baseSitePage. |
| lastModifiedBy | identitySet | The identity of the last modifier of the page template. Read-only. Inherited from baseSitePage. |
| lastModifiedDateTime | DateTimeOffset | The date and time the page template was last modified. Read-only. Inherited from baseSitePage. |
| name | String | The name of the page template. Inherited from baseSitePage. |
| pageLayout | pageLayoutType | The type of the page layout for the page. The possible values are: microsoftReserved, article, home, unknownFutureValue, newsLink. Use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: newsLink. Inherited from baseSitePage. |
| parentReference | itemReference | The parent information, if the page template has a parent. Inherited from baseSitePage. |
| publishingState | publicationFacet | The publishing status and the MM.mm version of the page template. Inherited from baseSitePage. |
| thumbnailWebUrl | String | The URL of the page template's thumbnail image |
| title | String | The title of the page template. Inherited from baseSitePage. |
| titleArea | titleArea | The title area on the SharePoint page template. |
| webUrl | String | The URL that displays the page template in the browser. Read-only. Inherited from baseSitePage. |
Graph reference: Permission
| Property | Type | Description |
|---|---|---|
| expirationDateTime | DateTimeOffset | A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there's no expiration set for this permission. Optional. |
| id | String | The unique identifier of the permission among all permissions on the item. Read-only. |
| hasPassword | Boolean | Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only.. |
| grantedTo (deprecated) | IdentitySet | For user type permissions, the details of the users and applications for this permission. Read-only. |
| grantedToIdentities (deprecated) | Collection(IdentitySet) | For type permissions, the details of the users to whom permission was granted. Read-only. |
| grantedToIdentitiesV2 | Collection([SharePointIdentitySet][]) | For link type permissions, the details of the users to whom permission was granted. Read-only. |
| grantedToV2 | [SharePointIdentitySet][] | For user type permissions, the details of the users and applications for this permission. Read-only. |
| inheritedFrom | ItemReference | Provides a reference to the ancestor of the current permission, if it's inherited from an ancestor. Read-only. |
| invitation | [SharingInvitation][] | Details of any associated sharing invitation for this permission. Read-only. |
| link | [SharingLink][] | Provides the link details of the current permission, if it's a link type permission. Read-only. |
| roles | Collection of String | The type of permission, for example, read. See below for the full list of roles. Read-only. |
| shareId | String | A unique token that can be used to access this shared item via the shares API. Read-only. |
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: recycleBin
| Property | Type | Description |
|---|---|---|
| id | String | The unique identifier for the **r |
Graph reference: recycleBinItem
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Date and time when the item was deleted. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| deletedFromLocation | String | Relative URL of the list or folder that originally contained the item. |
| id | String | Unique identifier of the delete transaction. Inherited from baseItem. |
| name | String | Name of the item. Inherited from baseItem. |
| size | Int64 | Size of the item in bytes. |
Graph reference: remoteItem
Graph reference: richLongRunningOperation
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time when this operation was created. |
| error | publicError | Error that caused the operation to fail. |
| id | String | Unique identifier for the operation. Inherited from entity. |
| lastActionDateTime | DateTimeOffset | The date and time when the last action was performed on this operation. |
| percentageComplete | Int32 | A value between 0 and 100 that indicates the progress of the operation. |
| resourceId | String | The unique identifier for the result. |
| resourceLocation | String | The canonical URL of the resource. |
| status | longRunningOperationStatus | The status of the long-running operation. Possible values are: notStarted, running, succeeded, failed, unknownFutureValue. |
| statusDetail | String | The detail about the status value. |
| type | String | The type of the operation. |
Graph reference: search-api-overview
Graph reference: searchRequest
| Property | Type | Description |
|---|---|---|
| aggregationFilters | String collection | Contains one or more filters to obtain search results aggregated and filtered to a specific value of a field. Optional. Build this filter based on a prior search that aggregates by the same field. From the response of the prior search, identify the searchBucket that filters results to the specific value of the field, use the string in its aggregationFilterToken property, and build an aggregation filter string in the format "{field}:\"{aggregationFilterToken}\"". If multiple values for the same field need to be provided, use the strings in its aggregationFilterToken property and build an aggregation filter string in the format "{field}:or(\"{aggregationFilterToken1}\",\"{aggregationFilterToken2}\")". For example, searching and aggregating drive items by file type returns a searchBucket for the file type docx in the response. You can conveniently use the aggregationFilterToken returned for this searchBucket in a subsequent search query and filter matches down to drive items of the docx file type. Example 1 and example 2 show the actual requests and responses. |
| aggregations | aggregationOption collection | Specifies aggregations (also known as refiners) to be returned alongside search results. Optional. |
| collapseProperties | collapseProperty collection | Contains the ordered collection of fields and limit to collapse results. Optional. |
| contentSources | String collection | Contains the connection to be targeted. |
| enableTopResults | Boolean | This triggers hybrid sort for messages : the first 3 messages are the most relevant. This property is only applicable to entityType=message. Optional. |
| entityTypes | entityType collection | One or more types of resources expected in the response. Possible values are: event, message, driveItem, externalItem, site, list, listItem, drive, chatMessage, person, acronym, bookmark. Use the Prefer: include-unknown-enum-members request header to get the following value(s) in this evolvable enum: chatMessage, person, acronym, bookmark. See known limitations for those combinations of two or more entity types that are supported in the same search request. Required. |
| fields | String collection | Contains the fields to be returned for each resource object specified in entityTypes, allowing customization of the fields returned by default; otherwise, including additional fields such as custom managed properties from SharePoint and OneDrive, or custom fields in externalItem from the content that Microsoft 365 Copilot connectors bring in. The fields property can use the semantic labels applied to properties. For example, if a property is labeled as title, you can retrieve it using the following syntax: label_title. Optional. |
| from | Int32 | Specifies the offset for the search results. Offset 0 returns the very first result. Optional. |
| query | searchQuery | Contains the query terms. Required. |
| queryAlterationOptions | searchAlterationOptions | Query alteration options formatted in a JSON blob that contains two optional flags related to spelling correction. Optional. |
| region | String | The geographic location for the search. Required for searches that use application permissions. For details, see Get the region value. |
| resultTemplateOptions | resultTemplateOption collection | Provides the search result template options to render search results from connectors. |
| sharePointOneDriveOptions | sharePointOneDriveOptions | Indicates the kind of contents to be searched when a search is performed using application permissions. Optional. |
| size | Int32 | The size of the page to be retrieved. The maximum value is 500. Optional. |
| sortProperties | sortProperty collection | Contains the ordered collection of fields and direction to sort results. There can be at most 5 sort properties in the collection. Optional. |
Graph reference: searchResponse
| Property | Type | Description |
|---|---|---|
| hitsContainers | searchHitsContainer collection | A collection of search results. |
| queryAlterationResponse | alterationResponse | Provides information related to spelling corrections in the alteration response. |
| resultTemplates | resultTemplate collection | A dictionary of resultTemplateIds and associated values, which include the name and JSON schema of the result templates. |
| searchTerms | String collection | Contains the search terms sent in the initial search query. |
Graph reference: sharingInvitation
Graph reference: sharingLink
| Property | Type | Description |
|---|---|---|
| application | [identity][] | The app the link is associated with. |
| preventsDownload | Boolean | If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint. |
| scope | String | The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant. |
| type | String | The type of the link created. |
| webHtml | String | For embed links, this property contains the HTML code for an <iframe> element that will embed the item in a webpage. |
| webUrl | String | A URL that opens the item in the browser on the OneDrive website. |
Graph reference: shift
Graph reference: site
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. |
| description | string | The descriptive text for the site. |
| displayName | string | The full title for the site. Read-only. |
| eTag | string | ETag for the item. Read-only. |
| id | string | The unique identifier of the item. Read-only. |
| isPersonalSite | bool | Identifies whether the site is personal or not. Read-only. |
| lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. |
| name | string | The name/title of the item. |
| root | root | If present, provides the root site in the site collection. Read-only. |
| sharepointIds | sharepointIds | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
| siteCollection | siteCollection | Provides details about the site's site collection. Available only on the root site. Read-only. |
| webUrl | string (url) | URL that displays the item in the browser. Read-only. |
Graph reference: sitePage
| Property | Type | Description |
|---|---|---|
| contentType | contentTypeInfo | The content type of this item. Inherited from baseSitePage. |
| createdBy | identitySet | Identity of the creator of this item. Read-only. Inherited from baseSitePage. |
| createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. Inherited from baseSitePage. |
| description | String | The descriptive text for the item. Inherited from baseSitePage. |
| eTag | String | ETag for the item. Inherited from baseSitePage. |
| id | String | The unique identifier of the item. Inherited from baseSitePage. |
| lastModifiedBy | identitySet | TIdentity of the last modifier of this item. Read-only. Inherited from baseSitePage. |
| lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. Inherited from baseSitePage. |
| name | String | The name of the item. Inherited from baseSitePage. |
| pageLayout | pageLayoutType | The name of the page layout of the page. The possible values are: microsoftReserved, article, home, unknownFutureValue. Inherited from baseSitePage. |
| parentReference | itemReference | Parent information, if the item has a parent. Inherited from baseSitePage. |
| promotionKind | pagePromotionType | Indicates the promotion kind of the sitePage. The possible values are: microsoftReserved, page, newsPost, unknownFutureValue. |
| publishingState | publicationFacet | The publishing status and the MM.mm version of the page. Inherited from baseSitePage. |
| reactions | reactionsFacet | Reactions information for the page. |
| showComments | Boolean | Determines whether or not to show comments at the bottom of the page. |
| showRecommendedPages | Boolean | Determines whether or not to show recommended pages at the bottom of the page. |
| thumbnailWebUrl | String | Url of the sitePage's thumbnail image |
| title | String | Title of the sitePage. Inherited from baseSitePage. |
| titleArea | titleArea | Title area on the SharePoint page. |
| webUrl | String | URL that displays the resource in the browser. Read-only. Inherited from baseSitePage. |
Graph reference: siteSettings
| Property | Type | Description |
|---|---|---|
| languageTag | String | The language tag for the language used on this site. |
| timeZone | String | Indicates the time offset for the time zone of the site from Coordinated Universal Time (UTC). |
Graph reference: standardWebPart
| Property | Type | Description |
|---|---|---|
| containerTextWebPartId | string | The instance identifier of the container text webPart. It only works for inline standard webPart in rich text webParts. |
| data | webPartData | Data of the webPart. |
| id | String | Instance identifier of the webPart. Inherited from entity. |
| webPartType | String | A Guid that indicates the webPart type. |
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. Any value under 45 minutes after the time of the request is automatically set to 45 minutes after the request time. 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 |
|---|---|---|
| assignedTo | scheduleChangeRequestActor | Indicates who the request is assigned to. Inherited from scheduleChangeRequest.The possible values are: sender, recipient, manager, system, unknownFutureValue. |
| createdBy | identitySet | The user who created the entity. Inherited from changeTrackedEntity. |
| createdDateTime | DateTimeOffset | The date and time when the entity was created. Inherited from changeTrackedEntity. |
| id | String | The unique identifier for the entity. Inherited from entity. Inherits from entity |
| lastModifiedBy | identitySet | The user who last modified the entity. Inherited from changeTrackedEntity. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the entity was last modified. Inherited from changeTrackedEntity. |
| managerActionDateTime | DateTimeOffset | The date and time when the manager approved or declined the request. Inherited from scheduleChangeRequest. |
| managerActionMessage | String | The message sent by the manager regarding the request. Inherited from scheduleChangeRequest. |
| managerUserId | String | The user ID of the manager who approved or declined the request. Inherited from scheduleChangeRequest. |
| recipientActionDateTime | DateTimeOffset | The date and time when the recipient approved or declined the request. Inherited from offerShiftRequest. |
| recipientActionMessage | String | The message sent by the recipient regarding the request. Inherited from offerShiftRequest. |
| recipientShiftId | String | The recipient's Shift ID |
| recipientUserId | String | The recipient's user ID. Inherited from offerShiftRequest. |
| senderDateTime | DateTimeOffset | The date and time when the sender sent the request. Inherited from scheduleChangeRequest. |
| senderMessage | String | The message sent by the sender of the request. Inherited from scheduleChangeRequest. |
| senderShiftId | String | The sender's shift ID. Inherited from offerShiftRequest. |
| senderUserId | String | The user ID of the sender of the request. Inherited from scheduleChangeRequest. |
| state | scheduleChangeState | The state of the entity. Inherited from scheduleChangeRequest.The possible values are: pending, approved, declined, unknownFutureValue. |
Graph reference: systemfacet
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 preconfigured 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: 1,024 characters. |
| displayName | string | The name of the team. |
| firstChannelName | String | The name of the first channel in the team. This is an optional property, only used during team creation and isn't returned in methods to get and list teams. |
| 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 was 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 goes to the team in the Microsoft Teams client. You get this URL when you right-click a team in the Microsoft Teams client and select **G |
Graph reference: textWebPart
| Property | Type | Description |
|---|---|---|
| id | String | Instance identifier of the web part. Inherited from entity. |
| innerHtml | String | The HTML string in text web part. |
Graph reference: Thumbnail
| Property | Type | Description |
|---|---|---|
| content | Stream | The content stream for the thumbnail. |
| height | Int32 | The height of the thumbnail, in pixels. |
| sourceItemId | String | The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested. |
| url | String | The URL used to fetch the thumbnail content. |
| width | Int32 | The width of the thumbnail, in pixels. |
Graph reference: ThumbnailSet
| Property | Type | Description |
|---|---|---|
| id | String | The ID within the item. Read-only. |
| large | Thumbnail | A 1920x1920 scaled thumbnail. |
| medium | Thumbnail | A 176x176 scaled thumbnail. |
| small | Thumbnail | A 48x48 cropped thumbnail. |
| source | Thumbnail | A custom thumbnail image or the original image used to generate other thumbnails. |
Graph reference: timeOffRequest
| Property | Type | Description |
|---|---|---|
| assignedTo | scheduleChangeRequestActor | Indicates who the request is assigned to. Inherited from scheduleChangeRequest.The possible values are: sender, recipient, manager, system, unknownFutureValue. |
| createdBy | identitySet | The user who created the entity. Inherited from changeTrackedEntity. |
| createdDateTime | DateTimeOffset | The date and time when the entity was created. Inherited from changeTrackedEntity. |
| endDateTime | DateTimeOffset | The date and time the time off ends in ISO 8601 format and in UTC time. |
| id | String | The unique identifier for the entity. Inherited from entity. Inherits from entity |
| lastModifiedBy | identitySet | The user who last modified the entity. Inherited from changeTrackedEntity. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the entity was last modified. Inherited from changeTrackedEntity. |
| managerActionDateTime | DateTimeOffset | The date and time when the manager approved or declined the request. Inherited from scheduleChangeRequest. |
| managerActionMessage | String | The message sent by the manager regarding the request. Inherited from scheduleChangeRequest. |
| managerUserId | String | The user ID of the manager who approved or declined the request. Inherited from scheduleChangeRequest. |
| senderDateTime | DateTimeOffset | The date and time when the sender sent the request. Inherited from scheduleChangeRequest. |
| senderMessage | String | The message sent by the sender of the request. Inherited from scheduleChangeRequest. |
| senderUserId | String | The user ID of the sender of the request. Inherited from scheduleChangeRequest. |
| startDateTime | DateTimeOffset | The date and time the time off starts in ISO 8601 format and in UTC time. |
| state | scheduleChangeState | The state of the entity. Inherited from scheduleChangeRequest.The possible values are: pending, approved, declined, unknownFutureValue. |
| 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: 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 or 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. |
| isManagementRestricted | Boolean | true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. 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]"]. Can store up to 250 values, each with a limit of 250 characters. 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 or 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/regions. 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: verticalSection
| Property | Type | Description |
|---|---|---|
| emphasis | sectionEmphasisType | Enumeration value that indicates the emphasis of the section background. The possible values are: none, netural, soft, strong, unknownFutureValue. |
| id | String | Unique identifier of the resource. Inherited from entity. |
Graph reference: virtualEventTownhall
| Property | Type | Description |
|---|---|---|
| audience | meetingAudience | The audience to whom the town hall is visible. Possible values are: everyone, organization, and unknownFutureValue. |
| coOrganizers | communicationsUserIdentity collection | Identity information of the coorganizers of the town hall. |
| createdBy | communicationsIdentitySet | Identity information of the creator of the town hall. Inherited from virtualEvent. Read-only. |
| description | itemBody | Description of the town hall. Inherited from virtualEvent. |
| displayName | String | Display name of the town hall. Inherited from virtualEvent. |
| endDateTime | dateTimeTimeZone | Date and time when the town hall ends. 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. Inherited from virtualEvent. |
| externalEventInformation | virtualEventExternalInformation collection | The external information of a town hall. Returned only for event organizers or coorganizers; otherwise, null. |
| id | String | Unique identifier of the town hall. Inherited from entity. Read-only. |
| invitedAttendees | identity collection | The attendees invited to the town hall. The supported identities are: communicationsUserIdentity and communicationsGuestIdentity. |
| isInviteOnly | Boolean | Indicates whether the town hall is only open to invited people and groups within your organization. The isInviteOnly property can only be true if the value of the audience property is set to organization. |
| settings | virtualEventSettings | The virtual event settings. |
| startDateTime | dateTimeTimeZone | Date and time when the town hall starts. 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. Inherited from virtualEvent. |
| status | virtualEventStatus | Status of the town hall. Possible values are: draft, published, canceled, and unknownFutureValue. Inherited from virtualEvent. |
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. |
| externalEventInformation | virtualEventExternalInformation collection | The external information of a webinar. Returned only for event organizers or coorganizers; otherwise, null. |
| 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. |
Graph reference: webPart
| Property | Type | Description |
|---|---|---|
| id | String | Unique instance identifier of the web part. Inherited from entity. |
Graph reference: webPartPosition
| Property | Type | Description |
|---|---|---|
| columnId | Double | Indicates the identifier of the column where the web part is located. |
| horizontalSectionId | Double | Indicates the horizontal section where the web part is located. |
| isInVerticalSection | Boolean | Indicates whether the web part is located in the vertical section. |
| webPartIndex | Double | Index of the current web part. Represents the order of the web part in this column or section. |
Graph reference: workbookNamedItem
| Property | Type | Description |
|---|---|---|
| comment | String | The comment associated with this name. |
| name | String | The name of the object. Read-only. |
| scope | String | Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only. |
| type | String | The type of reference is associated with the name. Possible values are: String, Integer, Double, Boolean, Range. Read-only. |
| value | String | The formula that the name is defined to refer to. For example, =Sheet14!$B$2:$H$12 and =4.75. Read-only. |
| visible | Boolean | Indicates whether the object is visible. |