User.Read.All
Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user.
Graph Methods
Type: A = Application Permission, D = Delegate Permission
Delegate Permission
Id | a154be20-db9c-4678-8ab7-66f6cc099a59 |
Consent Type | Admin |
Display String | Read all users' full profiles |
Description | Allows the app to read the full set of profile properties, reports, and managers of other users in your organization, on behalf of the signed-in user. |
Application Permission
Id | df021288-bdef-4463-88db-98f22de89214 |
Display String | Read all users' full profiles |
Description | Allows the app to read user profiles without a signed in user. |
Resources
administrativeUnit
Property | Type | Description |
---|---|---|
description | String | An optional description for the administrative unit. Supports $filter (eq , ne , in , startsWith ), $search . |
displayName | String | Display name for the administrative unit. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderBy . |
id | String | Unique identifier for the administrative unit. Read-only. Supports $filter (eq ). |
visibility | String | Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership . If not set (value is null ), the default behavior is public. When set to HiddenMembership , only members of the administrative unit can list other members of the administrative unit. |
application
Property | Type | Description |
---|---|---|
addIns | addIn collection | Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This will let services like Office 365 call the application in the context of a document the user is working on. |
api | apiApplication | Specifies settings for an application that implements a web API. |
appId | String | The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. Supports $filter (eq ). |
applicationTemplateId | String | Unique identifier of the applicationTemplate. Supports $filter (eq , not , ne ). |
appRoles | appRole collection | The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. |
certification | certification | Specifies the certification status of the application. |
createdDateTime | DateTimeOffset | The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. Supports $filter (eq , ne , not , ge , le , in , and eq on null values) and $orderBy . |
deletedDateTime | DateTimeOffset | The date and time the application was deleted. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. |
description | String | Free text field to provide a description of the application object to end users. The maximum allowed size is 1024 characters. Supports $filter (eq , ne , not , ge , le , startsWith ) and $search . |
disabledByMicrosoftStatus | String | Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled , and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq , ne , not ). |
displayName | String | The display name for the application. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderBy . |
groupMembershipClaims | String | Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this attribute, use one of the following valid string values: None , SecurityGroup (for security groups and Azure AD roles), All (this gets all of the security groups, distribution groups, and Azure AD directory roles that the signed-in user is a member of). |
id | String | Unique identifier for the application object. This property is referred to as Object ID in the Azure portal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
identifierUris | String collection | Also known as App ID URI, this value is set when an application is used as a resource app. The identifierUris acts as the prefix for the scopes you'll reference in your API's code, and it must be globally unique. You can use the default value provided, which is in the form api://<application-client-id> , or specify a more readable URI like https://contoso.com/api . For more information on valid identifierUris patterns and best practices, see Azure AD application registration security best practices. Not nullable. Supports $filter (eq , ne , ge , le , startsWith ). |
info | informationalUrl | Basic profile information of the application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps. Supports $filter (eq , ne , not , ge , le , and eq on null values). |
isDeviceOnlyAuthSupported | Boolean | Specifies whether this application supports device authentication without a user. The default is false . |
isFallbackPublicClient | Boolean | Specifies the fallback application type as public client, such as an installed application running on a mobile device. The default value is false which means the fallback application type is confidential client such as a web app. There are certain scenarios where Azure AD cannot determine the client application type. For example, the ROPC flow where it is configured without specifying a redirect URI. In those cases Azure AD interprets the application type based on the value of this property. |
keyCredentials | keyCredential collection | The collection of key credentials associated with the application. Not nullable. Supports $filter (eq , not , ge , le ). |
logo | Stream | The main logo for the application. Not nullable. |
notes | String | Notes relevant for the management of the application. |
oauth2RequiredPostResponse | Boolean | Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. The default is false , which specifies that only GET requests are allowed. |
optionalClaims | optionalClaims | Application developers can configure optional claims in their Azure AD applications to specify the claims that are sent to their application by the Microsoft security token service. For more information, see How to: Provide optional claims to your app. |
parentalControlSettings | parentalControlSettings | Specifies parental control settings for an application. |
passwordCredentials | passwordCredential collection | The collection of password credentials associated with the application. Not nullable. |
publicClient | publicClientApplication | Specifies settings for installed clients such as desktop or mobile devices. |
publisherDomain | String | The verified publisher domain for the application. Read-only. For more information, see How to: Configure an application's publisher domain. Supports $filter (eq , ne , ge , le , startsWith ). |
requiredResourceAccess | requiredResourceAccess collection | Specifies the resources that the application needs to access. This property also specifies the set of delegated permissions and application roles that it needs for each of those resources. This configuration of access to the required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning mid-October 2021, the total number of required permissions must not exceed 400. For more information, see Limits on requested permissions per app. Not nullable. Supports $filter (eq , not , ge , le ). |
samlMetadataUrl | String | The URL where the service exposes SAML metadata for federation. This property is valid only for single-tenant applications. Nullable. |
serviceManagementReference | String | References application or service contact information from a Service or Asset Management database. Nullable. |
signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg , AzureADMultipleOrgs , AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount . See more in the table. The value of this object also limits the number of permissions an app can request. For more information, see Limits on requested permissions per app. The value for this property has implications on other app object properties. As a result, if you change this property, you may need to change other properties first. For more information, see Validation differences for signInAudience. Supports $filter (eq , ne , not ). |
spa | spaApplication | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. |
tags | String collection | Custom strings that can be used to categorize and identify the application. Not nullable. Supports $filter (eq , not , ge , le , startsWith ). |
tokenEncryptionKeyId | String | Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD encrypts all the tokens it emits by using the key this property points to. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. |
verifiedPublisher | verifiedPublisher | Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see Publisher verification. |
web | webApplication | Specifies settings for a web application. |
convertIdResult
Property | Type | Description |
---|---|---|
errorDetails | genericError | An error object indicating the reason for the conversion failure. This value is not present if the conversion succeeded. |
sourceId | String | The identifier that was converted. This value is the original, un-converted identifier. |
targetId | String | The converted identifier. This value is not present if the conversion failed. |
dataPolicyOperation
Property | Type | Description |
---|---|---|
completedDateTime | DateTimeOffset | Represents when the request for this data policy operation was completed, in UTC time, using the ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Null until the operation completes. |
id | String | Unique key for this operation. |
status | dataPolicyOperationStatus | Possible values are: notStarted , running , complete , failed , unknownFutureValue . |
storageLocation | String | The URL location to where data is being exported for export requests. |
userId | String | The id for the user on whom the operation is performed. |
submittedDateTime | DateTimeOffset | Represents when the request for this data operation was submitted, in UTC time, using the ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
progress | String | Specifies the progress of an operation. |
device
Property | Type | Description |
---|---|---|
accountEnabled | Boolean | true if the account is enabled; otherwise, false . Required. Default is true . Supports $filter (eq , ne , not , in ). Only callers in Global Administrator and Cloud Device Administrator roles can set this property. |
alternativeSecurityIds | alternativeSecurityId collection | For internal use only. Not nullable. Supports $filter (eq , not , ge , le ). |
approximateLastSignInDateTime | DateTimeOffset | The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. Supports $filter (eq , ne , not , ge , le , and eq on null values) and $orderBy . |
complianceExpirationDateTime | DateTimeOffset | The timestamp when the device is no longer deemed compliant. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. |
deviceId | String | Unique identifier set by Azure Device Registration Service at the time of registration. This is an alternate key that can be used to reference the device object. Supports $filter (eq , ne , not , startsWith ). |
deviceMetadata | String | For internal use only. Set to null . |
deviceVersion | Int32 | For internal use only. |
displayName | String | The display name for the device. Required. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderBy . |
extensionAttributes | onPremisesExtensionAttributes | Contains extension attributes 1-15 for the device. The individual extension attributes are not selectable. These properties are mastered in cloud and can be set during creation or update of a device object in Azure AD. Supports $filter (eq , not , startsWith , and eq on null values). |
id | String | The unique identifier for the device. Inherited from directoryObject. Key, Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
isCompliant | Boolean | true if the device complies with Mobile Device Management (MDM) policies; otherwise, false . Read-only. This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq , ne , not ). |
isManaged | Boolean | true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false . This can only be updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq , ne , not ). |
manufacturer | String | Manufacturer of the device. Read-only. |
mdmAppId | String | Application identifier used to register device into MDM. Read-only. Supports $filter (eq , ne , not , startsWith ). |
model | String | Model of the device. Read-only. |
onPremisesLastSyncDateTime | DateTimeOffset | The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Read-only. Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesSyncEnabled | Boolean | true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Read-only. Supports $filter (eq , ne , not , in , and eq on null values). |
operatingSystem | String | The type of operating system on the device. Required. Supports $filter (eq , ne , not , ge , le , startsWith , and eq on null values). |
operatingSystemVersion | String | The version of the operating system on the device. Required. Supports $filter (eq , ne , not , ge , le , startsWith , and eq on null values). |
physicalIds | String collection | For internal use only. Not nullable. Supports $filter (eq , not , ge , le , startsWith ,/$count eq 0 , /$count ne 0 ). |
profileType | deviceProfileType | The profile type of the device. Possible values: RegisteredDevice (default), SecureVM , Printer , Shared , IoT . |
systemLabels | String collection | List of labels applied to the device by the system. Supports $filter (/$count eq 0 , /$count ne 0 ). |
trustType | String | Type of trust for the joined device. Read-only. Possible values: Workplace (indicates *b |
directory
Property | Type | Description |
---|---|---|
id | String | A unique identifier for the object; for example, 12345678-9abc-def0-1234-56789abcde . Key. Not nullable. Read-only. Inherited from entity. |
directoryObject
Property | Type | Description |
---|---|---|
deletedDateTime | DateTimeOffset | Date and time when this object was deleted. Always null when the object hasn't been deleted. |
id | String | The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde . The value of the **i |
educationalActivity
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
completionMonthYear | Date | The month and year the user graduated or completed the activity. |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
endMonthYear | Date | The month and year the user completed the educational activity referenced. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
institution | institutionData | Contains details of the institution studied at. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
program | educationalActivityDetail | Contains extended information about the program or course. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
startMonthYear | Date | The month and year the user commenced the activity referenced. |
emailAddress
Property | Type | Description |
---|---|---|
address | String | The email address of the person or entity. |
name | String | The display name of the person or entity. |
entity
Property | Type | Description |
---|---|---|
id | String | The unique idenfier for an entity. Read-only. |
evaluateDynamicMembershipResult
Property | Type | Description |
---|---|---|
membershipRule | String | If a group ID is provided, the value is the membership rule for the group. If a group ID is not provided, the value is the membership rule that was provided as a parameter. For more information, see Dynamic membership rules for groups in Azure Active Directory. |
membershipRuleEvaluationDetails | expressionEvaluationDetails | Provides a detailed anaylsis of the membership evaluation result. |
membershipRuleEvaluationResult | Boolean | The value is true if the user or device is a member of the group. The value can also be true if a membership rule was provided and the user or device passes the rule evaluation; otherwise false . |
group
Property | Type | Description |
---|---|---|
allowExternalSenders | Boolean | Indicates if people external to the organization can send messages to the group. Default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
assignedLabels | assignedLabel collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select . |
assignedLicenses | assignedLicense collection | The licenses that are assigned to the group. Returned only on $select . Supports $filter (eq ).Read-only. |
autoSubscribeNewMembers | Boolean | Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
classification | String | Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition. Returned by default. Supports $filter (eq , ne , not , ge , le , startsWith ). |
createdDateTime | DateTimeOffset | Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
deletedDateTime | DateTimeOffset | For some Azure Active Directory objects (user, group, application), if the object is deleted, it is first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null . If the object is restored, this property is updated to null . |
description | String | An optional description for the group. Returned by default. Supports $filter (eq , ne , not , ge , le , startsWith ) and $search . |
displayName | String | The display name for the group. This property is required when a group is created and cannot be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderBy . |
expirationDateTime | DateTimeOffset | Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
groupTypes | String collection | Specifies the group type and its membership. If the collection contains Unified , the group is a Microsoft 365 group; otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection includes DynamicMembership , the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq , not ). |
hasMembersWithLicenseErrors | Boolean | Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq ). |
hideFromAddressLists | Boolean | True if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. Default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
hideFromOutlookClients | Boolean | True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
id | String | The unique identifier for the group. Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
isArchived | Boolean | When a group is associated with a team this property determines whether the team is in read-only mode. To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs. |
isAssignableToRole | Boolean | Indicates whether this group can be assigned to an Azure Active Directory role or not. Optional. This property can only be set while creating the group and is immutable. If set to true , the securityEnabled property must also be set to true , visibility must be Hidden , and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership ). Only callers in Global Administrator and Privileged Role Administrator roles can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Azure AD role assignments Using this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq , ne , not ). |
isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true . Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
licenseProcessingState | String | Indicates status of the group license assignment to all members of the group. Default value is false . Read-only. Possible values: QueuedForProcessing , ProcessingInProgress , and ProcessingComplete .Returned only on $select . Read-only. |
String | The SMTP address for the group, for example, "[email protected]". Returned by default. Read-only. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
|
mailEnabled | Boolean | Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq , ne , not ). |
mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following: @ () \ [] " ; : <> , SPACE . Required. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
membershipRule | String | The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership ). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq , ne , not , ge , le , startsWith ). |
membershipRuleProcessingState | String | Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused . Returned by default. Supports $filter (eq , ne , not , in ). |
onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Read-only. Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq , not ). |
onPremisesSamAccountName | String | Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith ). Read-only. |
onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Supports $filter (eq including on null values). Read-only. |
onPremisesSyncEnabled | Boolean | true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq , ne , not , in , and eq on null values). |
preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling user must be assigned one of the following Azure AD roles:
For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default. |
preferredLanguage | String | The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US . Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
proxyAddresses | String collection | Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"] . The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq , not , ge , le , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned by default. Supports $filter (eq , ne , not , ge , le , in ). Read-only. |
resourceBehaviorOptions | String collection | Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This can be set only as part of creation (POST). Possible values are AllowOnlyMembersToPost , HideGroupInOutlook , SubscribeNewGroupMembers , WelcomeEmailDisabled . For more information, see Set Microsoft 365 group behaviors and provisioning options. |
resourceProvisioningOptions | String collection | Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team . For more information, see Set Microsoft 365 group behaviors and provisioning options. |
securityEnabled | Boolean | Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq , ne , not , in ). |
securityIdentifier | String | Security identifier of the group, used in Windows scenarios. Returned by default. |
theme | string | Specifies a Microsoft 365 group's color theme. Possible values are Teal , Purple , Green , Blue , Pink , Orange or Red . Returned by default. |
unseenCount | Int32 | Count of conversations that have received new posts since the signed-in user last visited the group. Returned only on $select . Supported only on the Get group API (GET /groups/{ID} ). |
visibility | String | Specifies the group join policy and group content visibility for groups. Possible values are: Private , Public , or HiddenMembership . HiddenMembership can be set only for Microsoft 365 groups, when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.If visibility value is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public . Groups assignable to roles are always Private . See group visibility options to learn more. Returned by default. Nullable. |
inferenceData
Property | Type | Description |
---|---|---|
confidenceScore | Double | Confidence score reflecting the accuracy of the data inferred about the user. |
userHasVerifiedAccuracy | Boolean | Records if the user has confirmed this inference as being True or False. |
insightsSettings
Property | Type | Description |
---|---|---|
isEnabledInOrganization | Boolean | true if the specified type of insights are enabled for the organization; false if the specified type of insights are disabled for all users without exceptions. Default is true . Optional. |
disabledForGroup | String | The ID of an Azure Active Directory group, of which the specified type of insights are disabled for its members. Default is empty . Optional. |
itemAddress
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
detail | physicalAddress | Details about the address itself. |
displayName | String | Friendly name the user has assigned to this address. |
geoCoordinates | geoCoordinates | The geocoordinates of the address. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
itemBody
Property | Type | Description |
---|---|---|
content | String | The content of the item. |
contentType | bodyType | The type of the content. Possible values are text and html . |
itemEmail
Property | Type | Description |
---|---|---|
address | String | The email address itself. |
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
displayName | String | The name or label a user has associated with a particular email address. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
type | emailType | The type of email address. Possible values are: unknown , work , personal , main , other . |
itemFacet
Property | Type | Description |
---|---|---|
allowedAudiences | allowedAudiences | The audiences that are able to see the values contained within the associated entity. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. |
id | String | Identifier used for individually addressing an entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. |
source | personDataSource | Where the values within an entity originated if synced from another service. |
itemPatent
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Descpription of the patent or filing. |
displayName | String | Title of the patent or filing. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
isPending | Boolean | Indicates the patent is pending. |
issuedDate | Date | The date that the patent was granted. |
issuingAuthority | String | Authority which granted the patent. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
number | String | The patent number. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
webUrl | String | URL referencing the patent or filing. |
itemPhone
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
displayName | String | Friendly name the user has assigned this phone number. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
number | String | Phone number provided by the user. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
type | phoneType | The type of phone number within the object. Possible values are: home , business , mobile , other , assistant , homeFax , businessFax , otherFax , pager , radio . |
itemPublication
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Description of the publication. |
displayName | String | Title of the publication. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
publishedDate | Date | The date that the publication was published. |
publisher | String | Publication or publisher for the publication. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
thumbnailUrl | String | URL referencing a thumbnail of the publication. |
webUrl | String | URL referencing the publication. |
languageProficiency
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
displayName | String | Contains the long-form name for the language. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
reading | languageProficiencyLevel | Represents the users reading comprehension for the language represented by the object. Possible values are: elementary , conversational , limitedWorking , professionalWorking , fullProfessional , nativeOrBilingual , unknownFutureValue . |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
spoken | languageProficiencyLevel | Represents the users spoken proficiency for the language represented by the object. Possible values are: elementary , conversational , limitedWorking , professionalWorking , fullProfessional , nativeOrBilingual , unknownFutureValue . |
tag | String | Contains the four-character BCP47 name for the language (en-US, no-NB, en-AU). |
written | languageProficiencyLevel | Represents the users written proficiency for the language represented by the object. Possible values are: elementary , conversational , limitedWorking , professionalWorking , fullProfessional , nativeOrBilingual , unknownFutureValue . |
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 skuPartNumber on the related SubscribedSku object; for example: "AAD_Premium". Read-only |
localeInfo
Property | Type | Description |
---|---|---|
displayName | string | A name representing the user's locale in natural language, for example, "English (United States)". |
locale | string | A locale representation for the user, which includes the user's preferred language and country/region. For example, "en-us". The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2. |
organizationalBranding
Property | Type | Description |
---|---|---|
backgroundColor | String | Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF . Inherited from organizationalBrandingProperties. |
backgroundImage | Stream | Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. Inherited from organizationalBrandingProperties. Returned only on $select . |
backgroundImageRelativeUrl | String | A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties. |
bannerLogo | Stream | A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties. Returned only on $select . |
bannerLogoRelativeUrl | String | A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. Inherited from organizationalBrandingProperties. |
cdnList | String collection | A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. Inherited from organizationalBrandingProperties. |
id | String | An identifier that represents the locale specified using culture names. Culture names follow the RFC 1766 standard in the format "languagecode2-country/regioncode2", where "languagecode2" is a lowercase two-letter code derived from ISO 639-1 and "country/regioncode2" is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is en-US . The id for the default /branding is always the String types 0 or default . Read-only. NOTE: Multiple branding for a single locale are currently not supported. Inherited from organizationalBrandingProperties. |
signInPageText | String | Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. Inherited from organizationalBrandingProperties. |
squareLogo | Stream | A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties. Returned only on $select . |
squareLogoRelativeUrl | String | A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties. |
usernameHintText | String | String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. Inherited from organizationalBrandingProperties. |
organizationalBrandingLocalization
Property | Type | Description |
---|---|---|
backgroundColor | String | Color that will appear in place of the background image in low-bandwidth connections. We recommend that you use the primary color of your banner logo or your organization color. Specify this in hexadecimal format, for example, white is #FFFFFF . Inherited from organizationalBrandingProperties. |
backgroundImage | Stream | Image that appears as the background of the sign-in page. The allowed types are PNG or JPEG not smaller than 300 KB and not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. Inherited from organizationalBrandingProperties. |
backgroundImageRelativeUrl | String | A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties. |
bannerLogo | Stream | A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties. |
bannerLogoRelativeUrl | String | A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the read-only version served by a CDN. Read-only. Inherited from organizationalBrandingProperties. |
cdnList | String collection | A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN providers are used at the same time for high availability of read requests. Read-only. Inherited from organizationalBrandingProperties. |
id | String | An identifier that represents the locale specified using culture names. Culture names follow the RFC 1766 standard in the format "languagecode2-country/regioncode2", where "languagecode2" is a lowercase two-letter code derived from ISO 639-1 and "country/regioncode2" is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is en-US . The id for the default /branding is always the String types 0 or default . Read-only. NOTE: Multiple branding for a single locale are currently not supported. Inherited from organizationalBrandingProperties. |
signInPageText | String | Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. Inherited from organizationalBrandingProperties. |
squareLogo | Stream | A square version of your company logo that appears in Windows 10 out-of-box experiences (OOBE) and when Windows Autopilot is enabled for deployment. Allowed types are PNG or JPEG no larger than 240 x 240 pixels and no more than 10 KB in size. We recommend using a transparent image with no padding around the logo. Inherited from organizationalBrandingProperties. |
squareLogoRelativeUrl | String | A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version served by a CDN. Read-only. Inherited from organizationalBrandingProperties. |
usernameHintText | String | String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links or code, and can't exceed 64 characters. Inherited from organizationalBrandingProperties. |
organizationSettings
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). |
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). |
personAnniversary
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
date | Date | Contains the date associated with the anniversary type. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
type | anniversaryType | The type of anniversary the date represents. Possible values are: birthday , wedding , unknownFutureValue . |
personAnnotation
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
detail | itemBody | Contains the detail of the note itself. |
displayName | String | Contains a friendly name for the note. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
personAward
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Descpription of the award or honor. |
displayName | String | Name of the award or honor. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
issuedDate | Date | The date that the award or honor was granted. |
issuingAuthority | String | Authority which granted the award or honor. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
thumbnailUrl | String | URL referencing a thumbnail of the award or honor. |
webUrl | String | URL referencing the award or honor. |
personCertification
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
certificationId | String | The referenceable identifier for the certification. |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Description of the certification. |
displayName | String | Title of the certification. |
endDate | Date | The date that the certification expires. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
issuedDate | Date | The date that the certification was issued. |
issuingAuthority | String | Authority which granted the certification. |
issuingCompany | String | Company which granted the certification. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
startDate | Date | The date that the certification became valid. |
thumbnailUrl | String | URL referencing a thumbnail of the certification. |
webUrl | String | URL referencing the certification. |
personInterest
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
categories | String collection | Contains categories a user has associated with the interest (for example, personal, recipies). |
collaborationTags | String collection | Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout , ableToMentor , wantsToLearn , wantsToImprove . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Contains a description of the interest. |
displayName | String | Contains a friendly name for the interest. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
webUrl | String | Contains a link to a web page or resource about the interest. |
personName
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
displayName | String | Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device. |
first | String | First name of the user. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
initials | String | Initials of the user. |
languageTag | String | Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format. |
last | String | Last name of the user. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
maiden | String | Maiden name of the user. |
middle | String | Middle name of the user. |
nickname | String | Nickname of the user. |
pronunciation | yomiPersonName | Guidance on how to pronounce the users name. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
suffix | String | Designators used after the users name (eg: PhD.) |
title | String | Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.) |
personResponsibility
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
collaborationTags | String collection | Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout , ableToMentor , wantsToLearn , wantsToImprove . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Description of the responsibility. |
displayName | String | Contains a friendly name for the responsibility. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
webUrl | String | Contains a link to a web page or resource about the responsibility. |
personWebsite
Property | Type | Description |
---|---|---|
categories | String collection | Contains categories a user has associated with the website (for example, personal, recipes). |
description | String | Contains a description of the website. |
displayName | String | Contains a friendly name for the website. |
webUrl | String | Contains a link to the website itself. |
profile
Property | Type | Description |
---|---|---|
id | String | Read-only. |
profileCardProperty
Property | Type | Description |
---|---|---|
annotations | profileCardAnnotation collection | Allows an administrator to set a custom display label for the directory property and localize it for the users in their tenant. |
directoryPropertyName | String | Identifies a **p |
profilePhoto
Property | Type | Description |
---|---|---|
id | string | Read-only. |
height | int32 | The height of the photo. Read-only. |
width | int32 | The width of the photo. Read-only. |
projectParticipation
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
categories | String collection | Contains categories a user has associated with the project (for example, digital transformation, oil rig). |
client | companyDetail | Contains detailed information about the client the project was for. |
collaborationTags | String collection | Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout , ableToMentor , wantsToLearn , wantsToImprove . |
colleagues | relatedPerson collection | Lists people that also worked on the project. |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
detail | positionDetail | Contains detail about the user's role on the project. |
displayName | String | Contains a friendly name for the project. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
sponsors | relatedPerson collection | The Person or people who sponsored the project. |
regionalAndLanguageSettings
Property | Type | Description |
---|---|---|
defaultDisplayLanguage | localeInfo | The user's preferred user interface language (menus, buttons, ribbons, warning messages) for Microsoft web applications. Returned by default. Not nullable. |
authoringLanguages | localeInfo collection | Prioritized list of languages the user reads and authors in. Returned by default. Not nullable. |
defaultTranslationLanguage | localeInfo | The language a user expects to have documents, emails, and messages translated into. Returned by default. |
defaultSpeechInputLanguage | localeInfo | The language a user expected to use as input for text to speech scenarios. Returned by default. |
defaultRegionalFormat | localeInfo | The locale that drives the default date, time, and calendar formatting. Returned by default. |
regionalFormatOverrides | regionalFormatOverrides | Allows a user to override their defaultRegionalFormat with field specific formats. Returned by default. |
translationPreferences | translationPreferences | The user's preferred settings when consuming translated documents, emails, messages, and websites. Returned by default. Not nullable. |
servicePrincipal
Property | Type | Description |
---|---|---|
accountEnabled | Boolean | true if the service principal account is enabled; otherwise, false . If set to false , then no users will be able to sign in to this app, even if they are assigned to it. Supports $filter (eq , ne , not , in ). |
addIns | addIn collection | Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This will let services like Microsoft 365 call the application in the context of a document the user is working on. |
alternativeNames | String collection | Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities. Supports $filter (eq , not , ge , le , startsWith ). |
appDescription | String | The description exposed by the associated application. |
appDisplayName | String | The display name exposed by the associated application. |
appId | String | The unique identifier for the associated application (its appId property). Supports $filter (eq , ne , not , in , startsWith ). |
applicationTemplateId | String | Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter (eq , ne , NOT , startsWith ). |
appOwnerOrganizationId | Guid | Contains the tenant id where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq , ne , NOT , ge , le ). |
appRoleAssignmentRequired | Boolean | Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false . Not nullable. Supports $filter (eq , ne , NOT ). |
appRoles | appRole collection | The roles exposed by the application which this service principal represents. For more information see the appRoles property definition on the application entity. Not nullable. |
deletedDateTime | DateTimeOffset | The date and time the service principal was deleted. Read-only. |
description | String | Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports $filter (eq , ne , not , ge , le , startsWith ) and $search . |
disabledByMicrosoftStatus | String | Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), NotDisabled , and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq , ne , not ). |
displayName | String | The display name for the service principal. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $search , and $orderBy . |
homepage | String | Home page or landing page of the application. |
id | String | The unique identifier for the service principal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq , ne , not , in ). |
info | informationalUrl | Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps. Supports $filter (eq , ne , not , ge , le , and eq on null values). |
keyCredentials | keyCredential collection | The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq , not , ge , le ). |
loginUrl | String | Specifies the URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL. |
logoutUrl | String | Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols. |
notes | String | Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1024 characters. |
notificationEmailAddresses | String collection | Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications. |
oauth2PermissionScopes | permissionScope collection | The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes property on the application entity's api property. Not nullable. |
passwordCredentials | passwordCredential collection | The collection of password credentials associated with the application. Not nullable. |
preferredSingleSignOnMode | string | Specifies the single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. The supported values are password , saml , notSupported , and oidc . |
preferredTokenSigningKeyThumbprint | String | Reserved for internal use only. Do not write or otherwise rely on this property. May be removed in future versions. |
replyUrls | String collection | The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. |
resourceSpecificApplicationPermissions | resourceSpecificPermission collection | The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only. |
samlSingleSignOnSettings | samlSingleSignOnSettings | The collection for settings related to saml single sign-on. |
servicePrincipalNames | String collection | Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For example,
The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq , not , ge , le , startsWith ). |
servicePrincipalType | String | Identifies whether the service principal represents an application, a managed identity, or a legacy application. This is set by Azure AD internally. The servicePrincipalType property can be set to three different values:
|
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. Supports $filter (eq , not , ge , le , startsWith ). |
tokenEncryptionKeyId | String | Specifies the keyId of a public key from the keyCredentials collection. When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. |
verifiedPublisher | verifiedPublisher | Specifies the verified publisher of the application which this service principal represents. |
shiftPreferences
Property | Type | Description |
---|---|---|
availability | shiftAvailability collection | Availability of the user to be scheduled for work and its recurrence pattern. |
createdDateTime | Edm.DateTimeOffset |
Timestamp corresponding to when the entity was created. |
id | Edm.String |
The identifier of the entity. |
lastModifiedBy | identitySet | Identity of the person who last modified the entity. |
lastModifiedDateTime | Edm.DateTimeOffset |
Timestamp corresponding to when the entity was last modified. |
@odata.etag | Edm.String |
The change key for the entity. |
skillProficiency
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
categories | String collection | Contains categories a user has associated with the skill (for example, personal, professional, hobby). |
collaborationTags | String collection | Contains experience scenario tags a user has associated with the interest. Allowed values in the collection are: askMeAbout , ableToMentor , wantsToLearn , wantsToImprove . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
displayName | String | Contains a friendly name for the skill. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
proficiency | skillProficiencyLevel | Detail of the users proficiency with this skill. Possible values are: elementary , limitedWorking , generalProfessional , advancedProfessional , expert , unknownFutureValue . |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
webUrl | String | Contains a link to an information source about the skill. |
team
Property | Type | Description |
---|---|---|
id | string | The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type. |
classification | string | An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory. |
classSettings | teamClassSettings | Configure settings of a class. Available only when the team represents a class. |
createdDateTime | dateTimeOffset | Timestamp at which the team was created. |
description | string | An optional description for the team. Maximum length: 1024 characters. |
displayName | string | The name of the team. |
funSettings | teamFunSettings | Settings to configure use of Giphy, memes, and stickers in the team. |
guestSettings | teamGuestSettings | Settings to configure whether guests can create, update, or delete channels in the team. |
internalId | string | A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API. |
isArchived | Boolean | Whether this team is in read-only mode. |
memberSettings | teamMemberSettings | Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team. |
messagingSettings | teamMessagingSettings | Settings to configure messaging and mentions in the team. |
specialization | teamSpecialization | Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case. |
summary | teamSummary | Contains summary information about the team, including number of owners, members, and guests. |
tenantId | string | The ID of the Azure Active Directory tenant. |
visibility | teamVisibilityType | The visibility of the group and team. Defaults to Public. |
webUrl | string (readonly) | A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select **G |
timeZoneInformation
Property | Type | Description |
---|---|---|
alias | string | An identifier for the time zone. |
displayName | string | A display string that represents the time zone. |
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 . |
user
Property | Type | Description |
---|---|---|
aboutMe | String | A freeform text entry field for the user to describe themselves. Returned only on $select . |
accountEnabled | Boolean | true if the account is enabled; otherwise, false . This property is required when a user is created. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
ageGroup | ageGroup | Sets the age group of the user. Allowed values: null , Minor , NotAdult and Adult . Refer to the legal age group property definitions for further information. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
assignedLicenses | assignedLicense collection | The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select . Supports $filter (eq , not , /$count eq 0 , /$count ne 0 ). |
assignedPlans | assignedPlan collection | The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select . Supports $filter (eq and not ). |
birthday | DateTimeOffset | The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned only on $select . |
businessPhones | String collection | The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq , not , ge , le , startsWith ). |
city | String | The city in which the user is located. Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
companyName | String | The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
consentProvidedForMinor | consentProvidedForMinor | Sets whether consent has been obtained for minors. Allowed values: null , Granted , Denied and NotRequired . Refer to the legal age group property definitions for further information. Returned only on $select . Supports $filter (eq , ne , not , and in ). |
country | String | The country/region in which the user is located; for example, US or UK . Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
createdDateTime | DateTimeOffset | The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
creationType | String | Indicates whether the user account was created through one of the following methods:
Read-only. Returned only on $select . Supports $filter (eq , ne , not , in ). |
deletedDateTime | DateTimeOffset | The date and time the user was deleted. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
department | String | The name for the department in which the user works. Maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , and eq on null values). |
displayName | String | The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values), $orderBy , and $search . |
employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in case of a future hire. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
employeeOrgData | employeeOrgData | Represents organization data (e.g. division and costCenter) associated with a user. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
employeeType | String | Captures enterprise worker type. For example, Employee , Contractor , Consultant , or Vendor . Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
externalUserState | String | For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted , or null for all other users. Returned only on $select . Supports $filter (eq , ne , not , in ). |
externalUserStateChangeDateTime | DateTimeOffset | Shows the timestamp for the latest change to the externalUserState property. Returned only on $select . Supports $filter (eq , ne , not , in ). |
faxNumber | String | The fax number of the user. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
givenName | String | The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
hireDate | DateTimeOffset | The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned only on $select . Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. |
id | String | The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only. Returned by default. Supports $filter (eq , ne , not , in ). |
identities | objectIdentity collection | Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on $select . Supports $filter (eq ) including on null values, only where the signInType is not userPrincipalName . |
imAddresses | String collection | The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned only on $select . Supports $filter (eq , not , ge , le , startsWith ). |
interests | String collection | A list for the user to describe their interests. Returned only on $select . |
isResourceAccount | Boolean | Do not use – reserved for future use. |
jobTitle | String | The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
lastPasswordChangeDateTime | DateTimeOffset | The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Returned only on $select . |
legalAgeGroupClassification | legalAgeGroupClassification | Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null , MinorWithOutParentalConsent , MinorWithParentalConsent , MinorNoParentalConsentRequired , NotAdult and Adult . Refer to the legal age group property definitions for further information. Returned only on $select . |
licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only. Returned only on $select . |
String | The SMTP address for the user, for example, [email protected] . Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters. NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , endsWith , and eq on null values). |
|
mailboxSettings | mailboxSettings | Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone. Returned only on $select . |
mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
mySite | String | The URL for the user's personal site. Returned only on $select . |
officeLocation | String | The office location in the user's place of business. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
onPremisesDistinguishedName | String | Contains the on-premises Active Directory distinguished name or DN . The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select . |
onPremisesDomainName | String | Contains the on-premises domainFQDN , also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select . |
onPremisesExtensionAttributes | onPremisesExtensionAttributes | Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. false ), these properties can be set during 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 Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ).. |
onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z . The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z . Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in ). |
onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned only on $select . Supports $filter (eq , not , ge , le ). |
onPremisesSamAccountName | String | Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Returned only on $select . Supports $filter (eq including on null values). |
onPremisesSyncEnabled | Boolean | true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Azure Active Directory (Azure AD). Read-only. Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). |
onPremisesUserPrincipalName | String | Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith ). |
otherMails | String collection | A list of additional email addresses for the user; for example: ["[email protected]", "[email protected]"] . NOTE: This property cannot contain accent characters. Returned only on $select . Supports $filter (eq , not , ge , le , in , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword , which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword . Returned only on $select . For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne , not , and eq on null values). |
passwordProfile | passwordProfile | Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). |
pastProjects | String collection | A list for the user to enumerate their past projects. Returned only on $select . |
postalCode | String | The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
preferredDataLocation | String | The preferred data location for the user. For more information, see OneDrive Online Multi-Geo. |
preferredLanguage | String | The preferred language for the user. Should follow ISO 639-1 Code; for example en-US . Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values) |
preferredName | String | The preferred name for the user. Not Supported. This attribute returns an empty string. Returned only on $select . |
provisionedPlans | provisionedPlan collection | The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select . Supports $filter (eq , not , ge , le ). |
proxyAddresses | String collection | For example: "SMTP: [email protected]", "smtp: [email protected]"] . Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Returned only on $select . Supports $filter (eq , not , ge , le , startsWith , endsWith , /$count eq 0 , /$count ne 0 ). |
refreshTokensValidFromDateTime | DateTimeOffset | Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Returned only on $select . Read-only. |
responsibilities | String collection | A list for the user to enumerate their responsibilities. Returned only on $select . |
schools | String collection | A list for the user to enumerate the schools they have attended. Returned only on $select . |
securityIdentifier | String | Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq , not , ge , le , startsWith ). |
showInAddressList | Boolean | Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue. |
signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset. Returned only on $select . |
skills | String collection | A list for the user to enumerate their skills. Returned only on $select . |
state | String | The state or province in the user's address. Maximum length is 128 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
streetAddress | String | The street address of the user's place of business. Maximum length is 1024 characters. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
surname | String | The user's surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
usageLocation | String | A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US , JP , and GB . Not nullable. Returned only on $select . Supports $filter (eq , ne , not , ge , le , in , startsWith , and eq on null values). |
userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is [email protected], where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z , a - z , 0 - 9 , ' . - _ ! # ^ ~ . For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq , ne , not , ge , le , in , startsWith , endsWith ) and $orderBy . |
userType | String | A string value that can be used to classify user types in your directory, such as Member and Guest . Returned only on $select . Supports $filter (eq , ne , not , in , and eq on null values). **N |
userAccountInformation
Property | Type | Description |
---|---|---|
ageGroup | String | Shows the age group of user. Allowed values null , minor , notAdult and adult are generated by the directory and cannot be changed. |
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
countryCode | String | Contains the two-character country code associated with the users account. |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
preferredLanguageTag | localeInfo | Contains the language the user has associated as preferred for the account. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
userPrincipalName | String | The user principal name (UPN) of the user associated with the account. |
userSettings
Property | Type | Description |
---|---|---|
contributionToContentDiscoveryAsOrganizationDisabled | Boolean | Reflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn't have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for Business is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center. |
contributionToContentDiscoveryDisabled | Boolean | When set to true, the delegate access to the user's trending API is disabled. When set to true, documents in the user's Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for Business is affected. Users can control this setting in Office Delve. |
id | String | Unique identifier of the user setting. Read-only. Inherited from entity. |
webAccount
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
description | String | Contains the description the user has provided for the account on the service being referenced. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
service | serviceInformation | Contains basic detail about the service that is being associated. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
statusMessage | String | Contains a status message from the cloud service if provided or synchronized. |
userId | String | The user name displayed for the webaccount. |
webUrl | String | Contains a link to the user's profile on the cloud service if one exists. |
workPosition
Property | Type | Description |
---|---|---|
allowedAudiences | String | The audiences that are able to see the values contained within the entity. Inherited from itemFacet. Possible values are: me , family , contacts , groupMembers , organization , federatedOrganizations , everyone , unknownFutureValue . |
categories | String collection | Categories that the user has associated with this position. |
colleagues | relatedPerson collection | Colleagues that are associated with this position. |
createdBy | identitySet | Provides the identifier of the user and/or application that created the entity. Inherited from itemFacet. |
createdDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
detail | positionDetail | Contains detailed information about the position. |
id | String | Identifier used for individually addressing the entity. Inherited from entity |
inference | inferenceData | Contains inference detail if the entity is inferred by the creating or modifying application. Inherited from itemFacet. |
isCurrent | Boolean | Denotes whether or not the position is current. |
lastModifiedBy | identitySet | Provides the identifier of the user and/or application that last modified the entity. Inherited from itemFacet. |
lastModifiedDateTime | DateTimeOffset | Provides the dateTimeOffset for when the entity was created. Inherited from itemFacet. |
manager | relatedPerson | Contains detail of the user's manager in this position. |
source | personDataSource | Where the values originated if synced from another service. Inherited from itemFacet. |
yomiPersonName
Property | Type | Description |
---|---|---|
displayName | String | Composite of first and last name pronunciation guides. |
first | String | Pronunciation guide for the first name of the user. |
last | String | Pronunciation guide for the last name of the user. |
maiden | String | Pronunciation guide for the maiden name of the user. |
middle | String | Pronunciation guide for the middle name of the user. |