Systems.Security.AccessTokens Entity

Namespace: Systems.Security

It keeps track of "grants" issued by Identity Server - Personal Access Tokens (PATs), refresh tokens, device codes, and consents. Entity: Sec_Access_Tokens (Introduced in version 26.2.0.13)

Default Visualization

Default Display Text Format:
{Id}: {AccessTokenKey}
Default Search Members:
__
Category: SystemData
Show in UI: ShownByDefault
API access: ReadWrite

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 Tree

• Systems.Security.AccessTokens

Attributes

Name	Type	Description
AccessTokenKey	string (256)	The unique key of the token. Required Filter(multi eq) ORD
Actor	string (128) nullable	For whom the token was issued (might be user email). Filter(multi eq)
Client	string (128) nullable	The client application. Filter(multi eq)
ConsumedTimestamp	datetime nullable	When it was used up (for one-time grants). Filter(ge;le)
CreationTimestamp	datetime	When the token was created. Required Default(NowUtc) Filter(ge;le)
Data	string (max) nullable	Token contents.
Description	string (128) nullable	The description of this AccessToken.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExpireTimestamp	datetime nullable	When the token expires. Filter(ge;le)
ExternalId	string	The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]
ExternalSystem	string	The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]
Id	guid
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.
Session	string (128) nullable	Session parameter. Filter(multi eq)
Type	string (64)	Type of the token - reference_token, refresh_token, etc. Required

References

Name	Type	Description
TrustedApplication	TrustedApplications (nullable)	Sec_Trusted_Applications // Matched trusted application (from Client). Filter(multi eq)
User	Users (nullable)	Matched user (from the actor). Filter(multi eq)

Attribute Details

AccessTokenKey

The unique key of the token. Required Filter(multi eq) ORD

Type: string (256)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: True
Maximum Length: 256
Show in UI: ShownByDefault

Actor

For whom the token was issued (might be user email). Filter(multi eq)

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

Client

The client application. Filter(multi eq)

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

ConsumedTimestamp

When it was used up (for one-time grants). Filter(ge;le)

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

CreationTimestamp

When the token was created. Required Default(NowUtc) Filter(ge;le)

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

Data

Token contents.

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

Description

The description of this AccessToken.

Type: string (128) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 128
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

ExpireTimestamp

When the token expires. Filter(ge;le)

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

ExternalId

The id of the object, when it is imported/synchronized with external system. Used by sync apps to identify the object in external systems. [Filter(multi eq)] [ORD] [Introduced in version 24.1.0.89]

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

ExternalSystem

The name of the external system from which the object is imported/synchronized. [Filter(multi eq)] [Introduced in version 24.1.0.89]

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

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
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

Session

Session parameter. Filter(multi eq)

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

Type

Type of the token - reference_token, refresh_token, etc. Required

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

Reference Details

TrustedApplication

Sec_Trusted_Applications // Matched trusted application (from Client). Filter(multi eq)

Type: TrustedApplications (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

User

Matched user (from the actor). Filter(multi eq)

Type: Users (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
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

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  The notification subject.
  Type: string

• priority
  The notification priority.
  Type: Systems.Core.NotificationsRepository.Priority
  Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
  Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

  Value	Description
  Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
  Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
  Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
  High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
  Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

  Optional: True
  Default Value: Normal

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Security_AccessTokens?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Security_AccessTokens?$top=10