adx_externalidentity EntityType
- Entity Set Path
- [organization URI]/api/data/v9.2/adx_externalidentities
- Base Type
- crmbaseentity
- Display Name
- External Identity
- Primary Key
- adx_externalidentityid
- Primary Key Attribute
- adx_username
- Operations Supported
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity.Some properties are read-only.
| Name | Type | Details | ||||||
|---|---|---|---|---|---|---|---|---|
| adx_externalidentityid | Edm.Guid |
Shows the entity instances. Display Name: External Identity |
||||||
| adx_identityprovidername | Edm.String |
Display Name: Identity Provider |
||||||
| adx_username | Edm.String |
Shows the name of the custom entity. Display Name: User Name |
||||||
| createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. Display Name: Created On Read Only
|
||||||
| importsequencenumber | Edm.Int32 |
Shows the sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||
| modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was modified. Display Name: Modified On Read Only
|
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Shows the date and time that the record was migrated. Display Name: Record Created On |
||||||
| statecode | Edm.Int32 |
Shows whether the external identity is active or inactive. Inactive records are read-only and can't be edited unless they are reactivated. Display Name: Status
Default Options
|
||||||
| statuscode | Edm.Int32 |
Select the external identity's status. Display Name: Status Reason
Default Options
|
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||
| utcconversiontimezonecode | Edm.Int32 |
Shows the time zone code that was in use when the record was created. Display Name: UTC Conversion Time Zone Code |
||||||
| versionnumber | Edm.Int64 |
Version Number Display Name: Version Number Read Only
|
Lookup Properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _adx_contactid_value | adx_contactid |
Unique identifier for Contact associated with External Identity. |
| _createdby_value | createdby |
Shows the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Shows the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Shows the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Shows the delegate user who modified the record. |
| _organizationid_value | organizationid |
Shows the organization. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| adx_contactid | contact | adx_contact_externalidentity |
| createdby | systemuser | lk_adx_externalidentity_createdby |
| createdonbehalfby | systemuser | lk_adx_externalidentity_createdonbehalfby |
| modifiedby | systemuser | lk_adx_externalidentity_modifiedby |
| modifiedonbehalfby | systemuser | lk_adx_externalidentity_modifiedonbehalfby |
| organizationid | organization | organization_adx_externalidentity |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| adx_externalidentity_AsyncOperations | asyncoperation | regardingobjectid_adx_externalidentity |
| adx_externalidentity_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_adx_externalidentity |
| adx_externalidentity_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_adx_externalidentity |
| adx_externalidentity_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_adx_externalidentity |
| adx_externalidentity_ProcessSession | processsession | regardingobjectid_adx_externalidentity |
| adx_externalidentity_SyncErrors | syncerror | regardingobjectid_adx_externalidentity |
Operations
The following operations can be used with the adx_externalidentity entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| IsValidStateTransition | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |