Directory.Read.All
Allows the app to read data in your organization's directory, such as users, groups and apps.
Caution
Directory permissions grant broad access to directory (Microsoft Entra ID) resources such as user, group, and device in an organization. Whenever possible, choose permissions specific to these resources and avoid using directory permissions.
Directory permissions might be deprecated in the future.
Before December 3rd, 2020, when the application permission Directory.Read.All was granted, the Directory Readers directory role was also assigned to the app's service principal. This directory role isn't removed automatically when the associated application permissions are revoked. To remove an application's access to read or write to the directory, customers must also remove any directory roles that were granted to the application.
A service update disabling this behavior began rolling out on December 3rd, 2020. Deployment to all customers completed on January 11th, 2021. Directory roles are no longer automatically assigned when application permissions are granted.
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
Directory.Read.Allpermission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReportcommand. See How To: Run a quick OAuth app audit of your tenant
| Category | Application | Delegated |
|---|---|---|
| Identifier | 7ab1d382-f21e-4acd-a863-ba3e13f7da61 | 06da0dbc-49e2-44d2-8312-53f166ab848a |
| DisplayText | Read directory data | Read directory data |
| Description | Allows the app to read data in your organization's directory, such as users, groups and apps, without a signed-in user. | Allows the app to read data in your organization's directory, such as users, groups and apps. |
| 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 | |
|---|---|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods | |
|---|---|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadBasic and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadBasic and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All |
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
AuditLog.Read.All and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadBasic and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
EduRoster.Read and Directory.Read.All ▪️ EduRoster.Read.All and Directory.Read.All ▪️ EduRoster.ReadBasic and Directory.Read.All ▪️ EduRoster.ReadWrite.All and Directory.Read.All ▪️ EduRoster.Write and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
AppRoleAssignment.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All ▪️ Application.ReadWrite.OwnedBy and Directory.Read.All ▪️ Directory.Read.All and Application.ReadWrite.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All |
|
Application.ReadWrite.All and Directory.Read.All |
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- adminConsentRequestPolicy
- administrativeUnit
- appCredentialSignInActivity
- application
- appRoleAssignment
- basetask
- basetasklist
- channel
- claimsMappingPolicy
- companySubscription
- contact
- Contract
- credential
- delegatedPermissionClassification
- device
- directoryAudit
- directoryObject
- directoryObjectPartnerReference
- directoryRole
- directoryRoleTemplate
- directorySetting
- directorySettingTemplate
- domain
- educationSchool
- event
- extensionproperty
- group
- groupLifecyclePolicy
- groups-overview
- groupSetting
- groupSettingTemplate
- homeRealmDiscoveryPolicy
- licenseDetails
- message
- oAuth2PermissionGrant
- opentypeextension
- organization
- orgContact
- passwordSingleSignOnCredentialSet
- permissionGrantConditionSet
- permissionGrantPolicy
- post
- provisioningObjectSummary
- remoteDesktopSecurityConfiguration
- scopedRoleMembership
- servicePrincipal
- servicePrincipalSignInActivity
- signIn
- subscribedSku
- targetDeviceGroup
- team
- teamsApp
- teamsAppInstallation
- teamsLicensingDetails
- teamsTab
- teamworkBot
- todoTask
- todoTaskList
- tokenIssuancePolicy
- tokenLifetimePolicy
- unifiedRoleAssignment
- unifiedRoleDefinition
- usageRight
- user
- users
Graph reference: adminConsentRequestPolicy
| Property | Type | Description |
|---|---|---|
| isEnabled | Boolean | Specifies whether the admin consent request feature is enabled or disabled. Required. |
| notifyReviewers | Boolean | Specifies whether reviewers will receive notifications. Required. |
| remindersEnabled | Boolean | Specifies whether reviewers will receive reminder emails. Required. |
| requestDurationInDays | Int32 | Specifies the duration the request is active before it automatically expires if no decision is applied. |
| reviewers | accessReviewReviewerScope collection | The list of reviewers for the admin consent. Required. |
| version | Int32 | Specifies the version of this policy. When the policy is updated, this version is updated. Read-only. |
Graph reference: 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). |
| membershipRule | String | The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see Manage rules for dynamic membership groups in Microsoft Entra ID. |
| membershipRuleProcessingState | String | Controls whether the dynamic membership rule is actively processed. Set to On to activate the dynamic membership rule, or Paused to stop updating membership dynamically. |
| membershipType | String | Indicates the membership type for the administrative unit. The possible values are: dynamic, assigned. If not set, the default value is null and the default behavior is assigned. |
| visibility | String | Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set, the default value is null and the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit. |
Graph reference: appCredentialSignInActivity
| Property | Type | Description |
|---|---|---|
| appId | String | The globally unique appId (also called client ID on the Microsoft Entra admin center) of the credentialed application. |
| appObjectId | String | The ID of the credential application instance. |
| createdDateTime | DateTimeOffset | The date and time when the credential was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| credentialOrigin | applicationKeyOrigin | The type the key credential originated from. Possible values are: application, servicePrincipal, unknownFutureValue. |
| expirationDateTime | DateTimeOffset | The date and time when the credential is set to expire. 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 | The unique identifier of the appCredentialSignInActivity instance in the response. |
| keyId | String | The key ID of the credential. |
| keyType | applicationKeyType | Specifies the key type. The possible values are: clientSecret, certificate, unknownFutureValue. |
| keyUsage | applicationKeyUsage | Specifies what the key was used for. The possible values are: sign, verify, unknownFutureValue. |
| resourceId | String | The ID of the accessed resource. |
| servicePrincipalObjectId | String | The ID of the service principal. |
| signInActivity | signInActivity | The sign-in activity of the credential across all flows. |
Graph reference: 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 can set the addIns property for its "FileHandler" functionality. This lets services like Microsoft 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 Microsoft Entra ID. Not nullable. Read-only. Alternate key. Supports $filter (eq). |
| applicationTemplateId | String | Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the app wasn't created from an application template. |
| 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 1,024 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 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 Microsoft Entra roles), All (this gets all of the security groups, distribution groups, and Microsoft Entra 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 Microsoft Entra admin center. 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 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://<appId>, or specify a more readable URI like https://contoso.com/api. For more information on valid identifierUris patterns and best practices, see Microsoft Entra 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 Microsoft Entra 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 Microsoft Entra ID can't determine the client application type. For example, the ROPC flow where it's configured without specifying a redirect URI. In those cases, Microsoft Entra ID 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. |
| nativeAuthenticationApisEnabled | nativeAuthenticationApisEnabled | Specifies whether the Native Authentication APIs are enabled for the application. The possible values are: none and all. Default is none. For more information, see Native Authentication. |
| notes | String | Notes relevant for the management of the application. |
| oauth2RequiredPostResponse | Boolean | Specifies whether, as part of OAuth 2.0 token requests, Microsoft Entra ID 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 Microsoft Entra 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). |
| requestSignatureVerification | requestSignatureVerification | Specifies whether this application requires Microsoft Entra ID to verify the signed authentication requests. |
| 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. |
| servicePrincipalLockConfiguration | servicePrincipalLockConfiguration | Specifies whether sensitive properties of a multitenant application should be locked for editing after the application is provisioned in a tenant. Nullable. null by default. |
| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg (default), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, 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 might 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. Strings added here will also appear in the tags property of any associated service principals. Supports $filter (eq, not, ge, le, startsWith) and $search. |
| tokenEncryptionKeyId | String | Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID 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. |
| uniqueName | String | The unique identifier that can be assigned to an application and used as an alternate key. Immutable. Read-only. |
| 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. |
Graph reference: appRoleAssignment
| Property | Type | Description |
|---|---|---|
| appRoleId | Guid | The identifier (id) for the app role that's assigned to the principal. This app role must be exposed in the appRoles property on the resource application's service principal (resourceId). If the resource application hasn't declared any app roles, a default app role ID of 00000000-0000-0000-0000-000000000000 can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. |
| createdDateTime | DateTimeOffset | The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| deletedDateTime | DateTimeOffset | The date and time when the app role assignment was deleted. Always null for an appRoleAssignment object that hasn't been deleted. Inherited from directoryObject. |
| id | String | A unique identifier for the appRoleAssignment key. Not nullable. Read-only. |
| principalDisplayName | String | The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports $filter (eq and startswith). |
| principalId | Guid | The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create. |
| principalType | String | The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only. |
| resourceDisplayName | String | The display name of the resource app's service principal to which the assignment is made. |
| resourceId | Guid | The unique identifier (**i |
Graph reference: basetask
| Property | Type | Description |
|---|---|---|
| textBody | String | The task body in text format that typically contains information about the task. |
| bodyLastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| completedDateTime | DateTimeOffset | The date when the task was finished. |
| createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| displayName | String | The name of the task. |
| dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
| id | String | Unique identifier for the task. By default, this value will not change if a task is moved from one list to another. |
| importance | importance | The importance of the task. Possible values are: low, normal, high. The possible values are: low, normal, high. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| viewpoint | taskViewpoint | Properties that are personal to a user such as reminderDateTime and categories. |
| recurrence | patternedRecurrence | The recurrence pattern for the task. |
| startDateTime | dateTimeTimeZone | The date in the specified time zone when the task is to begin. |
| status | taskStatus_v2 | Indicates the state or progress of the task. Possible values are: notStarted, inProgress, completed,unknownFutureValue. |
Graph reference: basetasklist
| Property | Type | Description |
|---|---|---|
| displayName | String | The name of the task list. |
| id | String | The identifier of the task list, unique in the user's mailbox. Read-only. |
Graph reference: channel
| Property | Type | Description |
|---|---|---|
| createdDateTime | dateTimeOffset | Read only. Timestamp at which the channel was created. |
| description | String | Optional textual description for the channel. |
| displayName | String | Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters. |
| String | The email address for sending messages to the channel. Read-only. | |
| id | String | The channel's unique identifier. Read-only. |
| isArchived | Boolean | Indicates whether the channel is archived. Read-only. |
| isFavoriteByDefault | Boolean | Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false. |
| membershipType | channelMembershipType | The type of the channel. Can be set during creation and can't be changed. The possible values are: standard, private, unknownFutureValue, shared. The default value is standard. 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 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: claimsMappingPolicy
| Property | Type | Description |
|---|---|---|
| definition | String collection | A string collection containing a JSON string that defines the rules and settings for this policy. For more information about the JSON schema for this property, see Properties of a claims-mapping policy definition. Required. |
| displayName | String | Display name for this policy. Required. |
| id | String | Unique identifier for this policy. Read-only. |
| isOrganizationDefault | Boolean | Ignore this property. The claims-mapping policy can only be applied to service principals and can't be set globally for the organization. |
Graph reference: companySubscription
| Property | Type | Description |
|---|---|---|
| commerceSubscriptionId | String | The ID of this subscription in the commerce system. Alternate key. |
| createdDateTime | DateTimeOffset | The date and time when this subscription 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. |
| id | String | The unique ID for this subscription. Inherited from entity. |
| isTrial | Boolean | Whether the subscription is a free trial or purchased. |
| nextLifecycleDateTime | DateTimeOffset | The date and time when the subscription will move to the next state (as defined by the status property) if not renewed by the tenant. 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. |
| ownerId | String | The object ID of the account admin. |
| ownerTenantId | String | The unique identifier for the Microsoft partner tenant that created the subscription on a customer tenant. |
| ownerType | String | Indicates the entity that ownerId belongs to, for example, "User". |
| serviceStatus | servicePlanInfo collection | The provisioning status of each service included in this subscription. |
| skuId | String | The object ID of the SKU associated with this subscription. |
| skuPartNumber | String | The SKU associated with this subscription. |
| status | String | The status of this subscription. Possible values are: Enabled, Deleted, Suspended, Warning, LockedOut. |
| totalLicenses | Int32 | The number of licenses included in this subscription. |
Graph reference: contact
| Property | Type | Description |
|---|---|---|
| assistantName | String | The name of the contact's assistant. |
| birthday | DateTimeOffset | The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| businessAddress | PhysicalAddress | The contact's business address. |
| businessHomePage | String | The business home page of the contact. |
| businessPhones | String collection | The contact's business phone numbers. |
| categories | String collection | The categories associated with the contact. |
| changeKey | String | Identifies the version of the contact. Every time the contact is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. |
| children | String collection | The names of the contact's children. |
| companyName | String | The name of the contact's company. |
| createdDateTime | DateTimeOffset | The time the contact was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| department | String | The contact's department. |
| displayName | String | The contact's display name. You can specify the display name in a create or update operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an update operation. |
| emailAddresses | EmailAddress collection | The contact's email addresses. |
| fileAs | String | The name the contact is filed under. |
| generation | String | The contact's suffix. |
| givenName | String | The contact's given name. |
| homeAddress | PhysicalAddress | The contact's home address. |
| homePhones | String collection | The contact's home phone numbers. |
| id | String | The contact's unique identifier. !INCLUDE [outlook-beta-id] Read-only. |
| imAddresses | String collection | The contact's instant messaging (IM) addresses. |
| initials | String | The contact's initials. |
| jobTitle | String | The contact’s job title. |
| lastModifiedDateTime | DateTimeOffset | The time the contact was modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| manager | String | The name of the contact's manager. |
| middleName | String | The contact's middle name. |
| mobilePhone | String | The contact's mobile phone number. |
| nickName | String | The contact's nickname. |
| officeLocation | String | The location of the contact's office. |
| otherAddress | PhysicalAddress | Other addresses for the contact. |
| parentFolderId | String | The ID of the contact's parent folder. |
| personalNotes | String | The user's notes about the contact. |
| profession | String | The contact's profession. |
| spouseName | String | The name of the contact's spouse/partner. |
| surname | String | The contact's surname. |
| title | String | The contact's title. |
| yomiCompanyName | String | The phonetic Japanese company name of the contact. |
| yomiGivenName | String | The phonetic Japanese given name (first name) of the contact. |
| yomiSurname | String | The phonetic Japanese surname (last name) of the contact. |
Graph reference: Contract
| Property | Type | Description |
|---|---|---|
| contractType | String | Type of contract. Possible values are: SyndicationPartner, BreadthPartner, ResellerPartner. See more in the table below. |
| customerId | Guid | The unique identifier for the customer tenant referenced by this partnership. Corresponds to the id property of the customer tenant's organization resource. |
| defaultDomainName | String | A copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's default domain name changes. |
| displayName | String | A copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It is not automatically updated if the customer tenant's display name changes. |
| id | String | The unique identifier for the partnership. Key, read-only |
Graph reference: credential
| Property | Type | Description |
|---|---|---|
| fieldId | String | The name of the field for this credential. e.g, username or password or phoneNumber. This is defined by the application. Must match what is in the html field on singleSignOnSettings/password object. |
| type | String | The type for this credential. Valid values: username, password, or other. |
| value | String | The value for this credential. e.g, mysuperhiddenpassword. Note the value for passwords is write-only, the value can never be read back. |
Graph reference: delegatedPermissionClassification
| Property | Type | Description |
|---|---|---|
| classification | permissionClassificationType | The classification value. Possible values: low, medium (preview), high (preview). Doesn't support $filter. |
| id | String | A unique identifier for the delegatedPermissionClassification Key. Not nullable. Read-only. |
| permissionId | String | The unique identifier (id) for the delegated permission listed in the oauth2PermissionScopes collection of the servicePrincipal. Required on create. Doesn't support $filter. |
| permissionName | String | The claim value (**v |
Graph reference: 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 with at least the Cloud Device Administrator role 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. |
| deviceCategory | String | User-defined property set by Intune to automatically add devices to groups and simplify managing devices. |
| deviceId | String | Unique identifier set by Azure Device Registration Service at the time of registration. This alternate key can be used to reference the device object. Supports $filter (eq, ne, not, startsWith). |
| deviceMetadata | String | For internal use only. Set to null. |
| deviceOwnership | String | Ownership of the device. Intune sets this property. Possible values are: unknown, company, personal. |
| 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. |
| enrollmentProfileName | String | Enrollment profile applied to the device. For example, Apple Device Enrollment Profile, Device enrollment - Corporate device identifiers, or Windows Autopilot profile name. This property is set by Intune. |
| enrollmentType | String | Enrollment type of the device. Intune sets this property. Possible values are: unknown, userEnrollment, deviceEnrollmentManager, appleBulkWithUser, appleBulkWithoutUser, windowsAzureADJoin, windowsBulkUserless, windowsAutoEnrollment, windowsBulkAzureDomainJoin, windowsCoManagement, windowsAzureADJoinUsingDeviceAuth,appleUserEnrollment, appleUserEnrollmentWithServiceAccount. NOTE: This property might return other values apart from those listed. |
| extensionAttributes | onPremisesExtensionAttributes | Contains extension attributes 1-15 for the device. The individual extension attributes aren't selectable. These properties are mastered in the cloud and can be set during creation or update of a device object in Microsoft Entra ID. 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. |
| isRooted | Boolean | true if the device is rooted or jail-broken. This property can only be updated by Intune. |
| managementType | String | The management channel of the device. This property is set by Intune. Possible values are: eas, mdm, easMdm, intuneClient, easIntuneClient, configurationManagerClient, configurationManagerClientMdm, configurationManagerClientMdmEas, unknown, jamf, googleCloudDevicePolicyController. |
| 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). |
| onPremisesSecurityIdentifier | String | The on-premises security identifier (SID) for the user who was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq). |
| 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. |
| registrationDateTime | DateTimeOffset | Date and time of when the device was registered. 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. |
| 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 |
Graph reference: directoryAudit
| Property | Type | Description |
|---|---|---|
| activityDateTime | DateTimeOffset | Indicates the date and time the activity was performed. The Timestamp type is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ge, le) and $orderby. |
| activityDisplayName | String | Indicates the activity name or the operation name (examples: "Create User" and "Add member to group"). For a list of activities logged, refer to Microsoft Entra audit log categories and activities. Supports $filter (eq, startswith). |
| additionalDetails | keyValue collection | Indicates additional details on the activity. |
| category | String | Indicates which resource category that's targeted by the activity. For example: UserManagement, GroupManagement, ApplicationManagement, RoleManagement. For a list of categories for activities logged, refer to Microsoft Entra audit log categories and activities. |
| correlationId | Guid | Indicates a unique ID that helps correlate activities that span across various services. Can be used to trace logs across services. Supports $filter (eq). |
| id | String | Indicates the unique ID for the activity. This is a GUID. Supports $filter (eq). |
| initiatedBy | auditActivityInitiator | Indicates information about the user or app initiated the activity. Supports $filter (eq) for user/id, user/displayName, user/userPrincipalName, app/appId, app/displayName; and $filter (startswith) for user/userPrincipalName. |
| loggedByService | String | Indicates information on which service initiated the activity (For example: Self-service Password Management, Core Directory, B2C, Invited Users, Microsoft Identity Manager, Privileged Identity Management. Supports $filter (eq). |
| operationType | String | Indicates the type of operation that was performed. The possible values include but are not limited to the following: Add, Assign, Update, Unassign, and Delete. |
| result | operationResult | Indicates the result of the activity. Possible values are: success, failure, timeout, unknownFutureValue. |
| resultReason | String | Indicates the reason for failure if the result is failure or timeout. |
| targetResources | targetResource collection | Indicates information on which resource was changed due to the activity. Target Resource Type can be User, Device, Directory, App, Role, Group, Policy or Other. Supports $filter (eq) for **i |
Graph reference: 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 |
Graph reference: directoryObjectPartnerReference
| Property | Type | Description |
|---|---|---|
| description | String | Description of the object returned. Read-only. |
| displayName | String | Name of directory object being returned, like group or application. Read-only. |
| externalPartnerTenantId | Guid | The tenant identifier for the partner tenant. Read-only. |
| id | String | The unique identifier for the resource. Inherited from directoryObject. Read-only. |
| objectType | String | The type of the referenced object in the partner tenant. Read-only. |
Graph reference: directoryRole
| Property | Type | Description |
|---|---|---|
| description | String | The description for the directory role. Read-only. Supports $filter (eq), $search, $select. |
| displayName | String | The display name for the directory role. Read-only. Supports $filter (eq), $search, $select. |
| id | String | The unique identifier for the directory role. Inherited from directoryObject. Key, Not nullable, Read-only. Supports $filter (eq), $select. |
| roleTemplateId | String | The **i |
Graph reference: directoryRoleTemplate
| Property | Type | Description |
|---|---|---|
| description | String | The description to set for the directory role. Read-only. |
| displayName | String | The display name to set for the directory role. Read-only. |
| id | String | The unique identifier for the template. Inherited from directoryObject. You specify the **i |
Graph reference: 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. |
Graph reference: 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. |
Graph reference: domain
| Property | Type | Description |
|---|---|---|
| authenticationType | String | Indicates the configured authentication type for the domain. The value is either Managed or Federated. Managed indicates a cloud managed domain where Microsoft Entra ID performs user authentication. Federated indicates authentication is federated with an identity provider such as the tenant's on-premises Active Directory via Active Directory Federation Services. Not nullable. To update this property in delegated scenarios, the calling app must be assigned the Directory.AccessAsUser.All delegated permission. |
| availabilityStatus | String | This property is always null except when the verify action is used. When the verify action is used, a domain entity is returned in the response. The availabilityStatus property of the domain entity in the response is either AvailableImmediately or EmailVerifiedDomainTakeoverScheduled. |
| id | String | The fully qualified name of the domain. Key, immutable, not nullable, unique. |
| isAdminManaged | Boolean | The value of the property is false if the DNS record management of the domain is delegated to Microsoft 365. Otherwise, the value is true. Not nullable |
| isDefault | Boolean | true if this is the default domain that is used for user creation. There's only one default domain per company. Not nullable. |
| isInitial | Boolean | true if this is the initial domain created by Microsoft Online Services (contoso.com). There's only one initial domain per company. Not nullable |
| isRoot | Boolean | true if the domain is a verified root domain. Otherwise, false if the domain is a subdomain or unverified. Not nullable. |
| isVerified | Boolean | true if the domain completed domain ownership verification. Not nullable. |
| passwordNotificationWindowInDays | Int32 | Specifies the number of days before a user receives notification that their password expires. If the property isn't set, a default value of 14 days is used. |
| passwordValidityPeriodInDays | Int32 | Specifies the length of time that a password is valid before it must be changed. If the property isn't set, a default value of 90 days is used. |
| state | domainState | Status of asynchronous operations scheduled for the domain. |
| supportedServices | String collection | The capabilities assigned to the domain. Can include 0, 1 or more of following values: Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune. The values that you can add or remove using the API include: Email, OfficeCommunicationsOnline, Yammer. Not nullable. |
Graph reference: educationSchool
| Property | Type | Description |
|---|---|---|
| address | physicalAddress | Address of the school. |
| createdBy | identitySet | Entity who created the school. |
| description | String | Description of the school. Inherited from educationOrganization. |
| displayName | String | Display name of the school. Inherited from educationOrganization. |
| externalId | String | ID of school in syncing system. |
| externalPrincipalId | String | ID of principal in syncing system. |
| externalSource | educationExternalSource | Source where this organization was created from. Inherited from educationOrganization. Possible values are: sis, manual. |
| externalSourceDetail | String | The name of the external source this resource was generated from. |
| highestGrade | String | Highest grade taught. |
| id | String | Object identifier. Inherited from entity. |
| lowestGrade | String | Lowest grade taught. |
| phone | String | Phone number of school. |
| principalEmail | String | Email address of the principal. |
| principalName | String | Name of the principal. |
| schoolNumber | String | School Number. |
Graph reference: event
| Property | Type | Description |
|---|---|---|
| allowNewTimeProposals | Boolean | true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. 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. |
Graph reference: extensionproperty
| Property | Type | Description |
|---|---|---|
| appDisplayName | String | Display name of the application object on which this extension property is defined. Read-only. |
| dataType | String | Specifies the data type of the value the extension property can hold. Following values are supported.
|
| deletedDateTime | DateTimeOffset | Date and time when this object was deleted. Always null when the object hasn't been deleted. Inherited from directoryObject. |
| isSyncedFromOnPremises | Boolean | Indicates if this extension property was synced from on-premises active directory using Microsoft Entra Connect. Read-only. |
| name | String | Name of the extension property. Not nullable. Supports $filter (eq). |
| isMultiValued | Boolean | Defines the directory extension as a multi-valued property. When true, the directory extension property can store a collection of objects of the dataType; for example, a collection of string types such as "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_jobGroupTracker": ["String 1", "String 2"]. The default value is false. Supports $filter (eq). |
| targetObjects | String collection | Following values are supported. Not nullable.
|
Graph reference: group
| Property | Type | Description |
|---|---|---|
| allowExternalSenders | Boolean | Indicates if people external to the organization can send messages to the group. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}). |
| assignedLabels | assignedLabel collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role. |
| assignedLicenses | assignedLicense collection | The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only. |
| autoSubscribeNewMembers | Boolean | Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}). |
| classification | String | Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith). |
| createdDateTime | DateTimeOffset | Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. |
| deletedDateTime | DateTimeOffset | For some Microsoft Entra objects (user, group, application), if the object is deleted, it's first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null. If the object is restored, this property is updated to null. Inherited from directoryObject. |
| description | String | An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. |
| displayName | String | The display name for the group. This property is required when a group is created and can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. |
| expirationDateTime | DateTimeOffset | Timestamp of when the group is set to expire. It's null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only. |
| groupTypes | String collection | Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not). |
| hasMembersWithLicenseErrors | Boolean | Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq). |
| hideFromAddressLists | Boolean | True if the group isn't displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}). |
| hideFromOutlookClients | Boolean | True if the group isn't displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}). |
| id | String | The unique identifier for the group. Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in). |
| isArchived | Boolean | When a group is associated with a team, this property determines whether the team is in read-only mode. To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs. |
| isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group can't be a dynamic group (that is, groupTypes can't contain DynamicMembership). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignments Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not). |
| isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}). |
| licenseProcessingState | String | Indicates the status of the group license assignment to all group members. The default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only. |
| String | The SMTP address for the group, for example, "[email protected]". Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
|
| mailEnabled | Boolean | Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not). |
| mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () \ [] " ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| membershipRule | String | The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith). |
| membershipRuleProcessingState | String | Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in). |
| onPremisesDomainName | String | Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Read-only. |
| onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in). |
| onPremisesNetBiosName | String | Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Read-only. |
| onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not). |
| onPremisesSamAccountName | String | Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only. |
| onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values). |
| onPremisesSyncEnabled | Boolean | true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values). |
| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles:
For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default. |
| preferredLanguage | String | The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| proxyAddresses | String collection | Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"]. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0). |
| renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This value can't be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only. |
| securityEnabled | Boolean | Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in). |
| securityIdentifier | String | Security identifier of the group, used in Windows scenarios. Read-only. Returned by default. |
| serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance). |
| theme | string | Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default. |
| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only. |
| unseenCount | Int32 | Count of conversations that received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}). |
| visibility | String | Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.If visibility value isn't specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable. |
Graph reference: groupLifecyclePolicy
| Property | Type | Description |
|---|---|---|
| alternateNotificationEmails | String | List of email address to send notifications for groups without owners. Multiple email address can be defined by separating email address with a semicolon. |
| groupLifetimeInDays | Int32 | Number of days before a group expires and needs to be renewed. Once renewed, the group expiration is extended by the number of days defined. |
| id | String | A unique identifier for a policy. Read-only. |
| managedGroupTypes | String | The group type for which the expiration policy applies. Possible values are **A |
Graph reference: groups-overview
Graph reference: 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 |
Graph reference: groupSettingTemplate
| Property | Type | Description |
|---|---|---|
| description | String | Description of the template. |
| displayName | String | Display name of the template. The template named Group.Unified can be used to configure tenant-wide Microsoft 365 group settings, while the template named Group.Unified.Guest can be used to configure group-specific settings. |
| 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. |
Graph reference: homeRealmDiscoveryPolicy
| Property | Type | Description |
|---|---|---|
| definition | String collection | A string collection containing a JSON string that defines the rules and settings for this policy. For more information about the JSON schema for this property, see Properties of a home realm discovery policy definition. Required. |
| description | String | Description for this policy. |
| displayName | String | Display name for this policy. Required. |
| id | String | Unique identifier for this policy. Read-only. |
| isOrganizationDefault | Boolean | If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. |
Graph reference: licenseDetails
| Property | Type | Description |
|---|---|---|
| id | String | The unique identifier for the license detail object. Read-only. Key. Not nullable. |
| servicePlans | servicePlanInfo collection | Information about the service plans assigned with the license. Read-only. Not nullable. |
| skuId | Guid | Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only. |
| skuPartNumber | String | Unique SKU display name. Equal to the **s |
Graph reference: message
| Property | Type | Description |
|---|---|---|
| bccRecipients | recipient collection | The Bcc: recipients for the message. |
| body | itemBody | The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body. |
| bodyPreview | String | The first 255 characters of the message body. It is in text format. |
| ccRecipients | recipient collection | The Cc: recipients for the message. |
| changeKey | String | The version of the message. |
| conversationId | String | The ID of the conversation the email belongs to. |
| conversationIndex | Edm.Binary | Indicates the position of the message within the conversation. |
| createdDateTime | DateTimeOffset | The date and time the message was created. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| flag | followupFlag | The flag value that indicates the status, start date, due date, or completion date for the message. |
| from | recipient | The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
| hasAttachments | Boolean | Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src="cid:[email protected]">. |
| id | String | Unique identifier for the message. !INCLUDE [outlook-beta-id] Read-only. |
| importance | importance | The importance of the message. The possible values are: low, normal, and high. |
| inferenceClassification | inferenceClassificationType | The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other. |
| internetMessageHeaders | internetMessageHeader collection | A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Returned only on applying a $select query option. Read-only. |
| internetMessageId | String | The message ID in the format specified by RFC2822. |
| isDeliveryReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
| isDraft | Boolean | Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet. |
| isRead | Boolean | Indicates whether the message has been read. |
| isReadReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
| lastModifiedDateTime | DateTimeOffset | The date and time the message was last changed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| parentFolderId | String | The unique identifier for the message's parent mailFolder. |
| receivedDateTime | DateTimeOffset | The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| replyTo | recipient collection | The email addresses to use when replying. |
| sender | recipient | The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
| sentDateTime | DateTimeOffset | The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| subject | String | The subject of the message. |
| toRecipients | recipient collection | The To: recipients for the message. |
| uniqueBody | itemBody | The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format. |
| webLink | String | The URL to open the message in Outlook on the web. You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane. The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser. This URL cannot be accessed from within an iFrame. |
Graph reference: oAuth2PermissionGrant
| Property | Type | Description |
|---|---|---|
| clientId | String | The object id (not appId) of the client service principal for the application that's authorized to act on behalf of a signed-in user when accessing an API. Required. Supports $filter (eq only). |
| consentType | String | Indicates if authorization is granted for the client application to impersonate all users or only a specific user. AllPrincipals indicates authorization to impersonate all users. Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted by an administrator. Nonadmin users might be authorized to consent on behalf of themselves in some cases, for some delegated permissions. Required. Supports $filter (eq only). |
| id | String | Unique identifier for the oAuth2PermissionGrant. Read-only. |
| principalId | String | The id of the user on behalf of whom the client is authorized to access the resource, when consentType is Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal. Supports $filter (eq only). |
| resourceId | String | The id of the resource service principal to which access is authorized. This identifies the API that the client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only). |
| scope | String | A space-separated list of the claim values for delegated permissions that should be included in access tokens for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value should match the **v |
Graph reference: opentypeextension
| Property | Type | Description |
|---|---|---|
| extensionName | String | A unique text identifier for an open type data extension. Optional. |
| id | String | A fully qualified identifier that concatenates the extension type with the **e |
Graph reference: organization
| Property | Type | Description |
|---|---|---|
| assignedPlans | assignedPlan collection | The collection of service plans associated with the tenant. Not nullable. |
| businessPhones | String collection | Telephone number for the organization. Although this property is a string collection, only one number can be set. |
| city | String | City name of the address for the organization. |
| country | String | Country or region name of the address for the organization. |
| countryLetterCode | String | Country or region abbreviation for the organization in ISO 3166-2 format. |
| createdDateTime | DateTimeOffset | Timestamp of when the organization was created. The value can't be modified and is automatically populated when the organization 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. Read-only. |
| defaultUsageLocation | String | Two-letter ISO 3166 country code indicating the default service usage location of an organization. |
| deletedDateTime | DateTimeOffset | Represents date and time of when the Microsoft Entra tenant was deleted 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. |
| displayName | String | The display name for the tenant. |
| id | String | The tenant ID, a unique identifier representing the organization (or tenant). Inherited from directoryObject. Key. Not nullable. Read-only. |
| isMultipleDataLocationsForServicesEnabled | Boolean | true if organization is Multi-Geo enabled; false if the organization isn't Multi-Geo enabled; null (default). Read-only. For more information, see OneDrive Online Multi-Geo. |
| marketingNotificationEmails | String collection | Not nullable. |
| onPremisesLastSyncDateTime | DateTimeOffset | The time and date at which the tenant was last 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. |
| 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. Nullable. null if this object isn't synced from on-premises active directory (default). |
| partnerTenantType | partnerTenantType | The type of partnership this tenant has with Microsoft. The possible values are: microsoftSupport, syndicatePartner, breadthPartner, breadthPartnerDelegatedAdmin, resellerPartnerDelegatedAdmin, valueAddedResellerPartnerDelegatedAdmin, unknownFutureValue. Nullable. For more information about the possible types, see partnerTenantType values. |
| postalCode | String | Postal code of the address for the organization. |
| preferredLanguage | String | The preferred language for the organization. Should follow ISO 639-1 Code; for example, en. |
| privacyProfile | privacyProfile | The privacy profile of an organization. |
| provisionedPlans | ProvisionedPlan collection | Not nullable. |
| securityComplianceNotificationMails | String collection | Not nullable. |
| securityComplianceNotificationPhones | String collection | Not nullable. |
| state | String | State name of the address for the organization. |
| street | String | Street name of the address for organization. |
| technicalNotificationMails | String collection | Not nullable. |
| tenantType | String | Not nullable. Can be one of the following types: AAD - An enterprise identity access management (IAM) service that serves business-to-employee and business-to-business (B2B) scenarios. AAD B2C An identity access management (IAM) service that serves business-to-consumer (B2C) scenarios. CIAM - A customer identity & access management (CIAM) solution that provides an integrated platform to serve consumers, partners, and citizen scenarios. |
| verifiedDomains | VerifiedDomain collection | The collection of domains associated with this tenant. Not nullable. |
Graph reference: 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). |
| 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). |
| serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a non-transient, service-specific error regarding the properties or link from an organizational contact object . Supports $filter (eq, not, for isResolved and serviceInstance). |
| 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). |
Graph reference: passwordSingleSignOnCredentialSet
| Property | Type | Description |
|---|---|---|
| credentials | credential collection | A list of credential objects that define the complete sign in flow. |
| id | String | The ID of the user or group this credential set belongs to. |
Graph reference: permissionGrantConditionSet
| Property | Type | Description |
|---|---|---|
| clientApplicationsFromVerifiedPublisherOnly | Boolean | Set to true to only match on client applications with a verified publisher. Set to false to match on any client app, even if it doesn't have a verified publisher. Default is false. |
| clientApplicationIds | String collection | A list of appId values for the client applications to match with, or a list with the single value all to match any client application. Default is the single value all. |
| clientApplicationPublisherIds | String collection | A list of Microsoft Partner Network (MPN) IDs for verified publishers of the client application, or a list with the single value all to match with client apps from any publisher. Default is the single value all. |
| clientApplicationTenantIds | String collection | A list of Microsoft Entra tenant IDs in which the client application is registered, or a list with the single value all to match with client apps registered in any tenant. Default is the single value all. |
| id | String | The unique identifier for the permission grant condition set. Key. Read-only. |
| permissionClassification | String | The permission classification for the permission being granted, or all to match with any permission classification (including permissions that aren't classified). Default is all. |
| permissions | String collection | The list of id values for the specific permissions to match with, or a list with the single value all to match with any permission. The id of delegated permissions can be found in the oauth2PermissionScopes property of the API's servicePrincipal object. The id of application permissions can be found in the appRoles property of the API's servicePrincipal object. The id of resource-specific application permissions can be found in the resourceSpecificApplicationPermissions property of the API's servicePrincipal object. Default is the single value all. |
| permissionType | permissionType | The permission type of the permission being granted. Possible values: application for application permissions (for example app roles), or delegated for delegated permissions. The value delegatedUserConsentable indicates delegated permissions that haven't been configured by the API publisher to require admin consent—this value may be used in built-in permission grant policies, but can't be used in custom permission grant policies. Required. |
| resourceApplication | String | The **a |
Graph reference: permissionGrantPolicy
| Property | Type | Description |
|---|---|---|
| displayName | String | The display name for the permission grant policy. |
| description | String | The description for the permission grant policy. |
| excludes | permissionGrantConditionSet collection | Condition sets that are excluded in this permission grant policy. Automatically expanded on GET. |
| id | String | The unique identifier for the permission grant policy. The id prefix microsoft- is reserved for built-in permission grant policies, and may not be used in a custom permission grant policy. Only letters, numbers, hyphens (-) and underscores (_) are allowed. Key. Not nullable. Required on create. Immutable. |
| includes | permissionGrantConditionSet collection | Condition sets that are *i |
Graph reference: 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. |
Graph reference: provisioningObjectSummary
| Property | Type | Description |
|---|---|---|
| activityDateTime | DateTimeOffset | Represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. SUpports $filter (eq, gt, lt) and orderby. |
| changeId | String | Unique ID of this change in this cycle. Supports $filter (eq, contains). |
| cycleId | String | Unique ID per job iteration. Supports $filter (eq, contains). |
| durationInMilliseconds | Int32 | Indicates how long this provisioning action took to finish. Measured in milliseconds. |
| id | String | Indicates the unique ID for the activity. Read-only. Supports $filter (eq, contains). |
| initiatedBy | initiator | Details of who initiated this provisioning. Supports $filter (eq, contains). |
| jobId | String | The unique ID for the whole provisioning job. Supports $filter (eq, contains). |
| modifiedProperties | modifiedProperty collection | Details of each property that was modified in this provisioning action on this object. |
| provisioningAction | provisioningAction | Indicates the activity name or the operation name. Possible values are: create, update, delete, stageddelete, disable, other and unknownFutureValue. For a list of activities logged, refer to Microsoft Entra activity list. Supports $filter (eq, contains). |
| provisioningStatusInfo | provisioningStatusInfo | Details of provisioning status. |
| provisioningSteps | provisioningStep collection | Details of each step in provisioning. |
| servicePrincipal | servicePrincipal collection | Represents the service principal used for provisioning. Supports $filter (eq) for id and name. |
| sourceIdentity | provisionedIdentity | Details of source object being provisioned. Supports $filter (eq, contains) for identityType, id, and displayName*. |
| sourceSystem | provisioningSystem | Details of source system of the object being provisioned. Supports $filter (eq, contains) for displayName. |
| targetIdentity | provisionedIdentity | Details of target object being provisioned. Supports $filter (eq, contains) for identityType, id, and displayName*. |
| targetSystem | provisioningSystem | Details of target system of the object being provisioned. Supports $filter (eq, contains) for displayName. |
| tenantId | String | Unique Microsoft Entra tenant ID. Supports $filter (eq, contains). |
Graph reference: remoteDesktopSecurityConfiguration
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier for the RDS security configuration. Inherited from entity. |
| isRemoteDesktopProtocolEnabled | Boolean | Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled. |
Graph reference: scopedRoleMembership
| Property | Type | Description |
|---|---|---|
| administrativeUnitId | string | Unique identifier for the administrative unit that the directory role is scoped to |
| ID | string | Unique identifier for the scoped-role membership. Read-only. |
| roleId | string | Unique identifier for the directory role that the member is in. |
| roleMemberInfo | identity | Role member identity information. Represents the user that is a member of this scoped-role. |
Graph reference: servicePrincipal
| Property | Type | Description |
|---|---|---|
| accountEnabled | Boolean | true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're 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 lets 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). Alternate key. Supports $filter (eq, ne, not, in, startsWith). |
| applicationTemplateId | String | Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the service principal wasn't created from an application template. |
| 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 that's linked to this service principal. For more information, see the appRoles property definition on the application entity. Not nullable. |
| 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). Filter value is case sensitive. |
| 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 displays the application description in this field. The maximum allowed size is 1,024 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 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 Microsoft Entra 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 Microsoft Entra ID to authenticate. Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps. When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL. |
| logoutUrl | String | Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenID Connect front-channel, back-channel, or SAML sign out protocols. |
| notes | String | Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1,024 characters. |
| notificationEmailAddresses | String collection | Specifies the list of email addresses where Microsoft Entra ID 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 Microsoft Entra 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. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, notSupported, and oidc. Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically. |
| preferredTokenSigningKeyThumbprint | String | This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property. |
| 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 Microsoft Entra ID. For example,
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 Microsoft Entra ID internally. The servicePrincipalType property can be set to three different values:
|
| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:
|
| tags | String collection | Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity's tags property. Supports $filter (eq, not, ge, le, startsWith). |
| tokenEncryptionKeyId | String | Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID 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 that's linked to this service principal. |
Graph reference: servicePrincipalSignInActivity
| Property | Type | Description |
|---|---|---|
| appId | String | The globally unique appId (also called client ID on the Microsoft Entra admin center) of the credentialed resource application. |
| applicationAuthenticationClientSignInActivity | signInActivity | The sign-in activity of the application in a app-only authentication flow (app-to-app tokens) where the application acts like a client. |
| applicationAuthenticationResourceSignInActivity | signInActivity | The sign-in activity of the application in a app-only authentication flow (app-to-app tokens) where the application acts like a resource. |
| delegatedClientSignInActivity | signInActivity | The sign-in activity of the application in a delegated flow (user sign-in) where the application acts like a client. |
| delegatedResourceSignInActivity | signInActivity | The sign-in activity of the application in a delegated flow (user sign-in) where the application acts like a resource. |
| id | String | The unique ID for each service principal sign-in event. |
| lastSignInActivity | signInActivity | The most recent sign-in activity of the application across delegated or app-only flows where the application is used either as a client or resource. |
Graph reference: signIn
| Property | Type | Description |
|---|---|---|
| appDisplayName | String | App name displayed in the Microsoft Entra admin center. Supports $filter (eq, startsWith). |
| appId | String | Unique GUID that represents the app ID in the Microsoft Entra ID. Supports $filter (eq). |
| appliedConditionalAccessPolicies | appliedConditionalAccessPolicy collection | Provides a list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see Permissions for viewing applied conditional access (CA) policies in sign-ins. |
| clientAppUsed | String | Identifies the client used for the sign-in activity. Modern authentication clients include Browser, modern clients. Legacy authentication clients include Exchange ActiveSync, IMAP, MAPI, SMTP, POP, and other clients. Supports $filter (eq). |
| conditionalAccessStatus | conditionalAccessStatus | Reports status of an activated conditional access policy. Possible values are: success, failure, notApplied, and unknownFutureValue. Supports $filter (eq). |
| correlationId | String | The request ID sent from the client when the sign-in is initiated. Used to troubleshoot sign-in activity. Supports $filter (eq). |
| createdDateTime | DateTimeOffset | Date and time (UTC) the sign-in was initiated. Example: midnight on Jan 1, 2014 is reported as 2014-01-01T00:00:00Z. Supports $orderby, $filter (eq, le, and ge). |
| deviceDetail | deviceDetail | Device information from where the sign-in occurred; includes device ID, operating system, and browser. Supports $filter (eq, startsWith) on browser and operatingSytem properties. |
| id | String | Unique ID representing the sign-in activity. Supports $filter (eq). |
| ipAddress | String | IP address of the client used to sign in. Supports $filter (eq, startsWith). |
| isInteractive | Boolean | Indicates whether a sign-in is interactive. |
| location | signInLocation | Provides the city, state, and country code where the sign-in originated. Supports $filter (eq, startsWith) on city, state, and countryOrRegion properties. |
| resourceDisplayName | String | Name of the resource the user signed into. Supports $filter (eq). |
| resourceId | String | ID of the resource that the user signed into. Supports $filter (eq). |
| riskDetail | riskDetail | The reason behind a specific state of a risky user, sign-in, or a risk event. The possible values are none, adminGeneratedTemporaryPassword, userPerformedSecuredPasswordChange, userPerformedSecuredPasswordReset, adminConfirmedSigninSafe, aiConfirmedSigninSafe, userPassedMFADrivenByRiskBasedPolicy, adminDismissedAllRiskForUser, adminConfirmedSigninCompromised, hidden, adminConfirmedUserCompromised, unknownFutureValue, adminConfirmedServicePrincipalCompromised, adminDismissedAllRiskForServicePrincipal, m365DAdminDismissedDetection, userChangedPasswordOnPremises, adminDismissedRiskForSignIn, adminConfirmedAccountSafe. You must use the Prefer: include-unknown-enum-members request header to get the following value or values in this evolvable enum: adminConfirmedServicePrincipalCompromised, adminDismissedAllRiskForServicePrincipal, m365DAdminDismissedDetection, userChangedPasswordOnPremises, adminDismissedRiskForSignIn, adminConfirmedAccountSafe.The value none means that Microsoft Entra risk detection did not flag the user or the sign-in as a risky event so far. Supports $filter (eq).Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden. |
| riskEventTypes_v2 | String collection | The list of risk event types associated with the sign-in. Possible values: unlikelyTravel, anonymizedIPAddress, maliciousIPAddress, unfamiliarFeatures, malwareInfectedIPAddress, suspiciousIPAddress, leakedCredentials, investigationsThreatIntelligence, generic, or unknownFutureValue. Supports $filter (eq, startsWith). |
| riskLevelAggregated | riskLevel | Aggregated risk level. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden. |
| riskLevelDuringSignIn | riskLevel | Risk level during sign-in. The possible values are: none, low, medium, high, hidden, and unknownFutureValue. The value hidden means the user or sign-in wasn't enabled for Microsoft Entra ID Protection. Supports $filter (eq). Note: Details for this property are only available for Microsoft Entra ID P2 customers. All other customers are returned hidden. |
| riskState | riskState | Reports status of the risky user, sign-in, or a risk event. The possible values are: none, confirmedSafe, remediated, dismissed, atRisk, confirmedCompromised, unknownFutureValue. Supports $filter (eq). |
| status | signInStatus | Sign-in status. Includes the error code and description of the error (if a sign-in failure occurs). Supports $filter (eq) on errorCode property. |
| userDisplayName | String | Display name of the user that initiated the sign-in. Supports $filter (eq, startsWith). |
| userId | String | ID of the user that initiated the sign-in. Supports $filter (eq). |
| userPrincipalName | String | User principal name of the user that initiated the sign-in. This value is always in lowercase. For guest users whose values in the user object typically contain #EXT# before the domain part, this property stores the value in both lowercase and the "true" format. For example, while the user object stores AdeleVance_fabrikam.com#EXT#@contoso.com, the sign-in logs store [email protected].Supports $filter (eq, startsWith). |
Graph reference: subscribedSku
| Property | Type | Description |
|---|---|---|
| accountId | String | The unique ID of the account this SKU belongs to. |
| accountName | String | The name of the account this SKU belongs to. |
| appliesTo | String | The target class for this SKU. Only SKUs with target class User are assignable. Possible values are: User, Company. |
| capabilityStatus | String | Enabled indicates that the prepaidUnits property has at least one unit that is enabled. LockedOut indicates that the customer canceled their subscription. Possible values are: Enabled, Warning, Suspended, Deleted, LockedOut. |
| 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. |
| subscriptionIds | String collection | A list of all subscription IDs associated with this SKU. |
Graph reference: targetDeviceGroup
| Property | Type | Description |
|---|---|---|
| displayName | String | Display name for the target device group. |
| id | String | Object identifier of the group. Inherited from entity. |
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 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 Microsoft Entra 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 |
Graph reference: 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 app ID generated for the catalog is different from the developer-provided ID found within the Microsoft Teams zip app package. The **e |
Graph reference: teamsAppInstallation
| Property | Type | Description |
|---|---|---|
| consentedPermissionSet | teamsAppPermissionSet | The set of resource-specific permissions consented to while installing or upgrading the teamsApp. |
| id | string | A unique ID (not the Teams app ID). |
Graph reference: teamsLicensingDetails
| Property | Type | Description |
|---|---|---|
| hasTeamsLicense | Boolean | Indicates whether the user has a valid license to use Microsoft Teams. |
Graph reference: 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. |
Graph reference: teamworkBot
| Property | Type | Description |
|---|---|---|
| id | String | The ID of the bot associated with the specific teamsAppDefinition. This value is usually a GUID. |
Graph reference: todoTask
| Property | Type | Description |
|---|---|---|
| body | itemBody | The task body that typically contains information about the task. |
| bodyLastModifiedDateTime | DateTimeOffset | The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| categories | String collection | The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined. |
| completedDateTime | dateTimeTimeZone | The date and time in the specified time zone that the task was finished. |
| createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| dueDateTime | dateTimeTimeZone | The date and time in the specified time zone that the task is to be finished. |
| hasAttachments | Boolean | Indicates whether the task has attachments. |
| id | String | Unique identifier for the task. By default, this value changes when the item is moved from one list to another. |
| importance | importance | The importance of the task. Possible values are: low, normal, high. |
| isReminderOn | Boolean | Set to true if an alert is set to remind the user of the task. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'. |
| recurrence | patternedRecurrence | The recurrence pattern for the task. |
| reminderDateTime | dateTimeTimeZone | The date and time in the specified time zone for a reminder alert of the task to occur. |
| startDateTime | dateTimeTimeZone | The date and time in the specified time zone at which the task is scheduled to start. |
| status | taskStatus | Indicates the state or progress of the task. Possible values are: notStarted, inProgress, completed, waitingOnOthers, deferred. |
| title | String | A brief description of the task. |
Graph reference: todoTaskList
| Property | Type | Description |
|---|---|---|
| displayName | String | The name of the task list. |
| id | String | The identifier of the task list, unique in the user's mailbox. Read-only. Inherited from entity |
| isOwner | Boolean | True if the user is owner of the given task list. |
| isShared | Boolean | True if the task list is shared with other users |
| wellknownListName | wellknownListName | Property indicating the list name if the given list is a well-known list. Possible values are: none, defaultList, flaggedEmails, unknownFutureValue. |
Graph reference: tokenIssuancePolicy
| Property | Type | Description |
|---|---|---|
| definition | String collection | A string collection containing a JSON string that defines the rules and settings for this policy. See below for more details about the JSON schema for this property. Required. |
| description | String | Description for this policy. |
| displayName | String | Display name for this policy. Required. |
| id | String | Unique identifier for this policy. Read-only. |
| isOrganizationDefault | Boolean | Ignore this property. The token-issuance policy can only be applied to service principals and can't be set globally for the organization. |
Graph reference: tokenLifetimePolicy
| Property | Type | Description |
|---|---|---|
| definition | String collection | A string collection containing a JSON string that defines the rules and settings for this policy. For more information about the JSON schema for this property, see Properties of a token lifetime policy definition . Required. |
| displayName | String | Display name for this policy. Required. |
| id | String | Unique identifier for this policy. Read-only. |
| isOrganizationDefault | Boolean | If set to true, activates this policy. There can be many policies for the same policy type, but only one can be activated as the organization default. Optional, default value is false. |
Graph reference: unifiedRoleAssignment
| Property | Type | Description |
|---|---|---|
| appScopeId | String | Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, /AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997. Supports $filter (eq, in). For example, /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'. |
| directoryScopeId | String | Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in). |
| id | String | The unique identifier for the unifiedRoleAssignment. Key, not nullable, Read-only. |
| principalId | String | Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports $filter (eq, in). |
| roleDefinitionId | String | Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in). |
Graph reference: unifiedRoleDefinition
| Property | Type | Description |
|---|---|---|
| description | String | The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true. |
| displayName | String | The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in). |
| id | String | The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, in). |
| isBuiltIn | Boolean | Flag indicating whether the role definition is part of the default set included in Microsoft Entra or a custom definition. Read-only. Supports $filter (eq, in). |
| isEnabled | Boolean | Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true. |
| resourceScopes | String collection | List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment. |
| rolePermissions | unifiedRolePermission collection | List of permissions included in the role. Read-only when isBuiltIn is true. Required. |
| templateId | String | Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories. |
| version | String | Indicates version of the role definition. Read-only when **i |
Graph reference: usageRight
| Property | Type | Description |
|---|---|---|
| catalogId | String | Product id corresponding to the usage right. |
| id | String | The id of the usage right. |
| serviceIdentifier | String | Identifier of the service corresponding to the usage right. |
| state | usageRightState | The state of the usage right. Possible values are: active, inactive, warning, suspended. |
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/region where the user is located; for example, US or UK. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| createdDateTime | DateTimeOffset | The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). |
| creationType | String | Indicates whether the user account was created through one of the following methods:
Read-only. Returned only on $select. Supports $filter (eq, ne, not, in). |
| customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Returned only on $select. Supports $filter (eq, ne, not, startsWith). The filter value is case-sensitive. |
| deletedDateTime | DateTimeOffset | The date and time the user was deleted. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in). |
| department | String | The name of the department in which the user works. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values). |
| displayName | String | The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search. |
| employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in a future hire. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). |
| employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user. |
| employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| employeeOrgData | employeeOrgData | Represents organization data (for example, division and costCenter) associated with a user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). |
| employeeType | String | Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith). |
| externalUserState | String | For a guest invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Returned only on $select. Supports $filter (eq, ne, not , in). |
| externalUserStateChangeDateTime | DateTimeOffset | Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, not , in). |
| faxNumber | String | The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| givenName | String | The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| hireDate | DateTimeOffset | The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Returned only on $select. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. |
| id | String | The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only. Returned by default. Supports $filter (eq, ne, not, in). |
| identities | objectIdentity collection | Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Returned only on $select. Supports $filter (eq) with limitations. |
| imAddresses | String collection | The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith). |
| interests | String collection | A list for the user to describe their interests. Returned only on $select. |
| 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, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Returned only on $select. |
| licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Returned only on $select. |
| String | The SMTP address for the user, for example, [email protected]. Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values). |
|
| mailboxSettings | mailboxSettings | Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Returned only on $select. |
| mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search. |
| mySite | String | The URL for the user's site. Returned only on $select. |
| officeLocation | String | The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| onPremisesDistinguishedName | String | Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. |
| onPremisesDomainName | String | Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. |
| onPremisesExtensionAttributes | onPremisesExtensionAttributes | Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. false), these properties can be set during the creation or update of a user object. Returned only on $select. Supports $filter (eq, ne, not, in). |
| onPremisesImmutableId | String | This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't be used when specifying this property. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in). |
| onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in). |
| onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, not, ge, le). |
| onPremisesSamAccountName | String | Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith). |
| onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select. Supports $filter (eq including on null values). |
| onPremisesSyncEnabled | Boolean | true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Microsoft Entra ID. Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). |
| onPremisesUserPrincipalName | String | Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith). |
| otherMails | String collection | A list of other email addresses for the user; for example: ["[email protected]", "[email protected]"]. NOTE: This property can't contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0). |
| passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values). |
| passwordProfile | passwordProfile | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). To update this property: |
| pastProjects | String collection | A list for the user to enumerate their past projects. Returned only on $select. |
| postalCode | String | The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| preferredDataLocation | String | The preferred data location for the user. For more information, see OneDrive Online Multi-Geo. |
| preferredLanguage | String | The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) |
| preferredName | String | The preferred name for the user. Not Supported. This attribute returns an empty string. Returned only on $select. |
| provisionedPlans | provisionedPlan collection | The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le). |
| proxyAddresses | String collection | For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0). |
| refreshTokensValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Returned only on $select. Read-only. |
| responsibilities | String collection | A list for the user to enumerate their responsibilities. Returned only on $select. |
| serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance). |
| schools | String collection | A list for the user to enumerate the schools they attended. Returned only on $select. |
| securityIdentifier | String | Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith). |
| showInAddressList | Boolean | Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue. |
| signInActivity | signInActivity | Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: |
| signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select. |
| skills | String collection | A list for the user to enumerate their skills. Returned only on $select. |
| state | String | The state or province in the user's address. Maximum length is 128 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| streetAddress | String | The street address of the user's place of business. Maximum length is 1,024 characters. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| surname | String | The user's surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| usageLocation | String | A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. 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: users
| Property | Description |
|---|---|
| id | The unique identifier for the user. |
| businessPhones | The user's phone numbers. |
| displayName | The name displayed in the address book for the user. |
| givenName | The first name of the user. |
| jobTitle | The user's job title. |
| The user's email address. | |
| mobilePhone | The user's cellphone number. |
| officeLocation | The user's physical office location. |
| preferredLanguage | The user's language of preference. |
| surname | The last name of the user. |
| userPrincipalName | The user's principal name. |