External Identity (adx_externalidentity) table/entity reference (Microsoft Dataverse)

Messages

The following table lists the messages for the External Identity (adx_externalidentity) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Associate Event: True	Associate records	Associate records
Create Event: True	POST /adx_externalidentities See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /adx_externalidentities(adx_externalidentityid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
Retrieve Event: True	GET /adx_externalidentities(adx_externalidentityid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /adx_externalidentities See Query data	Query data
SetState Event: True	PATCH /adx_externalidentities(adx_externalidentityid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /adx_externalidentities(adx_externalidentityid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /adx_externalidentities(adx_externalidentityid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest

Events

The following table lists the events for the External Identity (adx_externalidentity) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name	Web API Operation	SDK for .NET
BulkRetain	BulkRetain	Learn to use messages with the SDK for .NET
PurgeRetainedContent	PurgeRetainedContent	Learn to use messages with the SDK for .NET
Retain	Retain	Learn to use messages with the SDK for .NET
RollbackRetain	RollbackRetain	Learn to use messages with the SDK for .NET
ValidateRetentionConfig	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the External Identity (adx_externalidentity) table.

Property	Value
DisplayName	External Identity
DisplayCollectionName	External Identities
SchemaName	adx_externalidentity
CollectionSchemaName	adx_externalidentities
EntitySetName	adx_externalidentities
LogicalName	adx_externalidentity
LogicalCollectionName	adx_externalidentities
PrimaryIdAttribute	adx_externalidentityid
PrimaryNameAttribute	adx_username
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

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

• adx_contactid
• adx_externalidentityId
• adx_identityprovidername
• adx_username
• ImportSequenceNumber
• OverriddenCreatedOn
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

adx_contactid

Property	Value
Description	Unique identifier for Contact associated with External Identity.
DisplayName	Contact
IsValidForForm	True
IsValidForRead	True
LogicalName	adx_contactid
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	contact

adx_externalidentityId

Property	Value
Description	Shows the entity instances.
DisplayName	External Identity
IsValidForForm	False
IsValidForRead	True
LogicalName	adx_externalidentityid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

adx_identityprovidername

Property	Value
Description
DisplayName	Identity Provider
IsValidForForm	True
IsValidForRead	True
LogicalName	adx_identityprovidername
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	400

adx_username

Property	Value
Description	Shows the name of the custom entity.
DisplayName	User Name
IsValidForForm	True
IsValidForRead	True
LogicalName	adx_username
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

ImportSequenceNumber

Property	Value
Description	Shows the sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	importsequencenumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

OverriddenCreatedOn

Property	Value
Description	Shows the date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

statecode

Property	Value
Description	Shows whether the external identity is active or inactive. Inactive records are read-only and can't be edited unless they are reactivated.
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	adx_externalidentity_statecode

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: Active
1	Label: Inactive DefaultStatus: 2 InvariantName: Inactive

statuscode

Property	Value
Description	Select the external identity's status.
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	adx_externalidentity_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

UTCConversionTimeZoneCode

Property	Value
Description	Shows the time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

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

• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• VersionNumber

CreatedBy

Property	Value
Description	Shows the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Shows the date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Shows the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedBy

Property	Value
Description	Shows the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Shows the date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Shows the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Shows the organization.
DisplayName	Organization ID
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	None
Type	Lookup
Targets	organization

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• adx_contact_externalidentity
• lk_adx_externalidentity_createdby
• lk_adx_externalidentity_createdonbehalfby
• lk_adx_externalidentity_modifiedby
• lk_adx_externalidentity_modifiedonbehalfby
• organization_adx_externalidentity

adx_contact_externalidentity

One-To-Many Relationship: contact adx_contact_externalidentity

Property	Value
ReferencedEntity	contact
ReferencedAttribute	contactid
ReferencingAttribute	adx_contactid
ReferencingEntityNavigationPropertyName	adx_contactid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade RollupView: NoCascade Share: Cascade Unshare: Cascade

lk_adx_externalidentity_createdby

One-To-Many Relationship: systemuser lk_adx_externalidentity_createdby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdby
ReferencingEntityNavigationPropertyName	createdby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_adx_externalidentity_createdonbehalfby

One-To-Many Relationship: systemuser lk_adx_externalidentity_createdonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdonbehalfby
ReferencingEntityNavigationPropertyName	createdonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_adx_externalidentity_modifiedby

One-To-Many Relationship: systemuser lk_adx_externalidentity_modifiedby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedby
ReferencingEntityNavigationPropertyName	modifiedby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_adx_externalidentity_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_adx_externalidentity_modifiedonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedonbehalfby
ReferencingEntityNavigationPropertyName	modifiedonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

organization_adx_externalidentity

One-To-Many Relationship: organization organization_adx_externalidentity

Property	Value
ReferencedEntity	organization
ReferencedAttribute	organizationid
ReferencingAttribute	organizationid
ReferencingEntityNavigationPropertyName	organizationid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

• adx_externalidentity_AsyncOperations
• adx_externalidentity_BulkDeleteFailures
• adx_externalidentity_MailboxTrackingFolders
• adx_externalidentity_PrincipalObjectAttributeAccesses
• adx_externalidentity_ProcessSession
• adx_externalidentity_SyncErrors

adx_externalidentity_AsyncOperations

Many-To-One Relationship: asyncoperation adx_externalidentity_AsyncOperations

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	adx_externalidentity_AsyncOperations
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

adx_externalidentity_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure adx_externalidentity_BulkDeleteFailures

Property	Value
ReferencingEntity	bulkdeletefailure
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	adx_externalidentity_BulkDeleteFailures
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

adx_externalidentity_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder adx_externalidentity_MailboxTrackingFolders

Property	Value
ReferencingEntity	mailboxtrackingfolder
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	adx_externalidentity_MailboxTrackingFolders
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

adx_externalidentity_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess adx_externalidentity_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	principalobjectattributeaccess
ReferencingAttribute	objectid
ReferencedEntityNavigationPropertyName	adx_externalidentity_PrincipalObjectAttributeAccesses
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

adx_externalidentity_ProcessSession

Many-To-One Relationship: processsession adx_externalidentity_ProcessSession

Property	Value
ReferencingEntity	processsession
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	adx_externalidentity_ProcessSession
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

adx_externalidentity_SyncErrors

Many-To-One Relationship: syncerror adx_externalidentity_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	adx_externalidentity_SyncErrors
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
adx_externalidentity