ChannelMember.ReadWrite.All

Add and remove members from channels, on behalf of the signed-in user. Also allows changing a member's role, for example from owner to non-owner.

Merill's Note

For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the ChannelMember.ReadWrite.All permission.

If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the Export-MsIdAppConsentGrantReport command. See How To: Run a quick OAuth app audit of your tenant

Category	Application	Delegated
Identifier	35930dcf-aceb-4bd1-b99a-8ffed403c974	0c3e411a-ce45-4cd1-8f30-f99a3efa7b11
DisplayText	Add and remove members from all channels	Add and remove members from channels
Description	Add and remove members from all channels, without a signed-in user. Also allows changing a member's role, for example from owner to non-owner.	Add and remove members from channels, on behalf of the signed-in user. Also allows changing a member's role, for example from owner to non-owner.
AdminConsentRequired	Yes	Yes

Graph Methods

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	DELETE /teams/{id}/channels/{id}/members/{id}
	DELETE /teams/{team-id}/channels/{channel-id}/members/{membership-id}
	DELETE /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}
	GET /chats/{chat-id}/members/{membership-id}
	GET /chats/{id}/members/{id}
	GET /teams/{id}/channels/{id}/members/{id}
	GET /teams/{team-id}/channels/{channel-id}/allMembers
	GET /teams/{team-id}/channels/{channel-id}/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')
	GET /teams/{team-id}/channels/{channel-id}/members
	GET /teams/{team-id}/channels/{channel-id}/members/{membership-id}
	GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams
	GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}
	GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}/allowedMembers
	GET /users/{user-id \| user-principal-name}/chats/{chat-id}/members/{membership-id}
	PATCH /teams/{id}/channels/{id}/members/{id}
	PATCH /teams/{team-id}/channels/{channel-id}/members/{membership-id}
	PATCH /teams/{team-id}/members/{membership-id}
	POST /teams/{id}/channels/{id}/members
	POST /teams/{team-id}/channels/{channel-id}/members

→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)

	Methods
	DELETE /teams/{team-id}/channels/{channel-id}/members/{membership-id}
	DELETE /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}
	GET /chats/{chat-id}/members/{membership-id}
	GET /teams/{team-id}/channels/{channel-id}/allMembers
	GET /teams/{team-id}/channels/{channel-id}/doesUserHaveAccess(userId='@userId',tenantId='@tenantId',userPrincipalName='@userPrincipalName')
	GET /teams/{team-id}/channels/{channel-id}/members
	GET /teams/{team-id}/channels/{channel-id}/members/{membership-id}
	GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams
	GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}
	GET /teams/{team-id}/channels/{channel-id}/sharedWithTeams/{shared-with-channel-team-info-id}/allowedMembers
	GET /users/{user-id \| user-principal-name}/chats/{chat-id}/members/{membership-id}
	PATCH /teams/{id}/channels/{id}/members/{id}
	PATCH /teams/{id}/members/{id}
	PATCH /teams/{team-id}/channels/{channel-id}/members/{membership-id}
	PATCH /teams/{team-id}/members/{membership-id}
	POST /teams/{team-id}/channels/{channel-id}/members

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgChatMember
	Get-MgTeamChannelMember
	Get-MgTeamChannelSharedWithTeam
	Get-MgTeamChannelSharedWithTeamAllowedMember
	Invoke-MgHaveTeamChannel
	Remove-MgTeamChannelSharedWithTeam
	Update-MgTeamMember

→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)

	Commands
	Get-MgBetaChatMember
	Get-MgBetaTeamChannelMember
	Get-MgBetaTeamChannelSharedWithTeam
	Get-MgBetaTeamChannelSharedWithTeamAllowedMember
	Invoke-MgBetaHaveTeamChannel
	Remove-MgBetaTeamChannelSharedWithTeam
	Update-MgBetaTeamMember

Resources

Granting this permission allows the calling application to access (and/or update) the following information in your tenant.

Graph reference: aadUserConversationMember

Property	Type	Description
displayName	string	The display name of the user.
email	string	The email address of the user.
id	String	Read-only. Unique ID of the user.
roles	string collection	The roles of the user such as owner, member, or guest.
tenantId	string	TenantId which the Microsoft Entra user belongs to.
userId	string	The guid of the user.
visibleHistoryStartDateTime	DateTimeOffset	The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

Graph reference: 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.
isArchived	Boolean	Indicates whether the channel is archived. Read-only.
isFavoriteByDefault	Boolean	Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is `false`.
membershipType	channelMembershipType	The type of the channel. Can be set during creation and can't be changed. The possible values are: `standard`, `private`, `unknownFutureValue`, `shared`. The default value is `standard`. Use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `shared`.
tenantId	string	The ID of the Microsoft Entra tenant.
webUrl	String	A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.
summary	channelSummary	Contains summary information about the channel, including number of owners, members, guests, and an indicator for members from other tenants. The **s

Graph reference: chat

Property	Type	Description
chatType	chatType	Specifies the type of chat. Possible values are: `group`, `oneOnOne`, `meeting`, `unknownFutureValue`.
createdDateTime	dateTimeOffset	Date and time at which the chat was created. Read-only.
id	String	The chat's unique identifier. Read-only.
isHiddenForAllMembers	Boolean	Indicates whether the chat is hidden for all its members. Read-only.
lastUpdatedDateTime	dateTimeOffset	Date and time at which the chat was renamed or the list of members was last changed. Read-only.
onlineMeetingInfo	teamworkOnlineMeetingInfo	Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. Read-only.
tenantId	String	The identifier of the tenant in which the chat was created. Read-only.
topic	String	(Optional) Subject or topic for the chat. Only available for group chats.
viewpoint	chatViewpoint	Represents caller-specific information about the chat, such as the last message read date and time. This property is populated only when the request is made in a delegated context.
webUrl	String	The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.

Graph reference: chatMessage

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

Graph reference: conversationMember

Property	Type	Description
displayName	string	The display name of the user.
id	String	Read-only. Unique ID of the user.
roles	string collection	The roles for that user. This property contains more qualifiers only when relevant - for example, if the member has `owner` privileges, the roles property contains `owner` as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains `guest` as one of the values. A basic member shouldn't have any values specified in the roles property. An Out-of-tenant external member is assigned the `owner` role.
visibleHistoryStartDateTime	DateTimeOffset	The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.

Graph reference: sharedWithChannelTeamInfo

Property	Type	Description
displayName	String	The name of the team. Inherited from teamInfo.
id	String	The unique identifier for the team. Read-only.
isHostTeam	Boolean	Indicates whether the team is the host of the channel.
tenantId	String	The ID of the Microsoft Entra tenant. Inherited from teamInfo.

Graph reference: team

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

Graph reference: user

Property	Type	Description
aboutMe	String	A freeform text entry field for the user to describe themselves. Returned only on `$select`.
accountEnabled	Boolean	`true` if the account is enabled; otherwise, `false`. This property is required when a user is created. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, and `in`).
ageGroup	ageGroup	Sets the age group of the user. Allowed values: `null`, `Minor`, `NotAdult`, and `Adult`. For more information, see legal age group property definitions. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, and `in`).
assignedLicenses	assignedLicense collection	The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Returned only on `$select`. Supports `$filter` (`eq`, `not`, `/$count eq 0`, `/$count ne 0`).
assignedPlans	assignedPlan collection	The plans that are assigned to the user. Read-only. Not nullable. Returned only on `$select`. Supports `$filter` (`eq` and `not`).
birthday	DateTimeOffset	The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is `2014-01-01T00:00:00Z`. Returned only on `$select`.
businessPhones	String collection	The telephone numbers for the user. NOTE: Although it's a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`).
city	String	The city where the user is located. Maximum length is 128 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
companyName	String	The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
consentProvidedForMinor	consentProvidedForMinor	Sets whether consent was obtained for minors. Allowed values: `null`, `Granted`, `Denied`, and `NotRequired`. For more information, see legal age group property definitions. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, and `in`).
country	String	The country or region where the user is located; for example, `US` or `UK`. Maximum length is 128 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
createdDateTime	DateTimeOffset	The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is `null` for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).
creationType	String	Indicates whether the user account was created through one of the following methods: 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 a guest 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`).
customSecurityAttributes	customSecurityAttributeValue	An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). The filter value is case-sensitive. To read this property, the calling app must be assigned the CustomSecAttributeAssignment.Read.All permission. To write this property, the calling app must be assigned the CustomSecAttributeAssignment.ReadWrite.All permissions. To read or write this property in delegated scenarios, the admin must be assigned the Attribute Assignment Administrator role.
deletedDateTime	DateTimeOffset	The date and time the user was deleted. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`).
department	String	The name of the department in which the user works. Maximum length is 64 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, and `eq` on `null` values).
displayName	String	The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$orderby`, and `$search`.
employeeHireDate	DateTimeOffset	The date and time when the user was hired or will start work in a future hire. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).
employeeLeaveDateTime	DateTimeOffset	The date and time when the user left or will leave the organization. To read this property, the calling app must be assigned the User-LifeCycleInfo.Read.All permission. To write this property, the calling app must be assigned the User.Read.All and User-LifeCycleInfo.ReadWrite.All permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: Lifecycle Workflows Administrator (least privilege), Global Reader. To write this property in delegated scenarios, the admin needs the Global Administrator role. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). For more information, see Configure the employeeLeaveDateTime property for a user.
employeeId	String	The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
employeeOrgData	employeeOrgData	Represents organization data (for example, division and costCenter) associated with a user. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).
employeeType	String	Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`).
externalUserState	String	For a guest invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be `PendingAcceptance` or `Accepted`, or `null` for all other users. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `in`).
externalUserStateChangeDateTime	DateTimeOffset	Shows the timestamp for the latest change to the externalUserState property. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `in`).
faxNumber	String	The fax number of the user. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
givenName	String	The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
hireDate	DateTimeOffset	The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is `2014-01-01T00:00:00Z`. Returned only on `$select`. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
id	String	The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `in`).
identities	objectIdentity collection	Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on `$select`. Supports `$filter` (`eq`) with limitations.
imAddresses	String collection	The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`).
interests	String collection	A list for the user to describe their interests. Returned only on `$select`.
isResourceAccount	Boolean	Don't use – reserved for future use.
jobTitle	String	The user's job title. Maximum length is 128 characters. Returned by default. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
lastPasswordChangeDateTime	DateTimeOffset	The time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Returned only on `$select`.
legalAgeGroupClassification	legalAgeGroupClassification	Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: `null`, `Undefined`, `MinorWithOutParentalConsent`, `MinorWithParentalConsent`, `MinorNoParentalConsentRequired`, `NotAdult`, and `Adult`. For more information, see legal age group property definitions. Returned only on `$select`.
licenseAssignmentStates	licenseAssignmentState collection	State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on `$select`.
mail	String	The SMTP address for the user, for example, `[email protected]`. Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, and `eq` on `null` values).
mailboxSettings	mailboxSettings	Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on `$select`.
mailNickname	String	The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
mobilePhone	String	The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values) and `$search`.
mySite	String	The URL for the user's site. Returned only on `$select`.
officeLocation	String	The office location in the user's place of business. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
onPremisesDistinguishedName	String	Contains the on-premises Active Directory `distinguished name` or `DN`. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on `$select`.
onPremisesDomainName	String	Contains the on-premises `domainFQDN`, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on `$select`.
onPremisesExtensionAttributes	onPremisesExtensionAttributes	Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. 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 the 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 Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't be used when specifying this property. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`).
onPremisesLastSyncDateTime	DateTimeOffset	Indicates the last time at which the object was synced with the on-premises directory; for example: `2013-02-16T03:04:54Z`. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`).
onPremisesProvisioningErrors	onPremisesProvisioningError collection	Errors when using Microsoft synchronization product during provisioning. Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`).
onPremisesSamAccountName	String	Contains the on-premises `samAccountName` synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`).
onPremisesSecurityIdentifier	String	Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on `$select`. Supports `$filter` (`eq` including on `null` values).
onPremisesSyncEnabled	Boolean	`true` if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Microsoft Entra ID. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values).
onPremisesUserPrincipalName	String	Contains the on-premises `userPrincipalName` synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`).
otherMails	String collection	A list of other email addresses for the user; for example: `["[email protected]", "[email protected]"]`. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can't contain accent characters. Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, `/$count eq 0`, `/$count ne 0`).
passwordPolicies	String	Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two might be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`. Returned only on `$select`. For more information on the default password policies, see Microsoft Entra password policies. Supports `$filter` (`ne`, `not`, and `eq` on `null` values).
passwordProfile	passwordProfile	Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). To update this property: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that's allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.
pastProjects	String collection	A list for the user to enumerate their past projects. Returned only on `$select`.
postalCode	String	The postal code for the user's postal address. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
preferredDataLocation	String	The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
preferredLanguage	String	The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values)
preferredName	String	The preferred name for the user. Not Supported. This attribute returns an empty string. Returned only on `$select`.
provisionedPlans	provisionedPlan collection	The plans that are provisioned for the user. Read-only. Not nullable. Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`).
proxyAddresses	String collection	For example: `"SMTP: [email protected]", "smtp: [email protected]"]`. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with `SMTP` (capitalized) is the primary proxy address, while those addresses prefixed with `smtp` are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`, `endsWith`, `/$count eq 0`, `/$count ne 0`).
refreshTokensValidFromDateTime	DateTimeOffset	Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on `$select`. Read-only.
responsibilities	String collection	A list for the user to enumerate their responsibilities. Returned only on `$select`.
serviceProvisioningErrors	serviceProvisioningError collection	Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports `$filter` (`eq`, `not`, for isResolved and serviceInstance).
schools	String collection	A list for the user to enumerate the schools they attended. Returned only on `$select`.
securityIdentifier	String	Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports `$select` and `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`).
showInAddressList	Boolean	Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
signInActivity	signInActivity	Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`) but not with any other filterable properties. Note: Details for this property require a Microsoft Entra ID P1 or P2 license and the AuditLog.Read.All permission. This property isn't returned for a user who never signed in or last signed in before April 2020.
signInSessionsValidFromDateTime	DateTimeOffset	Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on `$select`.
skills	String collection	A list for the user to enumerate their skills. Returned only on `$select`.
state	String	The state or province in the user's address. Maximum length is 128 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
streetAddress	String	The street address of the user's place of business. Maximum length is 1,024 characters. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
surname	String	The user's surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
usageLocation	String	A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: `US`, `JP`, and `GB`. Not nullable. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).
userPrincipalName	String	The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. NOTE: This property can't contain accent characters. Only the following characters are allowed `A - Z`, `a - z`, `0 - 9`, `' . - _ ! # ^ ~`. For the complete list of allowed characters, see username policies. Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`) and `$orderby`.
userType	String	A string value that can be used to classify user types in your directory. The possible values are `Member` and `Guest`. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). **N

Graph reference: userIdentity

Property	Type	Description
displayName	String	The display name of the identity. This might not always be available or up-to-date.
id	String	Unique identifier for the identity. Nullable. When the unique identifier is unavailable, the displayName property is provided for the identity, but the id property isn't included in the response.
ipAddress	String	Indicates the client IP address associated with the user performing the activity (audit log only).
userPrincipalName	String	The **u

Table of Contents

ChannelMember.ReadWrite.All

Graph Methods

Resources