_objects

References to attached objects like files, tabs, meetings etc.

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.

If the message was sent in a channel, represents identity of the channel.

If the message was sent in a chat, represents the identity of the chat.

Timestamp of when the chat message was created.

Read only. Timestamp at which the chat message was deleted, or null if not deleted.

Read-only. Version number of the chat message.

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.

Details of the sender of the chat message. Can only be set during migration.

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.

The importance of the chat message. The possible values are: normal, high, urgent.

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.

Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed.

List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.

List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message.

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.

Defines the properties of a policy violation set by a data loss prevention (DLP) application.

Reactions for this chat message (for example, Like).

Read-only. ID of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels, not chats.)

The subject of the chat message, in plaintext.

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.

Read-only. Link to the message in Microsoft Teams.

Channel Messages

Timestamp at which the channel was created. Read only.

Optional textual description for the channel.

Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters.

The email address for sending messages to the channel. Read-only.

The channel's unique identifier. Read-only.

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.

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.

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.

Channels

Chat Messages

Specifies the type of chat. Possible values are: group, oneOnOne, meeting, unknownFutureValue.

Date and time at which the chat was created. Read-only.

Date and time at which the chat was renamed or list of members were last changed. Read-only.

Represents details about an online meeting. If the chat isn't associated with an online meeting, the property is empty. Read-only.

The identifier of the tenant in which the chat was created. Read-only.

(Optional) Subject or topic for the chat. Only available for group chats.

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.

The URL for the chat in Microsoft Teams. The URL should be treated as an opaque blob, and not parsed. Read-only.

Chats

The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has owner privileges, the roles property contains owner as one of the values. Similarly, if the member is an in-tenant guest, the roles property contains guest as one of the values. A basic member should not have any values specified in the roles property. An Out-of-tenant external member is assigned the owner role.

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.

Conversation Members

Indicates whether attendees can turn on their camera. Inherited from onlineMeetingBase.

Indicates whether attendees can turn on their microphone. Inherited from onlineMeetingBase.

Specifies the mode of meeting chat. Inherited from onlineMeetingBase.

Specifies if participants are allowed to rename themselves in an instance of the meeting. Inherited from onlineMeetingBase.

Indicates whether Teams reactions are enabled for the meeting. Inherited from onlineMeetingBase.

Specifies who can be a presenter in a meeting. Possible values are listed in the following table. Inherited from onlineMeetingBase.

The content stream of the attendee report of a Microsoft Teams live event. Read-only.

The phone access (dial-in) information for an online meeting. Read-only. Inherited from onlineMeetingBase.

The chat information associated with this online meeting. Inherited from onlineMeetingBase.

The meeting creation time in UTC. Read-only.

The default ID associated with the online meeting. Read-only. Inherited from onlineMeetingBase.

Indicates if this event is a Teams live event.

Indicates whether to announce when callers join or leave. Inherited from onlineMeetingBase.

The join information in the language and locale variant specified in the Accept-Language request HTTP header. Read-only. Inherited from onlineMeetingBase.

Specifies the joinMeetingId, the meeting passcode, and the requirement for the passcode. Once an onlineMeeting is created, the joinMeetingIdSettings can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from onlineMeetingBase.

The join URL of the online meeting. Read-only. Inherited from onlineMeetingBase.

Specifies which participants can bypass the meeting lobby. Inherited from onlineMeetingBase.

The participants associated with the online meeting, including the organizer and the attendees.

Indicates whether to record the meeting automatically. Inherited from onlineMeetingBase.

The recordings of an online meeting. Read-only.

Specifies whether meeting chat history is shared with participants. Possible values are: all, none, unknownFutureValue. Inherited from onlineMeetingBase.

The subject of the online meeting. Inherited from onlineMeetingBase.

The transcripts of an online meeting. Read-only.

The video teleconferencing ID. Read-only. Inherited from onlineMeetingBase.

Specifies whether the client application should apply a watermark a content type. Inherited from onlineMeetingBase.

onlineMeeting

Online Meetings

Configure settings of a class. Available only when the team represents a class.

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.

An optional description for the team. Maximum length: 1024 characters.

Settings to configure team discoverability by others.

Settings to configure use of Giphy, memes, and stickers in the team.

Settings to configure whether guests can create, update, or delete channels in the team.

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.

A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.

If set to true, the team is currently in the owner-only team membership state and not accessible by other team members, such as students.

Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team.

Settings to configure messaging and mentions in the team.

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.

Contains summary information about the team, including number of owners, members, and guests.

The visibility of the group and team. Defaults to Public.

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 Get link to team. This URL should be treated as an opaque blob, and not parsed.

Teams

A freeform text entry field for users to describe themselves.

true if the account is enabled; otherwise, false. This property is required when a user is created.

Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions.

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.

The plans that are assigned to the user. Read-only. Not nullable.

Identifiers that can be used to identify and authenticate a user in non-Azure AD environments. This property can store identifiers for smartcard-based certificates that users use to access on-premises Active Directory deployments or federated access. It can also be used to store the Subject Alternate Name (SAN) that's associated with a Common Access Card (CAC). Nullable.

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

The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced from on-premises directory.

The city where the user is located. Maximum length is 128 characters.

Microsoft realtime communication information related to the user.

The name of the company the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.

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.

The country or region where the user is located; for example, US or UK. Maximum length is 128 characters.

The date and time the user was created in ISO 8601 format and UTC. 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 Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users synced to Microsoft Entra ID before June 2018. Read-only.

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

An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable.

The name of the department where the user works. Maximum length is 64 characters.

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 last name. This property is required when a user is created, and it cannot be cleared during updates. Maximum length is 256 characters.

The date and time when the user was hired or will start work if there is a future hire.

The employee identifier assigned to the user by the organization. The maximum length is 16 characters.

The date and time when the user left or will leave the organization.

Represents organization data (for example, division and costCenter) associated with a user.

Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.

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.

Shows the timestamp for the latest change to the externalUserState property.

The given name (first name) of the user. Maximum length is 64 characters.

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.

The unique identifier for the user. It should be treated as an opaque identifier. Inherited from directoryObject. Not nullable. Read-only.

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. It may contain multiple items with the same signInType value.

The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only.

Identifies the info segments assigned to the user.

A list for users to describe their interests.

Indicates whether the user is pending an exchange mailbox license assignment. Read-only.

true if the user is a member of a restricted management administrative unit, which requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.

The user's job title. Maximum length is 128 characters.

When this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. 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.

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. For more information, see legal age group property definitions.

State of license assignments for this user. It also indicates licenses that are directly assigned and the ones the user inherited through group memberships. Read-only.

The SMTP address for the user, for example, admin@contoso.com. Changes to this property also update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters.

The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters.

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. For more information, see User preferences for languages and regional formats.

The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory.

The office location in the user's place of business. Maximum length is 128 characters.

Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15.

This property associates 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.

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.

Errors when using Microsoft synchronization product during provisioning.

Contains the on-premises sAMAccountName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

Contains the on-premises security identifier (SID) for the user synchronized from on-premises to the cloud. Read-only.

Contains all on-premises Session Initiation Protocol (SIP) information related to the user. Read-only.

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.

Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].

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.

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.

A list for users to enumerate their past projects.

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.

The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.

The preferred language for the user. The preferred language format is based on RFC 4646. The name combines 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'.

The preferred name for the user. Not Supported. This attribute returns an empty string.

The plans that are provisioned for the user. Read-only. Not nullable.

For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. Changes to the mail property also update this collection to include the value as an SMTP address. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while the ones 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.

Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications 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 it happens, the application must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use invalidateAllRefreshTokens to reset.

A list for the user to enumerate their responsibilities.

A list for the user to enumerate the schools they have attended.

Security identifier (SID) of the user, used in Windows scenarios. Read-only.

Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object.

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.

Get the last signed-in date and request ID of the sign-in for a given user. Read-only.

Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications 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 must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset.

A list for the user to enumerate their skills.

The state or province in the user's address. Maximum length is 128 characters.

The street address of the user's place of business. Maximum length is 1024 characters.

The user's surname (family name or last name). Maximum length is 64 characters.

A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable.

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 should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's verified domain collection. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.

A String value that can be used to classify user types in your directory, such as Member and Guest.

Microsoft Teams API Integration Profile

Get better integration infrastructure for your SaaS product today.