Show / Hide Table of Contents

Group.ReadWrite.All

Allows the app to create groups and read all group properties and memberships on behalf of the signed-in user. Additionally allows group owners to manage their groups and allows group members to update group content.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 D DELETE /directory/deleteditems/{id}
V1 D DELETE /directory/deletedItems/{id}
V1 A,D DELETE /directoryObjects/{id}
V1 A,D DELETE /groups/{id}
V1 D DELETE /groups/{id}/acceptedSenders/$ref?$id={id}
V1 D DELETE /groups/{id}/acceptedSenders/$ref?$id=https://graph.microsoft.com/v1.0/groups/{other-group-id}
V1 D DELETE /groups/{id}/acceptedSenders/$ref?$id=https://graph.microsoft.com/v1.0/users/{user-id}
V1 D DELETE /groups/{id}/calendar/events/{id}
V1 A,D DELETE /groups/{id}/conversations/{id}
V1 A,D DELETE /groups/{id}/conversations/{id}/threads/{id}
V1 D DELETE /groups/{id}/events/{id}
V1 A,D DELETE /groups/{id}/members/{id}/$ref
V1 A,D DELETE /groups/{id}/owners/{id}/$ref
V1 D DELETE /groups/{id}/rejectedSenders/$ref?$id={id}
V1 D DELETE /groups/{id}/rejectedSenders/$ref?$id=https://graph.microsoft.com/v1.0/groups/{other-group-id}
V1 D DELETE /groups/{id}/rejectedSenders/$ref?$id=https://graph.microsoft.com/v1.0/users/{user-id}
V1 A,D DELETE /groups/{id}/threads/{id}
V1 D DELETE /planner/buckets/{id}
V1 D DELETE /planner/plans/{id}
V1 D DELETE /planner/tasks/{id}
V1 D DELETE /teams/{id}/schedule/openShifts/{openShiftId}
V1 A,D DELETE /teams/{team-id}/channels/{channel-id}
V1 A,D DELETE /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
V1 A,D DELETE /teams/{team-id}/installedApps/{app-installation-id}
V1 D DELETE /teams/{teamId}/schedule/schedulingGroups/{schedulingGroupId}
V1 D DELETE /teams/{teamId}/schedule/shifts/{shiftId}
V1 D DELETE /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId}
V1 D DELETE /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}
V1 D DELETE /teams/{teamId}/schedule/timesOff/{timeOffId}
V1 A,D GET /directory/deleteditems/{id}
V1 A,D GET /directory/deletedItems/{id}
V1 A,D GET /directory/deletedItems/microsoft.graph.administrativeUnit
V1 A,D GET /directory/deleteditems/microsoft.graph.application
V1 A,D GET /directory/deleteditems/microsoft.graph.group
V1 A,D GET /directory/deletedItems/microsoft.graph.group
V1 A,D GET /directory/deleteditems/microsoft.graph.servicePrincipal
V1 A,D GET /directory/deletedItems/microsoft.graph.user
V1 D GET /drive/root/createdByUser/planner/plans
V1 D GET /drive/root/createdByUser/planner/tasks
V1 A,D GET /drives/{drive-id}/items/{item-id}
V1 A,D GET /drives/{drive-id}/root:/{item-path}
V1 A,D GET /groups
V1 A,D GET /groups/{group-id}/drive/items/{item-id}
V1 A,D GET /groups/{group-id}/drive/root:/{item-path}
V1 A,D GET /groups/{group-id}/permissionGrants
V1 D GET /groups/{group-id}/planner/plans
V1 A,D GET /groups/{groupId}/conversations/{conversationId}/threads/{threadId}/posts
V1 A,D GET /groups/{groupId}/threads/{threadId}/posts
V1 A,D GET /groups/{id}
V1 D GET /groups/{id}/acceptedSenders
V1 D GET /groups/{id}/calendar/events
V1 D GET /groups/{id}/calendar/events/{id}
V1 D GET /groups/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1 A,D GET /groups/{id}/conversations
V1 A,D GET /groups/{id}/conversations/{id}
V1 A,D GET /groups/{id}/conversations/{id}/threads
V1 A,D GET /groups/{id}/conversations/{id}/threads/{id}
V1 A,D GET /groups/{id}/conversations/{id}/threads/{id}/posts/{id}
V1 D GET /groups/{id}/conversations/{id}/threads/{id}/posts/{id}/attachments
V1 A,D GET /groups/{id}/endpoints
V1 A,D GET /groups/{id}/endpoints/{id}
V1 D GET /groups/{id}/events
V1 D GET /groups/{id}/events/{id}
V1 A,D GET /groups/{id}/members
V1 A,D GET /groups/{id}/owners
V1 A,D GET /groups/{id}/photo/$value
V1 A,D GET /groups/{id}/photos
V1 D GET /groups/{id}/rejectedSenders
V1 A,D GET /groups/{id}/threads
V1 A,D GET /groups/{id}/threads/{id}
V1 A,D GET /groups/{id}/threads/{id}/posts/{id}
V1 D GET /groups/{id}/threads/{id}/posts/{id}/attachments
V1 A,D GET /groups/{id}/transitiveMembers
V1 A,D GET /groups/delta
V1 A,D GET /groupSettings
V1 A,D GET /groupSettings/{groupSettingId}
V1 A,D GET /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D GET /me/contacts/{id}/photo/$value
V1 A,D GET /me/drive/items/{item-id}
V1 A,D GET /me/drive/root:/{item-path}
V1 A,D GET /me/photo/$value
V1 D GET /me/planner/all/delta
V1 D GET /me/planner/plans
V1 D GET /me/planner/tasks
V1 D GET /planner/buckets
V1 D GET /planner/buckets/{id}
V1 D GET /planner/buckets/{id}/tasks
V1 D GET /planner/plans
V1 D GET /planner/plans/{id}/details
V1 D GET /planner/plans/{plan-id}
V1 D GET /planner/plans/{plan-id}/buckets
V1 D GET /planner/plans/{plan-id}/tasks
V1 D GET /planner/tasks
V1 D GET /planner/tasks/{id}
V1 D GET /planner/tasks/{id}/assignedToTaskBoardFormat
V1 D GET /planner/tasks/{id}/bucketTaskBoardFormat
V1 D GET /planner/tasks/{id}/details
V1 D GET /planner/tasks/{id}/progressTaskBoardFormat
V1 A,D GET /settings
V1 A,D GET /settings/{directorySettingId}
V1 A,D GET /sites/{siteId}/drive/items/{itemId}
V1 A,D GET /sites/{siteId}/drive/root:/{item-path}
V1 A,D GET /team/{id}/photo/$value
V1 A,D GET /teams/{id}/channels/{id}/filesFolder
V1 A,D GET /teams/{id}/channels/{id}/tabs
V1 A,D GET /teams/{id}/installedApps/{id}
V1 D GET /teams/{id}/schedule/openShiftChangeRequests
V1 D GET /teams/{id}/schedule/openShiftChangeRequests/{openShiftsChangeRequestId}
V1 D GET /teams/{id}/schedule/openShifts
V1 D GET /teams/{id}/schedule/openShifts/{openShiftId}
V1 A,D GET /teams/{team-id}
V1 A,D GET /teams/{team-id}/channels
V1 A,D GET /teams/{team-id}/channels/{channel-id}
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/hostedContents
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/hostedContents/{hosted-content-id}
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}/hostedContents
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies/{reply-id}/hostedContents/{hosted-content-id}
V1 A,D GET /teams/{team-id}/channels/{channel-id}/messages/delta
V1 A,D GET /teams/{team-id}/channels/{channel-id}/tabs
V1 A,D GET /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
V1 A,D GET /teams/{team-id}/installedApps
V1 A,D GET /teams/{teamId}/channels/{channelId}/filesFolder
V1 D GET /teams/{teamId}/schedule
V1 D GET /teams/{teamId}/schedule/offerShiftRequests
V1 D GET /teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}
V1 D GET /teams/{teamId}/schedule/schedulingGroups
V1 D GET /teams/{teamId}/schedule/schedulingGroups/{schedulingGroupId}
V1 D GET /teams/{teamId}/schedule/shifts
V1 D GET /teams/{teamId}/schedule/shifts/{shiftId}
V1 D GET /teams/{teamId}/schedule/swapShiftsChangeRequests
V1 D GET /teams/{teamId}/schedule/timeOffReasons
V1 D GET /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId}
V1 D GET /teams/{teamId}/schedule/timeOffRequests
V1 D GET /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}
V1 D GET /teams/{teamId}/schedule/timesOff
V1 D GET /teams/{teamId}/schedule/timesOff/{timeOffId}
V1 A,D GET /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D GET /users/{id | userPrincipalName}/contacts/{id}/photo/$value
V1 A,D GET /users/{id | userPrincipalName}/joinedGroups/{id}/photos
V1 A,D GET /users/{id | userPrincipalName}/photo/$value
V1 D GET /users/{id}/planner/all/delta
V1 D GET /users/{id}/planner/plans
V1 D GET /users/{id}/planner/tasks
V1 A,D GET /users/{userId}/drive/items/{itemId}
V1 A,D GET /users/{userId}/drive/root:/{item-path}
V1 A,D PATCH /chats/{chatThread-id}/messages/{message-id}
V1 A,D PATCH /groups/{group id}/conversations/{conversation id}/threads/{thread id}
V1 A,D PATCH /groups/{group id}/threads/{thread id}
V1 A,D PATCH /groups/{id}
V1 D PATCH /groups/{id}/calendar/events/{id}
V1 D PATCH /groups/{id}/events/{id}
V1 A,D PATCH /groups/{id}/photo/$value
V1 D PATCH /groups/{id}/threads/{id}
V1 A,D PATCH /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D PATCH /me/contacts/{id}/photo/$value
V1 A,D PATCH /me/photo/$value
V1 D PATCH /me/planner
V1 D PATCH /planner/buckets/{id}
V1 D PATCH /planner/plans/{id}/details
V1 D PATCH /planner/plans/{plan-id}
V1 D PATCH /planner/tasks/{id}
V1 D PATCH /planner/tasks/{id}/assignedToTaskBoardFormat
V1 D PATCH /planner/tasks/{id}/bucketTaskBoardFormat
V1 D PATCH /planner/tasks/{id}/details
V1 D PATCH /planner/tasks/{id}/progressTaskBoardFormat
V1 A,D PATCH /teams/(team-id)/channels/{channel-id}/messages/{message-id}
V1 A,D PATCH /teams/(team-id)/channels/{channel-id}/messages/{message-id}/replies/{reply-id}
V1 A,D PATCH /teams/{id}/channels/{id}/members/{id}
V1 A,D PATCH /teams/{id}/members/{id}
V1 A,D PATCH /teams/{team-id}
V1 A,D PATCH /teams/{team-id}/channels/{channel-id}
V1 A,D PATCH /teams/{team-id}/channels/{channel-id}/tabs/{tab-id}
V1 A,D PATCH /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D PATCH /users/{id | userPrincipalName}/contacts/{id}/photo/$value
V1 A,D PATCH /users/{id | userPrincipalName}/photo/$value
V1 A,D POST /directory/administrativeUnits/{id}/members/$ref
V1 A,D POST /directory/deleteditems/{id}/restore
V1 A,D POST /directory/deletedItems/{id}/restore
V1 A,D POST /directory/deletedItems/getUserOwnedObjects
V1 A,D POST /directoryObjects/{id}/checkMemberGroups
V1 A,D POST /directoryObjects/{id}/checkMemberObjects
V1 A,D POST /directoryObjects/{id}/getMemberGroups
V1 A,D POST /directoryObjects/{id}/getMemberObjects
V1 A POST /directoryObjects/validateProperties
V1 A,D POST /groupLifecyclePolicies/renewGroup
V1 A,D POST /groups
V1 A,D POST /groups/{group-id}/members/$ref
V1 D POST /groups/{id}/acceptedSenders/$ref
V1 D POST /groups/{id}/addFavorite
V1 A,D POST /groups/{id}/assignLicense
V1 D POST /groups/{id}/calendar/events
V1 D POST /groups/{id}/conversations
V1 D POST /groups/{id}/conversations/{id}/threads
V1 A,D POST /groups/{id}/conversations/{id}/threads/{id}/posts/{id}/forward
V1 A,D POST /groups/{id}/conversations/{id}/threads/{id}/posts/{id}/reply
V1 D POST /groups/{id}/conversations/{id}/threads/{id}/reply
V1 D POST /groups/{id}/events
V1 A,D POST /groups/{id}/owners/$ref
V1 D POST /groups/{id}/rejectedSenders/$ref
V1 D POST /groups/{id}/removeFavorite
V1 A,D POST /groups/{id}/renew
V1 D POST /groups/{id}/resetUnseenCount
V1 D POST /groups/{id}/subscribeByMail
V1 D POST /groups/{id}/threads
V1 A,D POST /groups/{id}/threads/{id}/posts/{id}/forward
V1 A,D POST /groups/{id}/threads/{id}/posts/{id}/reply
V1 D POST /groups/{id}/threads/{id}/reply
V1 A,D POST /groups/{id}/unsubscribeByMail
V1 A,D POST /groups/{id}/validateProperties
V1 D POST /planner/buckets
V1 D POST /planner/plans
V1 D POST /planner/tasks
V1 A,D POST /teams
V1 A,D POST /teams/{id}/archive
V1 A,D POST /teams/{id}/channels/{id}/tabs
V1 A,D POST /teams/{id}/clone
V1 D POST /teams/{id}/schedule/openShiftChangeRequests
V1 D POST /teams/{id}/schedule/openShiftChangeRequests/{openShiftChangeRequestId}/approve
V1 D POST /teams/{id}/schedule/openShiftChangeRequests/{openShiftChangeRequestId}/decline
V1 D POST /teams/{id}/schedule/openShifts
V1 A,D POST /teams/{id}/unarchive
V1 A,D POST /teams/{team-id}/channels
V1 D POST /teams/{team-id}/channels/{channel-id}/messages
V1 D POST /teams/{team-id}/channels/{channel-id}/messages/{message-id}/replies
V1 A,D POST /teams/{team-id}/channels/{channel-id}/tabs
V1 A,D POST /teams/{team-id}/installedApps
V1 A,D POST /teams/{team-id}/installedApps/{app-installation-id}/upgrade
V1 D POST /teams/{teamId}/schedule/offerShiftRequests
V1 D POST /teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}/approve
V1 D POST /teams/{teamId}/schedule/offerShiftRequests/{offerShiftRequestId}/decline
V1 D POST /teams/{teamId}/schedule/schedulingGroups
V1 D POST /teams/{teamId}/schedule/share
V1 D POST /teams/{teamId}/schedule/shifts
V1 D POST /teams/{teamId}/schedule/swapShiftsChangeRequests
V1 D POST /teams/{teamId}/schedule/swapShiftsChangeRequests/{swapShiftChangeRequestId}/approve
V1 D POST /teams/{teamId}/schedule/swapShiftsChangeRequests/{swapShiftChangeRequestId}/decline
V1 D POST /teams/{teamId}/schedule/timeOffReasons
V1 D POST /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}/approve
V1 D POST /teams/{teamId}/schedule/timeOffRequests/{timeOffRequestId}/decline
V1 D POST /teams/{teamId}/schedule/timesOff
V1 A,D PUT /groups/{id}/photo/$value
V1 A,D PUT /groups/{id}/team
V1 A,D PUT /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D PUT /me/contacts/{id}/photo/$value
V1 A,D PUT /me/photo/$value
V1 A,D PUT /team/{id}/photo/$value
V1 D PUT /teams/{id}/schedule/openShifts/{openShiftId}
V1 D PUT /teams/{teamId}/schedule
V1 D PUT /teams/{teamId}/schedule/schedulingGroups/{schedulingGroupId}
V1 D PUT /teams/{teamId}/schedule/shifts/{shiftId}
V1 D PUT /teams/{teamId}/schedule/timeOffReasons/{timeOffReasonId}
V1 D PUT /teams/{teamId}/schedule/timesOff/{timeOffId}
V1 A,D PUT /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
V1 A,D PUT /users/{id | userPrincipalName}/contacts/{id}/photo/$value
V1 A,D PUT /users/{id | userPrincipalName}/photo/$value

Delegate Permission

Id 4e46008b-f24c-477d-8fff-7bb4ec7aafe0
Consent Type Admin
Display String Read and write all groups
Description Allows the app to create groups and read all group properties and memberships on behalf of the signed-in user. Additionally allows group owners to manage their groups and allows group members to update group content.

Application Permission

Id 62a82d76-70ea-41e2-9197-370581804d09
Display String Read and write all groups
Description Allows the app to create groups, read all group properties and memberships, update group properties and memberships, and delete groups. Also allows the app to read and write conversations. All of these operations can be performed by the app without a signed-in user.

Resources

administrativeUnit

Property Type Description
description String An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.
displayName String Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
id String Unique identifier for the administrative unit. Read-only. Supports $filter (eq).
visibility String Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.

application

Property Type Description
addIns addIn collection Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This will let services like Office 365 call the application in the context of a document the user is working on.
api apiApplication Specifies settings for an application that implements a web API.
appId String The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. Supports $filter (eq).
applicationTemplateId String Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne).
appRoles appRole collection The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable.
certification certification Specifies the certification status of the application.
createdDateTime DateTimeOffset The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderBy.
deletedDateTime DateTimeOffset The date and time the application was deleted. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
description String Free text field to provide a description of the application object to end users. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
disabledByMicrosoftStatus String Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).

Supports $filter (eq, ne, not).
displayName String The display name for the application. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
groupMembershipClaims String Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None, SecurityGroup (for security groups and Azure AD roles), All (this gets all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of).
id String Unique identifier for the application object. This property is referred to as Object ID in the Azure portal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in).
identifierUris String collection Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you'll reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form api://<application-client-id>, or specify a more readable URI like https://contoso.com/api. For more information on valid identifierUris patterns and best practices, see Azure AD application registration security best practices. Not nullable.

Supports $filter (eq, ne, ge, le, startsWith).
info informationalUrl Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps.

Supports $filter (eq, ne, not, ge, le, and eq on null values).
isDeviceOnlyAuthSupported Boolean Specifies whether this application supports device authentication without a user. The default is false.
isFallbackPublicClient Boolean Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where it is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property.
keyCredentials keyCredential collection The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le).
logo Stream The main logo for the application. Not nullable.
notes String Notes relevant for the management of the application.
oauth2RequiredPostResponse Boolean Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests are allowed.
optionalClaims optionalClaims Application developers can configure optional claims in their Azure AD applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app.
parentalControlSettings parentalControlSettings Specifies parental control settings for an application.
passwordCredentials passwordCredential collection The collection of password credentials associated with the application. Not nullable.
publicClient publicClientApplication Specifies settings for installed clients such as desktop or mobile devices.
publisherDomain String The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application's publisher domain. Supports $filter (eq, ne, ge, le, startsWith).
requiredResourceAccess requiredResourceAccess collection Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience.

No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable.

Supports $filter (eq, not, ge, le).
samlMetadataUrl String The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable.
serviceManagementReference String References application or service contact information from a Service or Asset Management database. Nullable.
signInAudience String Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount. See more in the table.

The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app.

The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see Validation differences for signInAudience.

Supports $filter (eq, ne, not).
spa spaApplication Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens.
tags String collection Custom strings that can be used to categorize and identify the application. Not nullable.

Supports $filter (eq, not, ge, le, startsWith).
tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
verifiedPublisher verifiedPublisher Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification.
web webApplication Specifies settings for a web application.

assignedLabel

Property Type Description
displayName String The display name of the label. Read-only.
labelId String The unique identifier of the label.

assignedLicense

Property Type Description
disabledPlans Guid collection A collection of the unique identifiers for plans that have been disabled.
skuId Guid The unique identifier for the SKU.

attachment

Property Type Description
contentType String The MIME type.
id String Read-only.
isInline Boolean true if the attachment is an inline attachment; otherwise, false.
lastModifiedDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
name String The attachment's file name.
size Int32 The length of the attachment in bytes.

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.
email String The email address for sending messages to the channel. Read-only.
id String The channel's unique identifier. Read-only.
isFavoriteByDefault Boolean Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: false.
membershipType channelMembershipType The type of the channel. Can be set during creation and can't be changed. The possible values are: standard, private, unknownFutureValue, shared. The default value is standard. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: shared.
tenantId string The ID of the Azure Active Directory 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.

channelModerationSettings

Property Type Description
allowNewMessageFromBots Boolean Indicates whether bots are allowed to post messages.
allowNewMessageFromConnectors Boolean Indicates whether connectors are allowed to post messages.
replyRestriction replyRestriction Indicates who is allowed to reply to the teams channel. Possible values are: everyone, authorAndModerators, unknownFutureValue.
userNewMessageRestriction userNewMessageRestriction Indicates who is allowed to post messages to teams channel. Possible values are: everyone, everyoneExceptGuests, moderators, unknownFutureValue.

chat

Property Type Description
chatType chatType Specifies the type of chat. Possible values are: group, oneOnOne, meeting, unknownFutureValue.
createdDateTime dateTimeOffset Date and time at which the chat was created. Read-only.
id String The chat's unique identifier. Read-only.
lastUpdatedDateTime dateTimeOffset Date and time at which the chat was renamed or list of members were 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 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.

chatMessage

Property Type Description
attachments chatMessageAttachment collection References to attached objects like files, tabs, meetings etc.
body itemBody Plaintext/HTML representation of the content of the chat message. Representation is specified by the contentType inside the body. The content is always in HTML if the chat message contains a chatMessageMention.
chatId string If the message was sent in a chat, represents the identity of the chat.
channelIdentity channelIdentity If the message was sent in a channel, represents identity of the channel.
createdDateTime dateTimeOffset Timestamp of when the chat message was created.
deletedDateTime dateTimeOffset Read only. Timestamp at which the chat message was deleted, or null if not deleted.
etag string Read-only. Version number of the chat message.
eventDetail eventMessageDetail Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, adding new members. For event messages, the messageType property will be set to systemEventMessage.
from chatMessageFromIdentitySet Details of the sender of the chat message. Can only be set during migration.
id String Read-only. Unique ID of the message. IDs are unique within a chat/channel/reply-to-message, but might be duplicated in other chats/channels/reply-to-messages.
importance string The importance of the chat message. The possible values are: normal, high, urgent.
lastModifiedDateTime dateTimeOffset Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.
lastEditedDateTime dateTimeOffset Read only. Timestamp when edits to the chat message were made. Triggers an "Edited" flag in the Teams UI. If no edits are made the value is null.
locale string Locale of the chat message set by the client. Always set to en-us.
mentions chatMessageMention collection List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.
messageType chatMessageType The type of chat message. The possible values are: message, chatEvent, typing, unknownFutureValue, systemEventMessage. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: systemEventMessage.
policyViolation chatMessagePolicyViolation Defines the properties of a policy violation set by a data loss prevention (DLP) application.
reactions chatMessageReaction collection Reactions for this chat message (for example, Like).
replyToId string Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)
subject string The subject of the chat message, in plaintext.
summary string Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
webUrl string Read-only. Link to the message in Microsoft Teams.

chatMessageHostedContent

Property Type Description
contentBytes Edm.Binary Write-only. When posting new chat message hosted content, represents the bytes of the payload. These are represented as a base64Encoded string.
contentType String Write-only. When posting new chat message hosted content, represents the type of content, such as image/png.
id String Read-only. Represents the chat message hosted content identifier.

clonableteamparts

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.

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 only contains additional qualifiers 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 a guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property.
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.

conversationThread

Property Type Description
ccRecipients recipient collection The Cc: recipients for the thread.

Returned only on $select.
hasAttachments Boolean Indicates whether any of the posts within this thread has at least one attachment.

Returned by default.
id String Read-only.

Returned by default.
isLocked Boolean Indicates if the thread is locked.

Returned by default.
lastDeliveredDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default.
preview String A short summary from the body of the latest post in this conversation.

Returned by default.
topic String The topic of the conversation. This property can be set when the conversation is created, but it cannot be updated.

Returned by default.
toRecipients recipient collection The To: recipients for the thread.

Returned only on $select.
uniqueSenders String collection All the users that sent a message to this thread.

Returned by default.

device

Property Type Description
accountEnabled Boolean true if the account is enabled; otherwise, false. Required. Default is true.

Supports $filter (eq, ne, not, in). Only callers in Global Administrator and Cloud Device Administrator roles can set this property.
alternativeSecurityIds alternativeSecurityId collection For internal use only. Not nullable. Supports $filter (eq, not, ge, le).
approximateLastSignInDateTime DateTimeOffset The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderBy.
complianceExpirationDateTime DateTimeOffset The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.
deviceId String Unique identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Supports $filter (eq, ne, not, startsWith).
deviceMetadata String For internal use only. Set to null.
deviceVersion Int32 For internal use only.
displayName String The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
extensionAttributes onPremisesExtensionAttributes Contains extension attributes 1-15 for the device. The individual extension attributes are not selectable. These properties are mastered in cloud and can be set during creation or update of a device object in Azure AD.

Supports $filter (eq, not, startsWith, and eq on null values).
id String The unique identifier for the device. Inherited from directoryObject. Key, Not nullable. Read-only. Supports $filter (eq, ne, not, in).
isCompliant Boolean true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
isManaged Boolean true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not).
manufacturer String Manufacturer of the device. Read-only.
mdmAppId String Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith).
model String Model of the device. Read-only.
onPremisesLastSyncDateTime DateTimeOffset The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in).
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
operatingSystem String The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
operatingSystemVersion String The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null values).
physicalIds String collection For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith,/$count eq 0, /$count ne 0).
profileType deviceProfileType The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.
systemLabels String collection List of labels applied to the device by the system. Supports $filter (/$count eq 0, /$count ne 0).
trustType String Type of trust for the joined device. Read-only. Possible values: Workplace (indicates *b

directory

Property Type Description
id String A unique identifier for the object; for example, 12345678-9abc-def0-1234-56789abcde. Key. Not nullable. Read-only. Inherited from entity.

directoryObject

Property Type Description
deletedDateTime DateTimeOffset Date and time when this object was deleted. Always null when the object hasn't been deleted.
id String The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde. The value of the **i

directorySetting

Property Type Description
displayName string Display name of this group of settings, which comes from the associated template. Read-only.
id string Unique identifier for these settings. Read-only.
templateId string Unique identifier for the template used to create this group of settings. Read-only.
values settingValue collection Collection of name-value pairs corresponding to the name and defaultValue properties in the referenced directorySettingTemplates object.

directorySettingTemplate

Property Type Description
description string Description of the template. Read-only.
displayName string Display name of the template. Read-only.
id string Unique identifier for the template. Read-only.
values settingTemplateValue collection Collection of settingTemplateValues that list the set of available settings, defaults and types that make up this template. Read-only.

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 will return personal. OneDrive for Business will return business. SharePoint document libraries will 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 is not returned by default and must be selected using the $select query parameter.
system [systemFacet][] If present, indicates that this is a system-managed drive. Read-only.
webUrl string (url) URL that displays the resource in the browser. Read-only.

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 which 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 is not changed if only the metadata is changed. Note This property is not 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 which 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 is not 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 has been 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.

Endpoint

Property Type Description
capability String Describes the capability that is associated with this resource. (e.g. Messages, Conversations, etc.) Not nullable. Read-only.
id String Unique identifier for the endpoint; Key. Not nullable. Read-only.
providerId String Application id of the publishing underlying service. Not nullable. Read-only.
providerName String Name of the publishing underlying service. Read-only.
providerResourceId String For Microsoft 365 groups, this is set to a well-known name for the resource (e.g. Yammer.FeedURL etc.). Not nullable. Read-only.
uri String URL of the published resource. Not nullable. Read-only.

event

Property Type Description
allowNewTimeProposals Boolean true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. Default is true.
attendees Attendee collection The collection of attendees for the event.
body ItemBody The body of the message associated with the event. It can be in HTML or text format.
bodyPreview String The preview of the message associated with the event. It is in text format.
categories String collection The categories associated with the event. Each category corresponds to the displayName property of an outlookCategory defined for the user.
changeKey String Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
createdDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
end DateTimeTimeZone The date, time, and time zone that the event ends. By default, the end time is in UTC.
hasAttachments Boolean Set to true if the event has attachments.
hideAttendees Boolean When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.
iCalUId String A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
id String Unique identifier for the event. !INCLUDE [outlook-beta-id] Case-sensitive and read-only.
importance String The importance of the event. The possible values are: low, normal, high.
isAllDay Boolean Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
isCancelled Boolean Set to true if the event has been canceled.
isDraft Boolean Set to true if the user has updated the meeting in Outlook but has not sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.
isOnlineMeeting Boolean True if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional.
After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.
isOrganizer Boolean Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.
isReminderOn Boolean Set to true if an alert is set to remind the user of the event.
lastModifiedDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
location Location The location of the event.
locations Location collection The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
onlineMeeting OnlineMeetingInfo Details for an attendee to join the meeting online. Default is null. Read-only.
After you set the isOnlineMeeting and onlineMeetingProvider properties to enable a meeting online, Microsoft Graph initializes onlineMeeting. When set, the meeting remains available online, and you cannot change the isOnlineMeeting, onlineMeetingProvider, and onlneMeeting properties again.
onlineMeetingProvider onlineMeetingProviderType Represents the online meeting service provider. By default, onlineMeetingProvider is unknown. The possible values are unknown, teamsForBusiness, skypeForBusiness, and skypeForConsumer. Optional.
After you set onlineMeetingProvider, Microsoft Graph initializes onlineMeeting. Subsequently you cannot change onlineMeetingProvider again, and the meeting remains available online.
onlineMeetingUrl String A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.
To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.
organizer Recipient The organizer of the event.
originalEndTimeZone String The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
originalStart DateTimeOffset Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
originalStartTimeZone String The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
recurrence PatternedRecurrence The recurrence pattern for the event.
reminderMinutesBeforeStart Int32 The number of minutes before the event start time that the reminder alert occurs.
responseRequested Boolean Default is true, which represents the organizer would like an invitee to send a response to the event.
responseStatus ResponseStatus Indicates the type of response sent in response to an event message.
sensitivity String Possible values are: normal, personal, private, confidential.
seriesMasterId String The ID for the recurring series master item, if this event is part of a recurring series.
showAs String The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
start DateTimeTimeZone The start date, time, and time zone of the event. By default, the start time is in UTC.
subject String The text of the event's subject line.
transactionId String A custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you cannot change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.
type String The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster. Read-only
webLink String The URL to open the event in Outlook on the web.

Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.

This URL cannot be accessed from within an iFrame.

fileAttachment

Property Type Description
contentBytes Edm.Binary The base64-encoded contents of the file.
contentId String The ID of the attachment in the Exchange store.
contentLocation String Do not use this property as it is not supported.
contentType String The content type of the attachment.
id String The attachment ID.
isInline Boolean Set to true if this is an inline attachment.
lastModifiedDateTime DateTimeOffset The date and time when the attachment was last modified.
name String The name representing the text that is displayed below the icon representing the embedded attachment.This does not need to be the actual file name.
size Int32 The size in bytes of the attachment.

group

Property Type Description
allowExternalSenders Boolean Indicates if people external to the organization can send messages to the group. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
assignedLabels assignedLabel collection The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group.

Returned only on $select.
assignedLicenses assignedLicense collection The licenses that are assigned to the group.

Returned only on $select. Supports $filter (eq).Read-only.
autoSubscribeNewMembers Boolean Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
classification String Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.

Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
createdDateTime DateTimeOffset Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
deletedDateTime DateTimeOffset For some Azure Active Directory objects (user, group, application), if the object is deleted, it is first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null. If the object is restored, this property is updated to null.
description String An optional description for the group.

Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
displayName String The display name for the group. This property is required when a group is created and cannot be cleared during updates. Maximum length is 256 characters.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
expirationDateTime DateTimeOffset Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
groupTypes String collection Specifies the group type and its membership.

If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.

If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static.

Returned by default. Supports $filter (eq, not).
hasMembersWithLicenseErrors Boolean Indicates whether there are members in this group that have license errors from its group-based license assignment.

This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example.

Supports $filter (eq).
hideFromAddressLists Boolean True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
hideFromOutlookClients Boolean True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
id String The unique identifier for the group.

Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only.

Supports $filter (eq, ne, not, in).
isArchived Boolean When a group is associated with a team this property determines whether the team is in read-only mode.
To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.
isAssignableToRole Boolean Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional.

This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership).

Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignments

Using this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).
isSubscribedByMail Boolean Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
licenseProcessingState String Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.

Returned only on $select. Read-only.
mail String The SMTP address for the group, for example, "[email protected]".

Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mailEnabled Boolean Specifies whether the group is mail-enabled. Required.

Returned by default. Supports $filter (eq, ne, not).
mailNickname String The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () \ [] " ; : <> , SPACE.

Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
membershipRule String The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax.

Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
membershipRuleProcessingState String Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused.

Returned by default. Supports $filter (eq, ne, not, in).
onPremisesLastSyncDateTime DateTimeOffset Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).
onPremisesProvisioningErrors onPremisesProvisioningError collection Errors when using Microsoft synchronization product during provisioning.

Returned by default. Supports $filter (eq, not).
onPremisesSamAccountName String Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.
onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.

Returned by default. Supports $filter (eq including on null values). Read-only.
onPremisesSyncEnabled Boolean true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default).

Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
preferredDataLocation String The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles:
  • Global Administrator
  • User Account Administrator
  • Directory Writer
  • Exchange Administrator
  • SharePoint Administrator

For more information about this property, see OneDrive Online Multi-Geo.

Nullable. Returned by default.
preferredLanguage String The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
proxyAddresses String collection Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"]. The any operator is required to filter expressions on multi-valued properties.

Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
renewedDateTime DateTimeOffset Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
resourceBehaviorOptions String collection Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are AllowOnlyMembersToPost, HideGroupInOutlook, SubscribeNewGroupMembers, WelcomeEmailDisabled. For more information, see Set Microsoft 365 group behaviors and provisioning options.
resourceProvisioningOptions String collection Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team. For more information, see Set Microsoft 365 group behaviors and provisioning options.
securityEnabled Boolean Specifies whether the group is a security group. Required.

Returned by default. Supports $filter (eq, ne, not, in).
securityIdentifier String Security identifier of the group, used in Windows scenarios.

Returned by default.
theme string Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red.

Returned by default.
unseenCount Int32 Count of conversations that have received new posts since the signed-in user last visited the group.

Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
visibility String Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.
If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. Groups assignable to roles are always Private. See group visibility options to learn more.

Returned by default. Nullable.

groups-overview

groupSetting

Property Type Description
displayName String Display name of this group of settings, which comes from the associated template.
id String Unique identifier for these settings. Read-only.
templateId String Unique identifier for the tenant-level groupSettingTemplates object that's been customized for this group-level settings object. Read-only.
values settingValue collection Collection of name-value pairs corresponding to the **n

groupWritebackConfiguration

Property Type Description
isEnabled Boolean Indicates whether writeback of cloud groups to on-premise Active Directory is enabled. Nullable. Default value is true for Microsoft 365 groups and false for security groups. Inherited from writebackConfiguration.
onPremisesGroupType String Indicates the target on-premise group type the cloud object will be written back as. Nullable. The possible values are: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.
  1. If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.
  2. Azure AD security groups can be written back as universalSecurityGroup.
  3. If **i

itemAttachment

Property Type Description
contentType String The content type of the attachment. Returned as null by default, when not set explicitly. Optional.
id String The attachment ID.
isInline Boolean Set to true if the attachment is inline, such as an embedded image within the body of the item.
lastModifiedDateTime DateTimeOffset The last time and date that the attachment was modified.
name String The display name of the attachment.
size Int32 The size in bytes of the attachment.

itemBody

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

offerShiftRequest

Property Type Description
recipientActionDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
recipientActionMessage String Custom message sent by recipient of the offer shift request.
recipientUserId String User ID of the recipient of the offer shift request.
senderShiftId String User ID of the sender of the offer shift request.

openShift

Property Type Description
draftOpenShift openShiftItem An unpublished open shift.
schedulingGroupId String ID for the scheduling group that the open shift belongs to.
sharedOpenShift openShiftItem A published open shift.

openShiftChangeRequest

Property Type Description
openShiftId String ID for the open shift.

orgContact

Property Type Description
addresses physicalOfficeAddress collection Postal addresses for this organizational contact. For now a contact can only have one physical address.
companyName String Name of the company that this organizational contact belongs to. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).
department String The name for the department in which the contact works. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).
displayName String Display name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values), $search, and $orderBy.
givenName String First name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).
id String Unique identifier for this organizational contact. Supports $filter (eq, ne, not, in).
jobTitle String Job title for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).
mail String The SMTP address for the contact, for example, "[email protected]". Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).
mailNickname String Email alias (portion of email address pre-pending the @ symbol) for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).
onPremisesLastSyncDateTime DateTimeOffset Date and time when this organizational contact was last synchronized from on-premises AD. This 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. Supports $filter (eq, ne, not, ge, le, in).
onPremisesProvisioningErrors onPremisesProvisioningError collection List of any synchronization provisioning errors for this organizational contact. Supports $filter (eq, not for category and propertyCausingError), /$count eq 0, /$count ne 0.
onPremisesSyncEnabled Boolean true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced and now mastered in Exchange; null if this object has never been synced from an on-premises directory (default).

Supports $filter (eq, ne, not, in, and eq for null values).
phones phone collection List of phones for this organizational contact. Phone types can be mobile, business, and businessFax. Only one of each type can ever be present in the collection.
proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]". The any operator is required for filter expressions on multi-valued properties. Supports $filter (eq, not, ge, le, startsWith, /$count eq 0, /$count ne 0).
surname String Last name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq for null values).

planner-identifiers-disclaimer

planner-order-hint-format

planner-overview

plannerAppliedCategories

plannerAssignedToTaskBoardTaskFormat

Property Type Description
id String ID of the resource. It is 28 characters long and case-sensitive. Format validation is done on the service. Read-only.
orderHintsByAssignee plannerOrderHintsByAssignee Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here.
unassignedOrderHint String Hint value used to order the task on the AssignedTo view of the Task Board when the task is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined here.

plannerAssignments

plannerBucket

Property Type Description
id String Read-only. ID of the bucket. It is 28 characters long and case-sensitive. Format validation is done on the service.
name String Name of the bucket.
orderHint String Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner.
planId String Plan ID to which the bucket belongs.

plannerBucketTaskBoardTaskFormat

Property Type Description
id String Read-only. ID of the resource. It is 28 characters long and case-sensitive. The format validation is done on the service.
orderHint String Hint used to order tasks in the bucket view of the task board. For details about the supported format, see Using order hints in Planner.

plannerCategoryDescriptions

Property Type Description
category1 String The label associated with Category 1
category2 String The label associated with Category 2
category3 String The label associated with Category 3
category4 String The label associated with Category 4
category5 String The label associated with Category 5
category6 String The label associated with Category 6
category7 String The label associated with Category 7
category8 String The label associated with Category 8
category9 String The label associated with Category 9
category10 String The label associated with Category 10
category11 String The label associated with Category 11
category12 String The label associated with Category 12
category13 String The label associated with Category 13
category14 String The label associated with Category 14
category15 String The label associated with Category 15
category16 String The label associated with Category 16
category17 String The label associated with Category 17
category18 String The label associated with Category 18
category19 String The label associated with Category 19
category20 String The label associated with Category 20
category21 String The label associated with Category 21
category22 String The label associated with Category 22
category23 String The label associated with Category 23
category24 String The label associated with Category 24
category25 String The label associated with Category 25

plannerChecklistItems

plannerExternalReferences

plannerFavoritePlanReferenceCollection

plannerOrderHintsByAssignee

plannerPlan

Property Type Description
container plannerPlanContainer Identifies the container of the plan. Specify only the url, the containerId and type, or all properties. After it is set, this property can’t be updated. Required.
createdBy identitySet Read-only. The user who created the plan.
createdDateTime DateTimeOffset Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
id String Read-only. ID of the plan. It is 28 characters long and case-sensitive. Format validation is done on the service.
owner (deprecated) String Use the container property instead. ID of the group that owns the plan. After it is set, this property can’t be updated. This property will not return a valid group ID if the container of the plan is not a group.
title String Required. Title of the plan.

plannerPlanContainer

Property Type Description
containerId String The identifier of the resource that contains the plan. Optional.
type plannerContainerType The type of the resource that contains the plan. For supported types, see the previous table. Possible values are: group, unknownFutureValue, roster. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: roster. Optional.
url String The full canonical URL of the container. Optional.

plannerPlanDetails

Property Type Description
categoryDescriptions plannerCategoryDescriptions An object that specifies the descriptions of the 25 categories that can be associated with tasks in the plan.
id String The unique identifier for the plan details. It is 28 characters long and case-sensitive. Format validation is done on the service. Read-only.
sharedWith plannerUserIds Set of user IDs that this plan is shared with. If you are leveraging Microsoft 365 groups, use the Groups API to manage group membership to share the group's plan. You can also add existing members of the group to this collection, although it is not required for them to access the plan owned by the group.

plannerProgressTaskBoardTaskFormat

Property Type Description
id String Read-only. ID of the resource. It is 28 characters long and case-sensitive. The format validation is done on the service.
orderHint String Hint value used to order the task on the progress view of the task board. For details about the supported format, see Using order hints in Planner.

plannerRecentPlanReferenceCollection

plannerTask

Property Type Description
activeChecklistItemCount Int32 Number of checklist items with value set to false, representing incomplete items.
appliedCategories plannerAppliedCategories The categories to which the task has been applied. See applied Categories for possible values.
assigneePriority String Hint used to order items of this type in a list view. The format is defined as outlined here.
assignments plannerAssignments The set of assignees the task is assigned to.
bucketId String Bucket ID to which the task belongs. The bucket needs to be in the plan that the task is in. It is 28 characters long and case-sensitive. Format validation is done on the service.
checklistItemCount Int32 Number of checklist items that are present on the task.
completedBy identitySet Identity of the user that completed the task.
completedDateTime DateTimeOffset Read-only. Date and time at which the 'percentComplete' of the task is set to '100'. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
conversationThreadId String Thread ID of the conversation on the task. This is the ID of the conversation thread object created in the group.
createdBy identitySet Identity of the user that created the task.
createdDateTime DateTimeOffset Read-only. Date and time at which the task is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
dueDateTime DateTimeOffset Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
hasDescription Boolean Read-only. Value is true if the details object of the task has a non-empty description and false otherwise.
id String Read-only. ID of the task. It is 28 characters long and case-sensitive. Format validation is done on the service.
orderHint String Hint used to order items of this type in a list view. The format is defined as outlined here.
percentComplete Int32 Percentage of task completion. When set to 100, the task is considered completed.
planId String Plan ID to which the task belongs.
previewType String This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference.
priority Int32 Priority of the task. The valid range of values is between 0 and 10, with the increasing value being lower priority (0 has the highest priority and 10 has the lowest priority). Currently, Planner interprets values 0 and 1 as "urgent", 2, 3 and 4 as "important", 5, 6, and 7 as "medium", and 8, 9, and 10 as "low". Additionally, Planner sets the value 1 for "urgent", 3 for "important", 5 for "medium", and 9 for "low".
referenceCount Int32 Number of external references that exist on the task.
startDateTime DateTimeOffset Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
title String Title of the task.

plannerTaskDetails

Property Type Description
checklist plannerChecklistItems The collection of checklist items on the task.
description String Description of the task.
id String Read-only. ID of the task details. It is 28 characters long and case-sensitive. Format validation is done on the service.
previewType string This sets the type of preview that shows up on the task. The possible values are: automatic, noPreview, checklist, description, reference. When set to automatic the displayed preview is chosen by the app viewing the task.
references plannerExternalReferences The collection of references on the task.

plannerUser

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

plannerUserIds

post

Property Type Description
body itemBody The contents of the post. This is a default property. This property can be null.
categories String collection The categories associated with the post.
changeKey String Identifies the version of the post. Every time the post is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
conversationId String Unique ID of the conversation. Read-only.
conversationThreadId String Unique ID of the conversation thread. Read-only.
createdDateTime DateTimeOffset Specifies when the post was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
from recipient Used in delegate access scenarios. Indicates who posted the message on behalf of another user. This is a default property.
hasAttachments Boolean Indicates whether the post has at least one attachment. This is a default property.
id String Read-only.
lastModifiedDateTime DateTimeOffset Specifies when the post was last modified. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
newParticipants recipient collection Conversation participants that were added to the thread as part of this post.
receivedDateTime DateTimeOffset Specifies when the post was received. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
sender recipient Contains the address of the sender. The value of Sender is assumed to be the address of the authenticated user in the case when Sender is not specified. This is a default property.

profilePhoto

Property Type Description
id string Read-only.
height int32 The height of the photo. Read-only.
width int32 The width of the photo. Read-only.

recipient

Property Type Description
emailAddress EmailAddress The recipient's email address.

referenceAttachment

Property Type Description
contentType String The content type of the attachment. Returned as null by default, when not set explicitly. Optional.
id String The attachment ID. Read-only.
isInline Boolean Set to true if the attachment appears inline in the body of the embedding object.
lastModifiedDateTime DateTimeOffset The date and time when the attachment 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
name String The text that is displayed below the icon representing the embedded attachment. This does not need to be the actual file name.
size Int32 The size of the metadata that is stored on the message for the attachment in bytes. This value does not indicate the size of the actual file.

resourceSpecificPermissionGrant

Property Type Description
clientId string ID of the Azure AD app that has been granted access. Read-only.
clientAppId string ID of the service principal of the Azure AD app that has been granted access. Read-only.
deletedDateTime dateTimeOffset Not used.
id string The unique identifier of the resource-specific permission grant. Read-only.
resourceAppId string ID of the Azure AD app that is hosting the resource. Read-only.
permissionType string The type of permission. Possible values are: Application, Delegated. Read-only.
permission string The name of the resource-specific permission. Read-only.

schedule

schedulingGroup

servicePrincipal

Property Type Description
accountEnabled Boolean true if the service principal account is enabled; otherwise, false. If set to false, then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq, ne, not, in).
addIns addIn collection Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on.
alternativeNames String collection Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq, not, ge, le, startsWith).
appDescription String The description exposed by the associated application.
appDisplayName String The display name exposed by the associated application.
appId String The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, startsWith).
applicationTemplateId String Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq, ne, NOT, startsWith).
appOwnerOrganizationId Guid Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le).
appRoleAssignmentRequired Boolean Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable.

Supports $filter (eq, ne, NOT).
appRoles appRole collection The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable.
deletedDateTime DateTimeOffset The date and time the service principal was deleted. Read-only.
description String Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
disabledByMicrosoftStatus String Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement).

Supports $filter (eq, ne, not).
displayName String The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderBy.
homepage String Home page or landing page of the application.
id String The unique identifier for the service principal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in).
info informationalUrl Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps.

Supports $filter (eq, ne, not, ge, le, and eq on null values).
keyCredentials keyCredential collection The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le).
loginUrl String Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.
logoutUrl String Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.
notes String Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters.
notificationEmailAddresses String collection Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
oauth2PermissionScopes permissionScope collection The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable.
passwordCredentials passwordCredential collection The collection of password credentials associated with the application. Not nullable.
preferredSingleSignOnMode string Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password, saml, notSupported, and oidc.
preferredTokenSigningKeyThumbprint String Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions.
replyUrls String collection The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable.
resourceSpecificApplicationPermissions resourceSpecificPermission collection The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only.
samlSingleSignOnSettings samlSingleSignOnSettings The collection for settings related to saml single sign-on.
servicePrincipalNames String collection Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,
  • Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the “aud” claim.

The any operator is required for filter expressions on multi-valued properties. Not nullable.

Supports $filter (eq, not, ge, le, startsWith).
servicePrincipalType String Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD internally. The servicePrincipalType property can be set to three different values:
  • Application - A service principal that represents an application or service. The appId property identifies the associated app registration, and matches the appId of an application, possibly from a different tenant. If the associated app registration is missing, tokens are not issued for the service principal.
  • ManagedIdentity - A service principal that represents a managed identity. Service principals representing managed identities can be granted access and permissions, but cannot be updated or modified directly.
  • Legacy - A service principal that represents an app created before app registrations, or through legacy experiences. Legacy service principal can have credentials, service principal names, reply URLs, and other properties which are editable by an authorized user, but does not have an associated app registration. The appId value does not associate the service principal with an app registration. The service principal can only be used in the tenant where it was created.
  • SocialIdp - For internal use.
signInAudience String Specifies the Microsoft accounts that are supported for the current application. Read-only.

Supported values are:
  • AzureADMyOrg: Users with a Microsoft work or school account in my organization’s Azure AD tenant (single-tenant).
  • AzureADMultipleOrgs: Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant).
  • AzureADandPersonalMicrosoftAccount: Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.
  • PersonalMicrosoftAccount: Users with a personal Microsoft account only.
tags String collection Custom strings that can be used to categorize and identify the service principal. Not nullable.

Supports $filter (eq, not, ge, le, startsWith).
tokenEncryptionKeyId String Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
verifiedPublisher verifiedPublisher Specifies the verified publisher of the application which this service principal represents.

shift

subscribedSku

Property Type Description
appliesTo String For example, "User" or "Company".
capabilityStatus String Possible values are: Enabled, Warning, Suspended, Deleted, LockedOut. The capabilityStatus is Enabled if the prepaidUnits property has at least 1 unit that is enabled, and LockedOut if the customer cancelled their subscription.
consumedUnits Int32 The number of licenses that have been assigned.
id String The unique identifier for the subscribed sku object. Key, not nullable.
prepaidUnits licenseUnitsDetail Information about the number and status of prepaid licenses.
servicePlans servicePlanInfo collection Information about the service plans that are available with the SKU. Not nullable
skuId Guid The unique identifier (GUID) for the service SKU.
skuPartNumber String The SKU part number; for example: "AAD_PREMIUM" or "RMSBASIC". To get a list of commercial subscriptions that an organization has acquired, see List subscribedSkus.

swapShiftsChangeRequest

Property Type Description
recipientShiftId String ShiftId for the recipient user with whom the request is to swap.

tasks-identifiers-disclaimer

team

Property Type Description
id string The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type.
classification string An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
classSettings teamClassSettings Configure settings of a class. Available only when the team represents a class.
createdDateTime dateTimeOffset Timestamp at which the team was created.
description string An optional description for the team. Maximum length: 1024 characters.
displayName string The name of the team.
funSettings teamFunSettings Settings to configure use of Giphy, memes, and stickers in the team.
guestSettings teamGuestSettings Settings to configure whether guests can create, update, or delete channels in the team.
internalId string A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
isArchived Boolean Whether this team is in read-only mode.
memberSettings teamMemberSettings Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.
messagingSettings teamMessagingSettings Settings to configure messaging and mentions in the team.
specialization teamSpecialization Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.
summary teamSummary Contains summary information about the team, including number of owners, members, and guests.
tenantId string The ID of the Azure Active Directory tenant.
visibility teamVisibilityType The visibility of the group and team. Defaults to Public.
webUrl string (readonly) A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select **G

teamsApp

Property Type Description
displayName string The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
distributionMethod teamsAppDistributionMethod The method of distribution for the app. Read-only.
externalId string The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
id string The catalog app's generated app ID (different from the developer-provided ID in the Microsoft Teams zip app package.

teamsAppInstallation

Property Type Description
id string A unique ID (not the Teams app ID).

teamsAsyncOperation

Property Type Description
attemptsCount Int32 Number of times the operation was attempted before being marked successful or failed.
createdDateTime DateTimeOffset Time when the operation was created.
error operationError Any error that causes the async operation to fail.
id string Unique operation id.
lastActionDateTime DateTimeOffset Time when the async operation was last updated.
operationType teamsAsyncOperationType Denotes which type of operation is being described.
status teamsAsyncOperationStatus Operation status.
targetResourceId guid The ID of the object that's created or modified as result of this async operation, typically a team.
targetResourceLocation string The location of the object that's created or modified as result of this async operation. This URL should be treated as an opaque value and not parsed into its component paths.

teamsTab

Property Type Description
configuration teamsTabConfiguration Container for custom settings applied to a tab. The tab is considered configured only once this property is set.
displayName string Name of the tab.
id string Identifier that uniquely identifies a specific instance of a channel tab. Read only.
webUrl string Deep link URL of the tab instance. Read only.

teamvisibilitytype

teamworkBot

Property Type Description
id String The ID of the bot associated with the specific teamsAppDefinition. This value is usually a GUID.

timeOff

timeOffItem

Property Type Description
endDateTime DateTimeOffset The end date and time for the timeOffItem. Required. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
startDateTime DateTimeOffset The start date and time for the timeOffItem. Required. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
theme scheduleEntityTheme Supported colors: white; blue; green; purple; pink; yellow; gray; darkBlue; darkGreen; darkPurple; darkPink; darkYellow.
timeOffReasonId string ID of the timeOffReason for this timeOffItem. Required.

timeOffReason

Property Type Description
createdDateTime DateTimeOffset The time stamp on which this timeOffReason was first 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.
displayName String The name of the timeOffReason. Required.
iconType timeOffReasonIconType Supported icon types are: none, car, calendar, running, plane, firstAid, doctor, notWorking, clock, juryDuty, globe, cup, phone, weather, umbrella, piggyBank, dog, cake, trafficCone, pin, sunny. Required.
id String Unique identifier for the time-off reason.
isActive Boolean Indicates whether the timeOffReason can be used when creating new entities or updating existing ones. Required.
lastModifiedBy identitySet The identity that last updated this timeOffReason.
lastModifiedDateTime DateTimeOffset The time stamp on which this **t

timeOffRequest

Property Type Description
endDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
startDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
timeOffReasonId String The reason for the time off.

user

Property Type Description
aboutMe String A freeform text entry field for the user to describe themselves. Returned only on $select.
accountEnabled Boolean true if the account is enabled; otherwise, false. This property is required when a user is created.

Returned only on $select. Supports $filter (eq, ne, not, and in).
ageGroup ageGroup Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information.

Returned only on $select. Supports $filter (eq, ne, not, and in).
assignedLicenses assignedLicense collection The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).
assignedPlans assignedPlan collection The plans that are assigned to the user. Read-only. Not nullable.

Returned only on $select. Supports $filter (eq and not).
birthday DateTimeOffset The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned only on $select.
businessPhones String collection The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory.

Returned by default. Supports $filter (eq, not, ge, le, startsWith).
city String The city in which the user is located. Maximum length is 128 characters.

Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
companyName String The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.

Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
consentProvidedForMinor consentProvidedForMinor Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information.

Returned only on $select. Supports $filter (eq, ne, not, and in).
country String The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters.

Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
createdDateTime DateTimeOffset The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Read-only.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
creationType String Indicates whether the user account was created through one of the following methods:
  • As a regular school or work account (null).
  • As an external account (Invitation).
  • As a local account for an Azure Active Directory B2C tenant (LocalAccount).
  • Through self-service sign-up by an internal user using email verification (EmailVerified).
  • Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).

Read-only.
Returned only on $select. Supports $filter (eq, ne, not, in).
deletedDateTime DateTimeOffset The date and time the user was deleted.

Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
department String The name for the department in which the user works. Maximum length is 64 characters.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).
displayName String The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters.

Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.
employeeHireDate DateTimeOffset The date and time when the user was hired or will start work in case of a future hire.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
employeeId String The employee identifier assigned to the user by the organization. The maximum length is 16 characters.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
employeeOrgData employeeOrgData Represents organization data (e.g. division and costCenter) associated with a user.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
employeeType String Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).
externalUserState String For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.

Returned only on $select. Supports $filter (eq, ne, not , in).
externalUserStateChangeDateTime DateTimeOffset Shows the timestamp for the latest change to the externalUserState property.

Returned only on $select. Supports $filter (eq, ne, not , in).
faxNumber String The fax number of the user.

Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
givenName String The given name (first name) of the user. Maximum length is 64 characters.

Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
hireDate DateTimeOffset The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned only on $select.
Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
id String The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only.

Returned by default. Supports $filter (eq, ne, not, in).
identities objectIdentity collection Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value.

Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.
imAddresses String collection The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only.

Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).
interests String collection A list for the user to describe their interests.

Returned only on $select.
isResourceAccount Boolean Do not use – reserved for future use.
jobTitle String The user's job title. Maximum length is 128 characters.

Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
lastPasswordChangeDateTime DateTimeOffset The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returned only on $select.
legalAgeGroupClassification legalAgeGroupClassification Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information.

Returned only on $select.
licenseAssignmentStates licenseAssignmentState collection State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only.

Returned only on $select.
mail String The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters.
NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).
mailboxSettings mailboxSettings Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone.

Returned only on $select.
mailNickname String The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters.

Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mobilePhone String The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
mySite String The URL for the user's personal site.

Returned only on $select.
officeLocation String The office location in the user's place of business.

Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
onPremisesDistinguishedName String Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

Returned only on $select.
onPremisesDomainName String Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

Returned only on $select.
onPremisesExtensionAttributes onPremisesExtensionAttributes Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15.
  • For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only.
  • For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during creation or update of a user object.
  • For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.

  • Returned only on $select. Supports $filter (eq, ne, not, in).
    onPremisesImmutableId String This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..
    onPremisesLastSyncDateTime DateTimeOffset Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
    onPremisesProvisioningErrors onPremisesProvisioningError collection Errors when using Microsoft synchronization product during provisioning.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    onPremisesSamAccountName String Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only.

    Returned only on $select. Supports $filter (eq including on null values).
    onPremisesSyncEnabled Boolean true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Azure Active Directory (Azure AD). Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    onPremisesUserPrincipalName String Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    otherMails String collection A list of additional email addresses for the user; for example: ["[email protected]", "[email protected]"].
    NOTE: This property cannot contain accent characters.

    Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
    passwordPolicies String Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

    Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).
    passwordProfile passwordProfile Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    pastProjects String collection A list for the user to enumerate their past projects.

    Returned only on $select.
    postalCode String The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    preferredDataLocation String The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
    preferredLanguage String The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)
    preferredName String The preferred name for the user. Not Supported. This attribute returns an empty string.

    Returned only on $select.
    provisionedPlans provisionedPlan collection The plans that are provisioned for the user. Read-only. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
    refreshTokensValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint.

    Returned only on $select. Read-only.
    responsibilities String collection A list for the user to enumerate their responsibilities.

    Returned only on $select.
    schools String collection A list for the user to enumerate the schools they have attended.

    Returned only on $select.
    securityIdentifier String Security identifier (SID) of the user, used in Windows scenarios.

    Read-only. Returned by default.
    Supports $select and $filter (eq, not, ge, le, startsWith).
    showInAddressList Boolean Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
    signInSessionsValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset.

    Returned only on $select.
    skills String collection A list for the user to enumerate their skills.

    Returned only on $select.
    state String The state or province in the user's address. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    streetAddress String The street address of the user's place of business. Maximum length is 1024 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    surname String The user's surname (family name or last name). Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    usageLocation String A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    userPrincipalName String The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is [email protected], where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.
    NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.
    userType String A string value that can be used to classify user types in your directory, such as Member and Guest.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). **N

    webhooks

    In This Article
    Back to top Created by merill | Submit feedback