User extends DirectoryObject
User class
Tags
Table of Contents
- $_propDict : array<string|int, mixed>
- The array of properties available to the model
- __construct() : mixed
- Construct a new Entity
- getAboutMe() : string|null
- Gets the aboutMe A freeform text entry field for the user to describe themselves. Returned only on $select.
- getAccountEnabled() : bool|null
- Gets the accountEnabled 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).
- getActivities() : array<string|int, mixed>|null
- Gets the activities The user's activities across devices. Read-only. Nullable.
- getAgeGroup() : string|null
- Gets the 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).
- getAgreementAcceptances() : array<string|int, mixed>|null
- Gets the agreementAcceptances The user's terms of use acceptance statuses. Read-only. Nullable.
- getAnalytics() : UserAnalytics|null
- Gets the analytics
- getAppConsentRequestsForApproval() : array<string|int, mixed>|null
- Gets the appConsentRequestsForApproval
- getAppRoleAssignments() : array<string|int, mixed>|null
- Gets the appRoleAssignments Represents the app roles a user has been granted for an application. Supports $expand.
- getApprovals() : array<string|int, mixed>|null
- Gets the approvals
- getAssignedLicenses() : array<string|int, mixed>|null
- Gets the assignedLicenses The licenses that are assigned to the user, including inherited (group-based) licenses. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
- getAssignedPlans() : array<string|int, mixed>|null
- Gets the assignedPlans The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
- getAuthentication() : Authentication|null
- Gets the authentication
- getBirthday() : DateTime|null
- Gets the birthday 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.
- getBusinessPhones() : string|null
- Gets the businessPhones 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 and NOT).
- getCalendar() : Calendar|null
- Gets the calendar The user's primary calendar. Read-only.
- getCalendarGroups() : array<string|int, mixed>|null
- Gets the calendarGroups The user's calendar groups. Read-only. Nullable.
- getCalendars() : array<string|int, mixed>|null
- Gets the calendars The user's calendars. Read-only. Nullable.
- getCalendarView() : array<string|int, mixed>|null
- Gets the calendarView The calendar view for the calendar. Read-only. Nullable.
- getChats() : array<string|int, mixed>|null
- Gets the chats
- getCity() : string|null
- Gets the city 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).
- getCompanyName() : string|null
- Gets the companyName 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 of the company name is 64 characters.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- getConsentProvidedForMinor() : string|null
- Gets the 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).
- getContactFolders() : array<string|int, mixed>|null
- Gets the contactFolders The user's contacts folders. Read-only. Nullable.
- getContacts() : array<string|int, mixed>|null
- Gets the contacts The user's contacts. Read-only. Nullable.
- getCountry() : string|null
- Gets the country 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).
- getCreatedDateTime() : DateTime|null
- Gets the createdDateTime The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, and in operators).
- getCreatedObjects() : array<string|int, mixed>|null
- Gets the createdObjects Directory objects that were created by the user. Read-only. Nullable.
- getCreationType() : string|null
- Gets the creationType Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, and in).
- getDeletedDateTime() : DateTime|null
- Gets the deletedDateTime
- getDepartment() : string|null
- Gets the department 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, and in operators).
- getDeviceEnrollmentConfigurations() : array<string|int, mixed>|null
- Gets the deviceEnrollmentConfigurations Get enrollment configurations targeted to the user
- getDeviceEnrollmentLimit() : int|null
- Gets the deviceEnrollmentLimit The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
- getDeviceKeys() : array<string|int, mixed>|null
- Gets the deviceKeys
- getDeviceManagementTroubleshootingEvents() : array<string|int, mixed>|null
- Gets the deviceManagementTroubleshootingEvents The list of troubleshooting events for this user.
- getDevices() : array<string|int, mixed>|null
- Gets the devices
- getDirectReports() : array<string|int, mixed>|null
- Gets the directReports The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
- getDisplayName() : string|null
- Gets the displayName 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), $orderBy, and $search.
- getDrive() : Drive|null
- Gets the drive The user's OneDrive. Read-only.
- getDrives() : array<string|int, mixed>|null
- Gets the drives A collection of drives available for this user. Read-only.
- getEmployeeHireDate() : DateTime|null
- Gets the employeeHireDate 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).
- getEmployeeId() : string|null
- Gets the employeeId The employee identifier assigned to the user by the organization. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- getEmployeeOrgData() : EmployeeOrgData|null
- Gets the 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).
- getEmployeeType() : string|null
- Gets the employeeType Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- getEvents() : array<string|int, mixed>|null
- Gets the events The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
- getExtensions() : array<string|int, mixed>|null
- Gets the extensions The collection of open extensions defined for the user. Read-only. Nullable.
- getExternalUserState() : string|null
- Gets the externalUserState 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).
- getExternalUserStateChangeDateTime() : string|null
- Gets the externalUserStateChangeDateTime Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, NOT , in).
- getFaxNumber() : string|null
- Gets the faxNumber The fax number of the user. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- getFollowedSites() : array<string|int, mixed>|null
- Gets the followedSites
- getGivenName() : string|null
- Gets the givenName 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).
- getHireDate() : DateTime|null
- Gets the hireDate 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.
- getId() : string|null
- Gets the id Read-only.
- getIdentities() : array<string|int, mixed>|null
- Gets the identities 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) only where the signInType is not userPrincipalName.
- getImAddresses() : string|null
- Gets the imAddresses 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).
- getInferenceClassification() : InferenceClassification|null
- Gets the inferenceClassification Relevance classification of the user's messages based on explicit designations which override inferred relevance or importance.
- getInfoCatalogs() : string|null
- Gets the infoCatalogs Identifies the info segments assigned to the user. Supports $filter (eq, NOT, ge, le, startsWith).
- getInformationProtection() : InformationProtection|null
- Gets the informationProtection
- getInsights() : ItemInsights|null
- Gets the insights Read-only. Nullable.
- getInterests() : string|null
- Gets the interests A list for the user to describe their interests. Returned only on $select.
- getIsResourceAccount() : bool|null
- Gets the isResourceAccount Do not use – reserved for future use.
- getJobTitle() : string|null
- Gets the jobTitle The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- getJoinedGroups() : array<string|int, mixed>|null
- Gets the joinedGroups Read-only. Nullable.
- getJoinedTeams() : array<string|int, mixed>|null
- Gets the joinedTeams The Microsoft Teams teams that the user is a member of. Read-only. Nullable.
- getLastPasswordChangeDateTime() : DateTime|null
- Gets the lastPasswordChangeDateTime The time when this Azure AD user last changed their password. 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.
- getLegalAgeGroupClassification() : string|null
- Gets the 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.
- getLicenseAssignmentStates() : array<string|int, mixed>|null
- Gets the licenseAssignmentStates State of license assignments for this user. Read-only. Returned only on $select.
- getLicenseDetails() : array<string|int, mixed>|null
- Gets the licenseDetails A collection of this user's license details. Read-only.
- getMail() : string|null
- Gets the mail The SMTP address for the user, for example<EMAIL_ADDRESS>to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith).
- getMailboxSettings() : MailboxSettings|null
- Gets the 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.
- getMailFolders() : array<string|int, mixed>|null
- Gets the mailFolders The user's mail folders. Read-only. Nullable.
- getMailNickname() : string|null
- Gets the mailNickname 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).
- getManagedAppRegistrations() : array<string|int, mixed>|null
- Gets the managedAppRegistrations Zero or more managed app registrations that belong to the user.
- getManagedDevices() : array<string|int, mixed>|null
- Gets the managedDevices The managed devices associated with the user.
- getManager() : DirectoryObject|null
- Gets the manager The user or contact that is this user's manager. Read-only. (HTTP Methods: GET, PUT, DELETE.). Supports $expand.
- getMemberOf() : array<string|int, mixed>|null
- Gets the memberOf The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
- getMessages() : array<string|int, mixed>|null
- Gets the messages The messages in a mailbox or folder. Read-only. Nullable.
- getMobileAppIntentAndStates() : array<string|int, mixed>|null
- Gets the mobileAppIntentAndStates The list of troubleshooting events for this user.
- getMobileAppTroubleshootingEvents() : array<string|int, mixed>|null
- Gets the mobileAppTroubleshootingEvents The list of mobile app troubleshooting events for this user.
- getMobilePhone() : string|null
- Gets the mobilePhone 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).
- getMySite() : string|null
- Gets the mySite The URL for the user's personal site. Returned only on $select.
- getNotifications() : array<string|int, mixed>|null
- Gets the notifications
- getOauth2PermissionGrants() : array<string|int, mixed>|null
- Gets the oauth2PermissionGrants
- getODataType() : string|null
- Gets the ODataType
- getOfficeLocation() : string|null
- Gets the officeLocation The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- getOnenote() : Onenote|null
- Gets the onenote Read-only.
- getOnlineMeetings() : array<string|int, mixed>|null
- Gets the onlineMeetings
- getOnPremisesDistinguishedName() : string|null
- Gets the onPremisesDistinguishedName 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.
- getOnPremisesDomainName() : string|null
- Gets the onPremisesDomainName 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.
- getOnPremisesExtensionAttributes() : OnPremisesExtensionAttributes|null
- Gets the onPremisesExtensionAttributes Contains extensionAttributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set during creation or update. These extension attributes are also known as Exchange custom attributes 1-15. Returned only on $select. Supports $filter (eq, NOT, ge, le, in).
- getOnPremisesImmutableId() : string|null
- Gets the onPremisesImmutableId 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).
- getOnPremisesLastSyncDateTime() : DateTime|null
- Gets the onPremisesLastSyncDateTime 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).
- getOnPremisesProvisioningErrors() : array<string|int, mixed>|null
- Gets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, NOT, ge, le).
- getOnPremisesSamAccountName() : string|null
- Gets the onPremisesSamAccountName 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).
- getOnPremisesSecurityIdentifier() : string|null
- Gets the onPremisesSecurityIdentifier 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.
- getOnPremisesSyncEnabled() : bool|null
- Gets the onPremisesSyncEnabled 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. Returned only on $select. Supports $filter (eq, ne, NOT, in).
- getOnPremisesUserPrincipalName() : string|null
- Gets the onPremisesUserPrincipalName 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).
- getOtherMails() : string|null
- Gets the otherMails A list of additional email addresses for the user; for example<EMAIL_ADDRESS><EMAIL_ADDRESS>NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, NOT, ge, le, in, startsWith).
- getOutlook() : OutlookUser|null
- Gets the outlook Read-only.
- getOwnedDevices() : array<string|int, mixed>|null
- Gets the ownedDevices Devices that are owned by the user. Read-only. Nullable. Supports $expand.
- getOwnedObjects() : array<string|int, mixed>|null
- Gets the ownedObjects Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.
- getPasswordPolicies() : string|null
- Gets the passwordPolicies 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).
- getPasswordProfile() : PasswordProfile|null
- Gets the 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. NOTE: For Azure B2C tenants, the forceChangePasswordNextSignIn property should be set to false and instead use custom policies and user flows to force password reset at first logon. See Force password reset at first logon.Returned only on $select. Supports $filter (eq, ne, NOT, in).
- getPastProjects() : string|null
- Gets the pastProjects A list for the user to enumerate their past projects. Returned only on $select.
- getPendingAccessReviewInstances() : array<string|int, mixed>|null
- Gets the pendingAccessReviewInstances Navigation property to get list of access reviews pending approval by reviewer.
- getPeople() : array<string|int, mixed>|null
- Gets the people People that are relevant to the user. Read-only. Nullable.
- getPhoto() : ProfilePhoto|null
- Gets the photo The user's profile photo. Read-only.
- getPhotos() : array<string|int, mixed>|null
- Gets the photos Read-only. Nullable.
- getPlanner() : PlannerUser|null
- Gets the planner Entry-point to the Planner resource that might exist for a user. Read-only.
- getPostalCode() : string|null
- Gets the postalCode 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).
- getPreferredDataLocation() : string|null
- Gets the preferredDataLocation The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
- getPreferredLanguage() : string|null
- Gets the preferredLanguage 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)
- getPreferredName() : string|null
- Gets the preferredName The preferred name for the user. Returned only on $select.
- getPresence() : Presence|null
- Gets the presence
- getProfile() : Profile|null
- Gets the profile Represents properties that are descriptive of a user in a tenant.
- getProperties() : array<string|int, mixed>
- Gets the property dictionary of the Entity
- getProvisionedPlans() : array<string|int, mixed>|null
- Gets the provisionedPlans The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le).
- getProxyAddresses() : string|null
- Gets the proxyAddresses For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only, Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le, startsWith).
- getRefreshTokensValidFromDateTime() : DateTime|null
- Gets the refreshTokensValidFromDateTime 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.
- getRegisteredDevices() : array<string|int, mixed>|null
- Gets the registeredDevices Devices that are registered for the user. Read-only. Nullable. Supports $expand.
- getResponsibilities() : string|null
- Gets the responsibilities A list for the user to enumerate their responsibilities. Returned only on $select.
- getSchools() : string|null
- Gets the schools A list for the user to enumerate the schools they have attended. Returned only on $select.
- getScopedRoleMemberOf() : array<string|int, mixed>|null
- Gets the scopedRoleMemberOf The scoped-role administrative unit memberships for this user. Read-only. Nullable.
- getSettings() : UserSettings|null
- Gets the settings Read-only. Nullable.
- getShowInAddressList() : bool|null
- Gets the showInAddressList true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Returned only on $select. Supports $filter (eq, ne, NOT, in).
- getSignInActivity() : SignInActivity|null
- Gets the signInActivity Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le) but, not with any other filterable properties. Note: Details for this property require an Azure AD Premium P1/P2 license and the AuditLog.Read.All permission.Note: There's a known issue with retrieving this property.
- getSignInSessionsValidFromDateTime() : DateTime|null
- Gets the signInSessionsValidFromDateTime 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.
- getSkills() : string|null
- Gets the skills A list for the user to enumerate their skills. Returned only on $select.
- getState() : string|null
- Gets the state 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).
- getStreetAddress() : string|null
- Gets the streetAddress 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).
- getSurname() : string|null
- Gets the surname 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).
- getTeamwork() : UserTeamwork|null
- Gets the teamwork A container for Microsoft Teams features available for the user. Read-only. Nullable.
- getTodo() : Todo|null
- Gets the todo Represents the To Do services available to a user.
- getTransitiveMemberOf() : array<string|int, mixed>|null
- Gets the transitiveMemberOf
- getTransitiveReports() : array<string|int, mixed>|null
- Gets the transitiveReports The transitive reports for a user. Read-only.
- getUsageLocation() : string|null
- Gets the usageLocation 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).
- getUsageRights() : array<string|int, mixed>|null
- Gets the usageRights
- getUserPrincipalName() : string|null
- Gets the userPrincipalName 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 alias@domain, 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. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy.
- getUserType() : string|null
- Gets the userType 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).
- getWindowsInformationProtectionDeviceRegistrations() : array<string|int, mixed>|null
- Gets the windowsInformationProtectionDeviceRegistrations Zero or more WIP device registrations that belong to the user.
- jsonSerialize() : array<string|int, mixed>
- Serializes the object by property array Manually serialize DateTime into RFC3339 format
- setAboutMe() : User
- Sets the aboutMe A freeform text entry field for the user to describe themselves. Returned only on $select.
- setAccountEnabled() : User
- Sets the accountEnabled 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).
- setActivities() : User
- Sets the activities The user's activities across devices. Read-only. Nullable.
- setAgeGroup() : User
- Sets the 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).
- setAgreementAcceptances() : User
- Sets the agreementAcceptances The user's terms of use acceptance statuses. Read-only. Nullable.
- setAnalytics() : User
- Sets the analytics
- setAppConsentRequestsForApproval() : User
- Sets the appConsentRequestsForApproval
- setAppRoleAssignments() : User
- Sets the appRoleAssignments Represents the app roles a user has been granted for an application. Supports $expand.
- setApprovals() : User
- Sets the approvals
- setAssignedLicenses() : User
- Sets the assignedLicenses The licenses that are assigned to the user, including inherited (group-based) licenses. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
- setAssignedPlans() : User
- Sets the assignedPlans The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
- setAuthentication() : User
- Sets the authentication
- setBirthday() : User
- Sets the birthday 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.
- setBusinessPhones() : User
- Sets the businessPhones 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 and NOT).
- setCalendar() : User
- Sets the calendar The user's primary calendar. Read-only.
- setCalendarGroups() : User
- Sets the calendarGroups The user's calendar groups. Read-only. Nullable.
- setCalendars() : User
- Sets the calendars The user's calendars. Read-only. Nullable.
- setCalendarView() : User
- Sets the calendarView The calendar view for the calendar. Read-only. Nullable.
- setChats() : User
- Sets the chats
- setCity() : User
- Sets the city 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).
- setCompanyName() : User
- Sets the companyName 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 of the company name is 64 characters.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- setConsentProvidedForMinor() : User
- Sets the 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).
- setContactFolders() : User
- Sets the contactFolders The user's contacts folders. Read-only. Nullable.
- setContacts() : User
- Sets the contacts The user's contacts. Read-only. Nullable.
- setCountry() : User
- Sets the country 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).
- setCreatedDateTime() : User
- Sets the createdDateTime The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, and in operators).
- setCreatedObjects() : User
- Sets the createdObjects Directory objects that were created by the user. Read-only. Nullable.
- setCreationType() : User
- Sets the creationType Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, and in).
- setDeletedDateTime() : DirectoryObject
- Sets the deletedDateTime
- setDepartment() : User
- Sets the department 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, and in operators).
- setDeviceEnrollmentConfigurations() : User
- Sets the deviceEnrollmentConfigurations Get enrollment configurations targeted to the user
- setDeviceEnrollmentLimit() : User
- Sets the deviceEnrollmentLimit The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
- setDeviceKeys() : User
- Sets the deviceKeys
- setDeviceManagementTroubleshootingEvents() : User
- Sets the deviceManagementTroubleshootingEvents The list of troubleshooting events for this user.
- setDevices() : User
- Sets the devices
- setDirectReports() : User
- Sets the directReports The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
- setDisplayName() : User
- Sets the displayName 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), $orderBy, and $search.
- setDrive() : User
- Sets the drive The user's OneDrive. Read-only.
- setDrives() : User
- Sets the drives A collection of drives available for this user. Read-only.
- setEmployeeHireDate() : User
- Sets the employeeHireDate 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).
- setEmployeeId() : User
- Sets the employeeId The employee identifier assigned to the user by the organization. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- setEmployeeOrgData() : User
- Sets the 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).
- setEmployeeType() : User
- Sets the employeeType Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- setEvents() : User
- Sets the events The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
- setExtensions() : User
- Sets the extensions The collection of open extensions defined for the user. Read-only. Nullable.
- setExternalUserState() : User
- Sets the externalUserState 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).
- setExternalUserStateChangeDateTime() : User
- Sets the externalUserStateChangeDateTime Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, NOT , in).
- setFaxNumber() : User
- Sets the faxNumber The fax number of the user. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- setFollowedSites() : User
- Sets the followedSites
- setGivenName() : User
- Sets the givenName 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).
- setHireDate() : User
- Sets the hireDate 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.
- setId() : Entity
- Sets the id Read-only.
- setIdentities() : User
- Sets the identities 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) only where the signInType is not userPrincipalName.
- setImAddresses() : User
- Sets the imAddresses 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).
- setInferenceClassification() : User
- Sets the inferenceClassification Relevance classification of the user's messages based on explicit designations which override inferred relevance or importance.
- setInfoCatalogs() : User
- Sets the infoCatalogs Identifies the info segments assigned to the user. Supports $filter (eq, NOT, ge, le, startsWith).
- setInformationProtection() : User
- Sets the informationProtection
- setInsights() : User
- Sets the insights Read-only. Nullable.
- setInterests() : User
- Sets the interests A list for the user to describe their interests. Returned only on $select.
- setIsResourceAccount() : User
- Sets the isResourceAccount Do not use – reserved for future use.
- setJobTitle() : User
- Sets the jobTitle The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
- setJoinedGroups() : User
- Sets the joinedGroups Read-only. Nullable.
- setJoinedTeams() : User
- Sets the joinedTeams The Microsoft Teams teams that the user is a member of. Read-only. Nullable.
- setLastPasswordChangeDateTime() : User
- Sets the lastPasswordChangeDateTime The time when this Azure AD user last changed their password. 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.
- setLegalAgeGroupClassification() : User
- Sets the 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.
- setLicenseAssignmentStates() : User
- Sets the licenseAssignmentStates State of license assignments for this user. Read-only. Returned only on $select.
- setLicenseDetails() : User
- Sets the licenseDetails A collection of this user's license details. Read-only.
- setMail() : User
- Sets the mail The SMTP address for the user, for example<EMAIL_ADDRESS>to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith).
- setMailboxSettings() : User
- Sets the 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.
- setMailFolders() : User
- Sets the mailFolders The user's mail folders. Read-only. Nullable.
- setMailNickname() : User
- Sets the mailNickname 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).
- setManagedAppRegistrations() : User
- Sets the managedAppRegistrations Zero or more managed app registrations that belong to the user.
- setManagedDevices() : User
- Sets the managedDevices The managed devices associated with the user.
- setManager() : User
- Sets the manager The user or contact that is this user's manager. Read-only. (HTTP Methods: GET, PUT, DELETE.). Supports $expand.
- setMemberOf() : User
- Sets the memberOf The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
- setMessages() : User
- Sets the messages The messages in a mailbox or folder. Read-only. Nullable.
- setMobileAppIntentAndStates() : User
- Sets the mobileAppIntentAndStates The list of troubleshooting events for this user.
- setMobileAppTroubleshootingEvents() : User
- Sets the mobileAppTroubleshootingEvents The list of mobile app troubleshooting events for this user.
- setMobilePhone() : User
- Sets the mobilePhone 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).
- setMySite() : User
- Sets the mySite The URL for the user's personal site. Returned only on $select.
- setNotifications() : User
- Sets the notifications
- setOauth2PermissionGrants() : User
- Sets the oauth2PermissionGrants
- setODataType() : Entity
- Sets the ODataType
- setOfficeLocation() : User
- Sets the officeLocation The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
- setOnenote() : User
- Sets the onenote Read-only.
- setOnlineMeetings() : User
- Sets the onlineMeetings
- setOnPremisesDistinguishedName() : User
- Sets the onPremisesDistinguishedName 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.
- setOnPremisesDomainName() : User
- Sets the onPremisesDomainName 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.
- setOnPremisesExtensionAttributes() : User
- Sets the onPremisesExtensionAttributes Contains extensionAttributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set during creation or update. These extension attributes are also known as Exchange custom attributes 1-15. Returned only on $select. Supports $filter (eq, NOT, ge, le, in).
- setOnPremisesImmutableId() : User
- Sets the onPremisesImmutableId 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).
- setOnPremisesLastSyncDateTime() : User
- Sets the onPremisesLastSyncDateTime 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).
- setOnPremisesProvisioningErrors() : User
- Sets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, NOT, ge, le).
- setOnPremisesSamAccountName() : User
- Sets the onPremisesSamAccountName 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).
- setOnPremisesSecurityIdentifier() : User
- Sets the onPremisesSecurityIdentifier 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.
- setOnPremisesSyncEnabled() : User
- Sets the onPremisesSyncEnabled 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. Returned only on $select. Supports $filter (eq, ne, NOT, in).
- setOnPremisesUserPrincipalName() : User
- Sets the onPremisesUserPrincipalName 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).
- setOtherMails() : User
- Sets the otherMails A list of additional email addresses for the user; for example<EMAIL_ADDRESS><EMAIL_ADDRESS>NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, NOT, ge, le, in, startsWith).
- setOutlook() : User
- Sets the outlook Read-only.
- setOwnedDevices() : User
- Sets the ownedDevices Devices that are owned by the user. Read-only. Nullable. Supports $expand.
- setOwnedObjects() : User
- Sets the ownedObjects Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.
- setPasswordPolicies() : User
- Sets the passwordPolicies 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).
- setPasswordProfile() : User
- Sets the 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. NOTE: For Azure B2C tenants, the forceChangePasswordNextSignIn property should be set to false and instead use custom policies and user flows to force password reset at first logon. See Force password reset at first logon.Returned only on $select. Supports $filter (eq, ne, NOT, in).
- setPastProjects() : User
- Sets the pastProjects A list for the user to enumerate their past projects. Returned only on $select.
- setPendingAccessReviewInstances() : User
- Sets the pendingAccessReviewInstances Navigation property to get list of access reviews pending approval by reviewer.
- setPeople() : User
- Sets the people People that are relevant to the user. Read-only. Nullable.
- setPhoto() : User
- Sets the photo The user's profile photo. Read-only.
- setPhotos() : User
- Sets the photos Read-only. Nullable.
- setPlanner() : User
- Sets the planner Entry-point to the Planner resource that might exist for a user. Read-only.
- setPostalCode() : User
- Sets the postalCode 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).
- setPreferredDataLocation() : User
- Sets the preferredDataLocation The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
- setPreferredLanguage() : User
- Sets the preferredLanguage 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)
- setPreferredName() : User
- Sets the preferredName The preferred name for the user. Returned only on $select.
- setPresence() : User
- Sets the presence
- setProfile() : User
- Sets the profile Represents properties that are descriptive of a user in a tenant.
- setProvisionedPlans() : User
- Sets the provisionedPlans The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le).
- setProxyAddresses() : User
- Sets the proxyAddresses For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only, Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le, startsWith).
- setRefreshTokensValidFromDateTime() : User
- Sets the refreshTokensValidFromDateTime 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.
- setRegisteredDevices() : User
- Sets the registeredDevices Devices that are registered for the user. Read-only. Nullable. Supports $expand.
- setResponsibilities() : User
- Sets the responsibilities A list for the user to enumerate their responsibilities. Returned only on $select.
- setSchools() : User
- Sets the schools A list for the user to enumerate the schools they have attended. Returned only on $select.
- setScopedRoleMemberOf() : User
- Sets the scopedRoleMemberOf The scoped-role administrative unit memberships for this user. Read-only. Nullable.
- setSettings() : User
- Sets the settings Read-only. Nullable.
- setShowInAddressList() : User
- Sets the showInAddressList true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Returned only on $select. Supports $filter (eq, ne, NOT, in).
- setSignInActivity() : User
- Sets the signInActivity Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le) but, not with any other filterable properties. Note: Details for this property require an Azure AD Premium P1/P2 license and the AuditLog.Read.All permission.Note: There's a known issue with retrieving this property.
- setSignInSessionsValidFromDateTime() : User
- Sets the signInSessionsValidFromDateTime 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.
- setSkills() : User
- Sets the skills A list for the user to enumerate their skills. Returned only on $select.
- setState() : User
- Sets the state 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).
- setStreetAddress() : User
- Sets the streetAddress 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).
- setSurname() : User
- Sets the surname 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).
- setTeamwork() : User
- Sets the teamwork A container for Microsoft Teams features available for the user. Read-only. Nullable.
- setTodo() : User
- Sets the todo Represents the To Do services available to a user.
- setTransitiveMemberOf() : User
- Sets the transitiveMemberOf
- setTransitiveReports() : User
- Sets the transitiveReports The transitive reports for a user. Read-only.
- setUsageLocation() : User
- Sets the usageLocation 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).
- setUsageRights() : User
- Sets the usageRights
- setUserPrincipalName() : User
- Sets the userPrincipalName 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 alias@domain, 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. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy.
- setUserType() : User
- Sets the userType 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).
- setWindowsInformationProtectionDeviceRegistrations() : User
- Sets the windowsInformationProtectionDeviceRegistrations Zero or more WIP device registrations that belong to the user.
Properties
$_propDict
The array of properties available to the model
protected
array<string|int, mixed>
$_propDict
Methods
__construct()
Construct a new Entity
public
__construct([array<string|int, mixed> $propDict = array() ]) : mixed
Parameters
- $propDict : array<string|int, mixed> = array()
-
A list of properties to set
Return values
mixed —getAboutMe()
Gets the aboutMe A freeform text entry field for the user to describe themselves. Returned only on $select.
public
getAboutMe() : string|null
Return values
string|null —The aboutMe
getAccountEnabled()
Gets the accountEnabled 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).
public
getAccountEnabled() : bool|null
Return values
bool|null —The accountEnabled
getActivities()
Gets the activities The user's activities across devices. Read-only. Nullable.
public
getActivities() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The activities
getAgeGroup()
Gets the 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).
public
getAgeGroup() : string|null
Return values
string|null —The ageGroup
getAgreementAcceptances()
Gets the agreementAcceptances The user's terms of use acceptance statuses. Read-only. Nullable.
public
getAgreementAcceptances() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The agreementAcceptances
getAnalytics()
Gets the analytics
public
getAnalytics() : UserAnalytics|null
Return values
UserAnalytics|null —The analytics
getAppConsentRequestsForApproval()
Gets the appConsentRequestsForApproval
public
getAppConsentRequestsForApproval() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The appConsentRequestsForApproval
getAppRoleAssignments()
Gets the appRoleAssignments Represents the app roles a user has been granted for an application. Supports $expand.
public
getAppRoleAssignments() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The appRoleAssignments
getApprovals()
Gets the approvals
public
getApprovals() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The approvals
getAssignedLicenses()
Gets the assignedLicenses The licenses that are assigned to the user, including inherited (group-based) licenses. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
public
getAssignedLicenses() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The assignedLicenses
getAssignedPlans()
Gets the assignedPlans The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
public
getAssignedPlans() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The assignedPlans
getAuthentication()
Gets the authentication
public
getAuthentication() : Authentication|null
Return values
Authentication|null —The authentication
getBirthday()
Gets the birthday 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.
public
getBirthday() : DateTime|null
Return values
DateTime|null —The birthday
getBusinessPhones()
Gets the businessPhones 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 and NOT).
public
getBusinessPhones() : string|null
Return values
string|null —The businessPhones
getCalendar()
Gets the calendar The user's primary calendar. Read-only.
public
getCalendar() : Calendar|null
Return values
Calendar|null —The calendar
getCalendarGroups()
Gets the calendarGroups The user's calendar groups. Read-only. Nullable.
public
getCalendarGroups() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The calendarGroups
getCalendars()
Gets the calendars The user's calendars. Read-only. Nullable.
public
getCalendars() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The calendars
getCalendarView()
Gets the calendarView The calendar view for the calendar. Read-only. Nullable.
public
getCalendarView() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The calendarView
getChats()
Gets the chats
public
getChats() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The chats
getCity()
Gets the city 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).
public
getCity() : string|null
Return values
string|null —The city
getCompanyName()
Gets the companyName 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 of the company name is 64 characters.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
getCompanyName() : string|null
Return values
string|null —The companyName
getConsentProvidedForMinor()
Gets the 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).
public
getConsentProvidedForMinor() : string|null
Return values
string|null —The consentProvidedForMinor
getContactFolders()
Gets the contactFolders The user's contacts folders. Read-only. Nullable.
public
getContactFolders() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The contactFolders
getContacts()
Gets the contacts The user's contacts. Read-only. Nullable.
public
getContacts() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The contacts
getCountry()
Gets the country 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).
public
getCountry() : string|null
Return values
string|null —The country
getCreatedDateTime()
Gets the createdDateTime The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, and in operators).
public
getCreatedDateTime() : DateTime|null
Return values
DateTime|null —The createdDateTime
getCreatedObjects()
Gets the createdObjects Directory objects that were created by the user. Read-only. Nullable.
public
getCreatedObjects() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The createdObjects
getCreationType()
Gets the creationType Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, and in).
public
getCreationType() : string|null
Return values
string|null —The creationType
getDeletedDateTime()
Gets the deletedDateTime
public
getDeletedDateTime() : DateTime|null
Return values
DateTime|null —The deletedDateTime
getDepartment()
Gets the department 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, and in operators).
public
getDepartment() : string|null
Return values
string|null —The department
getDeviceEnrollmentConfigurations()
Gets the deviceEnrollmentConfigurations Get enrollment configurations targeted to the user
public
getDeviceEnrollmentConfigurations() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The deviceEnrollmentConfigurations
getDeviceEnrollmentLimit()
Gets the deviceEnrollmentLimit The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
public
getDeviceEnrollmentLimit() : int|null
Return values
int|null —The deviceEnrollmentLimit
getDeviceKeys()
Gets the deviceKeys
public
getDeviceKeys() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The deviceKeys
getDeviceManagementTroubleshootingEvents()
Gets the deviceManagementTroubleshootingEvents The list of troubleshooting events for this user.
public
getDeviceManagementTroubleshootingEvents() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The deviceManagementTroubleshootingEvents
getDevices()
Gets the devices
public
getDevices() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The devices
getDirectReports()
Gets the directReports The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
public
getDirectReports() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The directReports
getDisplayName()
Gets the displayName 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), $orderBy, and $search.
public
getDisplayName() : string|null
Return values
string|null —The displayName
getDrive()
Gets the drive The user's OneDrive. Read-only.
public
getDrive() : Drive|null
Return values
Drive|null —The drive
getDrives()
Gets the drives A collection of drives available for this user. Read-only.
public
getDrives() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The drives
getEmployeeHireDate()
Gets the employeeHireDate 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).
public
getEmployeeHireDate() : DateTime|null
Return values
DateTime|null —The employeeHireDate
getEmployeeId()
Gets the employeeId The employee identifier assigned to the user by the organization. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
getEmployeeId() : string|null
Return values
string|null —The employeeId
getEmployeeOrgData()
Gets the 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).
public
getEmployeeOrgData() : EmployeeOrgData|null
Return values
EmployeeOrgData|null —The employeeOrgData
getEmployeeType()
Gets the employeeType Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
getEmployeeType() : string|null
Return values
string|null —The employeeType
getEvents()
Gets the events The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
public
getEvents() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The events
getExtensions()
Gets the extensions The collection of open extensions defined for the user. Read-only. Nullable.
public
getExtensions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The extensions
getExternalUserState()
Gets the externalUserState 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).
public
getExternalUserState() : string|null
Return values
string|null —The externalUserState
getExternalUserStateChangeDateTime()
Gets the externalUserStateChangeDateTime Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, NOT , in).
public
getExternalUserStateChangeDateTime() : string|null
Return values
string|null —The externalUserStateChangeDateTime
getFaxNumber()
Gets the faxNumber The fax number of the user. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
getFaxNumber() : string|null
Return values
string|null —The faxNumber
getFollowedSites()
Gets the followedSites
public
getFollowedSites() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The followedSites
getGivenName()
Gets the givenName 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).
public
getGivenName() : string|null
Return values
string|null —The givenName
getHireDate()
Gets the hireDate 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.
public
getHireDate() : DateTime|null
Return values
DateTime|null —The hireDate
getId()
Gets the id Read-only.
public
getId() : string|null
Return values
string|null —The id
getIdentities()
Gets the identities 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) only where the signInType is not userPrincipalName.
public
getIdentities() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The identities
getImAddresses()
Gets the imAddresses 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).
public
getImAddresses() : string|null
Return values
string|null —The imAddresses
getInferenceClassification()
Gets the inferenceClassification Relevance classification of the user's messages based on explicit designations which override inferred relevance or importance.
public
getInferenceClassification() : InferenceClassification|null
Return values
InferenceClassification|null —The inferenceClassification
getInfoCatalogs()
Gets the infoCatalogs Identifies the info segments assigned to the user. Supports $filter (eq, NOT, ge, le, startsWith).
public
getInfoCatalogs() : string|null
Return values
string|null —The infoCatalogs
getInformationProtection()
Gets the informationProtection
public
getInformationProtection() : InformationProtection|null
Return values
InformationProtection|null —The informationProtection
getInsights()
Gets the insights Read-only. Nullable.
public
getInsights() : ItemInsights|null
Return values
ItemInsights|null —The insights
getInterests()
Gets the interests A list for the user to describe their interests. Returned only on $select.
public
getInterests() : string|null
Return values
string|null —The interests
getIsResourceAccount()
Gets the isResourceAccount Do not use – reserved for future use.
public
getIsResourceAccount() : bool|null
Return values
bool|null —The isResourceAccount
getJobTitle()
Gets the jobTitle The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
getJobTitle() : string|null
Return values
string|null —The jobTitle
getJoinedGroups()
Gets the joinedGroups Read-only. Nullable.
public
getJoinedGroups() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The joinedGroups
getJoinedTeams()
Gets the joinedTeams The Microsoft Teams teams that the user is a member of. Read-only. Nullable.
public
getJoinedTeams() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The joinedTeams
getLastPasswordChangeDateTime()
Gets the lastPasswordChangeDateTime The time when this Azure AD user last changed their password. 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.
public
getLastPasswordChangeDateTime() : DateTime|null
Return values
DateTime|null —The lastPasswordChangeDateTime
getLegalAgeGroupClassification()
Gets the 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.
public
getLegalAgeGroupClassification() : string|null
Return values
string|null —The legalAgeGroupClassification
getLicenseAssignmentStates()
Gets the licenseAssignmentStates State of license assignments for this user. Read-only. Returned only on $select.
public
getLicenseAssignmentStates() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The licenseAssignmentStates
getLicenseDetails()
Gets the licenseDetails A collection of this user's license details. Read-only.
public
getLicenseDetails() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The licenseDetails
getMail()
Gets the mail The SMTP address for the user, for example<EMAIL_ADDRESS>to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith).
public
getMail() : string|null
Return values
string|null —The mail
getMailboxSettings()
Gets the 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.
public
getMailboxSettings() : MailboxSettings|null
Return values
MailboxSettings|null —The mailboxSettings
getMailFolders()
Gets the mailFolders The user's mail folders. Read-only. Nullable.
public
getMailFolders() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The mailFolders
getMailNickname()
Gets the mailNickname 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).
public
getMailNickname() : string|null
Return values
string|null —The mailNickname
getManagedAppRegistrations()
Gets the managedAppRegistrations Zero or more managed app registrations that belong to the user.
public
getManagedAppRegistrations() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The managedAppRegistrations
getManagedDevices()
Gets the managedDevices The managed devices associated with the user.
public
getManagedDevices() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The managedDevices
getManager()
Gets the manager The user or contact that is this user's manager. Read-only. (HTTP Methods: GET, PUT, DELETE.). Supports $expand.
public
getManager() : DirectoryObject|null
Return values
DirectoryObject|null —The manager
getMemberOf()
Gets the memberOf The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
public
getMemberOf() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The memberOf
getMessages()
Gets the messages The messages in a mailbox or folder. Read-only. Nullable.
public
getMessages() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The messages
getMobileAppIntentAndStates()
Gets the mobileAppIntentAndStates The list of troubleshooting events for this user.
public
getMobileAppIntentAndStates() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The mobileAppIntentAndStates
getMobileAppTroubleshootingEvents()
Gets the mobileAppTroubleshootingEvents The list of mobile app troubleshooting events for this user.
public
getMobileAppTroubleshootingEvents() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The mobileAppTroubleshootingEvents
getMobilePhone()
Gets the mobilePhone 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).
public
getMobilePhone() : string|null
Return values
string|null —The mobilePhone
getMySite()
Gets the mySite The URL for the user's personal site. Returned only on $select.
public
getMySite() : string|null
Return values
string|null —The mySite
getNotifications()
Gets the notifications
public
getNotifications() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The notifications
getOauth2PermissionGrants()
Gets the oauth2PermissionGrants
public
getOauth2PermissionGrants() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The oauth2PermissionGrants
getODataType()
Gets the ODataType
public
getODataType() : string|null
Return values
string|null —The ODataType
getOfficeLocation()
Gets the officeLocation The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
getOfficeLocation() : string|null
Return values
string|null —The officeLocation
getOnenote()
Gets the onenote Read-only.
public
getOnenote() : Onenote|null
Return values
Onenote|null —The onenote
getOnlineMeetings()
Gets the onlineMeetings
public
getOnlineMeetings() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The onlineMeetings
getOnPremisesDistinguishedName()
Gets the onPremisesDistinguishedName 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.
public
getOnPremisesDistinguishedName() : string|null
Return values
string|null —The onPremisesDistinguishedName
getOnPremisesDomainName()
Gets the onPremisesDomainName 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.
public
getOnPremisesDomainName() : string|null
Return values
string|null —The onPremisesDomainName
getOnPremisesExtensionAttributes()
Gets the onPremisesExtensionAttributes Contains extensionAttributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set during creation or update. These extension attributes are also known as Exchange custom attributes 1-15. Returned only on $select. Supports $filter (eq, NOT, ge, le, in).
public
getOnPremisesExtensionAttributes() : OnPremisesExtensionAttributes|null
Return values
OnPremisesExtensionAttributes|null —The onPremisesExtensionAttributes
getOnPremisesImmutableId()
Gets the onPremisesImmutableId 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).
public
getOnPremisesImmutableId() : string|null
.
Return values
string|null —The onPremisesImmutableId
getOnPremisesLastSyncDateTime()
Gets the onPremisesLastSyncDateTime 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).
public
getOnPremisesLastSyncDateTime() : DateTime|null
Return values
DateTime|null —The onPremisesLastSyncDateTime
getOnPremisesProvisioningErrors()
Gets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, NOT, ge, le).
public
getOnPremisesProvisioningErrors() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The onPremisesProvisioningErrors
getOnPremisesSamAccountName()
Gets the onPremisesSamAccountName 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).
public
getOnPremisesSamAccountName() : string|null
Return values
string|null —The onPremisesSamAccountName
getOnPremisesSecurityIdentifier()
Gets the onPremisesSecurityIdentifier 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.
public
getOnPremisesSecurityIdentifier() : string|null
Return values
string|null —The onPremisesSecurityIdentifier
getOnPremisesSyncEnabled()
Gets the onPremisesSyncEnabled 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. Returned only on $select. Supports $filter (eq, ne, NOT, in).
public
getOnPremisesSyncEnabled() : bool|null
Return values
bool|null —The onPremisesSyncEnabled
getOnPremisesUserPrincipalName()
Gets the onPremisesUserPrincipalName 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).
public
getOnPremisesUserPrincipalName() : string|null
Return values
string|null —The onPremisesUserPrincipalName
getOtherMails()
Gets the otherMails A list of additional email addresses for the user; for example<EMAIL_ADDRESS><EMAIL_ADDRESS>NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, NOT, ge, le, in, startsWith).
public
getOtherMails() : string|null
Return values
string|null —The otherMails
getOutlook()
Gets the outlook Read-only.
public
getOutlook() : OutlookUser|null
Return values
OutlookUser|null —The outlook
getOwnedDevices()
Gets the ownedDevices Devices that are owned by the user. Read-only. Nullable. Supports $expand.
public
getOwnedDevices() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The ownedDevices
getOwnedObjects()
Gets the ownedObjects Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.
public
getOwnedObjects() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The ownedObjects
getPasswordPolicies()
Gets the passwordPolicies 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).
public
getPasswordPolicies() : string|null
Return values
string|null —The passwordPolicies
getPasswordProfile()
Gets the 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. NOTE: For Azure B2C tenants, the forceChangePasswordNextSignIn property should be set to false and instead use custom policies and user flows to force password reset at first logon. See Force password reset at first logon.Returned only on $select. Supports $filter (eq, ne, NOT, in).
public
getPasswordProfile() : PasswordProfile|null
Return values
PasswordProfile|null —The passwordProfile
getPastProjects()
Gets the pastProjects A list for the user to enumerate their past projects. Returned only on $select.
public
getPastProjects() : string|null
Return values
string|null —The pastProjects
getPendingAccessReviewInstances()
Gets the pendingAccessReviewInstances Navigation property to get list of access reviews pending approval by reviewer.
public
getPendingAccessReviewInstances() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The pendingAccessReviewInstances
getPeople()
Gets the people People that are relevant to the user. Read-only. Nullable.
public
getPeople() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The people
getPhoto()
Gets the photo The user's profile photo. Read-only.
public
getPhoto() : ProfilePhoto|null
Return values
ProfilePhoto|null —The photo
getPhotos()
Gets the photos Read-only. Nullable.
public
getPhotos() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The photos
getPlanner()
Gets the planner Entry-point to the Planner resource that might exist for a user. Read-only.
public
getPlanner() : PlannerUser|null
Return values
PlannerUser|null —The planner
getPostalCode()
Gets the postalCode 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).
public
getPostalCode() : string|null
Return values
string|null —The postalCode
getPreferredDataLocation()
Gets the preferredDataLocation The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
public
getPreferredDataLocation() : string|null
Return values
string|null —The preferredDataLocation
getPreferredLanguage()
Gets the preferredLanguage 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)
public
getPreferredLanguage() : string|null
Return values
string|null —The preferredLanguage
getPreferredName()
Gets the preferredName The preferred name for the user. Returned only on $select.
public
getPreferredName() : string|null
Return values
string|null —The preferredName
getPresence()
Gets the presence
public
getPresence() : Presence|null
Return values
Presence|null —The presence
getProfile()
Gets the profile Represents properties that are descriptive of a user in a tenant.
public
getProfile() : Profile|null
Return values
Profile|null —The profile
getProperties()
Gets the property dictionary of the Entity
public
getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of properties
getProvisionedPlans()
Gets the provisionedPlans The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le).
public
getProvisionedPlans() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The provisionedPlans
getProxyAddresses()
Gets the proxyAddresses For example: ['SMTP<EMAIL_ADDRESS>'smtp<EMAIL_ADDRESS>For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only, Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le, startsWith).
public
getProxyAddresses() : string|null
Return values
string|null —The proxyAddresses
getRefreshTokensValidFromDateTime()
Gets the refreshTokensValidFromDateTime 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.
public
getRefreshTokensValidFromDateTime() : DateTime|null
Return values
DateTime|null —The refreshTokensValidFromDateTime
getRegisteredDevices()
Gets the registeredDevices Devices that are registered for the user. Read-only. Nullable. Supports $expand.
public
getRegisteredDevices() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The registeredDevices
getResponsibilities()
Gets the responsibilities A list for the user to enumerate their responsibilities. Returned only on $select.
public
getResponsibilities() : string|null
Return values
string|null —The responsibilities
getSchools()
Gets the schools A list for the user to enumerate the schools they have attended. Returned only on $select.
public
getSchools() : string|null
Return values
string|null —The schools
getScopedRoleMemberOf()
Gets the scopedRoleMemberOf The scoped-role administrative unit memberships for this user. Read-only. Nullable.
public
getScopedRoleMemberOf() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The scopedRoleMemberOf
getSettings()
Gets the settings Read-only. Nullable.
public
getSettings() : UserSettings|null
Return values
UserSettings|null —The settings
getShowInAddressList()
Gets the showInAddressList true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Returned only on $select. Supports $filter (eq, ne, NOT, in).
public
getShowInAddressList() : bool|null
Return values
bool|null —The showInAddressList
getSignInActivity()
Gets the signInActivity Get the last signed-in date and request ID of the sign-in for a given user. Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le) but, not with any other filterable properties. Note: Details for this property require an Azure AD Premium P1/P2 license and the AuditLog.Read.All permission.Note: There's a known issue with retrieving this property.
public
getSignInActivity() : SignInActivity|null
Return values
SignInActivity|null —The signInActivity
getSignInSessionsValidFromDateTime()
Gets the signInSessionsValidFromDateTime 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.
public
getSignInSessionsValidFromDateTime() : DateTime|null
Return values
DateTime|null —The signInSessionsValidFromDateTime
getSkills()
Gets the skills A list for the user to enumerate their skills. Returned only on $select.
public
getSkills() : string|null
Return values
string|null —The skills
getState()
Gets the state 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).
public
getState() : string|null
Return values
string|null —The state
getStreetAddress()
Gets the streetAddress 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).
public
getStreetAddress() : string|null
Return values
string|null —The streetAddress
getSurname()
Gets the surname 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).
public
getSurname() : string|null
Return values
string|null —The surname
getTeamwork()
Gets the teamwork A container for Microsoft Teams features available for the user. Read-only. Nullable.
public
getTeamwork() : UserTeamwork|null
Return values
UserTeamwork|null —The teamwork
getTodo()
Gets the todo Represents the To Do services available to a user.
public
getTodo() : Todo|null
Return values
Todo|null —The todo
getTransitiveMemberOf()
Gets the transitiveMemberOf
public
getTransitiveMemberOf() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The transitiveMemberOf
getTransitiveReports()
Gets the transitiveReports The transitive reports for a user. Read-only.
public
getTransitiveReports() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The transitiveReports
getUsageLocation()
Gets the usageLocation 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).
public
getUsageLocation() : string|null
Return values
string|null —The usageLocation
getUsageRights()
Gets the usageRights
public
getUsageRights() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The usageRights
getUserPrincipalName()
Gets the userPrincipalName 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 alias@domain, 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. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith) and $orderBy.
public
getUserPrincipalName() : string|null
Return values
string|null —The userPrincipalName
getUserType()
Gets the userType 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).
public
getUserType() : string|null
Return values
string|null —The userType
getWindowsInformationProtectionDeviceRegistrations()
Gets the windowsInformationProtectionDeviceRegistrations Zero or more WIP device registrations that belong to the user.
public
getWindowsInformationProtectionDeviceRegistrations() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —The windowsInformationProtectionDeviceRegistrations
jsonSerialize()
Serializes the object by property array Manually serialize DateTime into RFC3339 format
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of properties
setAboutMe()
Sets the aboutMe A freeform text entry field for the user to describe themselves. Returned only on $select.
public
setAboutMe(string $val) : User
Parameters
- $val : string
-
The aboutMe
Return values
User —setAccountEnabled()
Sets the accountEnabled 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).
public
setAccountEnabled(bool $val) : User
Parameters
- $val : bool
-
The accountEnabled
Return values
User —setActivities()
Sets the activities The user's activities across devices. Read-only. Nullable.
public
setActivities(UserActivity $val) : User
Parameters
- $val : UserActivity
-
The activities
Return values
User —setAgeGroup()
Sets the 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).
public
setAgeGroup(string $val) : User
Parameters
- $val : string
-
The ageGroup
Return values
User —setAgreementAcceptances()
Sets the agreementAcceptances The user's terms of use acceptance statuses. Read-only. Nullable.
public
setAgreementAcceptances(AgreementAcceptance $val) : User
Parameters
- $val : AgreementAcceptance
-
The agreementAcceptances
Return values
User —setAnalytics()
Sets the analytics
public
setAnalytics(UserAnalytics $val) : User
Parameters
- $val : UserAnalytics
-
The analytics
Return values
User —setAppConsentRequestsForApproval()
Sets the appConsentRequestsForApproval
public
setAppConsentRequestsForApproval(AppConsentRequest $val) : User
Parameters
- $val : AppConsentRequest
-
The appConsentRequestsForApproval
Return values
User —setAppRoleAssignments()
Sets the appRoleAssignments Represents the app roles a user has been granted for an application. Supports $expand.
public
setAppRoleAssignments(AppRoleAssignment $val) : User
Parameters
- $val : AppRoleAssignment
-
The appRoleAssignments
Return values
User —setApprovals()
Sets the approvals
public
setApprovals(Approval $val) : User
Parameters
- $val : Approval
-
The approvals
Return values
User —setAssignedLicenses()
Sets the assignedLicenses The licenses that are assigned to the user, including inherited (group-based) licenses. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
public
setAssignedLicenses(AssignedLicense $val) : User
Parameters
- $val : AssignedLicense
-
The assignedLicenses
Return values
User —setAssignedPlans()
Sets the assignedPlans The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and NOT).
public
setAssignedPlans(AssignedPlan $val) : User
Parameters
- $val : AssignedPlan
-
The assignedPlans
Return values
User —setAuthentication()
Sets the authentication
public
setAuthentication(Authentication $val) : User
Parameters
- $val : Authentication
-
The authentication
Return values
User —setBirthday()
Sets the birthday 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.
public
setBirthday(DateTime $val) : User
Parameters
- $val : DateTime
-
The birthday
Return values
User —setBusinessPhones()
Sets the businessPhones 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 and NOT).
public
setBusinessPhones(string $val) : User
Parameters
- $val : string
-
The businessPhones
Return values
User —setCalendar()
Sets the calendar The user's primary calendar. Read-only.
public
setCalendar(Calendar $val) : User
Parameters
- $val : Calendar
-
The calendar
Return values
User —setCalendarGroups()
Sets the calendarGroups The user's calendar groups. Read-only. Nullable.
public
setCalendarGroups(CalendarGroup $val) : User
Parameters
- $val : CalendarGroup
-
The calendarGroups
Return values
User —setCalendars()
Sets the calendars The user's calendars. Read-only. Nullable.
public
setCalendars(Calendar $val) : User
Parameters
- $val : Calendar
-
The calendars
Return values
User —setCalendarView()
Sets the calendarView The calendar view for the calendar. Read-only. Nullable.
public
setCalendarView(Event $val) : User
Parameters
- $val : Event
-
The calendarView
Return values
User —setChats()
Sets the chats
public
setChats(Chat $val) : User
Parameters
- $val : Chat
-
The chats
Return values
User —setCity()
Sets the city 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).
public
setCity(string $val) : User
Parameters
- $val : string
-
The city
Return values
User —setCompanyName()
Sets the companyName 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 of the company name is 64 characters.Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
setCompanyName(string $val) : User
Parameters
- $val : string
-
The companyName
Return values
User —setConsentProvidedForMinor()
Sets the 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).
public
setConsentProvidedForMinor(string $val) : User
Parameters
- $val : string
-
The consentProvidedForMinor
Return values
User —setContactFolders()
Sets the contactFolders The user's contacts folders. Read-only. Nullable.
public
setContactFolders(ContactFolder $val) : User
Parameters
- $val : ContactFolder
-
The contactFolders
Return values
User —setContacts()
Sets the contacts The user's contacts. Read-only. Nullable.
public
setContacts(Contact $val) : User
Parameters
- $val : Contact
-
The contacts
Return values
User —setCountry()
Sets the country 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).
public
setCountry(string $val) : User
Parameters
- $val : string
-
The country
Return values
User —setCreatedDateTime()
Sets the createdDateTime The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, and in operators).
public
setCreatedDateTime(DateTime $val) : User
Parameters
- $val : DateTime
-
The createdDateTime
Return values
User —setCreatedObjects()
Sets the createdObjects Directory objects that were created by the user. Read-only. Nullable.
public
setCreatedObjects(DirectoryObject $val) : User
Parameters
- $val : DirectoryObject
-
The createdObjects
Return values
User —setCreationType()
Sets the creationType Indicates whether the user account was created through one of the following methods: As a regular school or work account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, and in).
public
setCreationType(string $val) : User
Parameters
- $val : string
-
The creationType
Return values
User —setDeletedDateTime()
Sets the deletedDateTime
public
setDeletedDateTime(DateTime $val) : DirectoryObject
Parameters
- $val : DateTime
-
The deletedDateTime
Return values
DirectoryObject —setDepartment()
Sets the department 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, and in operators).
public
setDepartment(string $val) : User
Parameters
- $val : string
-
The department
Return values
User —setDeviceEnrollmentConfigurations()
Sets the deviceEnrollmentConfigurations Get enrollment configurations targeted to the user
public
setDeviceEnrollmentConfigurations(DeviceEnrollmentConfiguration $val) : User
Parameters
- $val : DeviceEnrollmentConfiguration
-
The deviceEnrollmentConfigurations
Return values
User —setDeviceEnrollmentLimit()
Sets the deviceEnrollmentLimit The limit on the maximum number of devices that the user is permitted to enroll. Allowed values are 5 or 1000.
public
setDeviceEnrollmentLimit(int $val) : User
Parameters
- $val : int
-
The deviceEnrollmentLimit
Return values
User —setDeviceKeys()
Sets the deviceKeys
public
setDeviceKeys(DeviceKey $val) : User
Parameters
- $val : DeviceKey
-
The deviceKeys
Return values
User —setDeviceManagementTroubleshootingEvents()
Sets the deviceManagementTroubleshootingEvents The list of troubleshooting events for this user.
public
setDeviceManagementTroubleshootingEvents(DeviceManagementTroubleshootingEvent $val) : User
Parameters
- $val : DeviceManagementTroubleshootingEvent
-
The deviceManagementTroubleshootingEvents
Return values
User —setDevices()
Sets the devices
public
setDevices(Device $val) : User
Parameters
- $val : Device
-
The devices
Return values
User —setDirectReports()
Sets the directReports The users and contacts that report to the user. (The users and contacts that have their manager property set to this user.) Read-only. Nullable. Supports $expand.
public
setDirectReports(DirectoryObject $val) : User
Parameters
- $val : DirectoryObject
-
The directReports
Return values
User —setDisplayName()
Sets the displayName 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), $orderBy, and $search.
public
setDisplayName(string $val) : User
Parameters
- $val : string
-
The displayName
Return values
User —setDrive()
Sets the drive The user's OneDrive. Read-only.
public
setDrive(Drive $val) : User
Parameters
- $val : Drive
-
The drive
Return values
User —setDrives()
Sets the drives A collection of drives available for this user. Read-only.
public
setDrives(Drive $val) : User
Parameters
- $val : Drive
-
The drives
Return values
User —setEmployeeHireDate()
Sets the employeeHireDate 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).
public
setEmployeeHireDate(DateTime $val) : User
Parameters
- $val : DateTime
-
The employeeHireDate
Return values
User —setEmployeeId()
Sets the employeeId The employee identifier assigned to the user by the organization. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
setEmployeeId(string $val) : User
Parameters
- $val : string
-
The employeeId
Return values
User —setEmployeeOrgData()
Sets the 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).
public
setEmployeeOrgData(EmployeeOrgData $val) : User
Parameters
- $val : EmployeeOrgData
-
The employeeOrgData
Return values
User —setEmployeeType()
Sets the employeeType Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
setEmployeeType(string $val) : User
Parameters
- $val : string
-
The employeeType
Return values
User —setEvents()
Sets the events The user's events. Default is to show Events under the Default Calendar. Read-only. Nullable.
public
setEvents(Event $val) : User
Parameters
- $val : Event
-
The events
Return values
User —setExtensions()
Sets the extensions The collection of open extensions defined for the user. Read-only. Nullable.
public
setExtensions(Extension $val) : User
Parameters
- $val : Extension
-
The extensions
Return values
User —setExternalUserState()
Sets the externalUserState 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).
public
setExternalUserState(string $val) : User
Parameters
- $val : string
-
The externalUserState
Return values
User —setExternalUserStateChangeDateTime()
Sets the externalUserStateChangeDateTime Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter (eq, ne, NOT , in).
public
setExternalUserStateChangeDateTime(string $val) : User
Parameters
- $val : string
-
The externalUserStateChangeDateTime
Return values
User —setFaxNumber()
Sets the faxNumber The fax number of the user. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
setFaxNumber(string $val) : User
Parameters
- $val : string
-
The faxNumber
Return values
User —setFollowedSites()
Sets the followedSites
public
setFollowedSites(Site $val) : User
Parameters
- $val : Site
-
The followedSites
Return values
User —setGivenName()
Sets the givenName 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).
public
setGivenName(string $val) : User
Parameters
- $val : string
-
The givenName
Return values
User —setHireDate()
Sets the hireDate 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.
public
setHireDate(DateTime $val) : User
Parameters
- $val : DateTime
-
The hireDate
Return values
User —setId()
Sets the id Read-only.
public
setId(string $val) : Entity
Parameters
- $val : string
-
The id
Return values
Entity —setIdentities()
Sets the identities 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) only where the signInType is not userPrincipalName.
public
setIdentities(ObjectIdentity $val) : User
Parameters
- $val : ObjectIdentity
-
The identities
Return values
User —setImAddresses()
Sets the imAddresses 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).
public
setImAddresses(string $val) : User
Parameters
- $val : string
-
The imAddresses
Return values
User —setInferenceClassification()
Sets the inferenceClassification Relevance classification of the user's messages based on explicit designations which override inferred relevance or importance.
public
setInferenceClassification(InferenceClassification $val) : User
Parameters
- $val : InferenceClassification
-
The inferenceClassification
Return values
User —setInfoCatalogs()
Sets the infoCatalogs Identifies the info segments assigned to the user. Supports $filter (eq, NOT, ge, le, startsWith).
public
setInfoCatalogs(string $val) : User
Parameters
- $val : string
-
The infoCatalogs
Return values
User —setInformationProtection()
Sets the informationProtection
public
setInformationProtection(InformationProtection $val) : User
Parameters
- $val : InformationProtection
-
The informationProtection
Return values
User —setInsights()
Sets the insights Read-only. Nullable.
public
setInsights(ItemInsights $val) : User
Parameters
- $val : ItemInsights
-
The insights
Return values
User —setInterests()
Sets the interests A list for the user to describe their interests. Returned only on $select.
public
setInterests(string $val) : User
Parameters
- $val : string
-
The interests
Return values
User —setIsResourceAccount()
Sets the isResourceAccount Do not use – reserved for future use.
public
setIsResourceAccount(bool $val) : User
Parameters
- $val : bool
-
The isResourceAccount
Return values
User —setJobTitle()
Sets the jobTitle The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, NOT , ge, le, in, startsWith).
public
setJobTitle(string $val) : User
Parameters
- $val : string
-
The jobTitle
Return values
User —setJoinedGroups()
Sets the joinedGroups Read-only. Nullable.
public
setJoinedGroups(Group $val) : User
Parameters
- $val : Group
-
The joinedGroups
Return values
User —setJoinedTeams()
Sets the joinedTeams The Microsoft Teams teams that the user is a member of. Read-only. Nullable.
public
setJoinedTeams(Team $val) : User
Parameters
- $val : Team
-
The joinedTeams
Return values
User —setLastPasswordChangeDateTime()
Sets the lastPasswordChangeDateTime The time when this Azure AD user last changed their password. 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.
public
setLastPasswordChangeDateTime(DateTime $val) : User
Parameters
- $val : DateTime
-
The lastPasswordChangeDateTime
Return values
User —setLegalAgeGroupClassification()
Sets the 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.
public
setLegalAgeGroupClassification(string $val) : User
Parameters
- $val : string
-
The legalAgeGroupClassification
Return values
User —setLicenseAssignmentStates()
Sets the licenseAssignmentStates State of license assignments for this user. Read-only. Returned only on $select.
public
setLicenseAssignmentStates(LicenseAssignmentState $val) : User
Parameters
- $val : LicenseAssignmentState
-
The licenseAssignmentStates
Return values
User —setLicenseDetails()
Sets the licenseDetails A collection of this user's license details. Read-only.
public
setLicenseDetails(LicenseDetails $val) : User
Parameters
- $val : LicenseDetails
-
The licenseDetails
Return values
User —setMail()
Sets the mail The SMTP address for the user, for example<EMAIL_ADDRESS>to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith).
public
setMail(string $val) : User
Parameters
- $val : string
-
The mail
Return values
User —setMailboxSettings()
Sets the 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.
public
setMailboxSettings(MailboxSettings $val) : User
Parameters
- $val : MailboxSettings
-
The mailboxSettings
Return values
User —setMailFolders()
Sets the mailFolders The user's mail folders. Read-only. Nullable.
public
setMailFolders(MailFolder $val) : User
Parameters
- $val : MailFolder
-
The mailFolders
Return values
User —setMailNickname()
Sets the mailNickname 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).
public
setMailNickname(string $val) : User
Parameters
- $val : string
-
The mailNickname
Return values
User —setManagedAppRegistrations()
Sets the managedAppRegistrations Zero or more managed app registrations that belong to the user.
public
setManagedAppRegistrations(ManagedAppRegistration $val) : User
Parameters
- $val : ManagedAppRegistration
-
The managedAppRegistrations
Return values
User —setManagedDevices()
Sets the managedDevices The managed devices associated with the user.
public
setManagedDevices(ManagedDevice $val) : User
Parameters
- $val : ManagedDevice
-
The managedDevices
Return values
User —setManager()
Sets the manager The user or contact that is this user's manager. Read-only. (HTTP Methods: GET, PUT, DELETE.). Supports $expand.
public
setManager(DirectoryObject $val) : User
Parameters
- $val : DirectoryObject
-
The manager
Return values
User —setMemberOf()
Sets the memberOf The groups and directory roles that the user is a member of. Read-only. Nullable. Supports $expand.
public
setMemberOf(DirectoryObject $val) : User
Parameters
- $val : DirectoryObject
-
The memberOf
Return values
User —setMessages()
Sets the messages The messages in a mailbox or folder. Read-only. Nullable.
public
setMessages(Message $val) : User
Parameters
- $val : Message
-
The messages
Return values
User —setMobileAppIntentAndStates()
Sets the mobileAppIntentAndStates The list of troubleshooting events for this user.
public
setMobileAppIntentAndStates(MobileAppIntentAndState $val) : User
Parameters
- $val : MobileAppIntentAndState
-
The mobileAppIntentAndStates
Return values
User —setMobileAppTroubleshootingEvents()
Sets the mobileAppTroubleshootingEvents The list of mobile app troubleshooting events for this user.
public
setMobileAppTroubleshootingEvents(MobileAppTroubleshootingEvent $val) : User
Parameters
- $val : MobileAppTroubleshootingEvent
-
The mobileAppTroubleshootingEvents
Return values
User —setMobilePhone()
Sets the mobilePhone 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).
public
setMobilePhone(string $val) : User
Parameters
- $val : string
-
The mobilePhone
Return values
User —setMySite()
Sets the mySite The URL for the user's personal site. Returned only on $select.
public
setMySite(string $val) : User
Parameters
- $val : string
-
The mySite
Return values
User —setNotifications()
Sets the notifications
public
setNotifications(Notification $val) : User
Parameters
- $val : Notification
-
The notifications
Return values
User —setOauth2PermissionGrants()
Sets the oauth2PermissionGrants
public
setOauth2PermissionGrants(OAuth2PermissionGrant $val) : User
Parameters
- $val : OAuth2PermissionGrant
-
The oauth2PermissionGrants
Return values
User —setODataType()
Sets the ODataType
public
setODataType(string $val) : Entity
Parameters
- $val : string
-
The ODataType
Return values
Entity —setOfficeLocation()
Sets the officeLocation The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith).
public
setOfficeLocation(string $val) : User
Parameters
- $val : string
-
The officeLocation
Return values
User —setOnenote()
Sets the onenote Read-only.
public
setOnenote(Onenote $val) : User
Parameters
- $val : Onenote
-
The onenote
Return values
User —setOnlineMeetings()
Sets the onlineMeetings
public
setOnlineMeetings(OnlineMeeting $val) : User
Parameters
- $val : OnlineMeeting
-
The onlineMeetings
Return values
User —setOnPremisesDistinguishedName()
Sets the onPremisesDistinguishedName 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.
public
setOnPremisesDistinguishedName(string $val) : User
Parameters
- $val : string
-
The onPremisesDistinguishedName
Return values
User —setOnPremisesDomainName()
Sets the onPremisesDomainName 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.
public
setOnPremisesDomainName(string $val) : User
Parameters
- $val : string
-
The onPremisesDomainName
Return values
User —setOnPremisesExtensionAttributes()
Sets the onPremisesExtensionAttributes Contains extensionAttributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set during creation or update. These extension attributes are also known as Exchange custom attributes 1-15. Returned only on $select. Supports $filter (eq, NOT, ge, le, in).
public
setOnPremisesExtensionAttributes(OnPremisesExtensionAttributes $val) : User
Parameters
- $val : OnPremisesExtensionAttributes
-
The onPremisesExtensionAttributes
Return values
User —setOnPremisesImmutableId()
Sets the onPremisesImmutableId 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).
public
setOnPremisesImmutableId(string $val) : User
.
Parameters
- $val : string
-
The onPremisesImmutableId
Return values
User —setOnPremisesLastSyncDateTime()
Sets the onPremisesLastSyncDateTime 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).
public
setOnPremisesLastSyncDateTime(DateTime $val) : User
Parameters
- $val : DateTime
-
The onPremisesLastSyncDateTime
Return values
User —setOnPremisesProvisioningErrors()
Sets the onPremisesProvisioningErrors Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter (eq, NOT, ge, le).
public
setOnPremisesProvisioningErrors(OnPremisesProvisioningError $val) : User
Parameters
- $val : OnPremisesProvisioningError
-
The onPremisesProvisioningErrors
Return values
User —setOnPremisesSamAccountName()
Sets the onPremisesSamAccountName 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).
public
setOnPremisesSamAccountName(string $val) : User
Parameters
- $val : string
-
The onPremisesSamAccountName
Return values
User —setOnPremisesSecurityIdentifier()
Sets the onPremisesSecurityIdentifier 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.
public
setOnPremisesSecurityIdentifier(string $val) : User
Parameters
- $val : string
-
The onPremisesSecurityIdentifier
Return values
User —setOnPremisesSyncEnabled()
Sets the onPremisesSyncEnabled 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. Returned only on $select. Supports $filter (eq, ne, NOT, in).
public
setOnPremisesSyncEnabled(bool $val) : User
Parameters
- $val : bool
-
The onPremisesSyncEnabled
Return values
User —setOnPremisesUserPrincipalName()
Sets the onPremisesUserPrincipalName 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).
public
setOnPremisesUserPrincipalName(string $val) : User
Parameters
- $val : string
-
The onPremisesUserPrincipalName
Return values
User —setOtherMails()
Sets the otherMails A list of additional email addresses for the user; for example<EMAIL_ADDRESS><EMAIL_ADDRESS>NOTE: This property cannot contain accent characters. Returned only on $select. Supports $filter (eq, NOT, ge, le, in, startsWith).
public
setOtherMails(string $val) : User
Parameters
- $val : string
-
The otherMails
Return values
User —setOutlook()
Sets the outlook Read-only.
public
setOutlook(OutlookUser $val) : User
Parameters
- $val : OutlookUser
-
The outlook
Return values
User —setOwnedDevices()
Sets the ownedDevices Devices that are owned by the user. Read-only. Nullable. Supports $expand.
public
setOwnedDevices(DirectoryObject $val) : User
Parameters
- $val : DirectoryObject
-
The ownedDevices
Return values
User —setOwnedObjects()
Sets the ownedObjects Directory objects that are owned by the user. Read-only. Nullable. Supports $expand.