User

Represents an Azure AD user account. Inherits from directoryObject. Contains identity, profile, organizational, and authentication properties.

AuthenticationAuthorizationIdentityMicrosoftMicrosoft EntraOAuthOpenID ConnectSAMLSCIMSingle Sign-OnZero Trust

Properties

Name Type Description
accountEnabled boolean True if the account is enabled; otherwise, false.
assignedLicenses array The licenses that are assigned to the user.
assignedPlans array The plans that are assigned to the user.
businessPhones array The telephone numbers for the user.
city ['string', 'null'] The city where the user is located.
companyName ['string', 'null'] The company name associated with the user.
country ['string', 'null'] The country or region where the user is located.
createdDateTime string The date and time the user was created.
department ['string', 'null'] The department in which the user works.
displayName string The name displayed in the address book for the user. Required on creation.
employeeId ['string', 'null'] The employee identifier assigned to the user by the organization.
employeeType ['string', 'null'] Captures the enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.
givenName ['string', 'null'] The given name (first name) of the user.
jobTitle ['string', 'null'] The user's job title.
mail ['string', 'null'] The SMTP address for the user.
mailNickname string The mail alias for the user. Required on creation.
mobilePhone ['string', 'null'] The primary cellular telephone number for the user.
officeLocation ['string', 'null'] The office location in the user's place of business.
onPremisesDistinguishedName ['string', 'null'] The on-premises Active Directory distinguished name.
onPremisesDomainName ['string', 'null'] The on-premises domain name.
onPremisesImmutableId ['string', 'null'] Used to associate an on-premises Active Directory user account to the Azure AD user object.
onPremisesLastSyncDateTime ['string', 'null'] The last time at which the object was synced with the on-premises directory.
onPremisesSyncEnabled ['boolean', 'null'] True if this user object is currently being synced from an on-premises Active Directory.
otherMails array Additional email addresses for the user.
passwordPolicies ['string', 'null'] Specifies password policies for the user. One of DisableStrongPassword and DisablePasswordExpiration, or both.
postalCode ['string', 'null'] The postal code for the user's postal address.
preferredLanguage ['string', 'null'] The preferred language for the user in ISO 639-1 code format. Example: en-US.
proxyAddresses array The proxy addresses for the user. Example: SMTP:[email protected], smtp:[email protected].
signInSessionsValidFromDateTime string Any refresh tokens or session tokens issued before this time are invalid.
state ['string', 'null'] The state or province in the user's address.
streetAddress ['string', 'null'] The street address of the user's place of business.
surname ['string', 'null'] The user's surname (family name or last name).
usageLocation ['string', 'null'] A two-letter country code (ISO 3166). Required for users who will be assigned licenses.
userPrincipalName string The user principal name (UPN) of the user. Required on creation. Format: alias@domain.
userType ['string', 'null'] A string value that classifies the user. Typically Member or Guest.
View JSON Schema on GitHub