aaduser table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Virtual entity that represents AAD user

Added by: Metadata Extension Solution

Messages

Message Web API Operation SDK class or method
Create POST [org URI]/api/data/v9.0/aadusers
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/aadusers(aaduserid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/aadusers(aaduserid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveEntityChanges RetrieveEntityChangesRequest
RetrieveMultiple GET [org URI]/api/data/v9.0/aadusers
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/aadusers(aaduserid)
See Update
UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName aadusers
DisplayCollectionName AAD Users
DisplayName AAD User
EntitySetName aadusers
IsBPFEntity False
LogicalCollectionName aadusers
LogicalName aaduser
OwnershipType OrganizationOwned
PrimaryIdAttribute aaduserid
PrimaryNameAttribute displayname
SchemaName aaduser

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

aaduserId

Property Value
Description Unique identifier of an aad user.
DisplayName AAD user id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName aaduserid
RequiredLevel SystemRequired
Type Uniqueidentifier

AccountEnabled

Property Value
Description Indicates if the Account of an AAD User is enabled.
DisplayName AAD User Account Enabled
IsValidForForm True
IsValidForRead True
LogicalName accountenabled
RequiredLevel None
Type Boolean

AccountEnabled Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

BusinessPhones

Property Value
Description Business phone number for the user
DisplayName Business Phones
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName businessphones
MaxLength 100
RequiredLevel None
Type String

City

Property Value
Description City.
DisplayName City
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName city
MaxLength 100
RequiredLevel None
Type String

CompanyName

Property Value
Description Company Name.
DisplayName Company Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName companyname
MaxLength 100
RequiredLevel None
Type String

DisplayName

Property Value
Description The name displayed in the address book for the user.
DisplayName Display Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName displayname
MaxLength 100
RequiredLevel None
Type String

GivenName

Property Value
Description The given name (first name) of the user.
DisplayName Given Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName givenname
MaxLength 100
RequiredLevel None
Type String

id

Property Value
Description A unique identifer for AAD User
DisplayName A unique identifer for AAD User
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName id
RequiredLevel SystemRequired
Type Uniqueidentifier

ImAddresses

Property Value
Description ImAddresses for the user
DisplayName ImAddresses
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName imaddresses
MaxLength 100
RequiredLevel None
Type String

JobTitle

Property Value
Description The user's job title.
DisplayName Job Title
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName jobtitle
MaxLength 100
RequiredLevel None
Type String

Mail

Property Value
Description The SMTP address for the user.
DisplayName Mail
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName mail
MaxLength 100
RequiredLevel None
Type String

MobilePhone

Property Value
Description The primary cellular telephone number for the user.
DisplayName Mobile Phone
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName mobilephone
MaxLength 100
RequiredLevel None
Type String

OfficeLocation

Property Value
Description The office location in the user's place of business.
DisplayName Office Location
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName officelocation
MaxLength 200
RequiredLevel None
Type String

PostalCode

Property Value
Description Postal Code.
DisplayName Postal Code
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName postalcode
MaxLength 100
RequiredLevel None
Type String

PreferredLanguage

Property Value
Description The preferred language for the user. Should follow ISO 639-1 Code; for example 'en-US'.
DisplayName Preferred Language
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName preferredlanguage
MaxLength 100
RequiredLevel None
Type String

StreetAddress

Property Value
Description Street Address.
DisplayName Street Address
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName streetaddress
MaxLength 100
RequiredLevel None
Type String

surname

Property Value
Description The user's surname (family name or last name).
DisplayName Surname
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName surname
MaxLength 100
RequiredLevel None
Type String

UserPrincipalName

Property Value
Description The user principal name (UPN) of the user.
DisplayName User Principal Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName userprincipalname
MaxLength 100
RequiredLevel None
Type String

UserType

Property Value
Description User Type.
DisplayName User Type
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName usertype
MaxLength 100
RequiredLevel None
Type String

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedDateTime

Property Value
DateTimeBehavior UserLocal
Description Date and time when the AAD user was created.
DisplayName Created Date Time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createddatetime
RequiredLevel None
Type DateTime

See also

Dataverse table/entity reference
Web API Reference
aaduser EntityType