Licensing

Citrix Secure Private Access telemetry data elements

Admin

Event header:

Field Description Example
ver Header version. Hardcoded: ver: 1.0 1.0
id Unique event Id (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
Event type name. Hardcoded admin
type: admin
st UTC formatted timestamp 2011-08-12T20:17:46.384Z
prod
Product name. Hardcoded.
prod: AccessSecurity.OnPrem
AccessSecurity.OnPrem
prodVer Product version 2402
user




Unique ID to identify the admin logged in.




{
fullName: Username,fullName: Username
samName: User’s SAM account name
upn: User’s UPN name
userSid: User’s SID
}

Event payload:

Field Description Example
actualtemplatecode
Payload template version.
Hardcoded:actualtemplatecode: 1.0
1.0
adminLoginType
RBAC of admin
type: enum
values: fulladmin/readonly/helpdesk
clientType From where admin logged in. Admin console/Director/Public API etc. Others will be sent when no User-Agent is received from client. AdminConsole/CitrixMonitor/Others
tenantName Tenant name for multitenant deployments (service providers) or site name for single tenant. SPASite1
enabledFeatures Denotes the features that are enabled for the session. 1

Configuration

Event header:

Field Description Example
ver Header version. Hardcoded: ver: 1.0 1.0
id Unique event Id (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
Event type name. Hardcoded config
type: config
st UTC formatted timestamp 2011-08-12T20:17:46.384Z
prod
Product name. Hardcoded AccessSecurity.OnPrem
prod: AccessSecurity.OnPrem
prodVer Product version 2405

Event payload:

Field Description Example
actualtemplatecode
Payload template version. Hardcoded.
actualtemplatecode: 1.0
1.0
appsPublished















List of internal and external applications published. Includes Web/SaaS and TCP/UDP apps.















[
{
name:jira
type: web
internal: true
}
{
name:Office 365
type: saas
internal: false
}
{
name:eng_printer
type: tcp
internal: true
}
]

User

Event header:

Field Description Example
ver Header version. Hardcoded: ver: 1.0 1.0
id Unique event Id (GUID) 1fced2a0-52e7-4c48-bf4e-6f2e06136e11
type
Event type name user
type: user
st UTC formatted timestamp 2011-08-12T20:17:46.384Z
prod
Product name. Hardcoded
prod: AccessSecurity.OnPrem
AccessSecurity.OnPrem
prodVer Product version 2402
user




Unique ID to identify a user.




{
fullName: Username, (optional)
samName: User’s SAM account name
upn: User’s UPN name
userSid: User’s SID
}
dvc


PII data, if enabled these values must be scrambled.
dvcId - Unique device ID to identify a device from where the application launch was initiated.
dvcName - Friendly name for the device.
{
dvcId: AE18C4D5
dvcName: User’s PC
}

Event payload:

Field Description Example
actualtemplatecode
Payload template version.
Hardcoded:actualtemplatecode: 1.5
1.5
transportProtocolType Connection type: TCP or UDP or 0 (for Web\SaaS) tcp
ngsRecordType Application type: websaas or tcpudp websaas
tenantName Tenant name for multitenant deployments (service providers) or site name for single tenant. SPAOPDEVSite
appsAccesed








List of apps which will be accessed by the user for the event.








{
published : {
internal : [issues.citrite.net]
external :[citrixsys.splunk.com, www.office365.com]
}
unpublished : {
internal : []
external : [www.okta.com, www.cloudcentral.com]
}
}
clientInfo This field indicates if the client is Citrix Enterprise Browser, Citrix Secure Access, Citrix Workspace App, RfWeb along with version. {name: ceb, version: 21.4.0}
platformType This field displays the agent OS type. Win/MacOS/iOS/Android
enabledFeatures Denotes the features that are enabled for the session. 1
Citrix Secure Private Access telemetry data elements