Systems.Security.UserDevices Entity

Namespace: Systems.Security

Information about devices linked to users, including login activity, and notification preferences for each device. Entity: Sec_User_Devices (Introduced in version 1.0.0.25)

Default Visualization

Default Display Text Format:
{DeviceName}
Default Search Members:
DeviceName
Name Data Member:
DeviceName
Category: Definitions
Show in UI: CannotBeShown

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Systems.Security.Users
Aggregate Root:
Systems.Security.Users

Attributes

Name	Type	Description
CreationTimeUtc	datetime	The exact server time (in UTC), when the device was registered. `Required` `Default(NowUtc)` `Filter(ge;le)` `ReadOnly` `Introduced in version 25.1.2.30`
DeviceFingerprint	string (2048) nullable	A unique identifier for the device based on its fingerprint, used to track devices securely. This column can be null if not provided. `Filter(eq)` `ReadOnly` `Introduced in version 25.1.2.30`
DeviceInfo	string (4092) nullable	Shows basic information about your device. `ReadOnly` `Introduced in version 25.1.2.34`
DeviceName	string (256)	The name of the device, such as the model or a custom name given by the user. `Required` `Introduced in version 25.1.2.30`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
LastLoginTimeUtc	datetime	The exact server time (in UTC) when the device was last used to sign in. `Required` `Default(NowUtc)` `Filter(ge;le)` `ORD` `ReadOnly` `Introduced in version 25.1.2.30`
NotificationsAllowed	boolean	Тhe device is allowed to receive notifications from the system. `Required` `Default(true)` `Filter(eq)` `Introduced in version 25.1.2.30`
NotificationsSystem	NotificationsSystem	The type or system of notifications allowed on the device, typically referring to the notification service (e.g., FCM, WebPush, etc.). `Required` `Filter(multi eq)` `ReadOnly` `Introduced in version 25.1.2.30`
NotificationsToken	string (2048) nullable	A token used for sending notifications to the device, such as a push notification token. null if not applicable. `ReadOnly` `Introduced in version 25.1.2.30`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

References

Name	Type	Description
User	Users	The to which this UserDevice belongs. `Required` `Filter(multi eq)` `Introduced in version 25.1.2.30` `Owner`

Attribute Details

CreationTimeUtc

The exact server time (in UTC), when the device was registered. Required Default(NowUtc) Filter(ge;le) ReadOnly Introduced in version 25.1.2.30

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

DeviceFingerprint

A unique identifier for the device based on its fingerprint, used to track devices securely. This column can be null if not provided. Filter(eq) ReadOnly Introduced in version 25.1.2.30

Type: string (2048) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 2048
Show in UI: ShownByDefault

DeviceInfo

Shows basic information about your device. ReadOnly Introduced in version 25.1.2.34

Type: string (4092) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 4092
Show in UI: ShownByDefault

DeviceName

The name of the device, such as the model or a custom name given by the user. Required Introduced in version 25.1.2.30

Type: string (256)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

LastLoginTimeUtc

The exact server time (in UTC) when the device was last used to sign in. Required Default(NowUtc) Filter(ge;le) ORD ReadOnly Introduced in version 25.1.2.30

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault

NotificationsAllowed

Тhe device is allowed to receive notifications from the system. Required Default(true) Filter(eq) Introduced in version 25.1.2.30

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

NotificationsSystem

The type or system of notifications allowed on the device, typically referring to the notification service (e.g., FCM, WebPush, etc.). Required Filter(multi eq) ReadOnly Introduced in version 25.1.2.30

Type: NotificationsSystem
Category: System
Allowed values for the NotificationsSystem(Systems.Security.UserDevices.md#notificationssystem) data attribute
Allowed Values (Systems.Security.UserDevicesRepository.NotificationsSystem Enum Members)

Value	Description
NotAvailable	No notification system available for the device.. Stored as 'NA'. Database Value: 'NA' Model Value: 0 Domain API Value: 'NotAvailable'
FirebaseCloudMessaging	Google service for sending notifications across platforms.. Stored as 'FCM'. Database Value: 'FCM' Model Value: 1 Domain API Value: 'FirebaseCloudMessaging'
WebPushAPI	Push notifications for web browsers.. Stored as 'WPUSH'. Database Value: 'WPUSH' Model Value: 2 Domain API Value: 'WebPushAPI'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

NotificationsToken

A token used for sending notifications to the device, such as a push notification token. null if not applicable. ReadOnly Introduced in version 25.1.2.30

Type: string (2048) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2048
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Reference Details

User

The to which this UserDevice belongs. Required Filter(multi eq) Introduced in version 25.1.2.30 Owner

Type: Users
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST